diff --git a/.buildkite/ftr_configs.yml b/.buildkite/ftr_configs.yml index 599289b7c6eac..bbf13a06a6421 100644 --- a/.buildkite/ftr_configs.yml +++ b/.buildkite/ftr_configs.yml @@ -79,6 +79,21 @@ disabled: # Asset Manager configs, in tech preview, will move to enabled after more stability introduced - x-pack/test/api_integration/apis/asset_manager/config.ts + # Serverless base config files + - x-pack/test_serverless/api_integration/config.base.ts + - x-pack/test_serverless/functional/config.base.ts + - x-pack/test_serverless/shared/config.base.ts + + # Serverless configs, currently only for manual tests runs, CI integration planned + - x-pack/test_serverless/api_integration/test_suites/common/config.ts + - x-pack/test_serverless/api_integration/test_suites/observability/config.ts + - x-pack/test_serverless/api_integration/test_suites/search/config.ts + - x-pack/test_serverless/api_integration/test_suites/security/config.ts + - x-pack/test_serverless/functional/test_suites/common/config.ts + - x-pack/test_serverless/functional/test_suites/observability/config.ts + - x-pack/test_serverless/functional/test_suites/search/config.ts + - x-pack/test_serverless/functional/test_suites/security/config.ts + defaultQueue: 'n2-4-spot' enabled: - test/accessibility/config.ts @@ -225,7 +240,7 @@ enabled: - x-pack/test/functional_basic/apps/ml/data_visualizer/group2/config.ts - x-pack/test/functional_basic/apps/ml/data_visualizer/group3/config.ts - x-pack/test/functional_basic/apps/transform/creation/index_pattern/config.ts - - x-pack/test/functional_basic/apps/transform/start_reset_delete/config.ts + - x-pack/test/functional_basic/apps/transform/actions/config.ts - x-pack/test/functional_basic/apps/transform/edit_clone/config.ts - x-pack/test/functional_basic/apps/transform/creation/runtime_mappings_saved_search/config.ts - x-pack/test/functional_basic/apps/transform/permissions/config.ts @@ -291,7 +306,7 @@ enabled: - x-pack/test/functional/apps/status_page/config.ts - x-pack/test/functional/apps/transform/creation/index_pattern/config.ts - x-pack/test/functional/apps/transform/creation/runtime_mappings_saved_search/config.ts - - x-pack/test/functional/apps/transform/start_reset_delete/config.ts + - x-pack/test/functional/apps/transform/actions/config.ts - x-pack/test/functional/apps/transform/edit_clone/config.ts - x-pack/test/functional/apps/transform/permissions/config.ts - x-pack/test/functional/apps/transform/feature_controls/config.ts diff --git a/.buildkite/scripts/steps/checks.sh b/.buildkite/scripts/steps/checks.sh index bf30578bfebc5..12077902c1c13 100755 --- a/.buildkite/scripts/steps/checks.sh +++ b/.buildkite/scripts/steps/checks.sh @@ -6,7 +6,6 @@ export DISABLE_BOOTSTRAP_VALIDATION=false .buildkite/scripts/bootstrap.sh .buildkite/scripts/steps/checks/precommit_hook.sh -.buildkite/scripts/steps/checks/packages.sh .buildkite/scripts/steps/checks/ts_projects.sh .buildkite/scripts/steps/checks/packages.sh .buildkite/scripts/steps/checks/bazel_packages.sh @@ -22,4 +21,4 @@ export DISABLE_BOOTSTRAP_VALIDATION=false .buildkite/scripts/steps/checks/test_projects.sh .buildkite/scripts/steps/checks/test_hardening.sh .buildkite/scripts/steps/checks/ftr_configs.sh -.buildkite/scripts/steps/checks/saved_objects_compat_changes.sh \ No newline at end of file +.buildkite/scripts/steps/checks/saved_objects_compat_changes.sh diff --git a/.buildkite/scripts/steps/storybooks/build_and_upload.ts b/.buildkite/scripts/steps/storybooks/build_and_upload.ts index 75be5696dbca6..3c47c3d99255b 100644 --- a/.buildkite/scripts/steps/storybooks/build_and_upload.ts +++ b/.buildkite/scripts/steps/storybooks/build_and_upload.ts @@ -50,6 +50,7 @@ const STORYBOOKS = [ 'language_documentation_popover', 'unified_search', 'random_sampling', + 'text_based_editor', ]; const GITHUB_CONTEXT = 'Build and Publish Storybooks'; diff --git a/.eslintrc.js b/.eslintrc.js index 8cf08f2819248..0dfe1901290fe 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -173,7 +173,7 @@ const DEV_PATTERNS = [ ...DEV_FILE_PATTERNS.map((file) => `{packages,src,x-pack}/**/${file}`), 'packages/kbn-interpreter/tasks/**/*', 'src/dev/**/*', - 'x-pack/{dev-tools,tasks,test,build_chromium}/**/*', + 'x-pack/{dev-tools,tasks,test,test_serverless,build_chromium}/**/*', 'x-pack/performance/**/*', 'src/setup_node_env/index.js', 'src/cli/dev.js', @@ -602,6 +602,8 @@ module.exports = { 'x-pack/test/ui_capabilities/*/tests/**/*', 'x-pack/test/performance/**/*.ts', '**/cypress.config.{js,ts}', + 'x-pack/test_serverless/**/config*.ts', + 'x-pack/test_serverless/*/test_suites/**/*', ], rules: { 'import/no-default-export': 'off', diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 8dd91e1213fba..541e3f64b516e 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -23,7 +23,7 @@ packages/kbn-alerts-as-data-utils @elastic/response-ops x-pack/test/alerting_api_integration/common/plugins/alerts_restricted @elastic/response-ops packages/kbn-alerts-ui-shared @elastic/response-ops packages/kbn-ambient-common-types @elastic/kibana-operations -packages/kbn-ambient-ftr-types @elastic/kibana-operations +packages/kbn-ambient-ftr-types @elastic/kibana-operations @elastic/appex-qa packages/kbn-ambient-storybook-types @elastic/kibana-operations packages/kbn-ambient-ui-types @elastic/kibana-operations packages/kbn-analytics @elastic/kibana-core @@ -331,7 +331,7 @@ x-pack/examples/embedded_lens_example @elastic/kibana-visualizations x-pack/plugins/encrypted_saved_objects @elastic/kibana-security x-pack/plugins/enterprise_search @elastic/enterprise-search-frontend packages/kbn-es @elastic/kibana-operations -packages/kbn-es-archiver @elastic/kibana-operations +packages/kbn-es-archiver @elastic/kibana-operations @elastic/appex-qa packages/kbn-es-errors @elastic/kibana-core packages/kbn-es-query @elastic/kibana-data-discovery packages/kbn-es-types @elastic/kibana-core @elastic/apm-ui @@ -346,7 +346,7 @@ src/plugins/event_annotation @elastic/kibana-visualizations x-pack/test/plugin_api_integration/plugins/event_log @elastic/response-ops x-pack/plugins/event_log @elastic/response-ops packages/kbn-expandable-flyout @elastic/security-threat-hunting-investigations -packages/kbn-expect @elastic/kibana-operations +packages/kbn-expect @elastic/kibana-operations @elastic/appex-qa x-pack/examples/exploratory_view_example @elastic/uptime x-pack/plugins/exploratory_view @elastic/uptime src/plugins/expression_error @elastic/kibana-presentation @@ -364,7 +364,7 @@ src/plugins/chart_expressions/expression_tagcloud @elastic/kibana-visualizations src/plugins/chart_expressions/expression_xy @elastic/kibana-visualizations examples/expressions_explorer @elastic/kibana-app-services src/plugins/expressions @elastic/kibana-visualizations -packages/kbn-failed-test-reporter-cli @elastic/kibana-operations +packages/kbn-failed-test-reporter-cli @elastic/kibana-operations @elastic/appex-qa x-pack/test/plugin_api_integration/plugins/feature_usage_test @elastic/kibana-security x-pack/plugins/features @elastic/kibana-core x-pack/test/functional_execution_context/plugins/alerts @elastic/kibana-core @@ -380,8 +380,8 @@ x-pack/plugins/fleet @elastic/fleet packages/kbn-flot-charts @elastic/kibana-operations x-pack/test/ui_capabilities/common/plugins/foo_plugin @elastic/kibana-security src/plugins/ftr_apis @elastic/kibana-core -packages/kbn-ftr-common-functional-services @elastic/kibana-operations -packages/kbn-ftr-screenshot-filename @elastic/kibana-operations +packages/kbn-ftr-common-functional-services @elastic/kibana-operations @elastic/appex-qa +packages/kbn-ftr-screenshot-filename @elastic/kibana-operations @elastic/appex-qa x-pack/test/functional_with_es_ssl/plugins/cases @elastic/response-ops packages/kbn-generate @elastic/kibana-operations packages/kbn-generate-csv @elastic/appex-sharedux @@ -423,7 +423,7 @@ test/interactive_setup_api_integration/plugins/test_endpoints @elastic/kibana-se packages/kbn-interpreter @elastic/kibana-visualizations packages/kbn-io-ts-utils @elastic/apm-ui packages/kbn-jest-serializers @elastic/kibana-operations -packages/kbn-journeys @elastic/kibana-operations +packages/kbn-journeys @elastic/kibana-operations @elastic/appex-qa packages/kbn-json-ast @elastic/kibana-operations test/health_gateway/plugins/status @elastic/kibana-core test/plugin_functional/plugins/kbn_sample_panel_action @elastic/kibana-app-services @@ -458,6 +458,7 @@ packages/kbn-mapbox-gl @elastic/kibana-gis x-pack/examples/third_party_maps_source_example @elastic/kibana-gis src/plugins/maps_ems @elastic/kibana-gis x-pack/plugins/maps @elastic/kibana-gis +x-pack/packages/maps/vector_tile_utils @elastic/kibana-gis x-pack/packages/ml/agg_utils @elastic/ml-ui x-pack/packages/ml/anomaly_utils @elastic/ml-ui x-pack/packages/ml/date_picker @elastic/ml-ui @@ -486,7 +487,7 @@ x-pack/packages/observability/alert_details @elastic/actionable-observability x-pack/test/cases_api_integration/common/plugins/observability @elastic/response-ops x-pack/plugins/observability_onboarding @elastic/apm-ui x-pack/plugins/observability @elastic/actionable-observability -x-pack/plugins/observability_shared @elastic/actionable-observability +x-pack/plugins/observability_shared @elastic/observability-ui x-pack/test/security_api_integration/plugins/oidc_provider @elastic/kibana-security test/common/plugins/otel_metrics @elastic/infra-monitoring-ui packages/kbn-optimizer @elastic/kibana-operations @@ -664,11 +665,13 @@ src/plugins/telemetry_management_section @elastic/kibana-core src/plugins/telemetry @elastic/kibana-core test/plugin_functional/plugins/telemetry @elastic/kibana-core packages/kbn-telemetry-tools @elastic/kibana-core -packages/kbn-test @elastic/kibana-operations +packages/kbn-test @elastic/kibana-operations @elastic/appex-qa x-pack/test/licensing_plugin/plugins/test_feature_usage @elastic/kibana-security -packages/kbn-test-jest-helpers @elastic/kibana-operations -packages/kbn-test-subj-selector @elastic/kibana-operations +packages/kbn-test-jest-helpers @elastic/kibana-operations @elastic/appex-qa +packages/kbn-test-subj-selector @elastic/kibana-operations @elastic/appex-qa x-pack/examples/testing_embedded_lens @elastic/kibana-visualizations +packages/kbn-text-based-editor @elastic/kibana-visualizations +src/plugins/text_based_languages @elastic/kibana-visualizations x-pack/examples/third_party_lens_navigation_prompt @elastic/kibana-visualizations x-pack/examples/third_party_vis_lens_example @elastic/kibana-visualizations x-pack/plugins/threat_intelligence @elastic/protections-experience @@ -791,16 +794,7 @@ packages/kbn-yarn-lock-validator @elastic/kibana-operations #CC# /x-pack/plugins/reporting/ @elastic/appex-sharedux #CC# /x-pack/plugins/serverless_security/ @elastic/appex-sharedux -### Observability Plugins - -# Observability Shared App -x-pack/plugins/observability_shared @elastic/observability-ui - -# Observability App -x-pack/plugins/observability @elastic/actionable-observability - -# Observability App > Overview page -x-pack/plugins/observability/public/pages/overview @elastic/observability-ui +### Observability packages # Observability App > Alert Details x-pack/packages/observability/alert_details @elastic/actionable-observability @@ -845,13 +839,6 @@ x-pack/test/observability_functional @elastic/actionable-observability /x-pack/test/functional/services/uptime @elastic/uptime /x-pack/test/api_integration/apis/uptime @elastic/uptime /x-pack/test/api_integration/apis/synthetics @elastic/uptime -/x-pack/plugins/observability/public/components/shared/exploratory_view @elastic/uptime -/x-pack/plugins/observability/public/components/shared/field_value_suggestions @elastic/uptime -/x-pack/plugins/observability/public/components/shared/core_web_vitals @elastic/uptime -/x-pack/plugins/observability/public/components/shared/load_when_in_view @elastic/uptime -/x-pack/plugins/observability/public/components/shared/filter_value_label @elastic/uptime -/x-pack/plugins/observability/public/utils/observability_data_views @elastic/uptime -/x-pack/plugins/observability/e2e @elastic/uptime # Client Side Monitoring / Uptime (lives in APM directories but owned by Uptime) /x-pack/plugins/apm/public/application/uxApp.tsx @elastic/uptime @@ -859,7 +846,7 @@ x-pack/test/observability_functional @elastic/actionable-observability /x-pack/test/apm_api_integration/tests/csm/ @elastic/uptime # Observability onboarding tour -/x-pack/plugins/observability/public/components/shared/tour @elastic/platform-onboarding +/x-pack/plugins/observability_shared/public/components/tour @elastic/platform-onboarding /x-pack/test/functional/apps/infra/tour.ts @elastic/platform-onboarding ### END Observability Plugins @@ -953,6 +940,7 @@ x-pack/test/observability_functional @elastic/actionable-observability /x-pack/.telemetryrc.json @elastic/kibana-core /src/plugins/telemetry/schema/ @elastic/kibana-core @elastic/kibana-telemetry /x-pack/plugins/telemetry_collection_xpack/schema/ @elastic/kibana-core @elastic/kibana-telemetry +x-pack/plugins/cloud_integrations/cloud_full_story/server/config.ts @elastic/kibana-core @elastic/kibana-telemetry @shahinakmal # Kibana Localization /src/dev/i18n/ @elastic/kibana-localization @elastic/kibana-core @@ -1083,25 +1071,12 @@ x-pack/test/observability_functional @elastic/actionable-observability /x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/network @elastic/security-threat-hunting-explore /x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users @elastic/security-threat-hunting-explore -## Security Solution sub teams - Detections and Response Alerts -/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts @elastic/security-detections-response-alerts -/x-pack/plugins/security_solution/common/field_maps @elastic/security-detections-response-alerts - -/x-pack/plugins/security_solution/public/detection_engine/rule_creation_ui @elastic/security-detections-response-alerts -/x-pack/plugins/security_solution/public/detections/pages/alerts @elastic/security-detections-response-alerts - -/x-pack/plugins/security_solution/server/lib/detection_engine/migrations @elastic/security-detections-response-alerts -/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview @elastic/security-detections-response-alerts -/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types @elastic/security-detections-response-alerts -/x-pack/plugins/security_solution/server/lib/detection_engine/routes/index @elastic/security-detections-response-alerts -/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals @elastic/security-detections-response-alerts - ## Security Solution sub teams - Detection Rule Management /x-pack/plugins/security_solution/common/detection_engine/fleet_integrations @elastic/security-detection-rule-management /x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules @elastic/security-detection-rule-management /x-pack/plugins/security_solution/common/detection_engine/rule_management @elastic/security-detection-rule-management /x-pack/plugins/security_solution/common/detection_engine/rule_monitoring @elastic/security-detection-rule-management -/x-pack/plugins/security_solution/common/detection_engine/rule_schema @elastic/security-detection-rule-management @elastic/security-detections-response-alerts +/x-pack/plugins/security_solution/common/detection_engine/rule_schema @elastic/security-detection-rule-management @elastic/security-detection-engine /x-pack/plugins/security_solution/public/common/components/health_truncate_text @elastic/security-detection-rule-management /x-pack/plugins/security_solution/public/common/components/links_to_docs @elastic/security-detection-rule-management @@ -1115,7 +1090,7 @@ x-pack/test/observability_functional @elastic/actionable-observability /x-pack/plugins/security_solution/public/detections/components/callouts @elastic/security-detection-rule-management /x-pack/plugins/security_solution/public/detections/components/modals/ml_job_upgrade_modal @elastic/security-detection-rule-management /x-pack/plugins/security_solution/public/detections/components/rules @elastic/security-detection-rule-management -/x-pack/plugins/security_solution/public/detections/components/rules/rule_preview @elastic/security-detections-response-alerts +/x-pack/plugins/security_solution/public/detections/components/rules/rule_preview @elastic/security-detection-engine /x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules @elastic/security-detection-rule-management /x-pack/plugins/security_solution/public/detections/mitre @elastic/security-detection-rule-management /x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules @elastic/security-detection-rule-management @@ -1125,49 +1100,61 @@ x-pack/test/observability_functional @elastic/actionable-observability /x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules @elastic/security-detection-rule-management /x-pack/plugins/security_solution/server/lib/detection_engine/rule_management @elastic/security-detection-rule-management /x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring @elastic/security-detection-rule-management -/x-pack/plugins/security_solution/server/lib/detection_engine/rule_schema @elastic/security-detection-rule-management @elastic/security-detections-response-alerts +/x-pack/plugins/security_solution/server/lib/detection_engine/rule_schema @elastic/security-detection-rule-management @elastic/security-detection-engine /x-pack/plugins/security_solution/server/utils @elastic/security-detection-rule-management -## Security Solution sub teams - Security Platform +## Security Solution sub teams - Detection Engine + +/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts @elastic/security-detection-engine +/x-pack/plugins/security_solution/common/field_maps @elastic/security-detection-engine + +/x-pack/plugins/security_solution/public/detection_engine/rule_creation_ui @elastic/security-detection-engine +/x-pack/plugins/security_solution/public/detections/pages/alerts @elastic/security-detection-engine + +/x-pack/plugins/security_solution/server/lib/detection_engine/migrations @elastic/security-detection-engine +/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview @elastic/security-detection-engine +/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types @elastic/security-detection-engine +/x-pack/plugins/security_solution/server/lib/detection_engine/routes/index @elastic/security-detection-engine +/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals @elastic/security-detection-engine -/x-pack/plugins/security_solution/cypress/e2e/data_sources @elastic/security-solution-platform -/x-pack/plugins/security_solution/cypress/e2e/exceptions @elastic/security-solution-platform -/x-pack/plugins/security_solution/cypress/e2e/value_lists @elastic/security-solution-platform +/x-pack/plugins/security_solution/cypress/e2e/data_sources @elastic/security-detection-engine +/x-pack/plugins/security_solution/cypress/e2e/exceptions @elastic/security-detection-engine +/x-pack/plugins/security_solution/cypress/e2e/value_lists @elastic/security-detection-engine -/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions @elastic/security-solution-platform +/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions @elastic/security-detection-engine -/x-pack/plugins/security_solution/public/detection_engine/rule_exceptions @elastic/security-solution-platform -/x-pack/plugins/security_solution/public/detection_engine/rule_exceptions_ui @elastic/security-solution-platform -/x-pack/plugins/security_solution/public/common/components/exceptions @elastic/security-solution-platform -/x-pack/plugins/security_solution/public/exceptions @elastic/security-solution-platform -/x-pack/plugins/security_solution/public/detections/containers/detection_engine/lists @elastic/security-solution-platform -/x-pack/plugins/security_solution/public/common/components/sourcerer @elastic/security-solution-platform +/x-pack/plugins/security_solution/public/detection_engine/rule_exceptions @elastic/security-detection-engine +/x-pack/plugins/security_solution/public/detection_engine/rule_exceptions_ui @elastic/security-detection-engine +/x-pack/plugins/security_solution/public/common/components/exceptions @elastic/security-detection-engine +/x-pack/plugins/security_solution/public/exceptions @elastic/security-detection-engine +/x-pack/plugins/security_solution/public/detections/containers/detection_engine/lists @elastic/security-detection-engine +/x-pack/plugins/security_solution/public/common/components/sourcerer @elastic/security-detection-engine -/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy @elastic/security-solution-platform -/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions @elastic/security-solution-platform -/x-pack/plugins/security_solution/server/lib/sourcerer @elastic/security-solution-platform +/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy @elastic/security-detection-engine +/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions @elastic/security-detection-engine +/x-pack/plugins/security_solution/server/lib/sourcerer @elastic/security-detection-engine ## Security Threat Intelligence - Under Security Platform -/x-pack/plugins/security_solution/public/common/components/threat_match @elastic/security-solution-platform +/x-pack/plugins/security_solution/public/common/components/threat_match @elastic/security-detection-engine ## Security Solution cross teams ownership /x-pack/plugins/security_solution/cypress/fixtures @elastic/security-detections-response @elastic/security-threat-hunting /x-pack/plugins/security_solution/cypress/helpers @elastic/security-detections-response @elastic/security-threat-hunting -/x-pack/plugins/security_solution/cypress/e2e/detection_rules @elastic/security-detection-rule-management @elastic/security-detections-response-alerts +/x-pack/plugins/security_solution/cypress/e2e/detection_rules @elastic/security-detection-rule-management @elastic/security-detection-engine /x-pack/plugins/security_solution/cypress/objects @elastic/security-detections-response @elastic/security-threat-hunting /x-pack/plugins/security_solution/cypress/plugins @elastic/security-detections-response @elastic/security-threat-hunting /x-pack/plugins/security_solution/cypress/screens/common @elastic/security-detections-response @elastic/security-threat-hunting /x-pack/plugins/security_solution/cypress/support @elastic/security-detections-response @elastic/security-threat-hunting -/x-pack/plugins/security_solution/cypress/urls @elastic/security-threat-hunting-investigations @elastic/security-solution-platform +/x-pack/plugins/security_solution/cypress/urls @elastic/security-threat-hunting-investigations @elastic/security-detection-engine /x-pack/plugins/security_solution/common/ecs @elastic/security-threat-hunting-investigations -/x-pack/plugins/security_solution/common/test @elastic/security-detection-rule-management @elastic/security-detections-response-alerts +/x-pack/plugins/security_solution/common/test @elastic/security-detection-rule-management @elastic/security-detection-engine /x-pack/plugins/security_solution/public/common/components/callouts @elastic/security-detections-response /x-pack/plugins/security_solution/public/common/components/hover_actions @elastic/security-threat-hunting-explore @elastic/security-threat-hunting-investigations -/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions @elastic/security-solution-platform @elastic/security-detection-rule-management +/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions @elastic/security-detection-engine @elastic/security-detection-rule-management /x-pack/plugins/security_solution/server/routes @elastic/security-detections-response @elastic/security-threat-hunting ## Security Solution sub teams - security-defend-workflows @@ -1228,7 +1215,6 @@ x-pack/test/threat_intelligence_cypress @elastic/protections-experience /x-pack/plugins/apm/**/*.scss @elastic/observability-design /x-pack/plugins/infra/**/*.scss @elastic/observability-design /x-pack/plugins/fleet/**/*.scss @elastic/observability-design -/x-pack/plugins/observability/**/*.scss @elastic/observability-design /x-pack/plugins/monitoring/**/*.scss @elastic/observability-design # Ent. Search design diff --git a/.gitignore b/.gitignore index 4d3db591bd758..6696ab8bcadb9 100644 --- a/.gitignore +++ b/.gitignore @@ -42,6 +42,14 @@ __tmp__ /x-pack/test/*/screenshots/visual_regression_gallery.html /x-pack/test/functional/apps/*/*/reporting/reports/failure +# Ignore the same artifacts in x-pack/test_serverless +/x-pack/test_serverless/*/failure_debug +/x-pack/test_serverless/*/screenshots/diff +/x-pack/test_serverless/*/screenshots/failure +/x-pack/test_serverless/*/screenshots/session +/x-pack/test_serverless/*/screenshots/visual_regression_gallery.html +/x-pack/test_serverless/functional/apps/*/*/reporting/reports/failure + /html_docs .eslintcache /plugins/ diff --git a/.i18nrc.json b/.i18nrc.json index d3afda75dce51..a2f4444c54d3a 100644 --- a/.i18nrc.json +++ b/.i18nrc.json @@ -76,6 +76,7 @@ "newsfeed": "src/plugins/newsfeed", "presentationUtil": "src/plugins/presentation_util", "randomSampling": "x-pack/packages/kbn-random-sampling", + "textBasedEditor": "packages/kbn-text-based-editor", "reporting": "packages/kbn-reporting/common", "savedObjects": "src/plugins/saved_objects", "savedObjectsFinder": "src/plugins/saved_objects_finder", @@ -87,6 +88,7 @@ "serverlessPackages": "packages/serverless", "coloring": "packages/kbn-coloring/src", "languageDocumentationPopover": "packages/kbn-language-documentation-popover/src", + "textBasedLanguages": "src/plugins/text_based_languages", "statusPage": "src/legacy/core_plugins/status_page", "telemetry": ["src/plugins/telemetry", "src/plugins/telemetry_management_section"], "timelion": ["src/plugins/vis_types/timelion"], diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index 49070dc763ad2..886ad643ba5ca 100644 --- a/api_docs/actions.mdx +++ b/api_docs/actions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions title: "actions" image: https://source.unsplash.com/400x175/?github description: API docs for the actions plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] --- import actionsObj from './actions.devdocs.json'; diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index 09b4c22df6c0c..0ed697b388d49 100644 --- a/api_docs/advanced_settings.mdx +++ b/api_docs/advanced_settings.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings title: "advancedSettings" image: https://source.unsplash.com/400x175/?github description: API docs for the advancedSettings plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] --- import advancedSettingsObj from './advanced_settings.devdocs.json'; diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx index a447d03b40938..0871ea21b63a1 100644 --- a/api_docs/aiops.mdx +++ b/api_docs/aiops.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops title: "aiops" image: https://source.unsplash.com/400x175/?github description: API docs for the aiops plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] --- import aiopsObj from './aiops.devdocs.json'; diff --git a/api_docs/alerting.devdocs.json b/api_docs/alerting.devdocs.json index 233ccd5783ffc..9b1ba8ab92b9b 100644 --- a/api_docs/alerting.devdocs.json +++ b/api_docs/alerting.devdocs.json @@ -4117,7 +4117,7 @@ "MuteOptions", ") => Promise; unmuteInstance: (options: ", "MuteOptions", - ") => Promise; runSoon: (options: { id: string; }) => Promise; listAlertTypes: () => Promise Promise; runSoon: (options: { id: string; }) => Promise; listRuleTypes: () => Promise>; getSpaceId: () => string | undefined; getAlertFromRaw: (params: ", "GetAlertFromRawParams", diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index 6231dd55124e4..0f77637be438f 100644 --- a/api_docs/alerting.mdx +++ b/api_docs/alerting.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting title: "alerting" image: https://source.unsplash.com/400x175/?github description: API docs for the alerting plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] --- import alertingObj from './alerting.devdocs.json'; diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json index d03bd09b17d31..a47bf23bab373 100644 --- a/api_docs/apm.devdocs.json +++ b/api_docs/apm.devdocs.json @@ -835,7 +835,7 @@ "label": "APIEndpoint", "description": [], "signature": [ - "\"POST /internal/apm/data_view/static\" | \"GET /internal/apm/data_view/title\" | \"GET /internal/apm/environments\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics_by_transaction_name\" | \"POST /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}/samples\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}/error/{errorId}\" | \"GET /internal/apm/services/{serviceName}/errors/distribution\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}/top_erroneous_transactions\" | \"POST /internal/apm/latency/overall_distribution/transactions\" | \"GET /internal/apm/services/{serviceName}/metrics/charts\" | \"GET /internal/apm/services/{serviceName}/metrics/nodes\" | \"GET /internal/apm/services/{serviceName}/metrics/serverless/charts\" | \"GET /internal/apm/services/{serviceName}/metrics/serverless/summary\" | \"GET /internal/apm/services/{serviceName}/metrics/serverless/functions_overview\" | \"GET /internal/apm/services/{serviceName}/metrics/serverless/active_instances\" | \"GET /internal/apm/observability_overview\" | \"GET /internal/apm/observability_overview/has_data\" | \"GET /internal/apm/service-map\" | \"GET /internal/apm/service-map/service/{serviceName}\" | \"GET /internal/apm/service-map/dependency\" | \"GET /internal/apm/services\" | \"POST /internal/apm/services/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/metadata/details\" | \"GET /internal/apm/services/{serviceName}/metadata/icons\" | \"GET /internal/apm/services/{serviceName}/agent\" | \"GET /internal/apm/services/{serviceName}/transaction_types\" | \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\" | \"GET /api/apm/services/{serviceName}/annotation/search\" | \"POST /api/apm/services/{serviceName}/annotation\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\" | \"GET /internal/apm/services/{serviceName}/throughput\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/dependencies\" | \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\" | \"GET /internal/apm/services/{serviceName}/anomaly_charts\" | \"GET /internal/apm/services/{serviceName}/alerts_count\" | \"GET /internal/apm/service-groups\" | \"GET /internal/apm/service-group\" | \"POST /internal/apm/service-group\" | \"DELETE /internal/apm/service-group\" | \"GET /internal/apm/service-group/services\" | \"GET /internal/apm/service-group/counts\" | \"GET /internal/apm/suggestions\" | \"GET /internal/apm/traces/{traceId}\" | \"GET /internal/apm/traces\" | \"GET /internal/apm/traces/{traceId}/root_transaction\" | \"GET /internal/apm/transactions/{transactionId}\" | \"GET /internal/apm/traces/find\" | \"POST /internal/apm/traces/aggregated_critical_path\" | \"GET /internal/apm/traces/{traceId}/transactions/{transactionId}\" | \"GET /internal/apm/traces/{traceId}/spans/{spanId}\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\" | \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\" | \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\" | \"GET /internal/apm/rule_types/transaction_error_rate/chart_preview\" | \"GET /internal/apm/rule_types/transaction_duration/chart_preview\" | \"GET /internal/apm/rule_types/error_count/chart_preview\" | \"GET /api/apm/settings/agent-configuration\" | \"GET /api/apm/settings/agent-configuration/view\" | \"DELETE /api/apm/settings/agent-configuration\" | \"PUT /api/apm/settings/agent-configuration\" | \"POST /api/apm/settings/agent-configuration/search\" | \"GET /api/apm/settings/agent-configuration/environments\" | \"GET /api/apm/settings/agent-configuration/agent_name\" | \"GET /internal/apm/settings/anomaly-detection/jobs\" | \"POST /internal/apm/settings/anomaly-detection/jobs\" | \"GET /internal/apm/settings/anomaly-detection/environments\" | \"POST /internal/apm/settings/anomaly-detection/update_to_v3\" | \"GET /internal/apm/settings/apm-index-settings\" | \"GET /internal/apm/settings/apm-indices\" | \"POST /internal/apm/settings/apm-indices/save\" | \"GET /internal/apm/settings/custom_links/transaction\" | \"GET /internal/apm/settings/custom_links\" | \"POST /internal/apm/settings/custom_links\" | \"PUT /internal/apm/settings/custom_links/{id}\" | \"DELETE /internal/apm/settings/custom_links/{id}\" | \"GET /api/apm/sourcemaps\" | \"POST /api/apm/sourcemaps\" | \"DELETE /api/apm/sourcemaps/{id}\" | \"POST /internal/apm/sourcemaps/migrate_fleet_artifacts\" | \"GET /internal/apm/fleet/has_apm_policies\" | \"GET /internal/apm/fleet/agents\" | \"POST /api/apm/fleet/apm_server_schema\" | \"GET /internal/apm/fleet/apm_server_schema/unsupported\" | \"GET /internal/apm/fleet/migration_check\" | \"POST /internal/apm/fleet/cloud_apm_package_policy\" | \"GET /internal/apm/fleet/java_agent_versions\" | \"GET /internal/apm/dependencies/top_dependencies\" | \"GET /internal/apm/dependencies/upstream_services\" | \"GET /internal/apm/dependencies/metadata\" | \"GET /internal/apm/dependencies/charts/latency\" | \"GET /internal/apm/dependencies/charts/throughput\" | \"GET /internal/apm/dependencies/charts/error_rate\" | \"GET /internal/apm/dependencies/operations\" | \"GET /internal/apm/dependencies/charts/distribution\" | \"GET /internal/apm/dependencies/operations/spans\" | \"GET /internal/apm/correlations/field_candidates/transactions\" | \"GET /internal/apm/correlations/field_value_stats/transactions\" | \"POST /internal/apm/correlations/field_value_pairs/transactions\" | \"POST /internal/apm/correlations/significant_correlations/transactions\" | \"POST /internal/apm/correlations/p_values/transactions\" | \"GET /internal/apm/fallback_to_transactions\" | \"GET /internal/apm/has_data\" | \"GET /internal/apm/event_metadata/{processorEvent}/{id}\" | \"GET /internal/apm/agent_keys\" | \"GET /internal/apm/agent_keys/privileges\" | \"POST /internal/apm/api_key/invalidate\" | \"POST /api/apm/agent_keys\" | \"GET /internal/apm/storage_explorer\" | \"GET /internal/apm/services/{serviceName}/storage_details\" | \"GET /internal/apm/storage_chart\" | \"GET /internal/apm/storage_explorer/privileges\" | \"GET /internal/apm/storage_explorer_summary_stats\" | \"GET /internal/apm/storage_explorer/is_cross_cluster_search\" | \"GET /internal/apm/storage_explorer/get_services\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes\" | \"GET /internal/apm/debug-telemetry\" | \"GET /internal/apm/time_range_metadata\" | \"GET /internal/apm/settings/labs\" | \"GET /internal/apm/get_agents_per_service\" | \"GET /internal/apm/get_latest_agent_versions\" | \"GET /internal/apm/services/{serviceName}/agent_instances\" | \"GET /internal/apm/services/{serviceName}/mobile/filters\" | \"GET /internal/apm/mobile-services/{serviceName}/most_used_charts\" | \"GET /internal/apm/mobile-services/{serviceName}/transactions/charts/sessions\" | \"GET /internal/apm/mobile-services/{serviceName}/transactions/charts/http_requests\" | \"GET /internal/apm/mobile-services/{serviceName}/stats\" | \"GET /internal/apm/mobile-services/{serviceName}/location/stats\" | \"GET /internal/apm/mobile-services/{serviceName}/terms\" | \"GET /internal/apm/mobile-services/{serviceName}/main_statistics\" | \"GET /internal/apm/mobile-services/{serviceName}/detailed_statistics\"" + "\"POST /internal/apm/data_view/static\" | \"GET /internal/apm/data_view/title\" | \"GET /internal/apm/environments\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics_by_transaction_name\" | \"POST /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}/samples\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}/error/{errorId}\" | \"GET /internal/apm/services/{serviceName}/errors/distribution\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}/top_erroneous_transactions\" | \"POST /internal/apm/latency/overall_distribution/transactions\" | \"GET /internal/apm/services/{serviceName}/metrics/charts\" | \"GET /internal/apm/services/{serviceName}/metrics/nodes\" | \"GET /internal/apm/services/{serviceName}/metrics/serverless/charts\" | \"GET /internal/apm/services/{serviceName}/metrics/serverless/summary\" | \"GET /internal/apm/services/{serviceName}/metrics/serverless/functions_overview\" | \"GET /internal/apm/services/{serviceName}/metrics/serverless/active_instances\" | \"GET /internal/apm/observability_overview\" | \"GET /internal/apm/observability_overview/has_data\" | \"GET /internal/apm/service-map\" | \"GET /internal/apm/service-map/service/{serviceName}\" | \"GET /internal/apm/service-map/dependency\" | \"GET /internal/apm/services\" | \"POST /internal/apm/services/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/metadata/details\" | \"GET /internal/apm/services/{serviceName}/metadata/icons\" | \"GET /internal/apm/services/{serviceName}/agent\" | \"GET /internal/apm/services/{serviceName}/transaction_types\" | \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\" | \"GET /api/apm/services/{serviceName}/annotation/search 2023-05-22\" | \"POST /api/apm/services/{serviceName}/annotation 2023-05-22\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\" | \"GET /internal/apm/services/{serviceName}/throughput\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/dependencies\" | \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\" | \"GET /internal/apm/services/{serviceName}/anomaly_charts\" | \"GET /internal/apm/services/{serviceName}/alerts_count\" | \"GET /internal/apm/service-groups\" | \"GET /internal/apm/service-group\" | \"POST /internal/apm/service-group\" | \"DELETE /internal/apm/service-group\" | \"GET /internal/apm/service-group/services\" | \"GET /internal/apm/service-group/counts\" | \"GET /internal/apm/suggestions\" | \"GET /internal/apm/traces/{traceId}\" | \"GET /internal/apm/traces\" | \"GET /internal/apm/traces/{traceId}/root_transaction\" | \"GET /internal/apm/transactions/{transactionId}\" | \"GET /internal/apm/traces/find\" | \"POST /internal/apm/traces/aggregated_critical_path\" | \"GET /internal/apm/traces/{traceId}/transactions/{transactionId}\" | \"GET /internal/apm/traces/{traceId}/spans/{spanId}\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\" | \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\" | \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\" | \"GET /internal/apm/rule_types/transaction_error_rate/chart_preview\" | \"GET /internal/apm/rule_types/transaction_duration/chart_preview\" | \"GET /internal/apm/rule_types/error_count/chart_preview\" | \"GET /api/apm/settings/agent-configuration 2023-05-22\" | \"GET /api/apm/settings/agent-configuration/view 2023-05-22\" | \"DELETE /api/apm/settings/agent-configuration 2023-05-22\" | \"PUT /api/apm/settings/agent-configuration 2023-05-22\" | \"POST /api/apm/settings/agent-configuration/search 2023-05-22\" | \"GET /api/apm/settings/agent-configuration/environments 2023-05-22\" | \"GET /api/apm/settings/agent-configuration/agent_name 2023-05-22\" | \"GET /internal/apm/settings/anomaly-detection/jobs\" | \"POST /internal/apm/settings/anomaly-detection/jobs\" | \"GET /internal/apm/settings/anomaly-detection/environments\" | \"POST /internal/apm/settings/anomaly-detection/update_to_v3\" | \"GET /internal/apm/settings/apm-index-settings\" | \"GET /internal/apm/settings/apm-indices\" | \"POST /internal/apm/settings/apm-indices/save\" | \"GET /internal/apm/settings/custom_links/transaction\" | \"GET /internal/apm/settings/custom_links\" | \"POST /internal/apm/settings/custom_links\" | \"PUT /internal/apm/settings/custom_links/{id}\" | \"DELETE /internal/apm/settings/custom_links/{id}\" | \"GET /api/apm/sourcemaps 2023-05-22\" | \"POST /api/apm/sourcemaps 2023-05-22\" | \"DELETE /api/apm/sourcemaps/{id} 2023-05-22\" | \"POST /internal/apm/sourcemaps/migrate_fleet_artifacts\" | \"GET /internal/apm/fleet/has_apm_policies\" | \"GET /internal/apm/fleet/agents\" | \"POST /api/apm/fleet/apm_server_schema 2023-05-22\" | \"GET /internal/apm/fleet/apm_server_schema/unsupported\" | \"GET /internal/apm/fleet/migration_check\" | \"POST /internal/apm/fleet/cloud_apm_package_policy\" | \"GET /internal/apm/fleet/java_agent_versions\" | \"GET /internal/apm/dependencies/top_dependencies\" | \"GET /internal/apm/dependencies/upstream_services\" | \"GET /internal/apm/dependencies/metadata\" | \"GET /internal/apm/dependencies/charts/latency\" | \"GET /internal/apm/dependencies/charts/throughput\" | \"GET /internal/apm/dependencies/charts/error_rate\" | \"GET /internal/apm/dependencies/operations\" | \"GET /internal/apm/dependencies/charts/distribution\" | \"GET /internal/apm/dependencies/operations/spans\" | \"GET /internal/apm/correlations/field_candidates/transactions\" | \"GET /internal/apm/correlations/field_value_stats/transactions\" | \"POST /internal/apm/correlations/field_value_pairs/transactions\" | \"POST /internal/apm/correlations/significant_correlations/transactions\" | \"POST /internal/apm/correlations/p_values/transactions\" | \"GET /internal/apm/fallback_to_transactions\" | \"GET /internal/apm/has_data\" | \"GET /internal/apm/event_metadata/{processorEvent}/{id}\" | \"GET /internal/apm/agent_keys\" | \"GET /internal/apm/agent_keys/privileges\" | \"POST /internal/apm/api_key/invalidate\" | \"POST /api/apm/agent_keys 2023-05-22\" | \"GET /internal/apm/storage_explorer\" | \"GET /internal/apm/services/{serviceName}/storage_details\" | \"GET /internal/apm/storage_chart\" | \"GET /internal/apm/storage_explorer/privileges\" | \"GET /internal/apm/storage_explorer_summary_stats\" | \"GET /internal/apm/storage_explorer/is_cross_cluster_search\" | \"GET /internal/apm/storage_explorer/get_services\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes\" | \"GET /internal/apm/debug-telemetry\" | \"GET /internal/apm/time_range_metadata\" | \"GET /internal/apm/settings/labs\" | \"GET /internal/apm/get_agents_per_service\" | \"GET /internal/apm/get_latest_agent_versions\" | \"GET /internal/apm/services/{serviceName}/agent_instances\" | \"GET /internal/apm/services/{serviceName}/mobile/filters\" | \"GET /internal/apm/mobile-services/{serviceName}/most_used_charts\" | \"GET /internal/apm/mobile-services/{serviceName}/transactions/charts/sessions\" | \"GET /internal/apm/mobile-services/{serviceName}/transactions/charts/http_requests\" | \"GET /internal/apm/mobile-services/{serviceName}/stats\" | \"GET /internal/apm/mobile-services/{serviceName}/location/stats\" | \"GET /internal/apm/mobile-services/{serviceName}/terms\" | \"GET /internal/apm/mobile-services/{serviceName}/main_statistics\" | \"GET /internal/apm/mobile-services/{serviceName}/detailed_statistics\"" ], "path": "x-pack/plugins/apm/server/routes/apm_routes/get_global_apm_server_route_repository.ts", "deprecated": false, @@ -897,15 +897,7 @@ "label": "APMServerRouteRepository", "description": [], "signature": [ - "{ \"GET /internal/apm/mobile-services/{serviceName}/detailed_statistics\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/mobile-services/{serviceName}/detailed_statistics\", ", + "{ \"GET /internal/apm/mobile-services/{serviceName}/detailed_statistics\": { endpoint: \"GET /internal/apm/mobile-services/{serviceName}/detailed_statistics\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -953,7 +945,7 @@ "StringC", "; fieldValues: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -961,19 +953,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "MobileDetailedStatisticsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/mobile-services/{serviceName}/main_statistics\": ", + " & { params: { path: { serviceName: string; }; query: { kuery: string; } & { start: number; end: number; } & { offset?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { field: string; fieldValues: string[]; }; }; }) => Promise<", + "MobileDetailedStatisticsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/mobile-services/{serviceName}/main_statistics\": { endpoint: \"GET /internal/apm/mobile-services/{serviceName}/main_statistics\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -1015,7 +1009,7 @@ "TypeC", "<{ field: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1023,19 +1017,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "MobileMainStatisticsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/mobile-services/{serviceName}/terms\": ", + " & { params: { path: { serviceName: string; }; query: { kuery: string; } & { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { field: string; }; }; }) => Promise<", + "MobileMainStatisticsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/mobile-services/{serviceName}/terms\": { endpoint: \"GET /internal/apm/mobile-services/{serviceName}/terms\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -1079,7 +1075,7 @@ "Type", "; fieldName: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1087,19 +1083,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { terms: ", - "MobileTermsByFieldResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/mobile-services/{serviceName}/location/stats\": ", + " & { params: { path: { serviceName: string; }; query: { kuery: string; } & { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { size: number; fieldName: string; }; }; }) => Promise<{ terms: ", + "MobileTermsByFieldResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/mobile-services/{serviceName}/location/stats\": { endpoint: \"GET /internal/apm/mobile-services/{serviceName}/location/stats\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -1145,7 +1143,7 @@ "PartialC", "<{ locationField: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1153,19 +1151,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "MobileLocationStats", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/mobile-services/{serviceName}/stats\": ", + " & { params: { path: { serviceName: string; }; query: { kuery: string; } & { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { offset?: string | undefined; } & { locationField?: string | undefined; }; }; }) => Promise<", + "MobileLocationStats", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/mobile-services/{serviceName}/stats\": { endpoint: \"GET /internal/apm/mobile-services/{serviceName}/stats\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -1211,7 +1211,7 @@ "PartialC", "<{ transactionType: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1219,19 +1219,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "MobilePeriodStats", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/mobile-services/{serviceName}/transactions/charts/http_requests\": ", + " & { params: { path: { serviceName: string; }; query: { kuery: string; } & { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { offset?: string | undefined; } & { transactionType?: string | undefined; }; }; }) => Promise<", + "MobilePeriodStats", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/mobile-services/{serviceName}/transactions/charts/http_requests\": { endpoint: \"GET /internal/apm/mobile-services/{serviceName}/transactions/charts/http_requests\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -1279,7 +1281,7 @@ "StringC", "; transactionName: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1287,19 +1289,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "HttpRequestsTimeseries", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/mobile-services/{serviceName}/transactions/charts/sessions\": ", + " & { params: { path: { serviceName: string; }; query: { kuery: string; } & { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { offset?: string | undefined; } & { transactionType?: string | undefined; transactionName?: string | undefined; }; }; }) => Promise<", + "HttpRequestsTimeseries", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/mobile-services/{serviceName}/transactions/charts/sessions\": { endpoint: \"GET /internal/apm/mobile-services/{serviceName}/transactions/charts/sessions\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -1347,7 +1351,7 @@ "StringC", "; transactionName: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1355,19 +1359,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "SessionsTimeseries", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/mobile-services/{serviceName}/most_used_charts\": ", + " & { params: { path: { serviceName: string; }; query: { kuery: string; } & { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { offset?: string | undefined; } & { transactionType?: string | undefined; transactionName?: string | undefined; }; }; }) => Promise<", + "SessionsTimeseries", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/mobile-services/{serviceName}/most_used_charts\": { endpoint: \"GET /internal/apm/mobile-services/{serviceName}/most_used_charts\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -1409,7 +1415,7 @@ "PartialC", "<{ transactionType: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1417,19 +1423,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { mostUsedCharts: { key: ", - "MobilePropertyType", - "; options: { key: string | number; docCount: number; }[] & { key: string | number; docCount: number; }[]; }[]; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/mobile/filters\": ", + " & { params: { path: { serviceName: string; }; query: { kuery: string; } & { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { transactionType?: string | undefined; }; }; }) => Promise<{ mostUsedCharts: { key: ", + "MobilePropertyType", + "; options: { key: string | number; docCount: number; }[] & { key: string | number; docCount: number; }[]; }[]; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/mobile/filters\": { endpoint: \"GET /internal/apm/services/{serviceName}/mobile/filters\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -1471,7 +1479,7 @@ "PartialC", "<{ transactionType: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1479,19 +1487,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { mobileFilters: ", - "MobileFiltersResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/agent_instances\": ", + " & { params: { path: { serviceName: string; }; query: { kuery: string; } & { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { transactionType?: string | undefined; }; }; }) => Promise<{ mobileFilters: ", + "MobileFiltersResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/agent_instances\": { endpoint: \"GET /internal/apm/services/{serviceName}/agent_instances\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -1533,7 +1543,7 @@ "TypeC", "<{ probability: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1541,19 +1551,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { items: ", - "AgentExplorerAgentInstancesResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/get_latest_agent_versions\": ", + " & { params: { path: { serviceName: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { probability: number; }; }; }) => Promise<{ items: ", + "AgentExplorerAgentInstancesResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/get_latest_agent_versions\": { endpoint: \"GET /internal/apm/get_latest_agent_versions\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1561,19 +1573,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + ") => Promise<", "AgentLatestVersionsResponse", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/get_agents_per_service\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/get_agents_per_service\", ", + "; \"GET /internal/apm/get_agents_per_service\": { endpoint: \"GET /internal/apm/get_agents_per_service\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -1617,7 +1621,7 @@ "StringC", "; agentLanguage: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1625,19 +1629,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "AgentExplorerAgentsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/settings/labs\": ", + " & { params: { query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { probability: number; } & { serviceName?: string | undefined; agentLanguage?: string | undefined; }; }; }) => Promise<", + "AgentExplorerAgentsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/settings/labs\": { endpoint: \"GET /internal/apm/settings/labs\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1645,17 +1651,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { labsItems: string[]; }, ", + ") => Promise<{ labsItems: string[]; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/time_range_metadata\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/time_range_metadata\", ", + "; \"GET /internal/apm/time_range_metadata\": { endpoint: \"GET /internal/apm/time_range_metadata\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -1677,7 +1675,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1685,19 +1683,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { query: { useSpanName: boolean; enableServiceTransactionMetrics: boolean; enableContinuousRollups: boolean; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<", "TimeRangeMetadata", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/debug-telemetry\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/debug-telemetry\", undefined, ", + "; \"GET /internal/apm/debug-telemetry\": { endpoint: \"GET /internal/apm/debug-telemetry\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1705,17 +1695,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", unknown, ", + ") => Promise; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/infrastructure_attributes\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/services/{serviceName}/infrastructure_attributes\", ", + "; \"GET /internal/apm/services/{serviceName}/infrastructure_attributes\": { endpoint: \"GET /internal/apm/services/{serviceName}/infrastructure_attributes\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -1753,7 +1735,7 @@ "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, - ">]>; }>]>; }>, ", + ">]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1761,17 +1743,19 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { containerIds: string[]; hostNames: string[]; podNames: string[]; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\": ", + " & { params: { path: { serviceName: string; }; query: { kuery: string; } & { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; }; }; }) => Promise<{ containerIds: string[]; hostNames: string[]; podNames: string[]; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\": { endpoint: \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -1791,7 +1775,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1799,19 +1783,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { spanLinksDetails: ", + " & { params: { path: { traceId: string; spanId: string; }; query: { kuery: string; } & { start: number; end: number; }; }; }) => Promise<{ spanLinksDetails: ", "SpanLinkDetails", - "[]; }, ", + "[]; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\", ", + "; \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\": { endpoint: \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -1875,7 +1851,7 @@ "section": "def-common.ProcessorEvent", "text": "ProcessorEvent" }, - ".span>]>; }>]>; }>, ", + ".span>]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1883,19 +1859,19 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { spanLinksDetails: ", - "SpanLinkDetails", - "[]; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/storage_explorer/get_services\": ", + " & { params: { path: { traceId: string; spanId: string; }; query: { kuery: string; } & { start: number; end: number; } & { processorEvent: ", { - "pluginId": "@kbn/server-route-repository", + "pluginId": "observability", "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" + "docId": "kibObservabilityPluginApi", + "section": "def-common.ProcessorEvent", + "text": "ProcessorEvent" }, - "<\"GET /internal/apm/storage_explorer/get_services\", ", + "; }; }; }) => Promise<{ spanLinksDetails: ", + "SpanLinkDetails", + "[]; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/storage_explorer/get_services\": { endpoint: \"GET /internal/apm/storage_explorer/get_services\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -1947,7 +1923,7 @@ "TypeC", "<{ kuery: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1955,17 +1931,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { services: { serviceName: string; }[]; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/storage_explorer/is_cross_cluster_search\": ", + " & { params: { query: { indexLifecyclePhase: ", + "IndexLifecyclePhaseSelectOption", + "; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; }; }; }) => Promise<{ services: { serviceName: string; }[]; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/storage_explorer/is_cross_cluster_search\": { endpoint: \"GET /internal/apm/storage_explorer/is_cross_cluster_search\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -1973,17 +1953,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { isCrossClusterSearch: boolean; }, ", + ") => Promise<{ isCrossClusterSearch: boolean; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/storage_explorer_summary_stats\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/storage_explorer_summary_stats\", ", + "; \"GET /internal/apm/storage_explorer_summary_stats\": { endpoint: \"GET /internal/apm/storage_explorer_summary_stats\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -2045,7 +2017,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2053,19 +2025,23 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "StorageExplorerSummaryStatisticsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/storage_explorer/privileges\": ", + " & { params: { query: { indexLifecyclePhase: ", + "IndexLifecyclePhaseSelectOption", + "; } & { probability: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<", + "StorageExplorerSummaryStatisticsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/storage_explorer/privileges\": { endpoint: \"GET /internal/apm/storage_explorer/privileges\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2073,17 +2049,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { hasPrivileges: boolean; }, ", + ") => Promise<{ hasPrivileges: boolean; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/storage_chart\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/storage_chart\", ", + "; \"GET /internal/apm/storage_chart\": { endpoint: \"GET /internal/apm/storage_chart\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -2145,7 +2113,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2153,19 +2121,23 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { storageTimeSeries: ", - "SizeTimeseriesResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/storage_details\": ", + " & { params: { query: { indexLifecyclePhase: ", + "IndexLifecyclePhaseSelectOption", + "; } & { probability: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<{ storageTimeSeries: ", + "SizeTimeseriesResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/storage_details\": { endpoint: \"GET /internal/apm/services/{serviceName}/storage_details\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -2231,7 +2203,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2239,19 +2211,23 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "StorageDetailsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/storage_explorer\": ", + " & { params: { path: { serviceName: string; }; query: { indexLifecyclePhase: ", + "IndexLifecyclePhaseSelectOption", + "; } & { probability: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<", + "StorageDetailsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/storage_explorer\": { endpoint: \"GET /internal/apm/storage_explorer\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -2313,7 +2289,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2321,19 +2297,23 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { serviceStatistics: ", - "StorageExplorerServiceStatisticsResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"POST /api/apm/agent_keys\": ", + " & { params: { query: { indexLifecyclePhase: ", + "IndexLifecyclePhaseSelectOption", + "; } & { probability: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<{ serviceStatistics: ", + "StorageExplorerServiceStatisticsResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"POST /api/apm/agent_keys 2023-05-22\": { endpoint: \"POST /api/apm/agent_keys 2023-05-22\"; params?: ", "TypeC", "<{ body: ", "TypeC", @@ -2351,7 +2331,7 @@ "LiteralC", "<", "PrivilegeType", - ".AGENT_CONFIG>]>>; }>; }>, ", + ".AGENT_CONFIG>]>>; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2359,25 +2339,19 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { body: { name: string; privileges: ", + "PrivilegeType", + "[]; }; }; }) => Promise<", "CreateAgentKeyResponse", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"POST /internal/apm/api_key/invalidate\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/apm/api_key/invalidate\", ", + "; \"POST /internal/apm/api_key/invalidate\": { endpoint: \"POST /internal/apm/api_key/invalidate\"; params?: ", "TypeC", "<{ body: ", "TypeC", "<{ id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2385,19 +2359,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { body: { id: string; }; }; }) => Promise<", "InvalidateAgentKeyResponse", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/agent_keys/privileges\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/agent_keys/privileges\", undefined, ", + "; \"GET /internal/apm/agent_keys/privileges\": { endpoint: \"GET /internal/apm/agent_keys/privileges\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2405,19 +2371,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + ") => Promise<", "AgentKeysPrivilegesResponse", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/agent_keys\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/agent_keys\", undefined, ", + "; \"GET /internal/apm/agent_keys\": { endpoint: \"GET /internal/apm/agent_keys\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2425,19 +2383,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + ") => Promise<", "AgentKeysResponse", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/event_metadata/{processorEvent}/{id}\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/event_metadata/{processorEvent}/{id}\", ", + "; \"GET /internal/apm/event_metadata/{processorEvent}/{id}\": { endpoint: \"GET /internal/apm/event_metadata/{processorEvent}/{id}\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -2485,7 +2435,7 @@ }, ".span>]>; id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2493,17 +2443,17 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { metadata: Partial>; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/has_data\": ", + " & { params: { path: { processorEvent: ", { - "pluginId": "@kbn/server-route-repository", + "pluginId": "observability", "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" + "docId": "kibObservabilityPluginApi", + "section": "def-common.ProcessorEvent", + "text": "ProcessorEvent" }, - "<\"GET /internal/apm/has_data\", undefined, ", + "; id: string; }; }; }) => Promise<{ metadata: Partial>; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/has_data\": { endpoint: \"GET /internal/apm/has_data\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2511,17 +2461,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { hasData: boolean; }, ", + ") => Promise<{ hasData: boolean; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/fallback_to_transactions\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/fallback_to_transactions\", ", + "; \"GET /internal/apm/fallback_to_transactions\": { endpoint: \"GET /internal/apm/fallback_to_transactions\"; params?: ", "PartialC", "<{ query: ", "IntersectionC", @@ -2535,7 +2477,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2543,17 +2485,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { fallbackToTransactions: boolean; }, ", + " & { params?: { query?: ({ kuery: string; } & { start?: number | undefined; end?: number | undefined; }) | undefined; } | undefined; }) => Promise<{ fallbackToTransactions: boolean; }>; } & ", "APMRouteCreateOptions", - ">; \"POST /internal/apm/correlations/p_values/transactions\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/apm/correlations/p_values/transactions\", ", + "; \"POST /internal/apm/correlations/p_values/transactions\": { endpoint: \"POST /internal/apm/correlations/p_values/transactions\"; params?: ", "TypeC", "<{ body: ", "IntersectionC", @@ -2605,7 +2539,7 @@ "ArrayC", "<", "StringC", - ">; }>]>; }>, ", + ">; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2613,19 +2547,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "PValuesResponse", - ", ", - "APMRouteCreateOptions", - ">; \"POST /internal/apm/correlations/significant_correlations/transactions\": ", + " & { params: { body: { serviceName?: string | undefined; transactionName?: string | undefined; transactionType?: string | undefined; durationMin?: number | undefined; durationMax?: number | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { fieldCandidates: string[]; }; }; }) => Promise<", + "PValuesResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"POST /internal/apm/correlations/significant_correlations/transactions\": { endpoint: \"POST /internal/apm/correlations/significant_correlations/transactions\"; params?: ", "TypeC", "<{ body: ", "IntersectionC", @@ -2685,7 +2621,7 @@ "StringC", ", ", "Type", - "]>; }>>; }>]>; }>, ", + "]>; }>>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2693,19 +2629,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "SignificantCorrelationsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"POST /internal/apm/correlations/field_value_pairs/transactions\": ", + " & { params: { body: { serviceName?: string | undefined; transactionName?: string | undefined; transactionType?: string | undefined; durationMin?: number | undefined; durationMax?: number | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { fieldValuePairs: { fieldName: string; fieldValue: string | number; }[]; }; }; }) => Promise<", + "SignificantCorrelationsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"POST /internal/apm/correlations/field_value_pairs/transactions\": { endpoint: \"POST /internal/apm/correlations/field_value_pairs/transactions\"; params?: ", "TypeC", "<{ body: ", "IntersectionC", @@ -2753,7 +2691,7 @@ "ArrayC", "<", "StringC", - ">; }>]>; }>, ", + ">; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2761,19 +2699,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "FieldValuePairsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/correlations/field_value_stats/transactions\": ", + " & { params: { body: { serviceName?: string | undefined; transactionName?: string | undefined; transactionType?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { fieldCandidates: string[]; }; }; }) => Promise<", + "FieldValuePairsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/correlations/field_value_stats/transactions\": { endpoint: \"GET /internal/apm/correlations/field_value_stats/transactions\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -2827,7 +2767,7 @@ "StringC", ", ", "NumberC", - "]>; }>]>; }>, ", + "]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2835,19 +2775,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "TopValuesStats", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/correlations/field_candidates/transactions\": ", + " & { params: { query: { serviceName?: string | undefined; transactionName?: string | undefined; transactionType?: string | undefined; samplerShardSize?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { fieldName: string; fieldValue: string | number; }; }; }) => Promise<", + "TopValuesStats", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/correlations/field_candidates/transactions\": { endpoint: \"GET /internal/apm/correlations/field_candidates/transactions\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -2889,7 +2831,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2897,19 +2839,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "DurationFieldCandidatesResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/dependencies/operations/spans\": ", + " & { params: { query: { serviceName?: string | undefined; transactionName?: string | undefined; transactionType?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<", + "DurationFieldCandidatesResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/dependencies/operations/spans\": { endpoint: \"GET /internal/apm/dependencies/operations/spans\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -2955,7 +2899,7 @@ "Type", "; sampleRangeTo: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -2963,19 +2907,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { spans: ", - "DependencySpan", - "[]; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/dependencies/charts/distribution\": ", + " & { params: { query: { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { dependencyName: string; spanName: string; } & { sampleRangeFrom?: number | undefined; sampleRangeTo?: number | undefined; }; }; }) => Promise<{ spans: ", + "DependencySpan", + "[]; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/dependencies/charts/distribution\": { endpoint: \"GET /internal/apm/dependencies/charts/distribution\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -3017,7 +2963,7 @@ "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, - ">]>; }>]>; }>, ", + ">]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3025,19 +2971,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "DependencyLatencyDistributionResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/dependencies/operations\": ", + " & { params: { query: { dependencyName: string; spanName: string; percentileThreshold: number; } & { start: number; end: number; } & { kuery: string; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; }; }; }) => Promise<", + "DependencyLatencyDistributionResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/dependencies/operations\": { endpoint: \"GET /internal/apm/dependencies/operations\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -3081,7 +3029,7 @@ "StringC", "; searchServiceDestinationMetrics: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3089,19 +3037,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { operations: ", - "DependencyOperation", - "[]; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/dependencies/charts/error_rate\": ", + " & { params: { query: { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { offset?: string | undefined; } & { dependencyName: string; searchServiceDestinationMetrics: boolean; }; }; }) => Promise<{ operations: ", + "DependencyOperation", + "[]; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/dependencies/charts/error_rate\": { endpoint: \"GET /internal/apm/dependencies/charts/error_rate\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -3147,7 +3097,7 @@ "PartialC", "<{ offset: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3155,17 +3105,19 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentTimeseries: { x: number; y: number; }[]; comparisonTimeseries: { x: number; y: number; }[] | null; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/dependencies/charts/throughput\": ", + " & { params: { query: { dependencyName: string; spanName: string; searchServiceDestinationMetrics: boolean; } & { start: number; end: number; } & { kuery: string; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { offset?: string | undefined; }; }; }) => Promise<{ currentTimeseries: { x: number; y: number; }[]; comparisonTimeseries: { x: number; y: number; }[] | null; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/dependencies/charts/throughput\": { endpoint: \"GET /internal/apm/dependencies/charts/throughput\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -3211,7 +3163,7 @@ "PartialC", "<{ offset: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3219,19 +3171,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ThroughputChartsForDependencyResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/dependencies/charts/latency\": ", + " & { params: { query: { dependencyName: string; spanName: string; searchServiceDestinationMetrics: boolean; } & { start: number; end: number; } & { kuery: string; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { offset?: string | undefined; }; }; }) => Promise<", + "ThroughputChartsForDependencyResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/dependencies/charts/latency\": { endpoint: \"GET /internal/apm/dependencies/charts/latency\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -3277,7 +3231,7 @@ "PartialC", "<{ offset: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3285,19 +3239,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "LatencyChartsDependencyResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/dependencies/metadata\": ", + " & { params: { query: { dependencyName: string; spanName: string; searchServiceDestinationMetrics: boolean; } & { start: number; end: number; } & { kuery: string; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { offset?: string | undefined; }; }; }) => Promise<", + "LatencyChartsDependencyResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/dependencies/metadata\": { endpoint: \"GET /internal/apm/dependencies/metadata\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -3311,7 +3267,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3319,19 +3275,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { metadata: ", + " & { params: { query: { dependencyName: string; } & { start: number; end: number; }; }; }) => Promise<{ metadata: ", "MetadataForDependencyResponse", - "; }, ", + "; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/dependencies/upstream_services\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/dependencies/upstream_services\", ", + "; \"GET /internal/apm/dependencies/upstream_services\": { endpoint: \"GET /internal/apm/dependencies/upstream_services\"; params?: ", "IntersectionC", "<[", "TypeC", @@ -3383,27 +3331,29 @@ "TypeC", "<{ kuery: ", "StringC", - "; }>]>; }>]>, ", + "; }>]>; }>]> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", "docId": "kibApmPluginApi", "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" - }, - ", ", - "UpstreamServicesForDependencyResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/dependencies/top_dependencies\": ", + }, + " & { params: { query: { dependencyName: string; } & { start: number; end: number; } & { numBuckets: number; }; } & { query?: ({ environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { offset?: string | undefined; } & { kuery: string; }) | undefined; }; }) => Promise<", + "UpstreamServicesForDependencyResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/dependencies/top_dependencies\": { endpoint: \"GET /internal/apm/dependencies/top_dependencies\"; params?: ", "IntersectionC", "<[", "TypeC", @@ -3449,7 +3399,7 @@ "PartialC", "<{ offset: ", "StringC", - "; }>; }>]>, ", + "; }>; }>]> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3457,19 +3407,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "TopDependenciesResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/fleet/java_agent_versions\": ", + " & { params: { query: { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { numBuckets: number; }; } & { query?: { offset?: string | undefined; } | undefined; }; }) => Promise<", + "TopDependenciesResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/fleet/java_agent_versions\": { endpoint: \"GET /internal/apm/fleet/java_agent_versions\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3477,17 +3429,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { versions: string[] | undefined; }, ", + ") => Promise<{ versions: string[] | undefined; }>; } & ", "APMRouteCreateOptions", - ">; \"POST /internal/apm/fleet/cloud_apm_package_policy\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/apm/fleet/cloud_apm_package_policy\", undefined, ", + "; \"POST /internal/apm/fleet/cloud_apm_package_policy\": { endpoint: \"POST /internal/apm/fleet/cloud_apm_package_policy\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3495,7 +3439,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { cloudApmPackagePolicy: ", + ") => Promise<{ cloudApmPackagePolicy: ", { "pluginId": "fleet", "scope": "common", @@ -3503,17 +3447,9 @@ "section": "def-common.PackagePolicy", "text": "PackagePolicy" }, - "; }, ", + "; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/fleet/migration_check\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/fleet/migration_check\", undefined, ", + "; \"GET /internal/apm/fleet/migration_check\": { endpoint: \"GET /internal/apm/fleet/migration_check\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3521,19 +3457,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + ") => Promise<", "RunMigrationCheckResponse", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/fleet/apm_server_schema/unsupported\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/fleet/apm_server_schema/unsupported\", undefined, ", + "; \"GET /internal/apm/fleet/apm_server_schema/unsupported\": { endpoint: \"GET /internal/apm/fleet/apm_server_schema/unsupported\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3541,19 +3469,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { unsupported: ", + ") => Promise<{ unsupported: ", "UnsupportedApmServerSchema", - "; }, ", + "; }>; } & ", "APMRouteCreateOptions", - ">; \"POST /api/apm/fleet/apm_server_schema\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /api/apm/fleet/apm_server_schema\", ", + "; \"POST /api/apm/fleet/apm_server_schema 2023-05-22\": { endpoint: \"POST /api/apm/fleet/apm_server_schema 2023-05-22\"; params?: ", "TypeC", "<{ body: ", "TypeC", @@ -3563,7 +3483,7 @@ "StringC", ", ", "UnknownC", - ">; }>; }>, ", + ">; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3571,17 +3491,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", void, ", + " & { params: { body: { schema: { [x: string]: unknown; }; }; }; }) => Promise; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/fleet/agents\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/fleet/agents\", undefined, ", + "; \"GET /internal/apm/fleet/agents\": { endpoint: \"GET /internal/apm/fleet/agents\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3589,19 +3501,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + ") => Promise<", "FleetAgentResponse", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/fleet/has_apm_policies\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/fleet/has_apm_policies\", undefined, ", + "; \"GET /internal/apm/fleet/has_apm_policies\": { endpoint: \"GET /internal/apm/fleet/has_apm_policies\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3609,17 +3513,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { hasApmPolicies: boolean; }, ", + ") => Promise<{ hasApmPolicies: boolean; }>; } & ", "APMRouteCreateOptions", - ">; \"POST /internal/apm/sourcemaps/migrate_fleet_artifacts\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/apm/sourcemaps/migrate_fleet_artifacts\", undefined, ", + "; \"POST /internal/apm/sourcemaps/migrate_fleet_artifacts\": { endpoint: \"POST /internal/apm/sourcemaps/migrate_fleet_artifacts\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3627,23 +3523,15 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", void, ", + ") => Promise; } & ", "APMRouteCreateOptions", - ">; \"DELETE /api/apm/sourcemaps/{id}\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"DELETE /api/apm/sourcemaps/{id}\", ", + "; \"DELETE /api/apm/sourcemaps/{id} 2023-05-22\": { endpoint: \"DELETE /api/apm/sourcemaps/{id} 2023-05-22\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3651,17 +3539,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", void, ", + " & { params: { path: { id: string; }; }; }) => Promise; } & ", "APMRouteCreateOptions", - ">; \"POST /api/apm/sourcemaps\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /api/apm/sourcemaps\", ", + "; \"POST /api/apm/sourcemaps 2023-05-22\": { endpoint: \"POST /api/apm/sourcemaps 2023-05-22\"; params?: ", "TypeC", "<{ body: ", "TypeC", @@ -3673,7 +3553,7 @@ "StringC", "; sourcemap: ", "Type", - "<{ version: number; sources: string[]; mappings: string; } & { names?: string[] | undefined; file?: string | undefined; sourceRoot?: string | undefined; sourcesContent?: (string | null)[] | undefined; }, string | Buffer, unknown>; }>; }>, ", + "<{ version: number; sources: string[]; mappings: string; } & { names?: string[] | undefined; file?: string | undefined; sourceRoot?: string | undefined; sourcesContent?: (string | null)[] | undefined; }, string | Buffer, unknown>; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3681,7 +3561,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { body: { service_name: string; service_version: string; bundle_filepath: string; sourcemap: { version: number; sources: string[]; mappings: string; } & { names?: string[] | undefined; file?: string | undefined; sourceRoot?: string | undefined; sourcesContent?: (string | null)[] | undefined; }; }; }; }) => Promise<", { "pluginId": "fleet", "scope": "server", @@ -3689,17 +3569,9 @@ "section": "def-server.Artifact", "text": "Artifact" }, - " | undefined, ", + " | undefined>; } & ", "APMRouteCreateOptions", - ">; \"GET /api/apm/sourcemaps\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /api/apm/sourcemaps\", ", + "; \"GET /api/apm/sourcemaps 2023-05-22\": { endpoint: \"GET /api/apm/sourcemaps 2023-05-22\"; params?: ", "PartialC", "<{ query: ", "PartialC", @@ -3707,7 +3579,7 @@ "Type", "; perPage: ", "Type", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3715,25 +3587,17 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params?: { query?: { page?: number | undefined; perPage?: number | undefined; } | undefined; } | undefined; }) => Promise<", "ListSourceMapArtifactsResponse", - " | undefined, ", + " | undefined>; } & ", "APMRouteCreateOptions", - ">; \"DELETE /internal/apm/settings/custom_links/{id}\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"DELETE /internal/apm/settings/custom_links/{id}\", ", + "; \"DELETE /internal/apm/settings/custom_links/{id}\": { endpoint: \"DELETE /internal/apm/settings/custom_links/{id}\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3741,17 +3605,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { result: string; }, ", + " & { params: { path: { id: string; }; }; }) => Promise<{ result: string; }>; } & ", "APMRouteCreateOptions", - ">; \"PUT /internal/apm/settings/custom_links/{id}\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"PUT /internal/apm/settings/custom_links/{id}\", ", + "; \"PUT /internal/apm/settings/custom_links/{id}\": { endpoint: \"PUT /internal/apm/settings/custom_links/{id}\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -3789,7 +3645,7 @@ "StringC", "; }>]>; value: ", "StringC", - "; }>>; }>]>; }>, ", + "; }>>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3797,17 +3653,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", void, ", + " & { params: { path: { id: string; }; body: { label: string; url: string; } & { id?: string | undefined; filters?: { key: \"\" | \"service.name\" | \"service.environment\" | \"transaction.name\" | \"transaction.type\"; value: string; }[] | undefined; }; }; }) => Promise; } & ", "APMRouteCreateOptions", - ">; \"POST /internal/apm/settings/custom_links\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/apm/settings/custom_links\", ", + "; \"POST /internal/apm/settings/custom_links\": { endpoint: \"POST /internal/apm/settings/custom_links\"; params?: ", "TypeC", "<{ body: ", "IntersectionC", @@ -3841,7 +3689,7 @@ "StringC", "; }>]>; value: ", "StringC", - "; }>>; }>]>; }>, ", + "; }>>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3849,17 +3697,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", void, ", + " & { params: { body: { label: string; url: string; } & { id?: string | undefined; filters?: { key: \"\" | \"service.name\" | \"service.environment\" | \"transaction.name\" | \"transaction.type\"; value: string; }[] | undefined; }; }; }) => Promise; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/settings/custom_links\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/settings/custom_links\", ", + "; \"GET /internal/apm/settings/custom_links\": { endpoint: \"GET /internal/apm/settings/custom_links\"; params?: ", "PartialC", "<{ query: ", "PartialC", @@ -3871,7 +3711,7 @@ "StringC", "; 'transaction.type': ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3879,19 +3719,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { customLinks: ", + " & { params?: { query?: { 'service.name'?: string | undefined; 'service.environment'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; } | undefined; } | undefined; }) => Promise<{ customLinks: ", "CustomLink", - "[]; }, ", + "[]; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/settings/custom_links/transaction\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/settings/custom_links/transaction\", ", + "; \"GET /internal/apm/settings/custom_links/transaction\": { endpoint: \"GET /internal/apm/settings/custom_links/transaction\"; params?: ", "PartialC", "<{ query: ", "PartialC", @@ -3903,7 +3735,7 @@ "StringC", "; 'transaction.type': ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3911,23 +3743,15 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params?: { query?: { 'service.name'?: string | undefined; 'service.environment'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; } | undefined; } | undefined; }) => Promise<", "Transaction", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"POST /internal/apm/settings/apm-indices/save\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/apm/settings/apm-indices/save\", ", + "; \"POST /internal/apm/settings/apm-indices/save\": { endpoint: \"POST /internal/apm/settings/apm-indices/save\"; params?: ", "TypeC", "<{ body: ", "PartialC", - "; }>, ", + "; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3935,7 +3759,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { body: { readonly error?: string | undefined; readonly metric?: string | undefined; readonly span?: string | undefined; readonly transaction?: string | undefined; readonly onboarding?: string | undefined; }; }; }) => Promise<", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", @@ -3943,17 +3767,9 @@ "section": "def-common.SavedObject", "text": "SavedObject" }, - "<{}>, ", + "<{}>>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/settings/apm-indices\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/settings/apm-indices\", undefined, ", + "; \"GET /internal/apm/settings/apm-indices\": { endpoint: \"GET /internal/apm/settings/apm-indices\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3961,17 +3777,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", Readonly<{ error: string; onboarding: string; span: string; transaction: string; metric: string; }>, ", + ") => Promise>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/settings/apm-index-settings\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/settings/apm-index-settings\", undefined, ", + "; \"GET /internal/apm/settings/apm-index-settings\": { endpoint: \"GET /internal/apm/settings/apm-index-settings\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3979,19 +3787,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { apmIndexSettings: ", + ") => Promise<{ apmIndexSettings: ", "ApmIndexSettingsResponse", - "; }, ", + "; }>; } & ", "APMRouteCreateOptions", - ">; \"POST /internal/apm/settings/anomaly-detection/update_to_v3\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/apm/settings/anomaly-detection/update_to_v3\", undefined, ", + "; \"POST /internal/apm/settings/anomaly-detection/update_to_v3\": { endpoint: \"POST /internal/apm/settings/anomaly-detection/update_to_v3\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -3999,17 +3799,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { update: boolean; }, ", + ") => Promise<{ update: boolean; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/settings/anomaly-detection/environments\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/settings/anomaly-detection/environments\", undefined, ", + "; \"GET /internal/apm/settings/anomaly-detection/environments\": { endpoint: \"GET /internal/apm/settings/anomaly-detection/environments\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4017,17 +3809,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { environments: string[]; }, ", + ") => Promise<{ environments: string[]; }>; } & ", "APMRouteCreateOptions", - ">; \"POST /internal/apm/settings/anomaly-detection/jobs\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/apm/settings/anomaly-detection/jobs\", ", + "; \"POST /internal/apm/settings/anomaly-detection/jobs\": { endpoint: \"POST /internal/apm/settings/anomaly-detection/jobs\"; params?: ", "TypeC", "<{ body: ", "TypeC", @@ -4051,7 +3835,7 @@ "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, - ">]>>; }>; }>, ", + ">]>>; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4059,17 +3843,19 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { jobCreated: true; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/settings/anomaly-detection/jobs\": ", + " & { params: { body: { environments: (\"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + ")[]; }; }; }) => Promise<{ jobCreated: true; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/settings/anomaly-detection/jobs\": { endpoint: \"GET /internal/apm/settings/anomaly-detection/jobs\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4077,25 +3863,17 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { jobs: ", + ") => Promise<{ jobs: ", "ApmMlJob", - "[]; hasLegacyJobs: boolean; }, ", + "[]; hasLegacyJobs: boolean; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /api/apm/settings/agent-configuration/agent_name\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /api/apm/settings/agent-configuration/agent_name\", ", + "; \"GET /api/apm/settings/agent-configuration/agent_name 2023-05-22\": { endpoint: \"GET /api/apm/settings/agent-configuration/agent_name 2023-05-22\"; params?: ", "TypeC", "<{ query: ", "TypeC", "<{ serviceName: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4103,23 +3881,15 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { agentName: string | undefined; }, ", + " & { params: { query: { serviceName: string; }; }; }) => Promise<{ agentName: string | undefined; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /api/apm/settings/agent-configuration/environments\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /api/apm/settings/agent-configuration/environments\", ", + "; \"GET /api/apm/settings/agent-configuration/environments 2023-05-22\": { endpoint: \"GET /api/apm/settings/agent-configuration/environments 2023-05-22\"; params?: ", "PartialC", "<{ query: ", "PartialC", "<{ serviceName: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4127,19 +3897,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { environments: ", + " & { params?: { query?: { serviceName?: string | undefined; } | undefined; } | undefined; }) => Promise<{ environments: ", "EnvironmentsResponse", - "; }, ", + "; }>; } & ", "APMRouteCreateOptions", - ">; \"POST /api/apm/settings/agent-configuration/search\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /api/apm/settings/agent-configuration/search\", ", + "; \"POST /api/apm/settings/agent-configuration/search 2023-05-22\": { endpoint: \"POST /api/apm/settings/agent-configuration/search 2023-05-22\"; params?: ", "TypeC", "<{ body: ", "IntersectionC", @@ -4157,7 +3919,7 @@ "StringC", "; mark_as_applied_by_agent: ", "BooleanC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4165,7 +3927,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { body: { service: { name?: string | undefined; environment?: string | undefined; }; } & { etag?: string | undefined; mark_as_applied_by_agent?: boolean | undefined; }; }; }) => Promise<", { "pluginId": "@kbn/es-types", "scope": "common", @@ -4175,17 +3937,9 @@ }, "<", "AgentConfiguration", - ", undefined, undefined> | null, ", + ", undefined, undefined> | null>; } & ", "APMRouteCreateOptions", - ">; \"PUT /api/apm/settings/agent-configuration\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"PUT /api/apm/settings/agent-configuration\", ", + "; \"PUT /api/apm/settings/agent-configuration 2023-05-22\": { endpoint: \"PUT /api/apm/settings/agent-configuration 2023-05-22\"; params?: ", "IntersectionC", "<[", "PartialC", @@ -4221,7 +3975,7 @@ "PartialC", ">]>; }>]>; }>]>, ", + ">>]>; }>]>; }>]> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4229,17 +3983,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", void, ", + " & { params: { query?: { overwrite?: boolean | undefined; } | undefined; } & { body: { agent_name?: string | undefined; } & { service: { name?: string | undefined; environment?: string | undefined; }; settings: { [x: string]: string; } & { [x: string]: any; }; }; }; }) => Promise; } & ", "APMRouteCreateOptions", - ">; \"DELETE /api/apm/settings/agent-configuration\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"DELETE /api/apm/settings/agent-configuration\", ", + "; \"DELETE /api/apm/settings/agent-configuration 2023-05-22\": { endpoint: \"DELETE /api/apm/settings/agent-configuration 2023-05-22\"; params?: ", "TypeC", "<{ body: ", "TypeC", @@ -4249,7 +3995,7 @@ "StringC", "; environment: ", "StringC", - "; }>; }>; }>, ", + "; }>; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4257,17 +4003,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { result: string; }, ", + " & { params: { body: { service: { name?: string | undefined; environment?: string | undefined; }; }; }; }) => Promise<{ result: string; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /api/apm/settings/agent-configuration/view\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /api/apm/settings/agent-configuration/view\", ", + "; \"GET /api/apm/settings/agent-configuration/view 2023-05-22\": { endpoint: \"GET /api/apm/settings/agent-configuration/view 2023-05-22\"; params?: ", "PartialC", "<{ query: ", "PartialC", @@ -4275,7 +4013,7 @@ "StringC", "; environment: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4283,19 +4021,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params?: { query?: { name?: string | undefined; environment?: string | undefined; } | undefined; } | undefined; }) => Promise<", "AgentConfiguration", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /api/apm/settings/agent-configuration\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /api/apm/settings/agent-configuration\", undefined, ", + "; \"GET /api/apm/settings/agent-configuration 2023-05-22\": { endpoint: \"GET /api/apm/settings/agent-configuration 2023-05-22\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4303,19 +4033,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { configurations: ", + ") => Promise<{ configurations: ", "AgentConfiguration", - "[]; }, ", + "[]; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/rule_types/transaction_duration/chart_preview\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/rule_types/transaction_duration/chart_preview\", ", + "; \"GET /internal/apm/rule_types/transaction_duration/chart_preview\": { endpoint: \"GET /internal/apm/rule_types/transaction_duration/chart_preview\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -4373,7 +4095,7 @@ "TypeC", "<{ interval: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4381,19 +4103,23 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { latencyChartPreview: ", - "TransactionDurationChartPreviewResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/rule_types/error_count/chart_preview\": ", + " & { params: { query: { aggregationType?: ", + "AggregationType", + " | undefined; serviceName?: string | undefined; errorGroupingKey?: string | undefined; transactionType?: string | undefined; transactionName?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { start: number; end: number; } & { interval: string; }; }; }) => Promise<{ latencyChartPreview: ", + "TransactionDurationChartPreviewResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/rule_types/error_count/chart_preview\": { endpoint: \"GET /internal/apm/rule_types/error_count/chart_preview\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -4451,7 +4177,7 @@ "TypeC", "<{ interval: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4459,17 +4185,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { errorCountChartPreview: { x: number; y: number; }[]; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/rule_types/transaction_error_rate/chart_preview\": ", + " & { params: { query: { aggregationType?: ", + "AggregationType", + " | undefined; serviceName?: string | undefined; errorGroupingKey?: string | undefined; transactionType?: string | undefined; transactionName?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { start: number; end: number; } & { interval: string; }; }; }) => Promise<{ errorCountChartPreview: { x: number; y: number; }[]; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/rule_types/transaction_error_rate/chart_preview\": { endpoint: \"GET /internal/apm/rule_types/transaction_error_rate/chart_preview\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -4527,7 +4257,7 @@ "TypeC", "<{ interval: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4535,19 +4265,23 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { errorRateChartPreview: ", - "TransactionErrorRateChartPreviewResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\": ", + " & { params: { query: { aggregationType?: ", + "AggregationType", + " | undefined; serviceName?: string | undefined; errorGroupingKey?: string | undefined; transactionType?: string | undefined; transactionName?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { start: number; end: number; } & { interval: string; }; }; }) => Promise<{ errorRateChartPreview: ", + "TransactionErrorRateChartPreviewResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\": { endpoint: \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -4597,7 +4331,7 @@ "PartialC", "<{ offset: ", "StringC", - "; }>]>]>; }>, ", + "; }>]>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4605,19 +4339,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ColdstartRateResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\": ", + " & { params: { path: { serviceName: string; }; query: { transactionType: string; transactionName: string; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { offset?: string | undefined; }; }; }) => Promise<", + "ColdstartRateResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\": { endpoint: \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -4665,7 +4401,7 @@ "PartialC", "<{ offset: ", "StringC", - "; }>]>]>; }>, ", + "; }>]>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4673,19 +4409,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ColdstartRateResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\": ", + " & { params: { path: { serviceName: string; }; query: { transactionType: string; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { offset?: string | undefined; }; }; }) => Promise<", + "ColdstartRateResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\": { endpoint: \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -4773,7 +4511,7 @@ "LiteralC", "<", "RollupInterval", - ".None>]>; }>]>]>; }>, ", + ".None>]>; }>]>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4781,19 +4519,29 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "FailedTransactionRateResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\": ", + " & { params: { path: { serviceName: string; }; query: { transactionType: string; bucketSizeInSeconds: number; } & { transactionName?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { offset?: string | undefined; } & { documentType: ", + "ApmDocumentType", + ".TransactionMetric | ", + "ApmDocumentType", + ".ServiceTransactionMetric | ", + "ApmDocumentType", + ".TransactionEvent; rollupInterval: ", + "RollupInterval", + "; }; }; }) => Promise<", + "FailedTransactionRateResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\": { endpoint: \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -4839,7 +4587,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4847,19 +4595,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "TransactionBreakdownResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\": ", + " & { params: { path: { serviceName: string; }; query: { transactionType: string; } & { transactionName?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<", + "TransactionBreakdownResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\": { endpoint: \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -4913,7 +4663,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -4921,19 +4671,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "TransactionTraceSamplesResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\": ", + " & { params: { path: { serviceName: string; }; query: { transactionType: string; transactionName: string; } & { transactionId?: string | undefined; traceId?: string | undefined; sampleRangeFrom?: number | undefined; sampleRangeTo?: number | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<", + "TransactionTraceSamplesResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\": { endpoint: \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -5037,7 +4789,7 @@ "LiteralC", "<", "RollupInterval", - ".None>]>; }>]>; }>, ", + ".None>]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5045,19 +4797,31 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "TransactionLatencyResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\": ", + " & { params: { path: { serviceName: string; }; query: { transactionType: string; latencyAggregationType: ", + "LatencyAggregationType", + "; bucketSizeInSeconds: number; } & { transactionName?: string | undefined; useDurationSummary?: boolean | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { offset?: string | undefined; } & { documentType: ", + "ApmDocumentType", + ".TransactionMetric | ", + "ApmDocumentType", + ".ServiceTransactionMetric | ", + "ApmDocumentType", + ".TransactionEvent; rollupInterval: ", + "RollupInterval", + "; }; }; }) => Promise<", + "TransactionLatencyResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\": { endpoint: \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -5157,7 +4921,7 @@ "LiteralC", "<", "LatencyAggregationType", - ".p99>]>; }>]>; }>, ", + ".p99>]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5165,19 +4929,29 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ServiceTransactionGroupDetailedStatisticsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\": ", + " & { params: { path: { serviceName: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { offset?: string | undefined; } & { documentType: ", + "ApmDocumentType", + ".TransactionMetric | ", + "ApmDocumentType", + ".TransactionEvent; rollupInterval: ", + "RollupInterval", + "; } & { bucketSizeInSeconds: number; useDurationSummary: boolean; } & { transactionNames: string[]; transactionType: string; latencyAggregationType: ", + "LatencyAggregationType", + "; }; }; }) => Promise<", + "ServiceTransactionGroupDetailedStatisticsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\": { endpoint: \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -5265,7 +5039,7 @@ "LiteralC", "<", "RollupInterval", - ".None>]>; }>]>; }>, ", + ".None>]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5273,19 +5047,29 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ServiceTransactionGroupsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/traces/{traceId}/spans/{spanId}\": ", + " & { params: { path: { serviceName: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { useDurationSummary: boolean; transactionType: string; latencyAggregationType: ", + "LatencyAggregationType", + "; } & { documentType: ", + "ApmDocumentType", + ".TransactionMetric | ", + "ApmDocumentType", + ".TransactionEvent; rollupInterval: ", + "RollupInterval", + "; }; }; }) => Promise<", + "ServiceTransactionGroupsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/traces/{traceId}/spans/{spanId}\": { endpoint: \"GET /internal/apm/traces/{traceId}/spans/{spanId}\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -5301,7 +5085,7 @@ "StringC", "; }>, ", "UndefinedC", - "]>; }>, ", + "]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5309,21 +5093,13 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { span?: ", + " & { params: { path: { traceId: string; spanId: string; }; query: { parentTransactionId?: string | undefined; } | undefined; }; }) => Promise<{ span?: ", "Span", " | undefined; parentTransaction?: ", "Transaction", - " | undefined; }, ", + " | undefined; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/traces/{traceId}/transactions/{transactionId}\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/traces/{traceId}/transactions/{transactionId}\", ", + "; \"GET /internal/apm/traces/{traceId}/transactions/{transactionId}\": { endpoint: \"GET /internal/apm/traces/{traceId}/transactions/{transactionId}\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -5331,7 +5107,7 @@ "StringC", "; transactionId: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5339,19 +5115,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { path: { traceId: string; transactionId: string; }; }; }) => Promise<", "Transaction", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"POST /internal/apm/traces/aggregated_critical_path\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/apm/traces/aggregated_critical_path\", ", + "; \"POST /internal/apm/traces/aggregated_critical_path\": { endpoint: \"POST /internal/apm/traces/aggregated_critical_path\"; params?: ", "TypeC", "<{ body: ", "IntersectionC", @@ -5399,7 +5167,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5407,19 +5175,31 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { criticalPath: ", - "CriticalPathResponse", - " | null; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/traces/find\": ", + " & { params: { body: { traceIds: string[]; serviceName: ", + "Branded", + " | null; transactionName: ", + "Branded", + " | null; } & { start: number; end: number; }; }; }) => Promise<{ criticalPath: ", + "CriticalPathResponse", + " | null; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/traces/find\": { endpoint: \"GET /internal/apm/traces/find\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -5463,7 +5243,7 @@ "LiteralC", "<", "TraceSearchType", - ".eql>]>; }>]>; }>, ", + ".eql>]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5471,25 +5251,29 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { traceSamples: ", - "TraceSamplesResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/transactions/{transactionId}\": ", + " & { params: { query: { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { query: string; type: ", + "TraceSearchType", + "; }; }; }) => Promise<{ traceSamples: ", + "TraceSamplesResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/transactions/{transactionId}\": { endpoint: \"GET /internal/apm/transactions/{transactionId}\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ transactionId: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5497,25 +5281,17 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { transaction: ", + " & { params: { path: { transactionId: string; }; }; }) => Promise<{ transaction: ", "Transaction", - "; }, ", + "; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/traces/{traceId}/root_transaction\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/traces/{traceId}/root_transaction\", ", + "; \"GET /internal/apm/traces/{traceId}/root_transaction\": { endpoint: \"GET /internal/apm/traces/{traceId}/root_transaction\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ traceId: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5523,19 +5299,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { transaction: ", + " & { params: { path: { traceId: string; }; }; }) => Promise<{ transaction: ", "Transaction", - "; }, ", + "; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/traces\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/traces\", ", + "; \"GET /internal/apm/traces\": { endpoint: \"GET /internal/apm/traces\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -5573,7 +5341,7 @@ "TypeC", "<{ probability: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5581,19 +5349,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "TopTracesPrimaryStatsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/traces/{traceId}\": ", + " & { params: { query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { probability: number; }; }; }) => Promise<", + "TopTracesPrimaryStatsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/traces/{traceId}\": { endpoint: \"GET /internal/apm/traces/{traceId}\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -5611,7 +5381,7 @@ "TypeC", "<{ entryTransactionId: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5619,21 +5389,13 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { traceItems: ", + " & { params: { path: { traceId: string; }; query: { start: number; end: number; } & { entryTransactionId: string; }; }; }) => Promise<{ traceItems: ", "TraceItems", "; entryTransaction?: ", "Transaction", - " | undefined; }, ", + " | undefined; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/suggestions\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/suggestions\", ", + "; \"GET /internal/apm/suggestions\": { endpoint: \"GET /internal/apm/suggestions\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -5653,7 +5415,7 @@ "PartialC", "<{ serviceName: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5661,17 +5423,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { terms: string[]; }, ", + " & { params: { query: { fieldName: string; fieldValue: string; } & { start: number; end: number; } & { serviceName?: string | undefined; }; }; }) => Promise<{ terms: string[]; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/service-group/counts\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/service-group/counts\", undefined, ", + "; \"GET /internal/apm/service-group/counts\": { endpoint: \"GET /internal/apm/service-group/counts\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5679,17 +5433,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ServiceGroupCounts, ", + ") => Promise; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/service-group/services\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/service-group/services\", ", + "; \"GET /internal/apm/service-group/services\": { endpoint: \"GET /internal/apm/service-group/services\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -5703,7 +5449,7 @@ "PartialC", "<{ kuery: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5711,25 +5457,17 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { items: ", + " & { params: { query: { start: number; end: number; } & { kuery?: string | undefined; }; }; }) => Promise<{ items: ", "LookupServicesResponse", - "; }, ", + "; }>; } & ", "APMRouteCreateOptions", - ">; \"DELETE /internal/apm/service-group\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"DELETE /internal/apm/service-group\", ", + "; \"DELETE /internal/apm/service-group\": { endpoint: \"DELETE /internal/apm/service-group\"; params?: ", "TypeC", "<{ query: ", "TypeC", "<{ serviceGroupId: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5737,17 +5475,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", void, ", + " & { params: { query: { serviceGroupId: string; }; }; }) => Promise; } & ", "APMRouteCreateOptions", - ">; \"POST /internal/apm/service-group\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/apm/service-group\", ", + "; \"POST /internal/apm/service-group\": { endpoint: \"POST /internal/apm/service-group\"; params?: ", "TypeC", "<{ query: ", "UnionC", @@ -5775,7 +5505,7 @@ "StringC", ", ", "UndefinedC", - "]>; }>; }>, ", + "]>; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5783,25 +5513,17 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { query: { serviceGroupId?: string | undefined; } | undefined; body: { groupName: string; kuery: string; description: string | undefined; color: string | undefined; }; }; }) => Promise<", "SavedServiceGroup", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/service-group\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/service-group\", ", + "; \"GET /internal/apm/service-group\": { endpoint: \"GET /internal/apm/service-group\"; params?: ", "TypeC", "<{ query: ", "TypeC", "<{ serviceGroup: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5809,19 +5531,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { serviceGroup: ", + " & { params: { query: { serviceGroup: string; }; }; }) => Promise<{ serviceGroup: ", "SavedServiceGroup", - "; }, ", + "; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/service-groups\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/service-groups\", undefined, ", + "; \"GET /internal/apm/service-groups\": { endpoint: \"GET /internal/apm/service-groups\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5829,19 +5543,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { serviceGroups: ", + ") => Promise<{ serviceGroups: ", "SavedServiceGroup", - "[]; }, ", + "[]; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/alerts_count\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/services/{serviceName}/alerts_count\", ", + "; \"GET /internal/apm/services/{serviceName}/alerts_count\": { endpoint: \"GET /internal/apm/services/{serviceName}/alerts_count\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -5875,7 +5581,7 @@ "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, - ">]>; }>]>; }>, ", + ">]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5883,17 +5589,19 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { serviceName: string; alertsCount: number; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/anomaly_charts\": ", + " & { params: { path: { serviceName: string; }; query: { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; }; }; }) => Promise<{ serviceName: string; alertsCount: number; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/anomaly_charts\": { endpoint: \"GET /internal/apm/services/{serviceName}/anomaly_charts\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -5931,7 +5639,7 @@ "TypeC", "<{ transactionType: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5939,19 +5647,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { allAnomalyTimeseries: ", - "ServiceAnomalyTimeseries", - "[]; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\": ", + " & { params: { path: { serviceName: string; }; query: { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { transactionType: string; }; }; }) => Promise<{ allAnomalyTimeseries: ", + "ServiceAnomalyTimeseries", + "[]; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\": { endpoint: \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -5989,7 +5699,7 @@ "TypeC", "<{ kuery: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5997,19 +5707,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { breakdown: ", - "ServiceDependenciesBreakdownResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/dependencies\": ", + " & { params: { path: { serviceName: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { start: number; end: number; } & { kuery: string; }; }; }) => Promise<{ breakdown: ", + "ServiceDependenciesBreakdownResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/dependencies\": { endpoint: \"GET /internal/apm/services/{serviceName}/dependencies\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -6051,7 +5763,7 @@ "PartialC", "<{ offset: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6059,19 +5771,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { serviceDependencies: ", - "ServiceDependenciesResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\": ", + " & { params: { path: { serviceName: string; }; query: { numBuckets: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { start: number; end: number; } & { offset?: string | undefined; }; }; }) => Promise<{ serviceDependencies: ", + "ServiceDependenciesResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\": { endpoint: \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -6135,7 +5849,7 @@ "PartialC", "<{ offset: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6143,19 +5857,23 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ServiceInstancesDetailedStatisticsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\": ", + " & { params: { path: { serviceName: string; }; query: { latencyAggregationType: ", + "LatencyAggregationType", + "; transactionType: string; serviceNodeIds: string[]; numBuckets: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { offset?: string | undefined; }; }; }) => Promise<", + "ServiceInstancesDetailedStatisticsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\": { endpoint: \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -6215,7 +5933,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6223,21 +5941,25 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: ", + " & { params: { path: { serviceName: string; }; query: { latencyAggregationType: ", + "LatencyAggregationType", + "; transactionType: string; } & { offset?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<{ currentPeriod: ", "ServiceInstanceMainStatisticsResponse", "; previousPeriod: ", "ServiceInstanceMainStatisticsResponse", - "; }, ", + "; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/throughput\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/services/{serviceName}/throughput\", ", + "; \"GET /internal/apm/services/{serviceName}/throughput\": { endpoint: \"GET /internal/apm/services/{serviceName}/throughput\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -6325,7 +6047,7 @@ "LiteralC", "<", "RollupInterval", - ".None>]>; }>]>]>; }>, ", + ".None>]>; }>]>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6333,21 +6055,31 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: ", + " & { params: { path: { serviceName: string; }; query: { transactionType: string; bucketSizeInSeconds: number; } & { transactionName?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { offset?: string | undefined; } & { documentType: ", + "ApmDocumentType", + ".TransactionMetric | ", + "ApmDocumentType", + ".ServiceTransactionMetric | ", + "ApmDocumentType", + ".TransactionEvent; rollupInterval: ", + "RollupInterval", + "; }; }; }) => Promise<{ currentPeriod: ", "ServiceThroughputResponse", "; previousPeriod: ", "ServiceThroughputResponse", - "; }, ", + "; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\", ", + "; \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\": { endpoint: \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -6361,7 +6093,7 @@ "Type", "; end: ", "Type", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6369,21 +6101,13 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { path: { serviceName: string; serviceNodeName: string; }; query: { start: number; end: number; }; }; }) => Promise<", "ServiceInstanceMetadataDetailsResponse", " & ({} | ", "ServiceInstanceContainerMetadataDetails", - "), ", + ")>; } & ", "APMRouteCreateOptions", - ">; \"POST /api/apm/services/{serviceName}/annotation\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /api/apm/services/{serviceName}/annotation\", ", + "; \"POST /api/apm/services/{serviceName}/annotation 2023-05-22\": { endpoint: \"POST /api/apm/services/{serviceName}/annotation 2023-05-22\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -6413,7 +6137,7 @@ "ArrayC", "<", "StringC", - ">; }>]>; }>, ", + ">; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6421,19 +6145,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { _id: string; _index: string; _source: ", + " & { params: { path: { serviceName: string; }; body: { '@timestamp': number; service: { version: string; } & { environment?: string | undefined; }; } & { message?: string | undefined; tags?: string[] | undefined; }; }; }) => Promise<{ _id: string; _index: string; _source: ", "Annotation", - "; }, ", + "; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /api/apm/services/{serviceName}/annotation/search\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /api/apm/services/{serviceName}/annotation/search\", ", + "; \"GET /api/apm/services/{serviceName}/annotation/search 2023-05-22\": { endpoint: \"GET /api/apm/services/{serviceName}/annotation/search 2023-05-22\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -6467,7 +6183,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6475,19 +6191,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ServiceAnnotationResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\": ", + " & { params: { path: { serviceName: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { start: number; end: number; }; }; }) => Promise<", + "ServiceAnnotationResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\": { endpoint: \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -6527,7 +6245,7 @@ "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, - ">]>; }>]>; }>, ", + ">]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6535,19 +6253,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ServiceNodeMetadataResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/transaction_types\": ", + " & { params: { path: { serviceName: string; serviceNodeName: string; }; query: { kuery: string; } & { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; }; }; }) => Promise<", + "ServiceNodeMetadataResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/transaction_types\": { endpoint: \"GET /internal/apm/services/{serviceName}/transaction_types\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -6559,7 +6279,7 @@ "Type", "; end: ", "Type", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6567,19 +6287,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { path: { serviceName: string; }; query: { start: number; end: number; }; }; }) => Promise<", "ServiceTransactionTypesResponse", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/agent\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/services/{serviceName}/agent\", ", + "; \"GET /internal/apm/services/{serviceName}/agent\": { endpoint: \"GET /internal/apm/services/{serviceName}/agent\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -6591,7 +6303,7 @@ "Type", "; end: ", "Type", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6599,19 +6311,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { path: { serviceName: string; }; query: { start: number; end: number; }; }; }) => Promise<", "ServiceAgentResponse", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/metadata/icons\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/services/{serviceName}/metadata/icons\", ", + "; \"GET /internal/apm/services/{serviceName}/metadata/icons\": { endpoint: \"GET /internal/apm/services/{serviceName}/metadata/icons\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -6623,7 +6327,7 @@ "Type", "; end: ", "Type", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6631,19 +6335,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { path: { serviceName: string; }; query: { start: number; end: number; }; }; }) => Promise<", "ServiceMetadataIcons", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/metadata/details\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/services/{serviceName}/metadata/details\", ", + "; \"GET /internal/apm/services/{serviceName}/metadata/details\": { endpoint: \"GET /internal/apm/services/{serviceName}/metadata/details\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -6655,7 +6351,7 @@ "Type", "; end: ", "Type", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6663,19 +6359,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { path: { serviceName: string; }; query: { start: number; end: number; }; }; }) => Promise<", "ServiceMetadataDetails", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"POST /internal/apm/services/detailed_statistics\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/apm/services/detailed_statistics\", ", + "; \"POST /internal/apm/services/detailed_statistics\": { endpoint: \"POST /internal/apm/services/detailed_statistics\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -6761,7 +6449,7 @@ "TypeC", "<{ serviceNames: ", "Type", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6769,19 +6457,29 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ServiceTransactionDetailedStatPeriodsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services\": ", + " & { params: { query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { offset?: string | undefined; } & { probability: number; } & { documentType: ", + "ApmDocumentType", + ".TransactionMetric | ", + "ApmDocumentType", + ".ServiceTransactionMetric | ", + "ApmDocumentType", + ".TransactionEvent; rollupInterval: ", + "RollupInterval", + "; } & { bucketSizeInSeconds: number; }; body: { serviceNames: string[]; }; }; }) => Promise<", + "ServiceTransactionDetailedStatPeriodsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services\": { endpoint: \"GET /internal/apm/services\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -6859,7 +6557,7 @@ "Type", "; end: ", "Type", - "; }>]>]>; }>, ", + "; }>]>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6867,19 +6565,29 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ServicesItemsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/service-map/dependency\": ", + " & { params: { query: { serviceGroup?: string | undefined; } & { probability: number; } & { documentType: ", + "ApmDocumentType", + ".TransactionMetric | ", + "ApmDocumentType", + ".ServiceTransactionMetric | ", + "ApmDocumentType", + ".TransactionEvent; rollupInterval: ", + "RollupInterval", + "; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<", + "ServicesItemsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/service-map/dependency\": { endpoint: \"GET /internal/apm/service-map/dependency\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -6917,7 +6625,7 @@ "PartialC", "<{ offset: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6925,19 +6633,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ServiceMapServiceDependencyInfoResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/service-map/service/{serviceName}\": ", + " & { params: { query: { dependencyName: string; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { start: number; end: number; } & { offset?: string | undefined; }; }; }) => Promise<", + "ServiceMapServiceDependencyInfoResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/service-map/service/{serviceName}\": { endpoint: \"GET /internal/apm/service-map/service/{serviceName}\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -6975,7 +6685,7 @@ "PartialC", "<{ offset: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -6983,19 +6693,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ServiceMapServiceNodeInfoResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/service-map\": ", + " & { params: { path: { serviceName: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { start: number; end: number; } & { offset?: string | undefined; }; }; }) => Promise<", + "ServiceMapServiceNodeInfoResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/service-map\": { endpoint: \"GET /internal/apm/service-map\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -7033,7 +6745,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7041,19 +6753,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "GroupResourceNodesResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/observability_overview/has_data\": ", + " & { params: { query: { serviceName?: string | undefined; serviceGroup?: string | undefined; kuery?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { start: number; end: number; }; }; }) => Promise<", + "GroupResourceNodesResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/observability_overview/has_data\": { endpoint: \"GET /internal/apm/observability_overview/has_data\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7061,19 +6775,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + ") => Promise<", "HasDataResponse", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/observability_overview\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/observability_overview\", ", + "; \"GET /internal/apm/observability_overview\": { endpoint: \"GET /internal/apm/observability_overview\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -7089,7 +6795,7 @@ "Type", "; intervalString: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7097,19 +6803,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", + " & { params: { query: { start: number; end: number; } & { bucketSize: number; intervalString: string; }; }; }) => Promise<", "ObservabilityOverviewResponse", - ", ", + ">; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/metrics/serverless/active_instances\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/services/{serviceName}/metrics/serverless/active_instances\", ", + "; \"GET /internal/apm/services/{serviceName}/metrics/serverless/active_instances\": { endpoint: \"GET /internal/apm/services/{serviceName}/metrics/serverless/active_instances\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -7151,7 +6849,7 @@ "PartialC", "<{ serverlessId: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7159,21 +6857,23 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { activeInstances: ", + " & { params: { path: { serviceName: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { serverlessId?: string | undefined; }; }; }) => Promise<{ activeInstances: ", "ActiveInstanceOverview", "[]; timeseries: ", "Coordinate", - "[]; }, ", + "[]; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/metrics/serverless/functions_overview\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/services/{serviceName}/metrics/serverless/functions_overview\", ", + "; \"GET /internal/apm/services/{serviceName}/metrics/serverless/functions_overview\": { endpoint: \"GET /internal/apm/services/{serviceName}/metrics/serverless/functions_overview\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -7211,7 +6911,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7219,19 +6919,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { serverlessFunctionsOverview: ", - "ServerlessFunctionsOverviewResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/metrics/serverless/summary\": ", + " & { params: { path: { serviceName: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<{ serverlessFunctionsOverview: ", + "ServerlessFunctionsOverviewResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/metrics/serverless/summary\": { endpoint: \"GET /internal/apm/services/{serviceName}/metrics/serverless/summary\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -7273,7 +6975,7 @@ "PartialC", "<{ serverlessId: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7281,19 +6983,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ServerlessSummaryResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/metrics/serverless/charts\": ", + " & { params: { path: { serviceName: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { serverlessId?: string | undefined; }; }; }) => Promise<", + "ServerlessSummaryResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/metrics/serverless/charts\": { endpoint: \"GET /internal/apm/services/{serviceName}/metrics/serverless/charts\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -7371,7 +7075,7 @@ "TypeC", "<{ bucketSizeInSeconds: ", "Type", - "; }>]>]>; }>, ", + "; }>]>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7379,19 +7083,27 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { charts: ", - "FetchAndTransformMetrics", - "[]; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/metrics/nodes\": ", + " & { params: { path: { serviceName: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { serverlessId?: string | undefined; } & { documentType: ", + "ApmDocumentType", + ".TransactionMetric | ", + "ApmDocumentType", + ".TransactionEvent; rollupInterval: ", + "RollupInterval", + "; } & { bucketSizeInSeconds: number; }; }; }) => Promise<{ charts: ", + "FetchAndTransformMetrics", + "[]; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/metrics/nodes\": { endpoint: \"GET /internal/apm/services/{serviceName}/metrics/nodes\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -7429,7 +7141,7 @@ "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, - ">]>; }>]>; }>, ", + ">]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7437,19 +7149,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { serviceNodes: ", - "ServiceNodesResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/metrics/charts\": ", + " & { params: { path: { serviceName: string; }; query: { kuery: string; } & { start: number; end: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; }; }; }) => Promise<{ serviceNodes: ", + "ServiceNodesResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/metrics/charts\": { endpoint: \"GET /internal/apm/services/{serviceName}/metrics/charts\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -7495,7 +7209,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7503,19 +7217,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { charts: ", - "FetchAndTransformMetrics", - "[]; }, ", - "APMRouteCreateOptions", - ">; \"POST /internal/apm/latency/overall_distribution/transactions\": ", + " & { params: { path: { serviceName: string; }; query: { agentName: string; } & { serviceNodeName?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<{ charts: ", + "FetchAndTransformMetrics", + "[]; }>; } & ", + "APMRouteCreateOptions", + "; \"POST /internal/apm/latency/overall_distribution/transactions\": { endpoint: \"POST /internal/apm/latency/overall_distribution/transactions\"; params?: ", "TypeC", "<{ body: ", "IntersectionC", @@ -7595,7 +7311,7 @@ "LiteralC", "<", "LatencyDistributionChartType", - ".dependencyLatency>]>; }>]>; }>, ", + ".dependencyLatency>]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7603,19 +7319,23 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "OverallLatencyDistributionResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/errors/{groupId}/top_erroneous_transactions\": ", + " & { params: { body: { serviceName?: string | undefined; transactionName?: string | undefined; transactionType?: string | undefined; termFilters?: { fieldName: string; fieldValue: string | number; }[] | undefined; durationMin?: number | undefined; durationMax?: number | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { percentileThreshold: number; chartType: ", + "LatencyDistributionChartType", + "; }; }; }) => Promise<", + "OverallLatencyDistributionResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/errors/{groupId}/top_erroneous_transactions\": { endpoint: \"GET /internal/apm/services/{serviceName}/errors/{groupId}/top_erroneous_transactions\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -7663,7 +7383,7 @@ "TypeC", "<{ numBuckets: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7671,19 +7391,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "TopErroneousTransactionsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/errors/distribution\": ", + " & { params: { path: { serviceName: string; groupId: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { offset?: string | undefined; } & { numBuckets: number; }; }; }) => Promise<", + "TopErroneousTransactionsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/errors/distribution\": { endpoint: \"GET /internal/apm/services/{serviceName}/errors/distribution\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -7729,7 +7451,7 @@ "PartialC", "<{ offset: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7737,19 +7459,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ErrorDistributionResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/errors/{groupId}/error/{errorId}\": ", + " & { params: { path: { serviceName: string; }; query: { groupId?: string | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { offset?: string | undefined; }; }; }) => Promise<", + "ErrorDistributionResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/errors/{groupId}/error/{errorId}\": { endpoint: \"GET /internal/apm/services/{serviceName}/errors/{groupId}/error/{errorId}\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -7791,7 +7515,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7799,19 +7523,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ErrorSampleDetailsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/errors/{groupId}/samples\": ", + " & { params: { path: { serviceName: string; groupId: string; errorId: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<", + "ErrorSampleDetailsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/errors/{groupId}/samples\": { endpoint: \"GET /internal/apm/services/{serviceName}/errors/{groupId}/samples\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -7851,7 +7577,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7859,19 +7585,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ErrorGroupSampleIdsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"POST /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\": ", + " & { params: { path: { serviceName: string; groupId: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<", + "ErrorGroupSampleIdsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"POST /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\": { endpoint: \"POST /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -7921,7 +7649,7 @@ "TypeC", "<{ groupIds: ", "Type", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7929,19 +7657,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ErrorGroupPeriodsResponse", - ", ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics_by_transaction_name\": ", + " & { params: { path: { serviceName: string; }; query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; } & { offset?: string | undefined; } & { numBuckets: number; }; body: { groupIds: string[]; }; }; }) => Promise<", + "ErrorGroupPeriodsResponse", + ">; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics_by_transaction_name\": { endpoint: \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics_by_transaction_name\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -7987,7 +7717,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -7995,19 +7725,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { errorGroups: ", - "ErrorGroupMainStatisticsResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\": ", + " & { params: { path: { serviceName: string; }; query: { transactionType: string; transactionName: string; maxNumberOfErrorGroups: number; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<{ errorGroups: ", + "ErrorGroupMainStatisticsResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\": { endpoint: \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -8055,7 +7787,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -8063,19 +7795,21 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { errorGroups: ", - "ErrorGroupMainStatisticsResponse", - "; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/environments\": ", + " & { params: { path: { serviceName: string; }; query: { sortField?: string | undefined; sortDirection?: \"asc\" | \"desc\" | undefined; } & { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "Branded", + "; } & { kuery: string; } & { start: number; end: number; }; }; }) => Promise<{ errorGroups: ", + "ErrorGroupMainStatisticsResponse", + "; }>; } & ", + "APMRouteCreateOptions", + "; \"GET /internal/apm/environments\": { endpoint: \"GET /internal/apm/environments\"; params?: ", "TypeC", "<{ query: ", "IntersectionC", @@ -8089,7 +7823,7 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -8097,7 +7831,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { environments: (\"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + " & { params: { query: { serviceName?: string | undefined; } & { start: number; end: number; }; }; }) => Promise<{ environments: (\"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", "Branded", ")[]; }, ", + ">)[]; }>; } & ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/data_view/title\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/apm/data_view/title\", undefined, ", + "; \"GET /internal/apm/data_view/title\": { endpoint: \"GET /internal/apm/data_view/title\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -8125,17 +7851,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { apmDataViewTitle: string; }, ", + ") => Promise<{ apmDataViewTitle: string; }>; } & ", "APMRouteCreateOptions", - ">; \"POST /internal/apm/data_view/static\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/apm/data_view/static\", undefined, ", + "; \"POST /internal/apm/data_view/static\": { endpoint: \"POST /internal/apm/data_view/static\"; params?: undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -8143,7 +7861,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { created: boolean; dataView: ", + ") => Promise<{ created: boolean; dataView: ", { "pluginId": "dataViews", "scope": "common", @@ -8151,9 +7869,9 @@ "section": "def-common.DataView", "text": "DataView" }, - "; } | { created: boolean; reason?: string | undefined; }, ", + "; } | { created: boolean; reason?: string | undefined; }>; } & ", "APMRouteCreateOptions", - ">; }" + "; }" ], "path": "x-pack/plugins/apm/server/routes/apm_routes/get_global_apm_server_route_repository.ts", "deprecated": false, diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index a5909d6a57f3c..0b65d8d132c5c 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm title: "apm" image: https://source.unsplash.com/400x175/?github description: API docs for the apm plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] --- import apmObj from './apm.devdocs.json'; diff --git a/api_docs/asset_manager.mdx b/api_docs/asset_manager.mdx index 99b4d2084892d..8a5038e08f429 100644 --- a/api_docs/asset_manager.mdx +++ b/api_docs/asset_manager.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/assetManager title: "assetManager" image: https://source.unsplash.com/400x175/?github description: API docs for the assetManager plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager'] --- import assetManagerObj from './asset_manager.devdocs.json'; diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index 3e3e25983bedd..0fd6f6c9b7d3c 100644 --- a/api_docs/banners.mdx +++ b/api_docs/banners.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners title: "banners" image: https://source.unsplash.com/400x175/?github description: API docs for the banners plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] --- import bannersObj from './banners.devdocs.json'; diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index 5c9d1ac60ae46..5f7d89e4d36e0 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch title: "bfetch" image: https://source.unsplash.com/400x175/?github description: API docs for the bfetch plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] --- import bfetchObj from './bfetch.devdocs.json'; diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx index 9e6c55d3b801e..2f92843923ef1 100644 --- a/api_docs/canvas.mdx +++ b/api_docs/canvas.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/canvas title: "canvas" image: https://source.unsplash.com/400x175/?github description: API docs for the canvas plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] --- import canvasObj from './canvas.devdocs.json'; diff --git a/api_docs/cases.devdocs.json b/api_docs/cases.devdocs.json index 4b3cd8fd8e35d..9e96296b9afb5 100644 --- a/api_docs/cases.devdocs.json +++ b/api_docs/cases.devdocs.json @@ -970,7 +970,7 @@ "section": "def-common.CasesFindResponseUI", "text": "CasesFindResponseUI" }, - ">; getCasesStatus: (query: { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ countOpenCases: number; countInProgressCases: number; countClosedCases: number; }>; getCasesMetrics: (query: { features: string[]; } & { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ mttr?: number | null | undefined; }>; bulkGet: (params: { ids: string[]; }, signal?: AbortSignal | undefined) => Promise<{ cases: { id: string; description: string; title: string; owner: string; version: string; totalComments: number; status: ", + ">; getCasesStatus: (query: { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ countOpenCases: number; countInProgressCases: number; countClosedCases: number; }>; getCasesMetrics: (query: { features: string[]; } & { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ mttr?: number | null | undefined; }>; bulkGet: (params: { ids: string[]; }, signal?: AbortSignal | undefined) => Promise<{ cases: ({ description: string; status: ", { "pluginId": "@kbn/cases-components", "scope": "common", @@ -978,7 +978,159 @@ "section": "def-common.CaseStatuses", "text": "CaseStatuses" }, - "; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; }[]; errors: { error: string; message: string; status: number | undefined; caseId: string; }[]; }>; }; }" + "; tags: string[]; title: string; connector: { id: string; } & (({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".casesWebhook; fields: null; } & { name: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } & { name: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none; fields: null; } & { name: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } & { name: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; } & { name: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; } & { name: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".swimlane; fields: { caseId: string | null; } | null; } & { name: string; })); settings: { syncAlerts: boolean; }; owner: string; severity: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseSeverity", + "text": "CaseSeverity" + }, + "; assignees: { uid: string; }[]; } & { duration: number | null; closed_at: string | null; closed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; external_service: ({ connector_id: string; } & { connector_name: string; external_id: string; external_title: string; external_url: string; pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: ((({ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | (({ externalReferenceId: string; externalReferenceStorage: { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ExternalReferenceStorageType", + "text": "ExternalReferenceStorageType" + }, + ".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonValue", + "text": "JsonValue" + }, + "; } | null; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".externalReference; owner: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ExternalReferenceStorageType", + "text": "ExternalReferenceStorageType" + }, + ".savedObject; soType: string; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonValue", + "text": "JsonValue" + }, + "; } | null; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".externalReference; owner: string; }) & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonValue", + "text": "JsonValue" + }, + "; }; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; })) & { id: string; version: string; })[] | undefined; })[]; errors: { error: string; message: string; status: number | undefined; caseId: string; }[]; }>; }; }" ], "path": "x-pack/plugins/cases/public/types.ts", "deprecated": false, @@ -2208,7 +2360,7 @@ "label": "CasesBulkGetResponse", "description": [], "signature": [ - "{ cases: { id: string; description: string; title: string; owner: string; version: string; totalComments: number; status: ", + "{ cases: ({ description: string; status: ", { "pluginId": "@kbn/cases-components", "scope": "common", @@ -2216,7 +2368,159 @@ "section": "def-common.CaseStatuses", "text": "CaseStatuses" }, - "; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; }[]; errors: { error: string; message: string; status: number | undefined; caseId: string; }[]; }" + "; tags: string[]; title: string; connector: { id: string; } & (({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".casesWebhook; fields: null; } & { name: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } & { name: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".none; fields: null; } & { name: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } & { name: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; } & { name: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; } & { name: string; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ConnectorTypes", + "text": "ConnectorTypes" + }, + ".swimlane; fields: { caseId: string | null; } | null; } & { name: string; })); settings: { syncAlerts: boolean; }; owner: string; severity: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseSeverity", + "text": "CaseSeverity" + }, + "; assignees: { uid: string; }[]; } & { duration: number | null; closed_at: string | null; closed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; external_service: ({ connector_id: string; } & { connector_name: string; external_id: string; external_title: string; external_url: string; pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: ((({ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | (({ externalReferenceId: string; externalReferenceStorage: { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ExternalReferenceStorageType", + "text": "ExternalReferenceStorageType" + }, + ".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonValue", + "text": "JsonValue" + }, + "; } | null; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".externalReference; owner: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ExternalReferenceStorageType", + "text": "ExternalReferenceStorageType" + }, + ".savedObject; soType: string; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonValue", + "text": "JsonValue" + }, + "; } | null; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".externalReference; owner: string; }) & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonValue", + "text": "JsonValue" + }, + "; }; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; })) & { id: string; version: string; })[] | undefined; })[]; errors: { error: string; message: string; status: number | undefined; caseId: string; }[]; }" ], "path": "x-pack/plugins/cases/common/api/cases/case.ts", "deprecated": false, diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index 6ab185d9c6d65..bebe08276fe07 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases title: "cases" image: https://source.unsplash.com/400x175/?github description: API docs for the cases plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] --- import casesObj from './cases.devdocs.json'; diff --git a/api_docs/charts.devdocs.json b/api_docs/charts.devdocs.json index 14d6098c42f3d..0b0e5610f488f 100644 --- a/api_docs/charts.devdocs.json +++ b/api_docs/charts.devdocs.json @@ -2289,7 +2289,15 @@ "Theme", ">; readonly darkModeEnabled$: ", "Observable", - "; useDarkMode: () => boolean; useChartsTheme: () => ", + "<", + { + "pluginId": "@kbn/core-theme-browser", + "scope": "common", + "docId": "kibKbnCoreThemeBrowserPluginApi", + "section": "def-common.CoreTheme", + "text": "CoreTheme" + }, + ">; useDarkMode: () => boolean; useChartsTheme: () => ", "RecursivePartial", "<", "Theme", diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index 331cc86f21645..033232640a1d2 100644 --- a/api_docs/charts.mdx +++ b/api_docs/charts.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts title: "charts" image: https://source.unsplash.com/400x175/?github description: API docs for the charts plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] --- import chartsObj from './charts.devdocs.json'; diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index af99c298ca3f5..cc6fd277e1c8c 100644 --- a/api_docs/cloud.mdx +++ b/api_docs/cloud.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud title: "cloud" image: https://source.unsplash.com/400x175/?github description: API docs for the cloud plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] --- import cloudObj from './cloud.devdocs.json'; diff --git a/api_docs/cloud_chat.mdx b/api_docs/cloud_chat.mdx index dad5bbc03fe25..9c8d4694fa926 100644 --- a/api_docs/cloud_chat.mdx +++ b/api_docs/cloud_chat.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChat title: "cloudChat" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudChat plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat'] --- import cloudChatObj from './cloud_chat.devdocs.json'; diff --git a/api_docs/cloud_data_migration.mdx b/api_docs/cloud_data_migration.mdx index ef232531b1c89..04125d1e33e4c 100644 --- a/api_docs/cloud_data_migration.mdx +++ b/api_docs/cloud_data_migration.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration title: "cloudDataMigration" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudDataMigration plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration'] --- import cloudDataMigrationObj from './cloud_data_migration.devdocs.json'; diff --git a/api_docs/cloud_defend.devdocs.json b/api_docs/cloud_defend.devdocs.json index 40015d4edbbb1..96fff9bfacc8f 100644 --- a/api_docs/cloud_defend.devdocs.json +++ b/api_docs/cloud_defend.devdocs.json @@ -13,7 +13,17 @@ "\nGets the cloud_defend link properties of a Cloud Defend page for navigation in the security solution." ], "signature": [ - "(cloudDefendPage: \"policies\") => CloudDefendLinkItem" + "(cloudDefendPage: ", + "CloudDefendPage", + ") => CloudDefendLinkItem" ], "path": "x-pack/plugins/cloud_defend/public/common/navigation/security_solution_links.ts", "deprecated": false, @@ -22,14 +32,14 @@ { "parentPluginId": "cloudDefend", "id": "def-public.getSecuritySolutionLink.$1", - "type": "string", + "type": "CompoundType", "tags": [], "label": "cloudDefendPage", "description": [ "the name of the cloud defend page." ], "signature": [ - "\"policies\"" + "CloudDefendPage" ], "path": "x-pack/plugins/cloud_defend/public/common/navigation/security_solution_links.ts", "deprecated": false, @@ -50,7 +60,17 @@ "\nGets the link properties of a Cloud Defend page for navigation in the old security solution navigation." ], "signature": [ - "(cloudDefendPage: \"policies\", basePath: string) => CloudDefendNavTab" + "(cloudDefendPage: ", + "CloudDefendPage", + ", basePath: string) => CloudDefendNavTab" ], "path": "x-pack/plugins/cloud_defend/public/common/navigation/security_solution_links.ts", "deprecated": false, @@ -59,14 +79,14 @@ { "parentPluginId": "cloudDefend", "id": "def-public.getSecuritySolutionNavTab.$1", - "type": "string", + "type": "CompoundType", "tags": [], "label": "cloudDefendPage", "description": [ "the name of the cloud defend page." ], "signature": [ - "\"policies\"" + "CloudDefendPage" ], "path": "x-pack/plugins/cloud_defend/public/common/navigation/security_solution_links.ts", "deprecated": false, @@ -135,7 +155,15 @@ "Gets the `SpyRoute` component for navigation highlighting and breadcrumbs." ], "signature": [ - "() => React.ComponentType<{ pageName: \"cloud_defend-policies\"; state?: Record | undefined; }>" + "() => React.ComponentType<{ pageName: ", + { + "pluginId": "cloudDefend", + "scope": "public", + "docId": "kibCloudDefendPluginApi", + "section": "def-public.CloudDefendPageId", + "text": "CloudDefendPageId" + }, + "; state?: Record | undefined; }>" ], "path": "x-pack/plugins/cloud_defend/public/types.ts", "deprecated": false, @@ -176,7 +204,7 @@ "\nAll the IDs for the cloud defend pages.\nThis needs to match the cloud defend page entries in `SecurityPageName` in `x-pack/plugins/security_solution/common/constants.ts`." ], "signature": [ - "\"cloud_defend-policies\"" + "\"cloud_defend-policies\" | \"kubernetes_security-dashboard\"" ], "path": "x-pack/plugins/cloud_defend/public/common/navigation/types.ts", "deprecated": false, diff --git a/api_docs/cloud_defend.mdx b/api_docs/cloud_defend.mdx index 89a9a8e29cc4d..5c3f6a9f1daaf 100644 --- a/api_docs/cloud_defend.mdx +++ b/api_docs/cloud_defend.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend title: "cloudDefend" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudDefend plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend'] --- import cloudDefendObj from './cloud_defend.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/ | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 15 | 0 | 4 | 1 | +| 15 | 0 | 4 | 2 | ## Client diff --git a/api_docs/cloud_experiments.mdx b/api_docs/cloud_experiments.mdx index 194287b5e0546..32ea9e5d954bc 100644 --- a/api_docs/cloud_experiments.mdx +++ b/api_docs/cloud_experiments.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudExperiments title: "cloudExperiments" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudExperiments plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments'] --- import cloudExperimentsObj from './cloud_experiments.devdocs.json'; diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx index 2d514d2d25d9a..177dac55e3623 100644 --- a/api_docs/cloud_security_posture.mdx +++ b/api_docs/cloud_security_posture.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture title: "cloudSecurityPosture" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudSecurityPosture plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] --- import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json'; diff --git a/api_docs/console.mdx b/api_docs/console.mdx index 23e7f6e9bcce6..76f2acb68dd46 100644 --- a/api_docs/console.mdx +++ b/api_docs/console.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/console title: "console" image: https://source.unsplash.com/400x175/?github description: API docs for the console plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] --- import consoleObj from './console.devdocs.json'; diff --git a/api_docs/content_management.mdx b/api_docs/content_management.mdx index c172799287721..a46ec51876994 100644 --- a/api_docs/content_management.mdx +++ b/api_docs/content_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement title: "contentManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the contentManagement plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement'] --- import contentManagementObj from './content_management.devdocs.json'; diff --git a/api_docs/controls.devdocs.json b/api_docs/controls.devdocs.json index ce95034b22ea9..b83dd602dbb28 100644 --- a/api_docs/controls.devdocs.json +++ b/api_docs/controls.devdocs.json @@ -265,6 +265,21 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "controls", + "id": "def-public.ControlGroupContainer.fieldFilterPredicate", + "type": "Function", + "tags": [], + "label": "fieldFilterPredicate", + "description": [], + "signature": [ + "FieldFilterPredicate", + " | undefined" + ], + "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.Unnamed", @@ -374,6 +389,22 @@ "deprecated": false, "trackAdoption": false, "isRequired": false + }, + { + "parentPluginId": "controls", + "id": "def-public.ControlGroupContainer.Unnamed.$5", + "type": "Function", + "tags": [], + "label": "fieldFilterPredicate", + "description": [], + "signature": [ + "FieldFilterPredicate", + " | undefined" + ], + "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": false } ], "returnComment": [] @@ -1546,6 +1577,8 @@ }, "> | undefined, settings?: ", "ControlGroupSettings", + " | undefined, fieldFilterPredicate?: ", + "FieldFilterPredicate", " | undefined) => Promise<", { "pluginId": "controls", @@ -1634,6 +1667,22 @@ "deprecated": false, "trackAdoption": false, "isRequired": false + }, + { + "parentPluginId": "controls", + "id": "def-public.ControlGroupContainerFactory.create.$4", + "type": "Function", + "tags": [], + "label": "fieldFilterPredicate", + "description": [], + "signature": [ + "FieldFilterPredicate", + " | undefined" + ], + "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false } ], "returnComment": [] diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index 226e2dd4461b4..1762fed6b6707 100644 --- a/api_docs/controls.mdx +++ b/api_docs/controls.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/controls title: "controls" image: https://source.unsplash.com/400x175/?github description: API docs for the controls plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] --- import controlsObj from './controls.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 301 | 0 | 294 | 13 | +| 304 | 0 | 297 | 14 | ## Client diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index 89a28d111b5f2..6877ba7ffcfa5 100644 --- a/api_docs/custom_integrations.mdx +++ b/api_docs/custom_integrations.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations title: "customIntegrations" image: https://source.unsplash.com/400x175/?github description: API docs for the customIntegrations plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] --- import customIntegrationsObj from './custom_integrations.devdocs.json'; diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index 271abca9e8fe4..e835a914147cf 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard title: "dashboard" image: https://source.unsplash.com/400x175/?github description: API docs for the dashboard plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] --- import dashboardObj from './dashboard.devdocs.json'; diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index 8b65fef99dc4d..238dc26429553 100644 --- a/api_docs/dashboard_enhanced.mdx +++ b/api_docs/dashboard_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced title: "dashboardEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the dashboardEnhanced plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] --- import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json'; diff --git a/api_docs/data.devdocs.json b/api_docs/data.devdocs.json index 403043a354a1e..f1c8f1a1cd160 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -11129,50 +11129,6 @@ "plugin": "synthetics", "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/index.ts" }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, { "plugin": "@kbn/core-saved-objects-browser-internal", "path": "packages/core/saved-objects/core-saved-objects-browser-internal/src/simple_saved_object.test.ts" @@ -28922,50 +28878,6 @@ "plugin": "synthetics", "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/index.ts" }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, { "plugin": "@kbn/core-saved-objects-browser-internal", "path": "packages/core/saved-objects/core-saved-objects-browser-internal/src/simple_saved_object.test.ts" diff --git a/api_docs/data.mdx b/api_docs/data.mdx index 141ba0bc6dbb1..7348ca51cb741 100644 --- a/api_docs/data.mdx +++ b/api_docs/data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data title: "data" image: https://source.unsplash.com/400x175/?github description: API docs for the data plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] --- import dataObj from './data.devdocs.json'; diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index 37f9d5eee951f..221bea7407f52 100644 --- a/api_docs/data_query.mdx +++ b/api_docs/data_query.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query title: "data.query" image: https://source.unsplash.com/400x175/?github description: API docs for the data.query plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] --- import dataQueryObj from './data_query.devdocs.json'; diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index bac8a21160e49..1bddd5762447c 100644 --- a/api_docs/data_search.mdx +++ b/api_docs/data_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search title: "data.search" image: https://source.unsplash.com/400x175/?github description: API docs for the data.search plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] --- import dataSearchObj from './data_search.devdocs.json'; diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index b368f27e0d8f9..bae047869ed47 100644 --- a/api_docs/data_view_editor.mdx +++ b/api_docs/data_view_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewEditor title: "dataViewEditor" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViewEditor plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] --- import dataViewEditorObj from './data_view_editor.devdocs.json'; diff --git a/api_docs/data_view_field_editor.mdx b/api_docs/data_view_field_editor.mdx index aa4f27b39c37d..47bb4b07252a8 100644 --- a/api_docs/data_view_field_editor.mdx +++ b/api_docs/data_view_field_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor title: "dataViewFieldEditor" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViewFieldEditor plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] --- import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json'; diff --git a/api_docs/data_view_management.mdx b/api_docs/data_view_management.mdx index ce7fc818fa1cc..813e17088e39a 100644 --- a/api_docs/data_view_management.mdx +++ b/api_docs/data_view_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewManagement title: "dataViewManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViewManagement plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] --- import dataViewManagementObj from './data_view_management.devdocs.json'; diff --git a/api_docs/data_views.devdocs.json b/api_docs/data_views.devdocs.json index c8b870b857b70..9781dd972ecdd 100644 --- a/api_docs/data_views.devdocs.json +++ b/api_docs/data_views.devdocs.json @@ -26468,50 +26468,6 @@ "plugin": "synthetics", "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/index.ts" }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, { "plugin": "@kbn/core-saved-objects-browser-internal", "path": "packages/core/saved-objects/core-saved-objects-browser-internal/src/simple_saved_object.test.ts" diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index 5e990aa45a4e1..b8085139b2a9f 100644 --- a/api_docs/data_views.mdx +++ b/api_docs/data_views.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews title: "dataViews" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViews plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] --- import dataViewsObj from './data_views.devdocs.json'; diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index 9313f652ffe0f..6ce811f32695f 100644 --- a/api_docs/data_visualizer.mdx +++ b/api_docs/data_visualizer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataVisualizer title: "dataVisualizer" image: https://source.unsplash.com/400x175/?github description: API docs for the dataVisualizer plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] --- import dataVisualizerObj from './data_visualizer.devdocs.json'; diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index 80b2f660e514d..9afccf6ab00ea 100644 --- a/api_docs/deprecations_by_api.mdx +++ b/api_docs/deprecations_by_api.mdx @@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api title: Deprecated API usage by API description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -43,8 +43,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | data, discover, imageEmbeddable, embeddable | - | | | @kbn/core-saved-objects-browser-mocks, dataViews, savedSearch, dashboard, graph, discover, @kbn/core-saved-objects-browser-internal | - | | | advancedSettings, discover | - | -| | @kbn/core-saved-objects-common, @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, home, dataViews, savedObjectsTagging, fleet, canvas, osquery, synthetics, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-import-export-server-internal, savedObjectsTaggingOss, lists, securitySolution, upgradeAssistant, savedObjectsManagement, cases, @kbn/core-ui-settings-server-internal, dashboard | - | -| | @kbn/core-saved-objects-common, @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, home, dataViews, savedObjectsTagging, fleet, canvas, osquery, synthetics, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-import-export-server-internal, savedObjectsTaggingOss, lists, securitySolution, upgradeAssistant, savedObjectsManagement, cases, @kbn/core-ui-settings-server-internal, data | - | +| | @kbn/core-saved-objects-common, @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, home, dataViews, savedObjectsTagging, fleet, canvas, osquery, synthetics, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-import-export-server-internal, savedObjectsTaggingOss, lists, securitySolution, upgradeAssistant, savedObjectsManagement, @kbn/core-ui-settings-server-internal, dashboard | - | +| | @kbn/core-saved-objects-common, @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, home, dataViews, savedObjectsTagging, fleet, canvas, osquery, synthetics, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-import-export-server-internal, savedObjectsTaggingOss, lists, securitySolution, upgradeAssistant, savedObjectsManagement, @kbn/core-ui-settings-server-internal, data | - | | | securitySolution | - | | | securitySolution | - | | | @kbn/securitysolution-data-table, securitySolution | - | @@ -68,7 +68,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, savedSearch, dashboard, graph | - | | | @kbn/core-saved-objects-browser-mocks, home, @kbn/core-saved-objects-browser-internal | - | | | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, visualizations, dashboard, graph | - | -| | @kbn/core-saved-objects-browser-mocks, synthetics, @kbn/core-saved-objects-browser-internal | - | +| | @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-browser-internal | - | | | @kbn/core-saved-objects-browser-mocks, dashboard, savedObjects, @kbn/core-saved-objects-browser-internal | - | | | @kbn/core-saved-objects-browser-mocks, fleet, synthetics, @kbn/core-saved-objects-browser-internal | - | | | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, dataViews, savedSearch, savedObjects | - | @@ -140,9 +140,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | apm, security, securitySolution | 8.8.0 | | | @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks, management, fleet, security, kibanaOverview, @kbn/core | 8.8.0 | | | @kbn/core-plugins-server-internal, @kbn/core | 8.8.0 | -| | security, guidedOnboarding, fleet | 8.8.0 | -| | security, guidedOnboarding, fleet | 8.8.0 | -| | security, guidedOnboarding, fleet | 8.8.0 | | | apm | 8.8.0 | | | security | 8.8.0 | | | mapsEms | 8.8.0 | diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index ea13a53c2cf69..381d5689744b9 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin title: Deprecated API usage by plugin description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -242,7 +242,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [internal_transforms.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts#:~:text=convertToMultiNamespaceTypeVersion), [internal_transforms.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts#:~:text=convertToMultiNamespaceTypeVersion), [internal_transforms.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts#:~:text=convertToMultiNamespaceTypeVersion), [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=convertToMultiNamespaceTypeVersion), [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=convertToMultiNamespaceTypeVersion), [utils.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/utils.ts#:~:text=convertToMultiNamespaceTypeVersion), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts#:~:text=convertToMultiNamespaceTypeVersion), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts#:~:text=convertToMultiNamespaceTypeVersion), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts#:~:text=convertToMultiNamespaceTypeVersion), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts#:~:text=convertToMultiNamespaceTypeVersion)+ 18 more | - | +| | [utils.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/utils.ts#:~:text=convertToMultiNamespaceTypeVersion), [internal_transforms.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts#:~:text=convertToMultiNamespaceTypeVersion), [internal_transforms.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts#:~:text=convertToMultiNamespaceTypeVersion), [internal_transforms.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts#:~:text=convertToMultiNamespaceTypeVersion), [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=convertToMultiNamespaceTypeVersion), [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=convertToMultiNamespaceTypeVersion), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts#:~:text=convertToMultiNamespaceTypeVersion), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts#:~:text=convertToMultiNamespaceTypeVersion), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts#:~:text=convertToMultiNamespaceTypeVersion), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts#:~:text=convertToMultiNamespaceTypeVersion)+ 17 more | - | @@ -418,10 +418,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject)+ 1 more | - | -| | [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObject)+ 23 more | - | | | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/common/ui/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/common/ui/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/common/ui/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/common/ui/types.ts#:~:text=ResolvedSimpleSavedObject) | - | -| | [so_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/attachment_framework/so_references.ts#:~:text=SavedObjectReference), [so_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/attachment_framework/so_references.ts#:~:text=SavedObjectReference), [so_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/attachment_framework/so_references.ts#:~:text=SavedObjectReference), [so_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/attachment_framework/so_references.ts#:~:text=SavedObjectReference), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObjectReference), [test_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_actions/test_utils.ts#:~:text=SavedObjectReference) | - | +| | [so_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/attachment_framework/so_references.ts#:~:text=SavedObjectReference), [so_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/attachment_framework/so_references.ts#:~:text=SavedObjectReference), [so_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/attachment_framework/so_references.ts#:~:text=SavedObjectReference), [so_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/attachment_framework/so_references.ts#:~:text=SavedObjectReference) | - | | | [cases.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/saved_object_types/cases.ts#:~:text=convertToMultiNamespaceTypeVersion), [configure.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/saved_object_types/configure.ts#:~:text=convertToMultiNamespaceTypeVersion), [comments.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/saved_object_types/comments.ts#:~:text=convertToMultiNamespaceTypeVersion), [user_actions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/saved_object_types/user_actions.ts#:~:text=convertToMultiNamespaceTypeVersion), [connector_mappings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/saved_object_types/connector_mappings.ts#:~:text=convertToMultiNamespaceTypeVersion) | - | @@ -709,9 +707,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [query_bar.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#:~:text=title), [query_bar.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#:~:text=title) | - | | | [query_bar.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#:~:text=title) | - | | | [use_get_logs_discover_link.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/multi_page_layout/hooks/use_get_logs_discover_link.tsx#:~:text=indexPatternId) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | -| | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | -| | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | | [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/app.tsx#:~:text=RedirectAppLinks)+ 5 more | - | | | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 | | | [assets.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/sections/epm/screens/detail/assets/assets.tsx#:~:text=savedObjects) | - | @@ -720,7 +715,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [assets.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/sections/epm/screens/detail/assets/assets.tsx#:~:text=ResolvedSimpleSavedObject), [assets.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/sections/epm/screens/detail/assets/assets.tsx#:~:text=ResolvedSimpleSavedObject) | - | | | [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion) | - | | | [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion) | - | -| | [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes) | - | +| | [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes) | - | | | [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectReference), [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectReference), [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectReference), [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectReference) | - | @@ -761,16 +756,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] -## guidedOnboarding - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [feature.ts](https://github.com/elastic/kibana/tree/main/src/plugins/guided_onboarding/server/feature.ts#:~:text=disabled) | 8.8.0 | -| | [feature.ts](https://github.com/elastic/kibana/tree/main/src/plugins/guided_onboarding/server/feature.ts#:~:text=disabled) | 8.8.0 | -| | [feature.ts](https://github.com/elastic/kibana/tree/main/src/plugins/guided_onboarding/server/feature.ts#:~:text=disabled) | 8.8.0 | - - - ## home | Deprecated API | Reference location(s) | Remove By | @@ -1131,13 +1116,10 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | | | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0 This is relied on by the reporting feature, and should be removed once reporting migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 | -| | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | -| | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | | | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0 This is relied on by the reporting feature, and should be removed once reporting @@ -1241,9 +1223,8 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | | [filter_group.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/filter_group/filter_group.tsx#:~:text=title), [filters_expression_select.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/filters_expression_select.tsx#:~:text=title) | - | | | [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) | - | | | [alert_messages.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [alert_messages.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [alert_messages.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_app.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_app.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_app.tsx#:~:text=RedirectAppLinks), [synthetics_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=RedirectAppLinks), [synthetics_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=RedirectAppLinks), [synthetics_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=RedirectAppLinks) | - | -| | [use_filters.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/common/monitor_filters/use_filters.ts#:~:text=savedObjects), [use_recently_viewed_monitors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_selector/use_recently_viewed_monitors.ts#:~:text=savedObjects), [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=savedObjects), [use_location_monitors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/settings/private_locations/hooks/use_location_monitors.ts#:~:text=savedObjects), [use_monitor_name.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/hooks/use_monitor_name.ts#:~:text=savedObjects), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/plugin.ts#:~:text=savedObjects) | - | -| | [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=bulkDelete) | - | -| | [use_filters.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/common/monitor_filters/use_filters.ts#:~:text=find), [use_location_monitors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/settings/private_locations/hooks/use_location_monitors.ts#:~:text=find), [use_monitor_name.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/hooks/use_monitor_name.ts#:~:text=find), [use_filters.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/common/monitor_filters/use_filters.test.ts#:~:text=find), [use_filters.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/common/monitor_filters/use_filters.test.ts#:~:text=find) | - | +| | [use_recently_viewed_monitors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_selector/use_recently_viewed_monitors.ts#:~:text=savedObjects), [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=savedObjects), [use_location_monitors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/settings/private_locations/hooks/use_location_monitors.ts#:~:text=savedObjects), [use_monitor_name.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/hooks/use_monitor_name.ts#:~:text=savedObjects), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/plugin.ts#:~:text=savedObjects) | - | +| | [use_location_monitors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/settings/private_locations/hooks/use_location_monitors.ts#:~:text=find), [use_monitor_name.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/hooks/use_monitor_name.ts#:~:text=find) | - | | | [use_recently_viewed_monitors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_selector/use_recently_viewed_monitors.ts#:~:text=bulkResolve) | - | | | [synthetics_monitor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/common/types/synthetics_monitor.ts#:~:text=SimpleSavedObject), [synthetics_monitor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/common/types/synthetics_monitor.ts#:~:text=SimpleSavedObject) | - | @@ -1440,7 +1421,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/types.ts#:~:text=ResolvedSimpleSavedObject) | - | | | [services.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/services.ts#:~:text=SavedObjectsStart), [services.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/services.ts#:~:text=SavedObjectsStart) | - | | | [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttribute), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttribute) | - | -| | [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [visualize_embeddable_factory.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx#:~:text=SavedObjectAttributes), [visualize_embeddable_factory.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx#:~:text=SavedObjectAttributes), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=SavedObjectAttributes), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=SavedObjectAttributes) | - | +| | [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=SavedObjectAttributes), [visualize_embeddable.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx#:~:text=SavedObjectAttributes), [visualize_embeddable_factory.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx#:~:text=SavedObjectAttributes), [visualize_embeddable_factory.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx#:~:text=SavedObjectAttributes) | - | | | [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectReference), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectReference), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectReference), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectReference), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectReference), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectReference), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectReference), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectReference), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectReference), [visualize_embeddable_factory.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx#:~:text=SavedObjectReference)+ 10 more | - | | | [visualization.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/server/saved_objects/visualization.ts#:~:text=convertToMultiNamespaceTypeVersion) | - | diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index fb788f1c9ee01..a3b6c7e50ec46 100644 --- a/api_docs/deprecations_by_team.mdx +++ b/api_docs/deprecations_by_team.mdx @@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam slug: /kibana-dev-docs/api-meta/deprecations-due-by-team title: Deprecated APIs due to be removed, by team description: Lists the teams that are referencing deprecated APIs with a remove by date. -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -36,9 +36,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| fleet | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | -| fleet | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | -| fleet | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | fleet | | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 | @@ -82,13 +79,10 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| security | | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | | security | | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0 This is relied on by the reporting feature, and should be removed once reporting migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 | -| security | | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | -| security | | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | | security | | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0 This is relied on by the reporting feature, and should be removed once reporting @@ -139,16 +133,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ -## @elastic/platform-onboarding - -| Plugin | Deprecated API | Reference location(s) | Remove By | -| --------|-------|-----------|-----------| -| guidedOnboarding | | [feature.ts](https://github.com/elastic/kibana/tree/main/src/plugins/guided_onboarding/server/feature.ts#:~:text=disabled) | 8.8.0 | -| guidedOnboarding | | [feature.ts](https://github.com/elastic/kibana/tree/main/src/plugins/guided_onboarding/server/feature.ts#:~:text=disabled) | 8.8.0 | -| guidedOnboarding | | [feature.ts](https://github.com/elastic/kibana/tree/main/src/plugins/guided_onboarding/server/feature.ts#:~:text=disabled) | 8.8.0 | - - - ## @elastic/profiling-ui | Plugin | Deprecated API | Reference location(s) | Remove By | diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index 59fe3c0352da9..1e15089a31a2b 100644 --- a/api_docs/dev_tools.mdx +++ b/api_docs/dev_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools title: "devTools" image: https://source.unsplash.com/400x175/?github description: API docs for the devTools plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] --- import devToolsObj from './dev_tools.devdocs.json'; diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index 50f6071fafa62..de6aac57bc858 100644 --- a/api_docs/discover.mdx +++ b/api_docs/discover.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover title: "discover" image: https://source.unsplash.com/400x175/?github description: API docs for the discover plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] --- import discoverObj from './discover.devdocs.json'; diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx index 08eef128e9869..c4f82259cefd1 100644 --- a/api_docs/discover_enhanced.mdx +++ b/api_docs/discover_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced title: "discoverEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the discoverEnhanced plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] --- import discoverEnhancedObj from './discover_enhanced.devdocs.json'; diff --git a/api_docs/ecs_data_quality_dashboard.mdx b/api_docs/ecs_data_quality_dashboard.mdx index a5456239f31e1..c07def6400ea1 100644 --- a/api_docs/ecs_data_quality_dashboard.mdx +++ b/api_docs/ecs_data_quality_dashboard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ecsDataQualityDashboard title: "ecsDataQualityDashboard" image: https://source.unsplash.com/400x175/?github description: API docs for the ecsDataQualityDashboard plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard'] --- import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json'; diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index 38aa0411076de..08577459228d5 100644 --- a/api_docs/embeddable.mdx +++ b/api_docs/embeddable.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable title: "embeddable" image: https://source.unsplash.com/400x175/?github description: API docs for the embeddable plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] --- import embeddableObj from './embeddable.devdocs.json'; diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index eb67890c03ff8..f835d9ab08eb5 100644 --- a/api_docs/embeddable_enhanced.mdx +++ b/api_docs/embeddable_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced title: "embeddableEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the embeddableEnhanced plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] --- import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json'; diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx index 48dd9c0eb14b9..1f95bd2e790ad 100644 --- a/api_docs/encrypted_saved_objects.mdx +++ b/api_docs/encrypted_saved_objects.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects title: "encryptedSavedObjects" image: https://source.unsplash.com/400x175/?github description: API docs for the encryptedSavedObjects plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] --- import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json'; diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index 945227844fa26..ad8e78953f0be 100644 --- a/api_docs/enterprise_search.mdx +++ b/api_docs/enterprise_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch title: "enterpriseSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the enterpriseSearch plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] --- import enterpriseSearchObj from './enterprise_search.devdocs.json'; diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index 902c9937b3545..3b9f69aff427d 100644 --- a/api_docs/es_ui_shared.mdx +++ b/api_docs/es_ui_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esUiShared title: "esUiShared" image: https://source.unsplash.com/400x175/?github description: API docs for the esUiShared plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] --- import esUiSharedObj from './es_ui_shared.devdocs.json'; diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index 3301c1b7acabd..c4f67e7c32faa 100644 --- a/api_docs/event_annotation.mdx +++ b/api_docs/event_annotation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation title: "eventAnnotation" image: https://source.unsplash.com/400x175/?github description: API docs for the eventAnnotation plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] --- import eventAnnotationObj from './event_annotation.devdocs.json'; diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index 239bbe81b1925..8ceb0ff95c220 100644 --- a/api_docs/event_log.mdx +++ b/api_docs/event_log.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog title: "eventLog" image: https://source.unsplash.com/400x175/?github description: API docs for the eventLog plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] --- import eventLogObj from './event_log.devdocs.json'; diff --git a/api_docs/exploratory_view.mdx b/api_docs/exploratory_view.mdx index fe0100ce0cb0a..31cf0aac7819f 100644 --- a/api_docs/exploratory_view.mdx +++ b/api_docs/exploratory_view.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/exploratoryView title: "exploratoryView" image: https://source.unsplash.com/400x175/?github description: API docs for the exploratoryView plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView'] --- import exploratoryViewObj from './exploratory_view.devdocs.json'; diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx index 2bac894068316..97dde760d9a4b 100644 --- a/api_docs/expression_error.mdx +++ b/api_docs/expression_error.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError title: "expressionError" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionError plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] --- import expressionErrorObj from './expression_error.devdocs.json'; diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx index 0b35d881247b2..8a9146f50ee21 100644 --- a/api_docs/expression_gauge.mdx +++ b/api_docs/expression_gauge.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionGauge title: "expressionGauge" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionGauge plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] --- import expressionGaugeObj from './expression_gauge.devdocs.json'; diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index 750e341a28a1a..f1365f6457d57 100644 --- a/api_docs/expression_heatmap.mdx +++ b/api_docs/expression_heatmap.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap title: "expressionHeatmap" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionHeatmap plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap'] --- import expressionHeatmapObj from './expression_heatmap.devdocs.json'; diff --git a/api_docs/expression_image.mdx b/api_docs/expression_image.mdx index a5f38c6280f53..8a44e9cdaf7af 100644 --- a/api_docs/expression_image.mdx +++ b/api_docs/expression_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionImage title: "expressionImage" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionImage plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage'] --- import expressionImageObj from './expression_image.devdocs.json'; diff --git a/api_docs/expression_legacy_metric_vis.mdx b/api_docs/expression_legacy_metric_vis.mdx index 302d7547a2e7f..277892a9c3898 100644 --- a/api_docs/expression_legacy_metric_vis.mdx +++ b/api_docs/expression_legacy_metric_vis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis title: "expressionLegacyMetricVis" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionLegacyMetricVis plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis'] --- import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json'; diff --git a/api_docs/expression_metric.mdx b/api_docs/expression_metric.mdx index 0a85949288237..b48105982bada 100644 --- a/api_docs/expression_metric.mdx +++ b/api_docs/expression_metric.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetric title: "expressionMetric" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionMetric plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] --- import expressionMetricObj from './expression_metric.devdocs.json'; diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx index 35b6b5e010ccb..45759ef5dfe37 100644 --- a/api_docs/expression_metric_vis.mdx +++ b/api_docs/expression_metric_vis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis title: "expressionMetricVis" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionMetricVis plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis'] --- import expressionMetricVisObj from './expression_metric_vis.devdocs.json'; diff --git a/api_docs/expression_partition_vis.mdx b/api_docs/expression_partition_vis.mdx index b77a590cee417..3ee7d8b29ba1d 100644 --- a/api_docs/expression_partition_vis.mdx +++ b/api_docs/expression_partition_vis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis title: "expressionPartitionVis" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionPartitionVis plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis'] --- import expressionPartitionVisObj from './expression_partition_vis.devdocs.json'; diff --git a/api_docs/expression_repeat_image.mdx b/api_docs/expression_repeat_image.mdx index 126b2a140ba31..31ed6aa44f967 100644 --- a/api_docs/expression_repeat_image.mdx +++ b/api_docs/expression_repeat_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage title: "expressionRepeatImage" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionRepeatImage plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage'] --- import expressionRepeatImageObj from './expression_repeat_image.devdocs.json'; diff --git a/api_docs/expression_reveal_image.mdx b/api_docs/expression_reveal_image.mdx index 4cf1c222541e8..129d1bdd5d58b 100644 --- a/api_docs/expression_reveal_image.mdx +++ b/api_docs/expression_reveal_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage title: "expressionRevealImage" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionRevealImage plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] --- import expressionRevealImageObj from './expression_reveal_image.devdocs.json'; diff --git a/api_docs/expression_shape.mdx b/api_docs/expression_shape.mdx index 4a83ac9af1608..5da13cf96acb6 100644 --- a/api_docs/expression_shape.mdx +++ b/api_docs/expression_shape.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionShape title: "expressionShape" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionShape plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape'] --- import expressionShapeObj from './expression_shape.devdocs.json'; diff --git a/api_docs/expression_tagcloud.mdx b/api_docs/expression_tagcloud.mdx index b77688b076281..0d9f80afb6f67 100644 --- a/api_docs/expression_tagcloud.mdx +++ b/api_docs/expression_tagcloud.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud title: "expressionTagcloud" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionTagcloud plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] --- import expressionTagcloudObj from './expression_tagcloud.devdocs.json'; diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx index 9e258813ced7a..fc2b3f4457bf1 100644 --- a/api_docs/expression_x_y.mdx +++ b/api_docs/expression_x_y.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionXY title: "expressionXY" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionXY plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] --- import expressionXYObj from './expression_x_y.devdocs.json'; diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index 7f9c0bc08627b..0d127666a5ee0 100644 --- a/api_docs/expressions.mdx +++ b/api_docs/expressions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions title: "expressions" image: https://source.unsplash.com/400x175/?github description: API docs for the expressions plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] --- import expressionsObj from './expressions.devdocs.json'; diff --git a/api_docs/features.devdocs.json b/api_docs/features.devdocs.json index 3e037f0975a4a..0a87280ddae61 100644 --- a/api_docs/features.devdocs.json +++ b/api_docs/features.devdocs.json @@ -339,9 +339,7 @@ "parentPluginId": "features", "id": "def-public.FeatureKibanaPrivileges.disabled", "type": "CompoundType", - "tags": [ - "deprecated" - ], + "tags": [], "label": "disabled", "description": [ "\nWhether or not this privilege should be hidden in the roles UI and disallowed on the API. Defaults to `false`." @@ -350,55 +348,8 @@ "boolean | undefined" ], "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", - "deprecated": true, - "removeBy": "8.8.0", - "trackAdoption": false, - "references": [ - { - "plugin": "security", - "path": "x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/lib/role_utils.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/lib/role_utils.ts" - }, - { - "plugin": "guidedOnboarding", - "path": "src/plugins/guided_onboarding/server/feature.ts" - }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/server/plugin.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/put.test.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts" - } - ] + "deprecated": false, + "trackAdoption": false }, { "parentPluginId": "features", @@ -1775,9 +1726,7 @@ "parentPluginId": "features", "id": "def-server.FeatureKibanaPrivileges.disabled", "type": "CompoundType", - "tags": [ - "deprecated" - ], + "tags": [], "label": "disabled", "description": [ "\nWhether or not this privilege should be hidden in the roles UI and disallowed on the API. Defaults to `false`." @@ -1786,55 +1735,8 @@ "boolean | undefined" ], "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", - "deprecated": true, - "removeBy": "8.8.0", - "trackAdoption": false, - "references": [ - { - "plugin": "security", - "path": "x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/lib/role_utils.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/lib/role_utils.ts" - }, - { - "plugin": "guidedOnboarding", - "path": "src/plugins/guided_onboarding/server/feature.ts" - }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/server/plugin.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/put.test.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts" - } - ] + "deprecated": false, + "trackAdoption": false }, { "parentPluginId": "features", @@ -3654,9 +3556,7 @@ "parentPluginId": "features", "id": "def-common.FeatureKibanaPrivileges.disabled", "type": "CompoundType", - "tags": [ - "deprecated" - ], + "tags": [], "label": "disabled", "description": [ "\nWhether or not this privilege should be hidden in the roles UI and disallowed on the API. Defaults to `false`." @@ -3665,55 +3565,8 @@ "boolean | undefined" ], "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", - "deprecated": true, - "removeBy": "8.8.0", - "trackAdoption": false, - "references": [ - { - "plugin": "security", - "path": "x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/lib/role_utils.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/lib/role_utils.ts" - }, - { - "plugin": "guidedOnboarding", - "path": "src/plugins/guided_onboarding/server/feature.ts" - }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/server/plugin.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/put.test.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts" - }, - { - "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts" - } - ] + "deprecated": false, + "trackAdoption": false }, { "parentPluginId": "features", diff --git a/api_docs/features.mdx b/api_docs/features.mdx index 4285e5f9ec2dc..22b08336de94f 100644 --- a/api_docs/features.mdx +++ b/api_docs/features.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/features title: "features" image: https://source.unsplash.com/400x175/?github description: API docs for the features plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] --- import featuresObj from './features.devdocs.json'; diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index 70789e96bc143..25dbba2badfe6 100644 --- a/api_docs/field_formats.mdx +++ b/api_docs/field_formats.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats title: "fieldFormats" image: https://source.unsplash.com/400x175/?github description: API docs for the fieldFormats plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] --- import fieldFormatsObj from './field_formats.devdocs.json'; diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index 9926acca2f2b9..dc30b32928912 100644 --- a/api_docs/file_upload.mdx +++ b/api_docs/file_upload.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload title: "fileUpload" image: https://source.unsplash.com/400x175/?github description: API docs for the fileUpload plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] --- import fileUploadObj from './file_upload.devdocs.json'; diff --git a/api_docs/files.mdx b/api_docs/files.mdx index 657d4c6dae2e9..5003d91eabd88 100644 --- a/api_docs/files.mdx +++ b/api_docs/files.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/files title: "files" image: https://source.unsplash.com/400x175/?github description: API docs for the files plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files'] --- import filesObj from './files.devdocs.json'; diff --git a/api_docs/files_management.mdx b/api_docs/files_management.mdx index f1b2808583d98..4b3f1b5c76d39 100644 --- a/api_docs/files_management.mdx +++ b/api_docs/files_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement title: "filesManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the filesManagement plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement'] --- import filesManagementObj from './files_management.devdocs.json'; diff --git a/api_docs/fleet.devdocs.json b/api_docs/fleet.devdocs.json index 246ed1e87b28b..af70561932745 100644 --- a/api_docs/fleet.devdocs.json +++ b/api_docs/fleet.devdocs.json @@ -5539,6 +5539,468 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFile", + "type": "Interface", + "tags": [], + "label": "FleetFile", + "description": [], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.FleetFile.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFile.actionId", + "type": "string", + "tags": [], + "label": "actionId", + "description": [], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFile.agents", + "type": "Array", + "tags": [], + "label": "agents", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFile.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFile.status", + "type": "CompoundType", + "tags": [], + "label": "status", + "description": [], + "signature": [ + "\"AWAITING_UPLOAD\" | \"UPLOADING\" | \"READY\" | \"UPLOAD_ERROR\" | \"DELETED\"" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFile.mimeType", + "type": "string", + "tags": [], + "label": "mimeType", + "description": [], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFile.size", + "type": "number", + "tags": [], + "label": "size", + "description": [], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFile.sha256", + "type": "string", + "tags": [], + "label": "sha256", + "description": [], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFile.created", + "type": "string", + "tags": [], + "label": "created", + "description": [], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface", + "type": "Interface", + "tags": [], + "label": "FleetFileClientInterface", + "description": [], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [ + "Creates a new file. Only applicable when type of file is `to-host`." + ], + "signature": [ + "(fileStream: ", + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.HapiReadableStream", + "text": "HapiReadableStream" + }, + ", agentIds: string[]) => Promise<", + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.FleetFile", + "text": "FleetFile" + }, + ">" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.create.$1", + "type": "Object", + "tags": [], + "label": "fileStream", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.HapiReadableStream", + "text": "HapiReadableStream" + } + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.create.$2", + "type": "Array", + "tags": [], + "label": "agentIds", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "Deletes a file. Only applicable when type of file is `to-host`." + ], + "signature": [ + "(fileId: string) => Promise" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.delete.$1", + "type": "string", + "tags": [], + "label": "fileId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.update", + "type": "Function", + "tags": [], + "label": "update", + "description": [ + "Updates metadata for the file. Only applicable when type of file is `to-host`." + ], + "signature": [ + "(fileId: string, updates: Partial<", + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.FleetFileUpdatableFields", + "text": "FleetFileUpdatableFields" + }, + ">) => Promise<", + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.FleetFile", + "text": "FleetFile" + }, + ">" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.update.$1", + "type": "string", + "tags": [], + "label": "fileId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.update.$2", + "type": "Object", + "tags": [], + "label": "updates", + "description": [], + "signature": [ + "Partial<", + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.FleetFileUpdatableFields", + "text": "FleetFileUpdatableFields" + }, + ">" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.doesFileHaveData", + "type": "Function", + "tags": [], + "label": "doesFileHaveData", + "description": [ + "Checks if a file has chunks" + ], + "signature": [ + "(fileId: string) => Promise" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.doesFileHaveData.$1", + "type": "string", + "tags": [], + "label": "fileId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.download", + "type": "Function", + "tags": [], + "label": "download", + "description": [ + "Returns a Stream for downloading the file" + ], + "signature": [ + "(fileId: string) => Promise<{ stream: ", + "Readable", + "; fileName: string; mimeType?: string | undefined; }>" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.download.$1", + "type": "string", + "tags": [], + "label": "fileId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "Returns meta info about the file" + ], + "signature": [ + "(fileId: string) => Promise<", + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.FleetFile", + "text": "FleetFile" + }, + ">" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileClientInterface.get.$1", + "type": "string", + "tags": [], + "label": "fileId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileUpdatableFields", + "type": "Interface", + "tags": [], + "label": "FleetFileUpdatableFields", + "description": [], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileUpdatableFields.agents", + "type": "Array", + "tags": [], + "label": "agents", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileUpdatableFields.actionId", + "type": "string", + "tags": [], + "label": "actionId", + "description": [], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-server.FleetSetupDeps", @@ -5718,6 +6180,47 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-server.HapiReadableStream", + "type": "Interface", + "tags": [], + "label": "HapiReadableStream", + "description": [ + "\nReadable returned by Hapi when `stream` is used to define a property and/or route payload" + ], + "signature": [ + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.HapiReadableStream", + "text": "HapiReadableStream" + }, + " extends ", + "Readable" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.HapiReadableStream.hapi", + "type": "Object", + "tags": [], + "label": "hapi", + "description": [], + "signature": [ + "{ filename: string; headers: Record; }" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-server.MessageSigningServiceInterface", @@ -9190,6 +9693,23 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetFileTransferDirection", + "type": "Type", + "tags": [], + "label": "FleetFileTransferDirection", + "description": [ + "\nThe type of file.\nUse `from-host` when interacting with files that were sent to ES from the\nhost (via Fleet-Server)\nUse `to-host` when interacting with files that are being sent to the host\n(via fleet-server)" + ], + "signature": [ + "\"from-host\" | \"to-host\"" + ], + "path": "x-pack/plugins/fleet/server/services/files/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-server.ListArtifactsProps", @@ -16193,6 +16713,91 @@ ], "returnComment": [] }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetStartContract.createFilesClient", + "type": "Function", + "tags": [], + "label": "createFilesClient", + "description": [ + "\nCreate a Fleet Files client instance" + ], + "signature": [ + "(packageName: string, type: ", + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.FleetFileTransferDirection", + "text": "FleetFileTransferDirection" + }, + ", maxSizeBytes?: number | undefined) => ", + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.FleetFileClientInterface", + "text": "FleetFileClientInterface" + } + ], + "path": "x-pack/plugins/fleet/server/plugin.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.FleetStartContract.createFilesClient.$1", + "type": "string", + "tags": [], + "label": "packageName", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/server/plugin.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetStartContract.createFilesClient.$2", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "server", + "docId": "kibFleetPluginApi", + "section": "def-server.FleetFileTransferDirection", + "text": "FleetFileTransferDirection" + } + ], + "path": "x-pack/plugins/fleet/server/plugin.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetStartContract.createFilesClient.$3", + "type": "number", + "tags": [], + "label": "maxSizeBytes", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/fleet/server/plugin.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + }, { "parentPluginId": "fleet", "id": "def-server.FleetStartContract.messageSigningService", @@ -20006,6 +20611,20 @@ "path": "x-pack/plugins/fleet/common/types/models/output.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.NewOutput.allow_edit", + "type": "Array", + "tags": [], + "label": "allow_edit", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -22921,6 +23540,51 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.FLEET_CLOUD_DEFEND_PACKAGE", + "type": "string", + "tags": [], + "label": "FLEET_CLOUD_DEFEND_PACKAGE", + "description": [], + "signature": [ + "\"cloud_defend\"" + ], + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FLEET_CLOUD_SECURITY_POSTURE_CNVM_POLICY_TEMPLATE", + "type": "string", + "tags": [], + "label": "FLEET_CLOUD_SECURITY_POSTURE_CNVM_POLICY_TEMPLATE", + "description": [], + "signature": [ + "\"vuln_mgmt\"" + ], + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FLEET_CLOUD_SECURITY_POSTURE_CSPM_POLICY_TEMPLATE", + "type": "string", + "tags": [], + "label": "FLEET_CLOUD_SECURITY_POSTURE_CSPM_POLICY_TEMPLATE", + "description": [], + "signature": [ + "\"cspm\"" + ], + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.FLEET_CLOUD_SECURITY_POSTURE_KSPM_POLICY_TEMPLATE", @@ -25527,6 +26191,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "fleet", + "id": "def-common.EPM_API_ROUTES.INSTALLED_LIST_PATTERN", + "type": "string", + "tags": [], + "label": "INSTALLED_LIST_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.LIMITED_LIST_PATTERN", @@ -25549,6 +26224,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "fleet", + "id": "def-common.EPM_API_ROUTES.DATA_STREAMS_PATTERN", + "type": "string", + "tags": [], + "label": "DATA_STREAMS_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.INSTALL_FROM_REGISTRY_PATTERN", diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index 1cd97f968d013..3c13c575612d3 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet title: "fleet" image: https://source.unsplash.com/400x175/?github description: API docs for the fleet plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] --- import fleetObj from './fleet.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) for questi | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 1118 | 3 | 1013 | 31 | +| 1159 | 3 | 1045 | 31 | ## Client diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index 89feab872083c..d48769aad589c 100644 --- a/api_docs/global_search.mdx +++ b/api_docs/global_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/globalSearch title: "globalSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the globalSearch plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] --- import globalSearchObj from './global_search.devdocs.json'; diff --git a/api_docs/guided_onboarding.mdx b/api_docs/guided_onboarding.mdx index 41b03c2028997..06b1e574173cd 100644 --- a/api_docs/guided_onboarding.mdx +++ b/api_docs/guided_onboarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/guidedOnboarding title: "guidedOnboarding" image: https://source.unsplash.com/400x175/?github description: API docs for the guidedOnboarding plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding'] --- import guidedOnboardingObj from './guided_onboarding.devdocs.json'; diff --git a/api_docs/home.mdx b/api_docs/home.mdx index 4ff297e3cce03..dda8b71c79317 100644 --- a/api_docs/home.mdx +++ b/api_docs/home.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/home title: "home" image: https://source.unsplash.com/400x175/?github description: API docs for the home plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] --- import homeObj from './home.devdocs.json'; diff --git a/api_docs/image_embeddable.mdx b/api_docs/image_embeddable.mdx index 478085884931f..88e497fc1e630 100644 --- a/api_docs/image_embeddable.mdx +++ b/api_docs/image_embeddable.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/imageEmbeddable title: "imageEmbeddable" image: https://source.unsplash.com/400x175/?github description: API docs for the imageEmbeddable plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable'] --- import imageEmbeddableObj from './image_embeddable.devdocs.json'; diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx index 6d0bbf50d795c..7f1e3547320b4 100644 --- a/api_docs/index_lifecycle_management.mdx +++ b/api_docs/index_lifecycle_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement title: "indexLifecycleManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the indexLifecycleManagement plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] --- import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json'; diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index b7c8452f4c022..f4e58d73cc570 100644 --- a/api_docs/index_management.mdx +++ b/api_docs/index_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexManagement title: "indexManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the indexManagement plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] --- import indexManagementObj from './index_management.devdocs.json'; diff --git a/api_docs/infra.devdocs.json b/api_docs/infra.devdocs.json index 767658d05117b..28ccc0b48df5d 100644 --- a/api_docs/infra.devdocs.json +++ b/api_docs/infra.devdocs.json @@ -379,6 +379,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "infra", + "id": "def-public.InfraClientStartExports.locators", + "type": "Object", + "tags": [], + "label": "locators", + "description": [], + "signature": [ + "InfraLocators" + ], + "path": "x-pack/plugins/infra/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "infra", "id": "def-public.InfraClientStartExports.ContainerMetricsTable", diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index c8141710fbe48..f9552e40029b2 100644 --- a/api_docs/infra.mdx +++ b/api_docs/infra.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/infra title: "infra" image: https://source.unsplash.com/400x175/?github description: API docs for the infra plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] --- import infraObj from './infra.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/inf | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 48 | 0 | 45 | 13 | +| 49 | 0 | 46 | 14 | ## Client diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index f02fecfcdc706..d50211ab3d03b 100644 --- a/api_docs/inspector.mdx +++ b/api_docs/inspector.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inspector title: "inspector" image: https://source.unsplash.com/400x175/?github description: API docs for the inspector plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector'] --- import inspectorObj from './inspector.devdocs.json'; diff --git a/api_docs/interactive_setup.mdx b/api_docs/interactive_setup.mdx index 7f6464688f568..02c9da8e2b05a 100644 --- a/api_docs/interactive_setup.mdx +++ b/api_docs/interactive_setup.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/interactiveSetup title: "interactiveSetup" image: https://source.unsplash.com/400x175/?github description: API docs for the interactiveSetup plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup'] --- import interactiveSetupObj from './interactive_setup.devdocs.json'; diff --git a/api_docs/kbn_ace.mdx b/api_docs/kbn_ace.mdx index c044ee8887b0f..008ca2778351f 100644 --- a/api_docs/kbn_ace.mdx +++ b/api_docs/kbn_ace.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ace title: "@kbn/ace" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ace plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace'] --- import kbnAceObj from './kbn_ace.devdocs.json'; diff --git a/api_docs/kbn_aiops_components.mdx b/api_docs/kbn_aiops_components.mdx index 31e495e3682c7..f9ffc67b95390 100644 --- a/api_docs/kbn_aiops_components.mdx +++ b/api_docs/kbn_aiops_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-components title: "@kbn/aiops-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/aiops-components plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components'] --- import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json'; diff --git a/api_docs/kbn_aiops_utils.mdx b/api_docs/kbn_aiops_utils.mdx index e8eb16106cec0..ee76f967013bd 100644 --- a/api_docs/kbn_aiops_utils.mdx +++ b/api_docs/kbn_aiops_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils title: "@kbn/aiops-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/aiops-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils'] --- import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json'; diff --git a/api_docs/kbn_alerting_state_types.mdx b/api_docs/kbn_alerting_state_types.mdx index 7396834bdd2a1..989b2a6daceca 100644 --- a/api_docs/kbn_alerting_state_types.mdx +++ b/api_docs/kbn_alerting_state_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-state-types title: "@kbn/alerting-state-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerting-state-types plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types'] --- import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json'; diff --git a/api_docs/kbn_alerts_as_data_utils.mdx b/api_docs/kbn_alerts_as_data_utils.mdx index 26f4142399dc8..8c74040b310c1 100644 --- a/api_docs/kbn_alerts_as_data_utils.mdx +++ b/api_docs/kbn_alerts_as_data_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-as-data-utils title: "@kbn/alerts-as-data-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerts-as-data-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-as-data-utils'] --- import kbnAlertsAsDataUtilsObj from './kbn_alerts_as_data_utils.devdocs.json'; diff --git a/api_docs/kbn_alerts_ui_shared.mdx b/api_docs/kbn_alerts_ui_shared.mdx index 2bc07c74917da..f0cef83d5c788 100644 --- a/api_docs/kbn_alerts_ui_shared.mdx +++ b/api_docs/kbn_alerts_ui_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-ui-shared title: "@kbn/alerts-ui-shared" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerts-ui-shared plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared'] --- import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.devdocs.json'; diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index a27a68f112334..283cd58583688 100644 --- a/api_docs/kbn_analytics.mdx +++ b/api_docs/kbn_analytics.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics title: "@kbn/analytics" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics'] --- import kbnAnalyticsObj from './kbn_analytics.devdocs.json'; diff --git a/api_docs/kbn_analytics_client.mdx b/api_docs/kbn_analytics_client.mdx index fb97772377293..322567b2bf65c 100644 --- a/api_docs/kbn_analytics_client.mdx +++ b/api_docs/kbn_analytics_client.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client title: "@kbn/analytics-client" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-client plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client'] --- import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx index 0ed5a62a64cc6..f9b263d6bb976 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-browser title: "@kbn/analytics-shippers-elastic-v3-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser'] --- import kbnAnalyticsShippersElasticV3BrowserObj from './kbn_analytics_shippers_elastic_v3_browser.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx index 3e1af959c7bcb..eb09495535c3d 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-common title: "@kbn/analytics-shippers-elastic-v3-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common'] --- import kbnAnalyticsShippersElasticV3CommonObj from './kbn_analytics_shippers_elastic_v3_common.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx index 3f47d662fbb2b..9f61cd2892518 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-server title: "@kbn/analytics-shippers-elastic-v3-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server'] --- import kbnAnalyticsShippersElasticV3ServerObj from './kbn_analytics_shippers_elastic_v3_server.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_fullstory.mdx b/api_docs/kbn_analytics_shippers_fullstory.mdx index 9397671edb068..be4c1d56c7002 100644 --- a/api_docs/kbn_analytics_shippers_fullstory.mdx +++ b/api_docs/kbn_analytics_shippers_fullstory.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory title: "@kbn/analytics-shippers-fullstory" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-fullstory plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory'] --- import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_gainsight.mdx b/api_docs/kbn_analytics_shippers_gainsight.mdx index 4385719df3e93..446105d46d7ee 100644 --- a/api_docs/kbn_analytics_shippers_gainsight.mdx +++ b/api_docs/kbn_analytics_shippers_gainsight.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-gainsight title: "@kbn/analytics-shippers-gainsight" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-gainsight plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-gainsight'] --- import kbnAnalyticsShippersGainsightObj from './kbn_analytics_shippers_gainsight.devdocs.json'; diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index 29239dc439ac5..475c20bc8ad6c 100644 --- a/api_docs/kbn_apm_config_loader.mdx +++ b/api_docs/kbn_apm_config_loader.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader title: "@kbn/apm-config-loader" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-config-loader plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader'] --- import kbnApmConfigLoaderObj from './kbn_apm_config_loader.devdocs.json'; diff --git a/api_docs/kbn_apm_synthtrace.mdx b/api_docs/kbn_apm_synthtrace.mdx index fbb32f5549a77..4acc11ab24255 100644 --- a/api_docs/kbn_apm_synthtrace.mdx +++ b/api_docs/kbn_apm_synthtrace.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace title: "@kbn/apm-synthtrace" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-synthtrace plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace'] --- import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json'; diff --git a/api_docs/kbn_apm_synthtrace_client.mdx b/api_docs/kbn_apm_synthtrace_client.mdx index 98ef12d3969b4..38e12f46bebdd 100644 --- a/api_docs/kbn_apm_synthtrace_client.mdx +++ b/api_docs/kbn_apm_synthtrace_client.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace-client title: "@kbn/apm-synthtrace-client" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-synthtrace-client plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace-client'] --- import kbnApmSynthtraceClientObj from './kbn_apm_synthtrace_client.devdocs.json'; diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index d28074482c07b..96eee6f3544af 100644 --- a/api_docs/kbn_apm_utils.mdx +++ b/api_docs/kbn_apm_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils title: "@kbn/apm-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils'] --- import kbnApmUtilsObj from './kbn_apm_utils.devdocs.json'; diff --git a/api_docs/kbn_axe_config.mdx b/api_docs/kbn_axe_config.mdx index d0227285d929f..9e30a46170684 100644 --- a/api_docs/kbn_axe_config.mdx +++ b/api_docs/kbn_axe_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config title: "@kbn/axe-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/axe-config plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] --- import kbnAxeConfigObj from './kbn_axe_config.devdocs.json'; diff --git a/api_docs/kbn_cases_components.mdx b/api_docs/kbn_cases_components.mdx index fe67a9389384a..1ec1e4b72c83e 100644 --- a/api_docs/kbn_cases_components.mdx +++ b/api_docs/kbn_cases_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cases-components title: "@kbn/cases-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cases-components plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cases-components'] --- import kbnCasesComponentsObj from './kbn_cases_components.devdocs.json'; diff --git a/api_docs/kbn_cell_actions.mdx b/api_docs/kbn_cell_actions.mdx index e0a211b7f1d0b..7224eaecb1234 100644 --- a/api_docs/kbn_cell_actions.mdx +++ b/api_docs/kbn_cell_actions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cell-actions title: "@kbn/cell-actions" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cell-actions plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cell-actions'] --- import kbnCellActionsObj from './kbn_cell_actions.devdocs.json'; diff --git a/api_docs/kbn_chart_expressions_common.mdx b/api_docs/kbn_chart_expressions_common.mdx index 925312dbe3ae2..4e5dff6ecd1e5 100644 --- a/api_docs/kbn_chart_expressions_common.mdx +++ b/api_docs/kbn_chart_expressions_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-expressions-common title: "@kbn/chart-expressions-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/chart-expressions-common plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/chart-expressions-common'] --- import kbnChartExpressionsCommonObj from './kbn_chart_expressions_common.devdocs.json'; diff --git a/api_docs/kbn_chart_icons.mdx b/api_docs/kbn_chart_icons.mdx index 30514e6ee2883..a33ee594fdb03 100644 --- a/api_docs/kbn_chart_icons.mdx +++ b/api_docs/kbn_chart_icons.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-icons title: "@kbn/chart-icons" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/chart-icons plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/chart-icons'] --- import kbnChartIconsObj from './kbn_chart_icons.devdocs.json'; diff --git a/api_docs/kbn_ci_stats_core.mdx b/api_docs/kbn_ci_stats_core.mdx index 02b72bc535f33..aefc7a50a20cc 100644 --- a/api_docs/kbn_ci_stats_core.mdx +++ b/api_docs/kbn_ci_stats_core.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core title: "@kbn/ci-stats-core" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ci-stats-core plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core'] --- import kbnCiStatsCoreObj from './kbn_ci_stats_core.devdocs.json'; diff --git a/api_docs/kbn_ci_stats_performance_metrics.mdx b/api_docs/kbn_ci_stats_performance_metrics.mdx index ebb722df6c2ee..4bcaa8f07a80f 100644 --- a/api_docs/kbn_ci_stats_performance_metrics.mdx +++ b/api_docs/kbn_ci_stats_performance_metrics.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-performance-metrics title: "@kbn/ci-stats-performance-metrics" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ci-stats-performance-metrics plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-performance-metrics'] --- import kbnCiStatsPerformanceMetricsObj from './kbn_ci_stats_performance_metrics.devdocs.json'; diff --git a/api_docs/kbn_ci_stats_reporter.mdx b/api_docs/kbn_ci_stats_reporter.mdx index c3ecc6b640486..a7a155b0544b9 100644 --- a/api_docs/kbn_ci_stats_reporter.mdx +++ b/api_docs/kbn_ci_stats_reporter.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter title: "@kbn/ci-stats-reporter" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ci-stats-reporter plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter'] --- import kbnCiStatsReporterObj from './kbn_ci_stats_reporter.devdocs.json'; diff --git a/api_docs/kbn_cli_dev_mode.mdx b/api_docs/kbn_cli_dev_mode.mdx index 9acb8a9a976c6..38aaaef189515 100644 --- a/api_docs/kbn_cli_dev_mode.mdx +++ b/api_docs/kbn_cli_dev_mode.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode title: "@kbn/cli-dev-mode" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cli-dev-mode plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode'] --- import kbnCliDevModeObj from './kbn_cli_dev_mode.devdocs.json'; diff --git a/api_docs/kbn_code_editor.mdx b/api_docs/kbn_code_editor.mdx index 22590c97ae7e1..896573587766c 100644 --- a/api_docs/kbn_code_editor.mdx +++ b/api_docs/kbn_code_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-code-editor title: "@kbn/code-editor" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/code-editor plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-editor'] --- import kbnCodeEditorObj from './kbn_code_editor.devdocs.json'; diff --git a/api_docs/kbn_code_editor_mocks.mdx b/api_docs/kbn_code_editor_mocks.mdx index 7f54e02814fd0..dc6f279f928e9 100644 --- a/api_docs/kbn_code_editor_mocks.mdx +++ b/api_docs/kbn_code_editor_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-code-editor-mocks title: "@kbn/code-editor-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/code-editor-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-editor-mocks'] --- import kbnCodeEditorMocksObj from './kbn_code_editor_mocks.devdocs.json'; diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx index 657db8069ee3b..1b0c63d60b970 100644 --- a/api_docs/kbn_coloring.mdx +++ b/api_docs/kbn_coloring.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-coloring title: "@kbn/coloring" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/coloring plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring'] --- import kbnColoringObj from './kbn_coloring.devdocs.json'; diff --git a/api_docs/kbn_config.mdx b/api_docs/kbn_config.mdx index 2bae2dcddb916..a40f968eceee4 100644 --- a/api_docs/kbn_config.mdx +++ b/api_docs/kbn_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config title: "@kbn/config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/config plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] --- import kbnConfigObj from './kbn_config.devdocs.json'; diff --git a/api_docs/kbn_config_mocks.mdx b/api_docs/kbn_config_mocks.mdx index ec2b36f8744ea..46ca7c4aef1f8 100644 --- a/api_docs/kbn_config_mocks.mdx +++ b/api_docs/kbn_config_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-mocks title: "@kbn/config-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/config-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks'] --- import kbnConfigMocksObj from './kbn_config_mocks.devdocs.json'; diff --git a/api_docs/kbn_config_schema.mdx b/api_docs/kbn_config_schema.mdx index c05f13da00f12..fb8fb79ade3a0 100644 --- a/api_docs/kbn_config_schema.mdx +++ b/api_docs/kbn_config_schema.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema title: "@kbn/config-schema" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/config-schema plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema'] --- import kbnConfigSchemaObj from './kbn_config_schema.devdocs.json'; diff --git a/api_docs/kbn_content_management_content_editor.mdx b/api_docs/kbn_content_management_content_editor.mdx index 71e53d8771d5c..b1bdccab7e79c 100644 --- a/api_docs/kbn_content_management_content_editor.mdx +++ b/api_docs/kbn_content_management_content_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-content-editor title: "@kbn/content-management-content-editor" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-content-editor plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-content-editor'] --- import kbnContentManagementContentEditorObj from './kbn_content_management_content_editor.devdocs.json'; diff --git a/api_docs/kbn_content_management_table_list.mdx b/api_docs/kbn_content_management_table_list.mdx index 6935750d77c44..c35af9c49b842 100644 --- a/api_docs/kbn_content_management_table_list.mdx +++ b/api_docs/kbn_content_management_table_list.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-table-list title: "@kbn/content-management-table-list" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-table-list plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-table-list'] --- import kbnContentManagementTableListObj from './kbn_content_management_table_list.devdocs.json'; diff --git a/api_docs/kbn_content_management_utils.devdocs.json b/api_docs/kbn_content_management_utils.devdocs.json index 6c6c13efb2b09..8fccb2a9f21a8 100644 --- a/api_docs/kbn_content_management_utils.devdocs.json +++ b/api_docs/kbn_content_management_utils.devdocs.json @@ -17,177 +17,576 @@ "objects": [] }, "common": { - "classes": [], - "functions": [ + "classes": [ { "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.createResultSchema", - "type": "Function", + "id": "def-common.SOContentStorage", + "type": "Class", "tags": [], - "label": "createResultSchema", + "label": "SOContentStorage", "description": [], "signature": [ - "(soSchema: ", { - "pluginId": "@kbn/config-schema", + "pluginId": "@kbn/content-management-utils", "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.ObjectType", - "text": "ObjectType" + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.SOContentStorage", + "text": "SOContentStorage" }, - ") => ", + " implements ", { - "pluginId": "@kbn/config-schema", - "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.ObjectType", - "text": "ObjectType" + "pluginId": "contentManagement", + "scope": "server", + "docId": "kibContentManagementPluginApi", + "section": "def-server.ContentStorage", + "text": "ContentStorage" }, - "<{ item: ", + "; }>" + ">" ], - "path": "packages/kbn-content-management-utils/src/schema.ts", + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.createResultSchema.$1", + "id": "def-common.SOContentStorage.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "{\n savedObjectType,\n cmServicesDefinition,\n createArgsToSoCreateOptions,\n updateArgsToSoUpdateOptions,\n searchArgsToSOFindOptions,\n enableMSearch,\n }", + "description": [], + "signature": [ + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.SOContentStorageConstrutorParams", + "text": "SOContentStorageConstrutorParams" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.mSearch", "type": "Object", "tags": [], - "label": "soSchema", + "label": "mSearch", "description": [], "signature": [ + "{ savedObjectType: string; toItemResult: (ctx: ", { - "pluginId": "@kbn/config-schema", + "pluginId": "contentManagement", + "scope": "server", + "docId": "kibContentManagementPluginApi", + "section": "def-server.StorageContext", + "text": "StorageContext" + }, + ", savedObject: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.ObjectType", - "text": "ObjectType" + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsFindResult", + "text": "SavedObjectsFindResult" }, - "" + ") => Types[\"Item\"]; } | undefined" ], - "path": "packages/kbn-content-management-utils/src/schema.ts", + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.objectTypeToGetResultSchema", - "type": "Function", - "tags": [], - "label": "objectTypeToGetResultSchema", - "description": [], - "signature": [ - "(soSchema: ", - { - "pluginId": "@kbn/config-schema", - "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.ObjectType", - "text": "ObjectType" - }, - ") => ", - { - "pluginId": "@kbn/config-schema", - "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.ObjectType", - "text": "ObjectType" - }, - "<{ item: ", - { - "pluginId": "@kbn/config-schema", - "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.ObjectType", - "text": "ObjectType" - }, - "; meta: ", - { - "pluginId": "@kbn/config-schema", - "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.ObjectType", - "text": "ObjectType" + "trackAdoption": false }, - "<{ outcome: ", { - "pluginId": "@kbn/config-schema", - "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.Type", - "text": "Type" + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "(ctx: ", + { + "pluginId": "contentManagement", + "scope": "server", + "docId": "kibContentManagementPluginApi", + "section": "def-server.StorageContext", + "text": "StorageContext" + }, + ", id: string) => Promise" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.get.$1", + "type": "Object", + "tags": [], + "label": "ctx", + "description": [], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "server", + "docId": "kibContentManagementPluginApi", + "section": "def-server.StorageContext", + "text": "StorageContext" + } + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.get.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] }, - "<\"conflict\" | \"exactMatch\" | \"aliasMatch\">; aliasTargetId: ", { - "pluginId": "@kbn/config-schema", - "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.Type", - "text": "Type" + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.bulkGet", + "type": "Function", + "tags": [], + "label": "bulkGet", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] }, - "; aliasPurpose: ", { - "pluginId": "@kbn/config-schema", - "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.Type", - "text": "Type" + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "(ctx: ", + { + "pluginId": "contentManagement", + "scope": "server", + "docId": "kibContentManagementPluginApi", + "section": "def-server.StorageContext", + "text": "StorageContext" + }, + ", data: Types[\"Attributes\"], options: Types[\"CreateOptions\"]) => Promise" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.create.$1", + "type": "Object", + "tags": [], + "label": "ctx", + "description": [], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "server", + "docId": "kibContentManagementPluginApi", + "section": "def-server.StorageContext", + "text": "StorageContext" + } + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.create.$2", + "type": "Uncategorized", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "Types[\"Attributes\"]" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.create.$3", + "type": "Uncategorized", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Types[\"CreateOptions\"]" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] }, - "<\"savedObjectConversion\" | \"savedObjectImport\" | undefined>; }>; }>" - ], - "path": "packages/kbn-content-management-utils/src/schema.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.objectTypeToGetResultSchema.$1", - "type": "Object", + "id": "def-common.SOContentStorage.update", + "type": "Function", "tags": [], - "label": "soSchema", + "label": "update", "description": [], "signature": [ + "(ctx: ", { - "pluginId": "@kbn/config-schema", - "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.ObjectType", - "text": "ObjectType" + "pluginId": "contentManagement", + "scope": "server", + "docId": "kibContentManagementPluginApi", + "section": "def-server.StorageContext", + "text": "StorageContext" }, - "" + ", id: string, data: Types[\"Attributes\"], options: Types[\"UpdateOptions\"]) => Promise" ], - "path": "packages/kbn-content-management-utils/src/schema.ts", + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.savedObjectSchema", - "type": "Function", - "tags": [], - "label": "savedObjectSchema", + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.update.$1", + "type": "Object", + "tags": [], + "label": "ctx", + "description": [], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "server", + "docId": "kibContentManagementPluginApi", + "section": "def-server.StorageContext", + "text": "StorageContext" + } + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.update.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.update.$3", + "type": "Uncategorized", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "Types[\"Attributes\"]" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.update.$4", + "type": "Uncategorized", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Types[\"UpdateOptions\"]" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [], + "signature": [ + "(ctx: ", + { + "pluginId": "contentManagement", + "scope": "server", + "docId": "kibContentManagementPluginApi", + "section": "def-server.StorageContext", + "text": "StorageContext" + }, + ", id: string) => Promise" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.delete.$1", + "type": "Object", + "tags": [], + "label": "ctx", + "description": [], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "server", + "docId": "kibContentManagementPluginApi", + "section": "def-server.StorageContext", + "text": "StorageContext" + } + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.delete.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.search", + "type": "Function", + "tags": [], + "label": "search", + "description": [], + "signature": [ + "(ctx: ", + { + "pluginId": "contentManagement", + "scope": "server", + "docId": "kibContentManagementPluginApi", + "section": "def-server.StorageContext", + "text": "StorageContext" + }, + ", query: ", + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.SearchQuery", + "text": "SearchQuery" + }, + ", options?: Types[\"SearchOptions\"]) => Promise" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.search.$1", + "type": "Object", + "tags": [], + "label": "ctx", + "description": [], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "server", + "docId": "kibContentManagementPluginApi", + "section": "def-server.StorageContext", + "text": "StorageContext" + } + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.search.$2", + "type": "Object", + "tags": [], + "label": "query", + "description": [], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.SearchQuery", + "text": "SearchQuery" + } + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorage.search.$3", + "type": "Uncategorized", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Types[\"SearchOptions\"]" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.createArgsToSoCreateOptionsDefault", + "type": "Function", + "tags": [], + "label": "createArgsToSoCreateOptionsDefault", "description": [], "signature": [ - "(attributesSchema: ", + "(params: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + ") => ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + } + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.createArgsToSoCreateOptionsDefault.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + } + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.createResultSchema", + "type": "Function", + "tags": [], + "label": "createResultSchema", + "description": [], + "signature": [ + "(soSchema: ", { "pluginId": "@kbn/config-schema", "scope": "common", @@ -203,38 +602,198 @@ "section": "def-common.ObjectType", "text": "ObjectType" }, - "<{ id: ", + "<{ item: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.Type", - "text": "Type" + "section": "def-common.ObjectType", + "text": "ObjectType" }, - "; type: ", + "; }>" + ], + "path": "packages/kbn-content-management-utils/src/schema.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.createResultSchema.$1", + "type": "Object", + "tags": [], + "label": "soSchema", + "description": [], + "signature": [ + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.ObjectType", + "text": "ObjectType" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/schema.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.objectTypeToGetResultSchema", + "type": "Function", + "tags": [], + "label": "objectTypeToGetResultSchema", + "description": [], + "signature": [ + "(soSchema: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.Type", - "text": "Type" + "section": "def-common.ObjectType", + "text": "ObjectType" }, - "; version: ", + ") => ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.Type", - "text": "Type" + "section": "def-common.ObjectType", + "text": "ObjectType" }, - "; createdAt: ", + "<{ item: ", { "pluginId": "@kbn/config-schema", "scope": "common", "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.Type", - "text": "Type" - }, + "section": "def-common.ObjectType", + "text": "ObjectType" + }, + "; meta: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.ObjectType", + "text": "ObjectType" + }, + "<{ outcome: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + "<\"conflict\" | \"exactMatch\" | \"aliasMatch\">; aliasTargetId: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + "; aliasPurpose: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + "<\"savedObjectConversion\" | \"savedObjectImport\" | undefined>; }>; }>" + ], + "path": "packages/kbn-content-management-utils/src/schema.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.objectTypeToGetResultSchema.$1", + "type": "Object", + "tags": [], + "label": "soSchema", + "description": [], + "signature": [ + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.ObjectType", + "text": "ObjectType" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/schema.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.savedObjectSchema", + "type": "Function", + "tags": [], + "label": "savedObjectSchema", + "description": [], + "signature": [ + "(attributesSchema: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.ObjectType", + "text": "ObjectType" + }, + ") => ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.ObjectType", + "text": "ObjectType" + }, + "<{ id: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + "; type: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + "; version: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + "; createdAt: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, "; updatedAt: ", { "pluginId": "@kbn/config-schema", @@ -267,56 +826,632 @@ "section": "def-common.Type", "text": "Type" }, - "[]>; namespaces: ", + "[]>; namespaces: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + "; originId: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + "; }>" + ], + "path": "packages/kbn-content-management-utils/src/schema.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.savedObjectSchema.$1", + "type": "Object", + "tags": [], + "label": "attributesSchema", + "description": [], + "signature": [ + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.ObjectType", + "text": "ObjectType" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/schema.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.searchArgsToSOFindOptionsDefault", + "type": "Function", + "tags": [], + "label": "searchArgsToSOFindOptionsDefault", + "description": [], + "signature": [ + "(params: ", + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.SearchIn", + "text": "SearchIn" + }, + ") => ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + } + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.searchArgsToSOFindOptionsDefault.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.SearchIn", + "text": "SearchIn" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.tagsToFindOptions", + "type": "Function", + "tags": [], + "label": "tagsToFindOptions", + "description": [], + "signature": [ + "({ included, excluded, }?: { included?: string[] | undefined; excluded?: string[] | undefined; }) => { hasReference: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + "[] | undefined; hasNoReference: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + "[] | undefined; }" + ], + "path": "packages/kbn-content-management-utils/src/utils.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.tagsToFindOptions.$1", + "type": "Object", + "tags": [], + "label": "{\n included,\n excluded,\n}", + "description": [], + "path": "packages/kbn-content-management-utils/src/utils.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.tagsToFindOptions.$1.included", + "type": "Array", + "tags": [], + "label": "included", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "packages/kbn-content-management-utils/src/utils.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.tagsToFindOptions.$1.excluded", + "type": "Array", + "tags": [], + "label": "excluded", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "packages/kbn-content-management-utils/src/utils.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.updateArgsToSoUpdateOptionsDefault", + "type": "Function", + "tags": [], + "label": "updateArgsToSoUpdateOptionsDefault", + "description": [], + "signature": [ + "(params: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.updateArgsToSoUpdateOptionsDefault.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes", + "type": "Interface", + "tags": [], + "label": "CMCrudTypes", + "description": [], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.Attributes", + "type": "Uncategorized", + "tags": [], + "label": "Attributes", + "description": [ + "\nSaved object attributes" + ], + "signature": [ + "object" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.Item", + "type": "Object", + "tags": [], + "label": "Item", + "description": [ + "\nComplete saved object" + ], + "signature": [ + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.SOWithMetadata", + "text": "SOWithMetadata" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.PartialItem", + "type": "CompoundType", + "tags": [], + "label": "PartialItem", + "description": [ + "\nPartial saved object, used as output for update" + ], + "signature": [ + "Omit<", + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.SOWithMetadata", + "text": "SOWithMetadata" + }, + ", \"references\" | \"attributes\"> & { attributes: object; references: ", + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.Reference", + "text": "Reference" + }, + "[] | undefined; }" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.GetIn", + "type": "Object", + "tags": [], + "label": "GetIn", + "description": [ + "\nGet item params" + ], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.GetIn", + "text": "GetIn" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.GetOut", + "type": "Object", + "tags": [], + "label": "GetOut", + "description": [ + "\nGet item result" + ], + "signature": [ + "{ item: ", + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.SOWithMetadata", + "text": "SOWithMetadata" + }, + "; meta: { outcome: \"conflict\" | \"exactMatch\" | \"aliasMatch\"; aliasTargetId?: string | undefined; aliasPurpose?: \"savedObjectConversion\" | \"savedObjectImport\" | undefined; }; }" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.CreateIn", + "type": "Object", + "tags": [], + "label": "CreateIn", + "description": [ + "\nCreate item params" + ], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.CreateIn", + "text": "CreateIn" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.CreateOut", + "type": "Object", + "tags": [], + "label": "CreateOut", + "description": [ + "\nCreate item result" + ], + "signature": [ + "{ item: ", + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.SOWithMetadata", + "text": "SOWithMetadata" + }, + "; }" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.CreateOptions", + "type": "Uncategorized", + "tags": [], + "label": "CreateOptions", + "description": [ + "\n" + ], + "signature": [ + "object" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.SearchIn", + "type": "Object", + "tags": [], + "label": "SearchIn", + "description": [ + "\nSearch item params" + ], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.SearchIn", + "text": "SearchIn" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.SearchOut", + "type": "Object", + "tags": [], + "label": "SearchOut", + "description": [ + "\nSearch item result" + ], + "signature": [ + "{ hits: ", + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.SOWithMetadata", + "text": "SOWithMetadata" + }, + "[]; pagination: { total: number; cursor?: string | undefined; }; }" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.SearchOptions", + "type": "Uncategorized", + "tags": [], + "label": "SearchOptions", + "description": [ + "\n" + ], + "signature": [ + "object" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.UpdateIn", + "type": "Object", + "tags": [], + "label": "UpdateIn", + "description": [ + "\nUpdate item params" + ], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.UpdateIn", + "text": "UpdateIn" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.UpdateOut", + "type": "Object", + "tags": [], + "label": "UpdateOut", + "description": [ + "\nUpdate item result" + ], + "signature": [ + "{ item: ", + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.SOWithMetadataPartial", + "text": "SOWithMetadataPartial" + }, + "; }" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, { - "pluginId": "@kbn/config-schema", - "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.Type", - "text": "Type" + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.UpdateOptions", + "type": "Uncategorized", + "tags": [], + "label": "UpdateOptions", + "description": [ + "\n" + ], + "signature": [ + "object" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false }, - "; originId: ", { - "pluginId": "@kbn/config-schema", - "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.Type", - "text": "Type" + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CMCrudTypes.DeleteIn", + "type": "Object", + "tags": [], + "label": "DeleteIn", + "description": [ + "\nDelete item params" + ], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.DeleteIn", + "text": "DeleteIn" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false }, - "; }>" - ], - "path": "packages/kbn-content-management-utils/src/schema.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.savedObjectSchema.$1", + "id": "def-common.CMCrudTypes.DeleteOut", "type": "Object", "tags": [], - "label": "attributesSchema", - "description": [], + "label": "DeleteOut", + "description": [ + "\nDelete item result" + ], "signature": [ { - "pluginId": "@kbn/config-schema", + "pluginId": "contentManagement", "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.ObjectType", - "text": "ObjectType" - }, - "" + "docId": "kibContentManagementPluginApi", + "section": "def-common.DeleteResult", + "text": "DeleteResult" + } ], - "path": "packages/kbn-content-management-utils/src/schema.ts", + "path": "packages/kbn-content-management-utils/src/types.ts", "deprecated": false, - "trackAdoption": false, - "isRequired": true + "trackAdoption": false } ], - "returnComment": [], "initialIsOpen": false - } - ], - "interfaces": [ + }, { "parentPluginId": "@kbn/content-management-utils", "id": "def-common.ContentManagementCrudTypes", @@ -343,6 +1478,20 @@ "deprecated": false, "trackAdoption": false, "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.ContentManagementCrudTypes.Attributes", + "type": "Uncategorized", + "tags": [], + "label": "Attributes", + "description": [], + "signature": [ + "Attributes" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/content-management-utils", "id": "def-common.ContentManagementCrudTypes.Item", @@ -620,7 +1769,15 @@ "\nUpdate item result" ], "signature": [ - "{ item: PartialItem; }" + "{ item: ", + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.SOWithMetadataPartial", + "text": "SOWithMetadataPartial" + }, + "; }" ], "path": "packages/kbn-content-management-utils/src/types.ts", "deprecated": false, @@ -1134,51 +2291,246 @@ ], "label": "aggs", "description": [ - "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" + "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" + ], + "signature": [ + "Record | undefined" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SavedObjectSearchOptions.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "array of namespaces to search" + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SavedObjectSearchOptions.pit", + "type": "Object", + "tags": [], + "label": "pit", + "description": [ + "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsPitParams", + "text": "SavedObjectsPitParams" + }, + " | undefined" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SavedObjectUpdateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectUpdateOptions", + "description": [ + "Saved Object update options - Pick and Omit to customize" + ], + "signature": [ + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.SavedObjectUpdateOptions", + "text": "SavedObjectUpdateOptions" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SavedObjectUpdateOptions.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [ + "Array of referenced saved objects." + ], + "signature": [ + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.Reference", + "text": "Reference" + }, + "[] | undefined" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SavedObjectUpdateOptions.version", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SavedObjectUpdateOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.MutatingOperationRefreshSetting", + "text": "MutatingOperationRefreshSetting" + }, + " | undefined" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SavedObjectUpdateOptions.upsert", + "type": "Uncategorized", + "tags": [], + "label": "upsert", + "description": [ + "If specified, will be used to perform an upsert if the object doesn't exist" + ], + "signature": [ + "Attributes | undefined" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SavedObjectUpdateOptions.retryOnConflict", + "type": "number", + "tags": [], + "label": "retryOnConflict", + "description": [ + "\nThe Elasticsearch `retry_on_conflict` setting for this operation.\nDefaults to `0` when `version` is provided, `3` otherwise." ], "signature": [ - "Record | undefined" + "number | undefined" ], "path": "packages/kbn-content-management-utils/src/types.ts", "deprecated": false, "trackAdoption": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SearchArgsToSOFindOptionsOptionsDefault", + "type": "Interface", + "tags": [], + "label": "SearchArgsToSOFindOptionsOptionsDefault", + "description": [], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.SavedObjectSearchOptions.namespaces", + "id": "def-common.SearchArgsToSOFindOptionsOptionsDefault.fields", "type": "Array", "tags": [], - "label": "namespaces", - "description": [ - "array of namespaces to search" - ], + "label": "fields", + "description": [], "signature": [ "string[] | undefined" ], - "path": "packages/kbn-content-management-utils/src/types.ts", + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.SavedObjectSearchOptions.pit", - "type": "Object", + "id": "def-common.SearchArgsToSOFindOptionsOptionsDefault.searchFields", + "type": "Array", "tags": [], - "label": "pit", - "description": [ - "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." + "label": "searchFields", + "description": [], + "signature": [ + "string[] | undefined" ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.ServicesDefinitionSet", + "type": "Interface", + "tags": [], + "label": "ServicesDefinitionSet", + "description": [], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.ServicesDefinitionSet.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[version: number]: ServicesDefinition", + "description": [], "signature": [ + "[version: number]: ", { - "pluginId": "@kbn/core-saved-objects-api-server", + "pluginId": "@kbn/object-versioning", "scope": "common", - "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", - "section": "def-common.SavedObjectsPitParams", - "text": "SavedObjectsPitParams" - }, - " | undefined" + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ServicesDefinition", + "text": "ServicesDefinition" + } ], "path": "packages/kbn-content-management-utils/src/types.ts", "deprecated": false, @@ -1189,116 +2541,130 @@ }, { "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.SavedObjectUpdateOptions", + "id": "def-common.SOContentStorageConstrutorParams", "type": "Interface", "tags": [], - "label": "SavedObjectUpdateOptions", - "description": [ - "Saved Object update options - Pick and Omit to customize" - ], + "label": "SOContentStorageConstrutorParams", + "description": [], "signature": [ { "pluginId": "@kbn/content-management-utils", "scope": "common", "docId": "kibKbnContentManagementUtilsPluginApi", - "section": "def-common.SavedObjectUpdateOptions", - "text": "SavedObjectUpdateOptions" + "section": "def-common.SOContentStorageConstrutorParams", + "text": "SOContentStorageConstrutorParams" }, - "" + "" ], - "path": "packages/kbn-content-management-utils/src/types.ts", + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.SavedObjectUpdateOptions.references", - "type": "Array", + "id": "def-common.SOContentStorageConstrutorParams.savedObjectType", + "type": "string", "tags": [], - "label": "references", - "description": [ - "Array of referenced saved objects." - ], + "label": "savedObjectType", + "description": [], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOContentStorageConstrutorParams.cmServicesDefinition", + "type": "Object", + "tags": [], + "label": "cmServicesDefinition", + "description": [], "signature": [ { "pluginId": "@kbn/content-management-utils", "scope": "common", "docId": "kibKbnContentManagementUtilsPluginApi", - "section": "def-common.Reference", - "text": "Reference" - }, - "[] | undefined" + "section": "def-common.ServicesDefinitionSet", + "text": "ServicesDefinitionSet" + } ], - "path": "packages/kbn-content-management-utils/src/types.ts", + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.SavedObjectUpdateOptions.version", - "type": "string", + "id": "def-common.SOContentStorageConstrutorParams.createArgsToSoCreateOptions", + "type": "Function", "tags": [], - "label": "version", + "label": "createArgsToSoCreateOptions", "description": [], "signature": [ - "string | undefined" + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.CreateArgsToSoCreateOptions", + "text": "CreateArgsToSoCreateOptions" + }, + " | undefined" ], - "path": "packages/kbn-content-management-utils/src/types.ts", + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.SavedObjectUpdateOptions.refresh", - "type": "CompoundType", + "id": "def-common.SOContentStorageConstrutorParams.updateArgsToSoUpdateOptions", + "type": "Function", "tags": [], - "label": "refresh", - "description": [ - "The Elasticsearch Refresh setting for this operation" - ], + "label": "updateArgsToSoUpdateOptions", + "description": [], "signature": [ { - "pluginId": "@kbn/core-saved-objects-api-server", + "pluginId": "@kbn/content-management-utils", "scope": "common", - "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", - "section": "def-common.MutatingOperationRefreshSetting", - "text": "MutatingOperationRefreshSetting" + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.UpdateArgsToSoUpdateOptions", + "text": "UpdateArgsToSoUpdateOptions" }, - " | undefined" + " | undefined" ], - "path": "packages/kbn-content-management-utils/src/types.ts", + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.SavedObjectUpdateOptions.upsert", - "type": "Uncategorized", + "id": "def-common.SOContentStorageConstrutorParams.searchArgsToSOFindOptions", + "type": "Function", "tags": [], - "label": "upsert", - "description": [ - "If specified, will be used to perform an upsert if the object doesn't exist" - ], + "label": "searchArgsToSOFindOptions", + "description": [], "signature": [ - "Attributes | undefined" + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.SearchArgsToSOFindOptions", + "text": "SearchArgsToSOFindOptions" + }, + " | undefined" ], - "path": "packages/kbn-content-management-utils/src/types.ts", + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/content-management-utils", - "id": "def-common.SavedObjectUpdateOptions.retryOnConflict", - "type": "number", + "id": "def-common.SOContentStorageConstrutorParams.enableMSearch", + "type": "CompoundType", "tags": [], - "label": "retryOnConflict", - "description": [ - "\nThe Elasticsearch `retry_on_conflict` setting for this operation.\nDefaults to `0` when `version` is provided, `3` otherwise." - ], + "label": "enableMSearch", + "description": [], "signature": [ - "number | undefined" + "boolean | undefined" ], - "path": "packages/kbn-content-management-utils/src/types.ts", + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", "deprecated": false, "trackAdoption": false } @@ -1475,6 +2841,45 @@ ], "enums": [], "misc": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CreateArgsToSoCreateOptions", + "type": "Type", + "tags": [], + "label": "CreateArgsToSoCreateOptions", + "description": [], + "signature": [ + "(params: Types[\"CreateOptions\"]) => ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + } + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.CreateArgsToSoCreateOptions.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Types[\"CreateOptions\"]" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/content-management-utils", "id": "def-common.GetResultSO", @@ -1491,6 +2896,116 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SearchArgsToSOFindOptions", + "type": "Type", + "tags": [], + "label": "SearchArgsToSOFindOptions", + "description": [], + "signature": [ + "(params: Types[\"SearchIn\"]) => ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + } + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SearchArgsToSOFindOptions.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Types[\"SearchIn\"]" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.SOWithMetadataPartial", + "type": "Type", + "tags": [], + "label": "SOWithMetadataPartial", + "description": [], + "signature": [ + "Omit<", + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.SOWithMetadata", + "text": "SOWithMetadata" + }, + ", \"references\" | \"attributes\"> & { attributes: Partial; references: ", + { + "pluginId": "@kbn/content-management-utils", + "scope": "common", + "docId": "kibKbnContentManagementUtilsPluginApi", + "section": "def-common.Reference", + "text": "Reference" + }, + "[] | undefined; }" + ], + "path": "packages/kbn-content-management-utils/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.UpdateArgsToSoUpdateOptions", + "type": "Type", + "tags": [], + "label": "UpdateArgsToSoUpdateOptions", + "description": [], + "signature": [ + "(params: Types[\"UpdateOptions\"]) => ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + "" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/content-management-utils", + "id": "def-common.UpdateArgsToSoUpdateOptions.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Types[\"UpdateOptions\"]" + ], + "path": "packages/kbn-content-management-utils/src/saved_object_content_storage.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false } ], "objects": [ diff --git a/api_docs/kbn_content_management_utils.mdx b/api_docs/kbn_content_management_utils.mdx index 821c626f9118d..56191f0bb8962 100644 --- a/api_docs/kbn_content_management_utils.mdx +++ b/api_docs/kbn_content_management_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-utils title: "@kbn/content-management-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-utils'] --- import kbnContentManagementUtilsObj from './kbn_content_management_utils.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 106 | 1 | 57 | 0 | +| 177 | 1 | 112 | 0 | ## Common @@ -31,6 +31,9 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k ### Functions +### Classes + + ### Interfaces diff --git a/api_docs/kbn_core_analytics_browser.mdx b/api_docs/kbn_core_analytics_browser.mdx index d803e274fcfc0..c0b14dc90e016 100644 --- a/api_docs/kbn_core_analytics_browser.mdx +++ b/api_docs/kbn_core_analytics_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser title: "@kbn/core-analytics-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser'] --- import kbnCoreAnalyticsBrowserObj from './kbn_core_analytics_browser.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_browser_internal.mdx b/api_docs/kbn_core_analytics_browser_internal.mdx index c9cf2752e7f8a..195d69d32b31d 100644 --- a/api_docs/kbn_core_analytics_browser_internal.mdx +++ b/api_docs/kbn_core_analytics_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-internal title: "@kbn/core-analytics-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-browser-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-internal'] --- import kbnCoreAnalyticsBrowserInternalObj from './kbn_core_analytics_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_browser_mocks.mdx b/api_docs/kbn_core_analytics_browser_mocks.mdx index 375b556e56d5b..0c3a72112becd 100644 --- a/api_docs/kbn_core_analytics_browser_mocks.mdx +++ b/api_docs/kbn_core_analytics_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-mocks title: "@kbn/core-analytics-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-mocks'] --- import kbnCoreAnalyticsBrowserMocksObj from './kbn_core_analytics_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_server.mdx b/api_docs/kbn_core_analytics_server.mdx index 666e28ba9a85e..2ee69c15989ec 100644 --- a/api_docs/kbn_core_analytics_server.mdx +++ b/api_docs/kbn_core_analytics_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server title: "@kbn/core-analytics-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server'] --- import kbnCoreAnalyticsServerObj from './kbn_core_analytics_server.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_server_internal.mdx b/api_docs/kbn_core_analytics_server_internal.mdx index 5b373ab1bffc4..4e8a318f1d065 100644 --- a/api_docs/kbn_core_analytics_server_internal.mdx +++ b/api_docs/kbn_core_analytics_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-internal title: "@kbn/core-analytics-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-internal'] --- import kbnCoreAnalyticsServerInternalObj from './kbn_core_analytics_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_server_mocks.mdx b/api_docs/kbn_core_analytics_server_mocks.mdx index 82ac382ba4b0e..929d3924360ea 100644 --- a/api_docs/kbn_core_analytics_server_mocks.mdx +++ b/api_docs/kbn_core_analytics_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-mocks title: "@kbn/core-analytics-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-mocks'] --- import kbnCoreAnalyticsServerMocksObj from './kbn_core_analytics_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_application_browser.mdx b/api_docs/kbn_core_application_browser.mdx index 53f0a918309c3..1f69429c61da4 100644 --- a/api_docs/kbn_core_application_browser.mdx +++ b/api_docs/kbn_core_application_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser title: "@kbn/core-application-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-browser'] --- import kbnCoreApplicationBrowserObj from './kbn_core_application_browser.devdocs.json'; diff --git a/api_docs/kbn_core_application_browser_internal.mdx b/api_docs/kbn_core_application_browser_internal.mdx index 107c1e2d9f7cb..5ea0c762dbd4b 100644 --- a/api_docs/kbn_core_application_browser_internal.mdx +++ b/api_docs/kbn_core_application_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser-internal title: "@kbn/core-application-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-browser-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-browser-internal'] --- import kbnCoreApplicationBrowserInternalObj from './kbn_core_application_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_application_browser_mocks.mdx b/api_docs/kbn_core_application_browser_mocks.mdx index 94284557a0cfa..04889e77f04fc 100644 --- a/api_docs/kbn_core_application_browser_mocks.mdx +++ b/api_docs/kbn_core_application_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser-mocks title: "@kbn/core-application-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-browser-mocks'] --- import kbnCoreApplicationBrowserMocksObj from './kbn_core_application_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_application_common.mdx b/api_docs/kbn_core_application_common.mdx index 6751acf659e3f..993c03955d7a8 100644 --- a/api_docs/kbn_core_application_common.mdx +++ b/api_docs/kbn_core_application_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-common title: "@kbn/core-application-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-common plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-common'] --- import kbnCoreApplicationCommonObj from './kbn_core_application_common.devdocs.json'; diff --git a/api_docs/kbn_core_apps_browser_internal.mdx b/api_docs/kbn_core_apps_browser_internal.mdx index d5b8324a30e1c..772d4021fb2cb 100644 --- a/api_docs/kbn_core_apps_browser_internal.mdx +++ b/api_docs/kbn_core_apps_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-browser-internal title: "@kbn/core-apps-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-apps-browser-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-browser-internal'] --- import kbnCoreAppsBrowserInternalObj from './kbn_core_apps_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_apps_browser_mocks.mdx b/api_docs/kbn_core_apps_browser_mocks.mdx index 1f60a473221a7..a4d90fc388049 100644 --- a/api_docs/kbn_core_apps_browser_mocks.mdx +++ b/api_docs/kbn_core_apps_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-browser-mocks title: "@kbn/core-apps-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-apps-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-browser-mocks'] --- import kbnCoreAppsBrowserMocksObj from './kbn_core_apps_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_apps_server_internal.mdx b/api_docs/kbn_core_apps_server_internal.mdx index 26cf3e6ee4b87..19c98045fb43b 100644 --- a/api_docs/kbn_core_apps_server_internal.mdx +++ b/api_docs/kbn_core_apps_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-server-internal title: "@kbn/core-apps-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-apps-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-server-internal'] --- import kbnCoreAppsServerInternalObj from './kbn_core_apps_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_base_browser_mocks.mdx b/api_docs/kbn_core_base_browser_mocks.mdx index 18e486520408b..4f49e31172e80 100644 --- a/api_docs/kbn_core_base_browser_mocks.mdx +++ b/api_docs/kbn_core_base_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-browser-mocks title: "@kbn/core-base-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-browser-mocks'] --- import kbnCoreBaseBrowserMocksObj from './kbn_core_base_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_base_common.mdx b/api_docs/kbn_core_base_common.mdx index fe8b39045e238..56cbc8628b64e 100644 --- a/api_docs/kbn_core_base_common.mdx +++ b/api_docs/kbn_core_base_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-common title: "@kbn/core-base-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-common plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-common'] --- import kbnCoreBaseCommonObj from './kbn_core_base_common.devdocs.json'; diff --git a/api_docs/kbn_core_base_server_internal.mdx b/api_docs/kbn_core_base_server_internal.mdx index c21cbe6a338d8..35283ce8163d1 100644 --- a/api_docs/kbn_core_base_server_internal.mdx +++ b/api_docs/kbn_core_base_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-internal title: "@kbn/core-base-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-internal'] --- import kbnCoreBaseServerInternalObj from './kbn_core_base_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_base_server_mocks.mdx b/api_docs/kbn_core_base_server_mocks.mdx index 06ac046d9c20f..0207fdbb18ae0 100644 --- a/api_docs/kbn_core_base_server_mocks.mdx +++ b/api_docs/kbn_core_base_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-mocks title: "@kbn/core-base-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-mocks'] --- import kbnCoreBaseServerMocksObj from './kbn_core_base_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_capabilities_browser_mocks.mdx b/api_docs/kbn_core_capabilities_browser_mocks.mdx index 0360e83604006..1ad533c490d9d 100644 --- a/api_docs/kbn_core_capabilities_browser_mocks.mdx +++ b/api_docs/kbn_core_capabilities_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-browser-mocks title: "@kbn/core-capabilities-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-browser-mocks'] --- import kbnCoreCapabilitiesBrowserMocksObj from './kbn_core_capabilities_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_capabilities_common.mdx b/api_docs/kbn_core_capabilities_common.mdx index 955f42bfe88e8..74c0797e6c260 100644 --- a/api_docs/kbn_core_capabilities_common.mdx +++ b/api_docs/kbn_core_capabilities_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-common title: "@kbn/core-capabilities-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-common plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-common'] --- import kbnCoreCapabilitiesCommonObj from './kbn_core_capabilities_common.devdocs.json'; diff --git a/api_docs/kbn_core_capabilities_server.mdx b/api_docs/kbn_core_capabilities_server.mdx index 923d1079d28bb..d939240a94800 100644 --- a/api_docs/kbn_core_capabilities_server.mdx +++ b/api_docs/kbn_core_capabilities_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-server title: "@kbn/core-capabilities-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-server'] --- import kbnCoreCapabilitiesServerObj from './kbn_core_capabilities_server.devdocs.json'; diff --git a/api_docs/kbn_core_capabilities_server_mocks.mdx b/api_docs/kbn_core_capabilities_server_mocks.mdx index 709722c529b2c..92b5702f317a8 100644 --- a/api_docs/kbn_core_capabilities_server_mocks.mdx +++ b/api_docs/kbn_core_capabilities_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-server-mocks title: "@kbn/core-capabilities-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-server-mocks'] --- import kbnCoreCapabilitiesServerMocksObj from './kbn_core_capabilities_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_chrome_browser.mdx b/api_docs/kbn_core_chrome_browser.mdx index 5ef595e8b5825..458d19257f844 100644 --- a/api_docs/kbn_core_chrome_browser.mdx +++ b/api_docs/kbn_core_chrome_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-chrome-browser title: "@kbn/core-chrome-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-chrome-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-chrome-browser'] --- import kbnCoreChromeBrowserObj from './kbn_core_chrome_browser.devdocs.json'; diff --git a/api_docs/kbn_core_chrome_browser_mocks.mdx b/api_docs/kbn_core_chrome_browser_mocks.mdx index 3487c007b95a0..82323394d99b8 100644 --- a/api_docs/kbn_core_chrome_browser_mocks.mdx +++ b/api_docs/kbn_core_chrome_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-chrome-browser-mocks title: "@kbn/core-chrome-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-chrome-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-chrome-browser-mocks'] --- import kbnCoreChromeBrowserMocksObj from './kbn_core_chrome_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_config_server_internal.mdx b/api_docs/kbn_core_config_server_internal.mdx index bfd672b25eef9..dff018d5e19c4 100644 --- a/api_docs/kbn_core_config_server_internal.mdx +++ b/api_docs/kbn_core_config_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-config-server-internal title: "@kbn/core-config-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-config-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-config-server-internal'] --- import kbnCoreConfigServerInternalObj from './kbn_core_config_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_browser.mdx b/api_docs/kbn_core_custom_branding_browser.mdx index fe904128a3be2..2166f046a4f9c 100644 --- a/api_docs/kbn_core_custom_branding_browser.mdx +++ b/api_docs/kbn_core_custom_branding_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser title: "@kbn/core-custom-branding-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-browser'] --- import kbnCoreCustomBrandingBrowserObj from './kbn_core_custom_branding_browser.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_browser_internal.mdx b/api_docs/kbn_core_custom_branding_browser_internal.mdx index e17f1451f9607..fab2f25bb8e95 100644 --- a/api_docs/kbn_core_custom_branding_browser_internal.mdx +++ b/api_docs/kbn_core_custom_branding_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser-internal title: "@kbn/core-custom-branding-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-browser-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-browser-internal'] --- import kbnCoreCustomBrandingBrowserInternalObj from './kbn_core_custom_branding_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_browser_mocks.mdx b/api_docs/kbn_core_custom_branding_browser_mocks.mdx index e35d737e68433..ad93f90d8eee8 100644 --- a/api_docs/kbn_core_custom_branding_browser_mocks.mdx +++ b/api_docs/kbn_core_custom_branding_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser-mocks title: "@kbn/core-custom-branding-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-browser-mocks'] --- import kbnCoreCustomBrandingBrowserMocksObj from './kbn_core_custom_branding_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_common.mdx b/api_docs/kbn_core_custom_branding_common.mdx index b80426269e78f..28e5ab4162354 100644 --- a/api_docs/kbn_core_custom_branding_common.mdx +++ b/api_docs/kbn_core_custom_branding_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-common title: "@kbn/core-custom-branding-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-common plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-common'] --- import kbnCoreCustomBrandingCommonObj from './kbn_core_custom_branding_common.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_server.mdx b/api_docs/kbn_core_custom_branding_server.mdx index ca8f0201ade80..f166508fea355 100644 --- a/api_docs/kbn_core_custom_branding_server.mdx +++ b/api_docs/kbn_core_custom_branding_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server title: "@kbn/core-custom-branding-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-server'] --- import kbnCoreCustomBrandingServerObj from './kbn_core_custom_branding_server.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_server_internal.mdx b/api_docs/kbn_core_custom_branding_server_internal.mdx index ba3e924682934..33d1ffcc3a1f7 100644 --- a/api_docs/kbn_core_custom_branding_server_internal.mdx +++ b/api_docs/kbn_core_custom_branding_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server-internal title: "@kbn/core-custom-branding-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-server-internal'] --- import kbnCoreCustomBrandingServerInternalObj from './kbn_core_custom_branding_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_server_mocks.mdx b/api_docs/kbn_core_custom_branding_server_mocks.mdx index 80487cdcfbbbc..ac624b7ec7875 100644 --- a/api_docs/kbn_core_custom_branding_server_mocks.mdx +++ b/api_docs/kbn_core_custom_branding_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server-mocks title: "@kbn/core-custom-branding-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-server-mocks'] --- import kbnCoreCustomBrandingServerMocksObj from './kbn_core_custom_branding_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_browser.mdx b/api_docs/kbn_core_deprecations_browser.mdx index ad529266563b4..52d524d943a09 100644 --- a/api_docs/kbn_core_deprecations_browser.mdx +++ b/api_docs/kbn_core_deprecations_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser title: "@kbn/core-deprecations-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser'] --- import kbnCoreDeprecationsBrowserObj from './kbn_core_deprecations_browser.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_browser_internal.mdx b/api_docs/kbn_core_deprecations_browser_internal.mdx index a6ed53f82151f..6b7fd33f1482b 100644 --- a/api_docs/kbn_core_deprecations_browser_internal.mdx +++ b/api_docs/kbn_core_deprecations_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser-internal title: "@kbn/core-deprecations-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-browser-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser-internal'] --- import kbnCoreDeprecationsBrowserInternalObj from './kbn_core_deprecations_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_browser_mocks.mdx b/api_docs/kbn_core_deprecations_browser_mocks.mdx index 9f68b3b5494eb..46452a488f4bc 100644 --- a/api_docs/kbn_core_deprecations_browser_mocks.mdx +++ b/api_docs/kbn_core_deprecations_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser-mocks title: "@kbn/core-deprecations-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser-mocks'] --- import kbnCoreDeprecationsBrowserMocksObj from './kbn_core_deprecations_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_common.mdx b/api_docs/kbn_core_deprecations_common.mdx index 08a4a7a344eee..a4d5302b320ba 100644 --- a/api_docs/kbn_core_deprecations_common.mdx +++ b/api_docs/kbn_core_deprecations_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-common title: "@kbn/core-deprecations-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-common plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-common'] --- import kbnCoreDeprecationsCommonObj from './kbn_core_deprecations_common.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_server.mdx b/api_docs/kbn_core_deprecations_server.mdx index eaa2f07a6eacf..c685458a5cdb5 100644 --- a/api_docs/kbn_core_deprecations_server.mdx +++ b/api_docs/kbn_core_deprecations_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server title: "@kbn/core-deprecations-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-server'] --- import kbnCoreDeprecationsServerObj from './kbn_core_deprecations_server.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_server_internal.mdx b/api_docs/kbn_core_deprecations_server_internal.mdx index efc96cf779b39..2a7736a6bb603 100644 --- a/api_docs/kbn_core_deprecations_server_internal.mdx +++ b/api_docs/kbn_core_deprecations_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server-internal title: "@kbn/core-deprecations-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-server-internal'] --- import kbnCoreDeprecationsServerInternalObj from './kbn_core_deprecations_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_server_mocks.mdx b/api_docs/kbn_core_deprecations_server_mocks.mdx index 873ddb2039dea..7596e734660d3 100644 --- a/api_docs/kbn_core_deprecations_server_mocks.mdx +++ b/api_docs/kbn_core_deprecations_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server-mocks title: "@kbn/core-deprecations-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-server-mocks'] --- import kbnCoreDeprecationsServerMocksObj from './kbn_core_deprecations_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_doc_links_browser.mdx b/api_docs/kbn_core_doc_links_browser.mdx index b676c19a517a7..d22076db023d0 100644 --- a/api_docs/kbn_core_doc_links_browser.mdx +++ b/api_docs/kbn_core_doc_links_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser title: "@kbn/core-doc-links-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser'] --- import kbnCoreDocLinksBrowserObj from './kbn_core_doc_links_browser.devdocs.json'; diff --git a/api_docs/kbn_core_doc_links_browser_mocks.mdx b/api_docs/kbn_core_doc_links_browser_mocks.mdx index 31a6b294bf3ef..c687f4ab05542 100644 --- a/api_docs/kbn_core_doc_links_browser_mocks.mdx +++ b/api_docs/kbn_core_doc_links_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser-mocks title: "@kbn/core-doc-links-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser-mocks'] --- import kbnCoreDocLinksBrowserMocksObj from './kbn_core_doc_links_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_doc_links_server.mdx b/api_docs/kbn_core_doc_links_server.mdx index aef2fe10ac742..40d7af3bf40c8 100644 --- a/api_docs/kbn_core_doc_links_server.mdx +++ b/api_docs/kbn_core_doc_links_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server title: "@kbn/core-doc-links-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server'] --- import kbnCoreDocLinksServerObj from './kbn_core_doc_links_server.devdocs.json'; diff --git a/api_docs/kbn_core_doc_links_server_mocks.mdx b/api_docs/kbn_core_doc_links_server_mocks.mdx index 4a52c23cb4e7b..61e6fee4c6941 100644 --- a/api_docs/kbn_core_doc_links_server_mocks.mdx +++ b/api_docs/kbn_core_doc_links_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server-mocks title: "@kbn/core-doc-links-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server-mocks'] --- import kbnCoreDocLinksServerMocksObj from './kbn_core_doc_links_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_client_server_internal.mdx b/api_docs/kbn_core_elasticsearch_client_server_internal.mdx index c8b352a1c0135..9fdb8793f21e1 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_internal.mdx +++ b/api_docs/kbn_core_elasticsearch_client_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-client-server-internal title: "@kbn/core-elasticsearch-client-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-client-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-client-server-internal'] --- import kbnCoreElasticsearchClientServerInternalObj from './kbn_core_elasticsearch_client_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx index 8bceb83e1d325..98cb57323bfe6 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx +++ b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-client-server-mocks title: "@kbn/core-elasticsearch-client-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-client-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-client-server-mocks'] --- import kbnCoreElasticsearchClientServerMocksObj from './kbn_core_elasticsearch_client_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_server.mdx b/api_docs/kbn_core_elasticsearch_server.mdx index a90a4d9659458..2c29cbb48de29 100644 --- a/api_docs/kbn_core_elasticsearch_server.mdx +++ b/api_docs/kbn_core_elasticsearch_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server title: "@kbn/core-elasticsearch-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server'] --- import kbnCoreElasticsearchServerObj from './kbn_core_elasticsearch_server.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_server_internal.mdx b/api_docs/kbn_core_elasticsearch_server_internal.mdx index 8a1c9c5d6ec25..8e46c69073c65 100644 --- a/api_docs/kbn_core_elasticsearch_server_internal.mdx +++ b/api_docs/kbn_core_elasticsearch_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server-internal title: "@kbn/core-elasticsearch-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server-internal'] --- import kbnCoreElasticsearchServerInternalObj from './kbn_core_elasticsearch_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_server_mocks.mdx index 00557081ae341..001b86846199b 100644 --- a/api_docs/kbn_core_elasticsearch_server_mocks.mdx +++ b/api_docs/kbn_core_elasticsearch_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server-mocks title: "@kbn/core-elasticsearch-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server-mocks'] --- import kbnCoreElasticsearchServerMocksObj from './kbn_core_elasticsearch_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_environment_server_internal.mdx b/api_docs/kbn_core_environment_server_internal.mdx index c858e2c9560fe..a9cbb7d3afb46 100644 --- a/api_docs/kbn_core_environment_server_internal.mdx +++ b/api_docs/kbn_core_environment_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-internal title: "@kbn/core-environment-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-environment-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-internal'] --- import kbnCoreEnvironmentServerInternalObj from './kbn_core_environment_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_environment_server_mocks.mdx b/api_docs/kbn_core_environment_server_mocks.mdx index f10eedfd90ef0..6d03fdceb81e0 100644 --- a/api_docs/kbn_core_environment_server_mocks.mdx +++ b/api_docs/kbn_core_environment_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-mocks title: "@kbn/core-environment-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-environment-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-mocks'] --- import kbnCoreEnvironmentServerMocksObj from './kbn_core_environment_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_browser.mdx b/api_docs/kbn_core_execution_context_browser.mdx index 88314bf7f5703..00fcea3b7dcc0 100644 --- a/api_docs/kbn_core_execution_context_browser.mdx +++ b/api_docs/kbn_core_execution_context_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser title: "@kbn/core-execution-context-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser'] --- import kbnCoreExecutionContextBrowserObj from './kbn_core_execution_context_browser.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_browser_internal.mdx b/api_docs/kbn_core_execution_context_browser_internal.mdx index a8aad1cb53d3f..1916246834de9 100644 --- a/api_docs/kbn_core_execution_context_browser_internal.mdx +++ b/api_docs/kbn_core_execution_context_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-internal title: "@kbn/core-execution-context-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-browser-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-internal'] --- import kbnCoreExecutionContextBrowserInternalObj from './kbn_core_execution_context_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_browser_mocks.mdx b/api_docs/kbn_core_execution_context_browser_mocks.mdx index f8e90f271b8c2..a7ff90becaf36 100644 --- a/api_docs/kbn_core_execution_context_browser_mocks.mdx +++ b/api_docs/kbn_core_execution_context_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-mocks title: "@kbn/core-execution-context-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-mocks'] --- import kbnCoreExecutionContextBrowserMocksObj from './kbn_core_execution_context_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_common.mdx b/api_docs/kbn_core_execution_context_common.mdx index f9a1b1beddabc..8d07ce97eaf79 100644 --- a/api_docs/kbn_core_execution_context_common.mdx +++ b/api_docs/kbn_core_execution_context_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-common title: "@kbn/core-execution-context-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-common plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-common'] --- import kbnCoreExecutionContextCommonObj from './kbn_core_execution_context_common.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_server.mdx b/api_docs/kbn_core_execution_context_server.mdx index 59f1708743673..6d832fa1611b8 100644 --- a/api_docs/kbn_core_execution_context_server.mdx +++ b/api_docs/kbn_core_execution_context_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server title: "@kbn/core-execution-context-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server'] --- import kbnCoreExecutionContextServerObj from './kbn_core_execution_context_server.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_server_internal.mdx b/api_docs/kbn_core_execution_context_server_internal.mdx index 4dda136e8cd9a..2520296877662 100644 --- a/api_docs/kbn_core_execution_context_server_internal.mdx +++ b/api_docs/kbn_core_execution_context_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-internal title: "@kbn/core-execution-context-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-internal'] --- import kbnCoreExecutionContextServerInternalObj from './kbn_core_execution_context_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_server_mocks.mdx b/api_docs/kbn_core_execution_context_server_mocks.mdx index 58a297bc31f85..c94303d1aa110 100644 --- a/api_docs/kbn_core_execution_context_server_mocks.mdx +++ b/api_docs/kbn_core_execution_context_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-mocks title: "@kbn/core-execution-context-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-mocks'] --- import kbnCoreExecutionContextServerMocksObj from './kbn_core_execution_context_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_fatal_errors_browser.mdx b/api_docs/kbn_core_fatal_errors_browser.mdx index c74461455bce9..c6147bff23671 100644 --- a/api_docs/kbn_core_fatal_errors_browser.mdx +++ b/api_docs/kbn_core_fatal_errors_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser title: "@kbn/core-fatal-errors-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-fatal-errors-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-browser'] --- import kbnCoreFatalErrorsBrowserObj from './kbn_core_fatal_errors_browser.devdocs.json'; diff --git a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx index d5312ea51964d..a1591010389a2 100644 --- a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx +++ b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser-mocks title: "@kbn/core-fatal-errors-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-fatal-errors-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-browser-mocks'] --- import kbnCoreFatalErrorsBrowserMocksObj from './kbn_core_fatal_errors_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_browser.mdx b/api_docs/kbn_core_http_browser.mdx index ade19d1171e40..0774046a60ee5 100644 --- a/api_docs/kbn_core_http_browser.mdx +++ b/api_docs/kbn_core_http_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser title: "@kbn/core-http-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser'] --- import kbnCoreHttpBrowserObj from './kbn_core_http_browser.devdocs.json'; diff --git a/api_docs/kbn_core_http_browser_internal.mdx b/api_docs/kbn_core_http_browser_internal.mdx index b3dcabf4c970e..85f67fb7ef902 100644 --- a/api_docs/kbn_core_http_browser_internal.mdx +++ b/api_docs/kbn_core_http_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser-internal title: "@kbn/core-http-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-browser-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-internal'] --- import kbnCoreHttpBrowserInternalObj from './kbn_core_http_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_browser_mocks.mdx b/api_docs/kbn_core_http_browser_mocks.mdx index 267a844c71bc7..88d998f2c8bac 100644 --- a/api_docs/kbn_core_http_browser_mocks.mdx +++ b/api_docs/kbn_core_http_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser-mocks title: "@kbn/core-http-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-mocks'] --- import kbnCoreHttpBrowserMocksObj from './kbn_core_http_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_common.mdx b/api_docs/kbn_core_http_common.mdx index fbcc40e455f32..5c2fec3ca9e93 100644 --- a/api_docs/kbn_core_http_common.mdx +++ b/api_docs/kbn_core_http_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-common title: "@kbn/core-http-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-common plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-common'] --- import kbnCoreHttpCommonObj from './kbn_core_http_common.devdocs.json'; diff --git a/api_docs/kbn_core_http_context_server_mocks.mdx b/api_docs/kbn_core_http_context_server_mocks.mdx index 57cdf7072c8d0..cb28d1b8325ef 100644 --- a/api_docs/kbn_core_http_context_server_mocks.mdx +++ b/api_docs/kbn_core_http_context_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-context-server-mocks title: "@kbn/core-http-context-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-context-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-context-server-mocks'] --- import kbnCoreHttpContextServerMocksObj from './kbn_core_http_context_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_request_handler_context_server.mdx b/api_docs/kbn_core_http_request_handler_context_server.mdx index 9c8811cc5e288..522f6dc913030 100644 --- a/api_docs/kbn_core_http_request_handler_context_server.mdx +++ b/api_docs/kbn_core_http_request_handler_context_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-request-handler-context-server title: "@kbn/core-http-request-handler-context-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-request-handler-context-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-request-handler-context-server'] --- import kbnCoreHttpRequestHandlerContextServerObj from './kbn_core_http_request_handler_context_server.devdocs.json'; diff --git a/api_docs/kbn_core_http_resources_server.mdx b/api_docs/kbn_core_http_resources_server.mdx index a66e5fd100f7d..2e822c7dd4e5a 100644 --- a/api_docs/kbn_core_http_resources_server.mdx +++ b/api_docs/kbn_core_http_resources_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server title: "@kbn/core-http-resources-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-resources-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-resources-server'] --- import kbnCoreHttpResourcesServerObj from './kbn_core_http_resources_server.devdocs.json'; diff --git a/api_docs/kbn_core_http_resources_server_internal.mdx b/api_docs/kbn_core_http_resources_server_internal.mdx index 609e0ff58d856..f4c7c935e3ed8 100644 --- a/api_docs/kbn_core_http_resources_server_internal.mdx +++ b/api_docs/kbn_core_http_resources_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server-internal title: "@kbn/core-http-resources-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-resources-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-resources-server-internal'] --- import kbnCoreHttpResourcesServerInternalObj from './kbn_core_http_resources_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_resources_server_mocks.mdx b/api_docs/kbn_core_http_resources_server_mocks.mdx index 137ce57a963cf..fc261ba42e60e 100644 --- a/api_docs/kbn_core_http_resources_server_mocks.mdx +++ b/api_docs/kbn_core_http_resources_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server-mocks title: "@kbn/core-http-resources-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-resources-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-resources-server-mocks'] --- import kbnCoreHttpResourcesServerMocksObj from './kbn_core_http_resources_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_router_server_internal.mdx b/api_docs/kbn_core_http_router_server_internal.mdx index c8829115c110f..4493956abc81e 100644 --- a/api_docs/kbn_core_http_router_server_internal.mdx +++ b/api_docs/kbn_core_http_router_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-router-server-internal title: "@kbn/core-http-router-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-router-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-router-server-internal'] --- import kbnCoreHttpRouterServerInternalObj from './kbn_core_http_router_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_router_server_mocks.mdx b/api_docs/kbn_core_http_router_server_mocks.mdx index ea977bbaa2654..7c99ed5ec5800 100644 --- a/api_docs/kbn_core_http_router_server_mocks.mdx +++ b/api_docs/kbn_core_http_router_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-router-server-mocks title: "@kbn/core-http-router-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-router-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-router-server-mocks'] --- import kbnCoreHttpRouterServerMocksObj from './kbn_core_http_router_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_server.devdocs.json b/api_docs/kbn_core_http_server.devdocs.json index c2cb299143bbe..c5f8e23d2140a 100644 --- a/api_docs/kbn_core_http_server.devdocs.json +++ b/api_docs/kbn_core_http_server.devdocs.json @@ -2689,6 +2689,49 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-common.IHttpEluMonitorConfig", + "type": "Interface", + "tags": [], + "label": "IHttpEluMonitorConfig", + "description": [ + "\nHTTP request ELU monitor config" + ], + "path": "packages/core/http/core-http-server/src/elu_monitor.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-common.IHttpEluMonitorConfig.enabled", + "type": "boolean", + "tags": [], + "label": "enabled", + "description": [ + "\nWhether the monitoring of event loop utilization for HTTP requests is enabled." + ], + "path": "packages/core/http/core-http-server/src/elu_monitor.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-common.IHttpEluMonitorConfig.logging", + "type": "Object", + "tags": [], + "label": "logging", + "description": [], + "signature": [ + "{ readonly enabled: boolean; readonly threshold: { readonly elu: number; readonly ela: number; }; }" + ], + "path": "packages/core/http/core-http-server/src/elu_monitor.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-http-server", "id": "def-common.IKibanaResponse", @@ -5065,6 +5108,22 @@ "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-common.KibanaRequestState.measureElu", + "type": "Function", + "tags": [], + "label": "measureElu", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/kbn_core_http_server.mdx b/api_docs/kbn_core_http_server.mdx index 8899766b60987..f26ead2df5c42 100644 --- a/api_docs/kbn_core_http_server.mdx +++ b/api_docs/kbn_core_http_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server title: "@kbn/core-http-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server'] --- import kbnCoreHttpServerObj from './kbn_core_http_server.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 440 | 1 | 176 | 0 | +| 444 | 1 | 178 | 0 | ## Common diff --git a/api_docs/kbn_core_http_server_internal.devdocs.json b/api_docs/kbn_core_http_server_internal.devdocs.json index 10c1e0de34015..5ab81378db238 100644 --- a/api_docs/kbn_core_http_server_internal.devdocs.json +++ b/api_docs/kbn_core_http_server_internal.devdocs.json @@ -535,6 +535,26 @@ "path": "packages/core/http/core-http-server-internal/src/http_config.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-http-server-internal", + "id": "def-common.HttpConfig.eluMonitor", + "type": "Object", + "tags": [], + "label": "eluMonitor", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "common", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-common.IHttpEluMonitorConfig", + "text": "IHttpEluMonitorConfig" + } + ], + "path": "packages/core/http/core-http-server-internal/src/http_config.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -881,7 +901,7 @@ "section": "def-common.ByteSizeValue", "text": "ByteSizeValue" }, - "; readonly rewriteBasePath: boolean; readonly keepaliveTimeout: number; readonly socketTimeout: number; readonly xsrf: Readonly<{} & { disableProtection: boolean; allowlist: string[]; }>; readonly requestId: Readonly<{} & { allowFromAnyIp: boolean; ipAllowlist: string[]; }>; readonly restrictInternalApis: boolean; }" + "; readonly rewriteBasePath: boolean; readonly keepaliveTimeout: number; readonly socketTimeout: number; readonly xsrf: Readonly<{} & { disableProtection: boolean; allowlist: string[]; }>; readonly eluMonitor: Readonly<{} & { enabled: boolean; logging: Readonly<{} & { enabled: boolean; threshold: Readonly<{} & { elu: number; ela: number; }>; }>; }>; readonly requestId: Readonly<{} & { allowFromAnyIp: boolean; ipAllowlist: string[]; }>; readonly restrictInternalApis: boolean; }" ], "path": "packages/core/http/core-http-server-internal/src/http_config.ts", "deprecated": false, diff --git a/api_docs/kbn_core_http_server_internal.mdx b/api_docs/kbn_core_http_server_internal.mdx index dc7b86b0b60e5..32ee7694283a6 100644 --- a/api_docs/kbn_core_http_server_internal.mdx +++ b/api_docs/kbn_core_http_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server-internal title: "@kbn/core-http-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server-internal'] --- import kbnCoreHttpServerInternalObj from './kbn_core_http_server_internal.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 56 | 0 | 50 | 6 | +| 57 | 0 | 51 | 6 | ## Common diff --git a/api_docs/kbn_core_http_server_mocks.mdx b/api_docs/kbn_core_http_server_mocks.mdx index da38c28701354..e088e3569d237 100644 --- a/api_docs/kbn_core_http_server_mocks.mdx +++ b/api_docs/kbn_core_http_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server-mocks title: "@kbn/core-http-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server-mocks'] --- import kbnCoreHttpServerMocksObj from './kbn_core_http_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_browser.mdx b/api_docs/kbn_core_i18n_browser.mdx index aec54dd82b672..a5a3392a7b761 100644 --- a/api_docs/kbn_core_i18n_browser.mdx +++ b/api_docs/kbn_core_i18n_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser title: "@kbn/core-i18n-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser'] --- import kbnCoreI18nBrowserObj from './kbn_core_i18n_browser.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_browser_mocks.mdx b/api_docs/kbn_core_i18n_browser_mocks.mdx index 51da02006c848..dda09ae3767a9 100644 --- a/api_docs/kbn_core_i18n_browser_mocks.mdx +++ b/api_docs/kbn_core_i18n_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser-mocks title: "@kbn/core-i18n-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser-mocks'] --- import kbnCoreI18nBrowserMocksObj from './kbn_core_i18n_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_server.mdx b/api_docs/kbn_core_i18n_server.mdx index e7233f7caa8d7..210b164f40921 100644 --- a/api_docs/kbn_core_i18n_server.mdx +++ b/api_docs/kbn_core_i18n_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server title: "@kbn/core-i18n-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server'] --- import kbnCoreI18nServerObj from './kbn_core_i18n_server.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_server_internal.mdx b/api_docs/kbn_core_i18n_server_internal.mdx index 81baa069b2d53..90687e16b8a55 100644 --- a/api_docs/kbn_core_i18n_server_internal.mdx +++ b/api_docs/kbn_core_i18n_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server-internal title: "@kbn/core-i18n-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server-internal'] --- import kbnCoreI18nServerInternalObj from './kbn_core_i18n_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_server_mocks.mdx b/api_docs/kbn_core_i18n_server_mocks.mdx index dc48f1dc133d4..9ae2bb8a1a1c2 100644 --- a/api_docs/kbn_core_i18n_server_mocks.mdx +++ b/api_docs/kbn_core_i18n_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server-mocks title: "@kbn/core-i18n-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server-mocks'] --- import kbnCoreI18nServerMocksObj from './kbn_core_i18n_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx index ddb392b791ad2..9b7aee88f0b27 100644 --- a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx +++ b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser-mocks title: "@kbn/core-injected-metadata-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-injected-metadata-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser-mocks'] --- import kbnCoreInjectedMetadataBrowserMocksObj from './kbn_core_injected_metadata_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_integrations_browser_internal.mdx b/api_docs/kbn_core_integrations_browser_internal.mdx index 850604c29cfbf..161979092fcc7 100644 --- a/api_docs/kbn_core_integrations_browser_internal.mdx +++ b/api_docs/kbn_core_integrations_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-integrations-browser-internal title: "@kbn/core-integrations-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-integrations-browser-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-integrations-browser-internal'] --- import kbnCoreIntegrationsBrowserInternalObj from './kbn_core_integrations_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_integrations_browser_mocks.mdx b/api_docs/kbn_core_integrations_browser_mocks.mdx index 309fa28863b77..60486a5d532b4 100644 --- a/api_docs/kbn_core_integrations_browser_mocks.mdx +++ b/api_docs/kbn_core_integrations_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-integrations-browser-mocks title: "@kbn/core-integrations-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-integrations-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-integrations-browser-mocks'] --- import kbnCoreIntegrationsBrowserMocksObj from './kbn_core_integrations_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_browser.devdocs.json b/api_docs/kbn_core_lifecycle_browser.devdocs.json index 1cc2ffe7326c0..6a76c5c95593d 100644 --- a/api_docs/kbn_core_lifecycle_browser.devdocs.json +++ b/api_docs/kbn_core_lifecycle_browser.devdocs.json @@ -677,10 +677,6 @@ "plugin": "monitoring", "path": "x-pack/plugins/monitoring/public/application/pages/elasticsearch/ingest_pipeline_modal.tsx" }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/common/monitor_filters/use_filters.ts" - }, { "plugin": "synthetics", "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_selector/use_recently_viewed_monitors.ts" diff --git a/api_docs/kbn_core_lifecycle_browser.mdx b/api_docs/kbn_core_lifecycle_browser.mdx index 654ef77892cd3..05028d3220d8d 100644 --- a/api_docs/kbn_core_lifecycle_browser.mdx +++ b/api_docs/kbn_core_lifecycle_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-browser title: "@kbn/core-lifecycle-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-browser'] --- import kbnCoreLifecycleBrowserObj from './kbn_core_lifecycle_browser.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_browser_mocks.mdx b/api_docs/kbn_core_lifecycle_browser_mocks.mdx index 5b72a22f2c00f..84bdfbc9cadc5 100644 --- a/api_docs/kbn_core_lifecycle_browser_mocks.mdx +++ b/api_docs/kbn_core_lifecycle_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-browser-mocks title: "@kbn/core-lifecycle-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-browser-mocks'] --- import kbnCoreLifecycleBrowserMocksObj from './kbn_core_lifecycle_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_server.mdx b/api_docs/kbn_core_lifecycle_server.mdx index ed7bf9b6ebcde..1c95dfbbccff1 100644 --- a/api_docs/kbn_core_lifecycle_server.mdx +++ b/api_docs/kbn_core_lifecycle_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-server title: "@kbn/core-lifecycle-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-server'] --- import kbnCoreLifecycleServerObj from './kbn_core_lifecycle_server.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_server_mocks.mdx b/api_docs/kbn_core_lifecycle_server_mocks.mdx index 83bddf413c7b6..059a10b87df3e 100644 --- a/api_docs/kbn_core_lifecycle_server_mocks.mdx +++ b/api_docs/kbn_core_lifecycle_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-server-mocks title: "@kbn/core-lifecycle-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-server-mocks'] --- import kbnCoreLifecycleServerMocksObj from './kbn_core_lifecycle_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_logging_browser_mocks.mdx b/api_docs/kbn_core_logging_browser_mocks.mdx index ab18f62c40755..fd985fb515663 100644 --- a/api_docs/kbn_core_logging_browser_mocks.mdx +++ b/api_docs/kbn_core_logging_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-browser-mocks title: "@kbn/core-logging-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-browser-mocks'] --- import kbnCoreLoggingBrowserMocksObj from './kbn_core_logging_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_logging_common_internal.mdx b/api_docs/kbn_core_logging_common_internal.mdx index f1783eef591e8..5bc591b3cc7f0 100644 --- a/api_docs/kbn_core_logging_common_internal.mdx +++ b/api_docs/kbn_core_logging_common_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-common-internal title: "@kbn/core-logging-common-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-common-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-common-internal'] --- import kbnCoreLoggingCommonInternalObj from './kbn_core_logging_common_internal.devdocs.json'; diff --git a/api_docs/kbn_core_logging_server.mdx b/api_docs/kbn_core_logging_server.mdx index 197e85d31466a..f6b7c9c0fe060 100644 --- a/api_docs/kbn_core_logging_server.mdx +++ b/api_docs/kbn_core_logging_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server title: "@kbn/core-logging-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server'] --- import kbnCoreLoggingServerObj from './kbn_core_logging_server.devdocs.json'; diff --git a/api_docs/kbn_core_logging_server_internal.mdx b/api_docs/kbn_core_logging_server_internal.mdx index 6afd80453160c..4a4e46400d3e3 100644 --- a/api_docs/kbn_core_logging_server_internal.mdx +++ b/api_docs/kbn_core_logging_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-internal title: "@kbn/core-logging-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-internal'] --- import kbnCoreLoggingServerInternalObj from './kbn_core_logging_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_logging_server_mocks.mdx b/api_docs/kbn_core_logging_server_mocks.mdx index c0c56eb04919a..2b6053dc1b3a3 100644 --- a/api_docs/kbn_core_logging_server_mocks.mdx +++ b/api_docs/kbn_core_logging_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-mocks title: "@kbn/core-logging-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-mocks'] --- import kbnCoreLoggingServerMocksObj from './kbn_core_logging_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_collectors_server_internal.mdx b/api_docs/kbn_core_metrics_collectors_server_internal.mdx index d5f498d2a2bc0..9a7d063468a51 100644 --- a/api_docs/kbn_core_metrics_collectors_server_internal.mdx +++ b/api_docs/kbn_core_metrics_collectors_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-collectors-server-internal title: "@kbn/core-metrics-collectors-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-collectors-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-collectors-server-internal'] --- import kbnCoreMetricsCollectorsServerInternalObj from './kbn_core_metrics_collectors_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_collectors_server_mocks.mdx b/api_docs/kbn_core_metrics_collectors_server_mocks.mdx index 6c5d68617ab01..b91fa2582c885 100644 --- a/api_docs/kbn_core_metrics_collectors_server_mocks.mdx +++ b/api_docs/kbn_core_metrics_collectors_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-collectors-server-mocks title: "@kbn/core-metrics-collectors-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-collectors-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-collectors-server-mocks'] --- import kbnCoreMetricsCollectorsServerMocksObj from './kbn_core_metrics_collectors_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_server.mdx b/api_docs/kbn_core_metrics_server.mdx index 848bf24c5cdc8..7b5da51240408 100644 --- a/api_docs/kbn_core_metrics_server.mdx +++ b/api_docs/kbn_core_metrics_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server title: "@kbn/core-metrics-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server'] --- import kbnCoreMetricsServerObj from './kbn_core_metrics_server.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_server_internal.mdx b/api_docs/kbn_core_metrics_server_internal.mdx index 105dbfb2e8a33..42cb6be2e3e0c 100644 --- a/api_docs/kbn_core_metrics_server_internal.mdx +++ b/api_docs/kbn_core_metrics_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server-internal title: "@kbn/core-metrics-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server-internal'] --- import kbnCoreMetricsServerInternalObj from './kbn_core_metrics_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_server_mocks.mdx b/api_docs/kbn_core_metrics_server_mocks.mdx index 6ac4d287cf8b4..02ba3ccabd7ee 100644 --- a/api_docs/kbn_core_metrics_server_mocks.mdx +++ b/api_docs/kbn_core_metrics_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server-mocks title: "@kbn/core-metrics-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server-mocks'] --- import kbnCoreMetricsServerMocksObj from './kbn_core_metrics_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_mount_utils_browser.mdx b/api_docs/kbn_core_mount_utils_browser.mdx index dc738e5200e21..cd8a11c8cc905 100644 --- a/api_docs/kbn_core_mount_utils_browser.mdx +++ b/api_docs/kbn_core_mount_utils_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-mount-utils-browser title: "@kbn/core-mount-utils-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-mount-utils-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-mount-utils-browser'] --- import kbnCoreMountUtilsBrowserObj from './kbn_core_mount_utils_browser.devdocs.json'; diff --git a/api_docs/kbn_core_node_server.mdx b/api_docs/kbn_core_node_server.mdx index dfde6079d5574..827ac3b86ac4a 100644 --- a/api_docs/kbn_core_node_server.mdx +++ b/api_docs/kbn_core_node_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server title: "@kbn/core-node-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-node-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server'] --- import kbnCoreNodeServerObj from './kbn_core_node_server.devdocs.json'; diff --git a/api_docs/kbn_core_node_server_internal.mdx b/api_docs/kbn_core_node_server_internal.mdx index 6e70d30bd37a3..217fb96bca5af 100644 --- a/api_docs/kbn_core_node_server_internal.mdx +++ b/api_docs/kbn_core_node_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-internal title: "@kbn/core-node-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-node-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-internal'] --- import kbnCoreNodeServerInternalObj from './kbn_core_node_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_node_server_mocks.mdx b/api_docs/kbn_core_node_server_mocks.mdx index b3b908ae8309b..a32d75d5aa389 100644 --- a/api_docs/kbn_core_node_server_mocks.mdx +++ b/api_docs/kbn_core_node_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-mocks title: "@kbn/core-node-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-node-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-mocks'] --- import kbnCoreNodeServerMocksObj from './kbn_core_node_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_notifications_browser.mdx b/api_docs/kbn_core_notifications_browser.mdx index 6f4ad2901c159..3f075e6f7857c 100644 --- a/api_docs/kbn_core_notifications_browser.mdx +++ b/api_docs/kbn_core_notifications_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser title: "@kbn/core-notifications-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-notifications-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-notifications-browser'] --- import kbnCoreNotificationsBrowserObj from './kbn_core_notifications_browser.devdocs.json'; diff --git a/api_docs/kbn_core_notifications_browser_internal.mdx b/api_docs/kbn_core_notifications_browser_internal.mdx index 1eb861c0f9e44..56bbb11f5546e 100644 --- a/api_docs/kbn_core_notifications_browser_internal.mdx +++ b/api_docs/kbn_core_notifications_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser-internal title: "@kbn/core-notifications-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-notifications-browser-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-notifications-browser-internal'] --- import kbnCoreNotificationsBrowserInternalObj from './kbn_core_notifications_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_notifications_browser_mocks.mdx b/api_docs/kbn_core_notifications_browser_mocks.mdx index 47d951d3b7370..ea0eac15dfdcd 100644 --- a/api_docs/kbn_core_notifications_browser_mocks.mdx +++ b/api_docs/kbn_core_notifications_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser-mocks title: "@kbn/core-notifications-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-notifications-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-notifications-browser-mocks'] --- import kbnCoreNotificationsBrowserMocksObj from './kbn_core_notifications_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_overlays_browser.mdx b/api_docs/kbn_core_overlays_browser.mdx index 84912738d2b0f..6de19c20387f5 100644 --- a/api_docs/kbn_core_overlays_browser.mdx +++ b/api_docs/kbn_core_overlays_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser title: "@kbn/core-overlays-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-overlays-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-overlays-browser'] --- import kbnCoreOverlaysBrowserObj from './kbn_core_overlays_browser.devdocs.json'; diff --git a/api_docs/kbn_core_overlays_browser_internal.mdx b/api_docs/kbn_core_overlays_browser_internal.mdx index 5cc32b132e1b7..3e09e6792d356 100644 --- a/api_docs/kbn_core_overlays_browser_internal.mdx +++ b/api_docs/kbn_core_overlays_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser-internal title: "@kbn/core-overlays-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-overlays-browser-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-overlays-browser-internal'] --- import kbnCoreOverlaysBrowserInternalObj from './kbn_core_overlays_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_overlays_browser_mocks.mdx b/api_docs/kbn_core_overlays_browser_mocks.mdx index a7fb1a06a8097..76e5171c899fc 100644 --- a/api_docs/kbn_core_overlays_browser_mocks.mdx +++ b/api_docs/kbn_core_overlays_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser-mocks title: "@kbn/core-overlays-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-overlays-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-overlays-browser-mocks'] --- import kbnCoreOverlaysBrowserMocksObj from './kbn_core_overlays_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_browser.mdx b/api_docs/kbn_core_plugins_browser.mdx index 00945cdc047d3..8a62e99754d23 100644 --- a/api_docs/kbn_core_plugins_browser.mdx +++ b/api_docs/kbn_core_plugins_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-browser title: "@kbn/core-plugins-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-browser'] --- import kbnCorePluginsBrowserObj from './kbn_core_plugins_browser.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_browser_mocks.mdx b/api_docs/kbn_core_plugins_browser_mocks.mdx index a8cd31b53caad..72a2e7c0a86f5 100644 --- a/api_docs/kbn_core_plugins_browser_mocks.mdx +++ b/api_docs/kbn_core_plugins_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-browser-mocks title: "@kbn/core-plugins-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-browser-mocks'] --- import kbnCorePluginsBrowserMocksObj from './kbn_core_plugins_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_server.mdx b/api_docs/kbn_core_plugins_server.mdx index 098e23da919f2..815a1dfafa101 100644 --- a/api_docs/kbn_core_plugins_server.mdx +++ b/api_docs/kbn_core_plugins_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-server title: "@kbn/core-plugins-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-server'] --- import kbnCorePluginsServerObj from './kbn_core_plugins_server.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_server_mocks.mdx b/api_docs/kbn_core_plugins_server_mocks.mdx index c63e3f3f96504..12d9d9af991f0 100644 --- a/api_docs/kbn_core_plugins_server_mocks.mdx +++ b/api_docs/kbn_core_plugins_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-server-mocks title: "@kbn/core-plugins-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-server-mocks'] --- import kbnCorePluginsServerMocksObj from './kbn_core_plugins_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_preboot_server.mdx b/api_docs/kbn_core_preboot_server.mdx index d306582a58e8c..9812f2d4e7660 100644 --- a/api_docs/kbn_core_preboot_server.mdx +++ b/api_docs/kbn_core_preboot_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-preboot-server title: "@kbn/core-preboot-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-preboot-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server'] --- import kbnCorePrebootServerObj from './kbn_core_preboot_server.devdocs.json'; diff --git a/api_docs/kbn_core_preboot_server_mocks.mdx b/api_docs/kbn_core_preboot_server_mocks.mdx index 2d6ffa83279c8..d7db6134fd73c 100644 --- a/api_docs/kbn_core_preboot_server_mocks.mdx +++ b/api_docs/kbn_core_preboot_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-preboot-server-mocks title: "@kbn/core-preboot-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-preboot-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server-mocks'] --- import kbnCorePrebootServerMocksObj from './kbn_core_preboot_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_rendering_browser_mocks.mdx b/api_docs/kbn_core_rendering_browser_mocks.mdx index 1a4c7f498b407..d6f17a5a6c367 100644 --- a/api_docs/kbn_core_rendering_browser_mocks.mdx +++ b/api_docs/kbn_core_rendering_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-browser-mocks title: "@kbn/core-rendering-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-rendering-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-rendering-browser-mocks'] --- import kbnCoreRenderingBrowserMocksObj from './kbn_core_rendering_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_rendering_server_internal.mdx b/api_docs/kbn_core_rendering_server_internal.mdx index d03e92a72dcec..a3202148a94d9 100644 --- a/api_docs/kbn_core_rendering_server_internal.mdx +++ b/api_docs/kbn_core_rendering_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-server-internal title: "@kbn/core-rendering-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-rendering-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-rendering-server-internal'] --- import kbnCoreRenderingServerInternalObj from './kbn_core_rendering_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_rendering_server_mocks.mdx b/api_docs/kbn_core_rendering_server_mocks.mdx index aa703854fbde7..9c93b4e3bc2b5 100644 --- a/api_docs/kbn_core_rendering_server_mocks.mdx +++ b/api_docs/kbn_core_rendering_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-server-mocks title: "@kbn/core-rendering-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-rendering-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-rendering-server-mocks'] --- import kbnCoreRenderingServerMocksObj from './kbn_core_rendering_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_root_server_internal.mdx b/api_docs/kbn_core_root_server_internal.mdx index 89ada4c4b9360..ec5f14d71af2a 100644 --- a/api_docs/kbn_core_root_server_internal.mdx +++ b/api_docs/kbn_core_root_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-root-server-internal title: "@kbn/core-root-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-root-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-root-server-internal'] --- import kbnCoreRootServerInternalObj from './kbn_core_root_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_api_browser.devdocs.json b/api_docs/kbn_core_saved_objects_api_browser.devdocs.json index 84c6911dd2f32..48f45f4599674 100644 --- a/api_docs/kbn_core_saved_objects_api_browser.devdocs.json +++ b/api_docs/kbn_core_saved_objects_api_browser.devdocs.json @@ -1787,10 +1787,6 @@ "plugin": "@kbn/core-saved-objects-browser-mocks", "path": "packages/core/saved-objects/core-saved-objects-browser-mocks/src/saved_objects_service.mock.ts" }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/settings/global_params/delete_param.tsx" - }, { "plugin": "@kbn/core-saved-objects-browser-internal", "path": "packages/core/saved-objects/core-saved-objects-browser-internal/src/saved_objects_client.ts" @@ -1959,10 +1955,6 @@ "plugin": "graph", "path": "x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts" }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/common/monitor_filters/use_filters.ts" - }, { "plugin": "synthetics", "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/settings/private_locations/hooks/use_location_monitors.ts" @@ -1979,14 +1971,6 @@ "plugin": "ml", "path": "x-pack/plugins/ml/public/application/services/dashboard_service.test.ts" }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/common/monitor_filters/use_filters.test.ts" - }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/common/monitor_filters/use_filters.test.ts" - }, { "plugin": "savedObjects", "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" diff --git a/api_docs/kbn_core_saved_objects_api_browser.mdx b/api_docs/kbn_core_saved_objects_api_browser.mdx index 8912bacb162c4..dcfe5029e2c1c 100644 --- a/api_docs/kbn_core_saved_objects_api_browser.mdx +++ b/api_docs/kbn_core_saved_objects_api_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-browser title: "@kbn/core-saved-objects-api-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-browser'] --- import kbnCoreSavedObjectsApiBrowserObj from './kbn_core_saved_objects_api_browser.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_api_server.mdx b/api_docs/kbn_core_saved_objects_api_server.mdx index 88fc4efc03ef5..cd5867be855c3 100644 --- a/api_docs/kbn_core_saved_objects_api_server.mdx +++ b/api_docs/kbn_core_saved_objects_api_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server title: "@kbn/core-saved-objects-api-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-server'] --- import kbnCoreSavedObjectsApiServerObj from './kbn_core_saved_objects_api_server.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_api_server_mocks.mdx b/api_docs/kbn_core_saved_objects_api_server_mocks.mdx index 13e294d8fca83..ebdbb365a8282 100644 --- a/api_docs/kbn_core_saved_objects_api_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_api_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server-mocks title: "@kbn/core-saved-objects-api-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-server-mocks'] --- import kbnCoreSavedObjectsApiServerMocksObj from './kbn_core_saved_objects_api_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_base_server_internal.devdocs.json b/api_docs/kbn_core_saved_objects_base_server_internal.devdocs.json index 0df63b7a92fb8..84d650339af37 100644 --- a/api_docs/kbn_core_saved_objects_base_server_internal.devdocs.json +++ b/api_docs/kbn_core_saved_objects_base_server_internal.devdocs.json @@ -356,6 +356,55 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/core-saved-objects-base-server-internal", + "id": "def-common.convertModelVersionBackwardConversionSchema", + "type": "Function", + "tags": [], + "label": "convertModelVersionBackwardConversionSchema", + "description": [], + "signature": [ + "(schema: ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectModelVersionForwardCompatibilitySchema", + "text": "SavedObjectModelVersionForwardCompatibilitySchema" + }, + ") => ", + "ConvertedSchema" + ], + "path": "packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/backward_conversion_schema.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-base-server-internal", + "id": "def-common.convertModelVersionBackwardConversionSchema.$1", + "type": "CompoundType", + "tags": [], + "label": "schema", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectModelVersionForwardCompatibilitySchema", + "text": "SavedObjectModelVersionForwardCompatibilitySchema" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/backward_conversion_schema.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-saved-objects-base-server-internal", "id": "def-common.decodeRequestVersion", diff --git a/api_docs/kbn_core_saved_objects_base_server_internal.mdx b/api_docs/kbn_core_saved_objects_base_server_internal.mdx index 7534e45428b5c..143fdf4c0e7cb 100644 --- a/api_docs/kbn_core_saved_objects_base_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_base_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-base-server-internal title: "@kbn/core-saved-objects-base-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-base-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-base-server-internal'] --- import kbnCoreSavedObjectsBaseServerInternalObj from './kbn_core_saved_objects_base_server_internal.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 83 | 0 | 57 | 9 | +| 85 | 0 | 59 | 11 | ## Common diff --git a/api_docs/kbn_core_saved_objects_base_server_mocks.mdx b/api_docs/kbn_core_saved_objects_base_server_mocks.mdx index b7c8d09ae7219..9b3beb6cf77c5 100644 --- a/api_docs/kbn_core_saved_objects_base_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_base_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-base-server-mocks title: "@kbn/core-saved-objects-base-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-base-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-base-server-mocks'] --- import kbnCoreSavedObjectsBaseServerMocksObj from './kbn_core_saved_objects_base_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_browser.mdx b/api_docs/kbn_core_saved_objects_browser.mdx index 2fe8071707758..3aba0017169f0 100644 --- a/api_docs/kbn_core_saved_objects_browser.mdx +++ b/api_docs/kbn_core_saved_objects_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser title: "@kbn/core-saved-objects-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser'] --- import kbnCoreSavedObjectsBrowserObj from './kbn_core_saved_objects_browser.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_browser_internal.mdx b/api_docs/kbn_core_saved_objects_browser_internal.mdx index 3f1b2388131c8..a8b94bcc2c027 100644 --- a/api_docs/kbn_core_saved_objects_browser_internal.mdx +++ b/api_docs/kbn_core_saved_objects_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser-internal title: "@kbn/core-saved-objects-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-browser-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser-internal'] --- import kbnCoreSavedObjectsBrowserInternalObj from './kbn_core_saved_objects_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_browser_mocks.mdx b/api_docs/kbn_core_saved_objects_browser_mocks.mdx index 5c9cec1554413..129c4071a1e5f 100644 --- a/api_docs/kbn_core_saved_objects_browser_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser-mocks title: "@kbn/core-saved-objects-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser-mocks'] --- import kbnCoreSavedObjectsBrowserMocksObj from './kbn_core_saved_objects_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_common.devdocs.json b/api_docs/kbn_core_saved_objects_common.devdocs.json index c67aaf197d228..7bafa56049214 100644 --- a/api_docs/kbn_core_saved_objects_common.devdocs.json +++ b/api_docs/kbn_core_saved_objects_common.devdocs.json @@ -1753,50 +1753,6 @@ "plugin": "synthetics", "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/index.ts" }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, { "plugin": "@kbn/core-saved-objects-browser-internal", "path": "packages/core/saved-objects/core-saved-objects-browser-internal/src/simple_saved_object.test.ts" @@ -2017,19 +1973,19 @@ }, { "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx" + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" }, { "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx" + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" }, { "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx" }, { "plugin": "visualizations", - "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx" }, { "plugin": "dashboard", @@ -2047,14 +2003,6 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/common/types/models/epm.ts" }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/common/types/models/settings.ts" - }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/common/types/models/settings.ts" - }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/shareable_runtime/types.ts" @@ -3198,14 +3146,6 @@ "plugin": "infra", "path": "x-pack/plugins/infra/public/common/visualizations/types.ts" }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/user_actions/test_utils.ts" - }, { "plugin": "infra", "path": "x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_references_manager.test.ts" diff --git a/api_docs/kbn_core_saved_objects_common.mdx b/api_docs/kbn_core_saved_objects_common.mdx index d3224ae25b7f5..bd7dc3851c6da 100644 --- a/api_docs/kbn_core_saved_objects_common.mdx +++ b/api_docs/kbn_core_saved_objects_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-common title: "@kbn/core-saved-objects-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-common plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-common'] --- import kbnCoreSavedObjectsCommonObj from './kbn_core_saved_objects_common.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx b/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx index 9a1af624b3bfe..413372478cfe4 100644 --- a/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-import-export-server-internal title: "@kbn/core-saved-objects-import-export-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-import-export-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-import-export-server-internal'] --- import kbnCoreSavedObjectsImportExportServerInternalObj from './kbn_core_saved_objects_import_export_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx b/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx index 4388a52c18e46..97fd25812bbe2 100644 --- a/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-import-export-server-mocks title: "@kbn/core-saved-objects-import-export-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-import-export-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-import-export-server-mocks'] --- import kbnCoreSavedObjectsImportExportServerMocksObj from './kbn_core_saved_objects_import_export_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_migration_server_internal.devdocs.json b/api_docs/kbn_core_saved_objects_migration_server_internal.devdocs.json index f1fbe10296e72..0aff378016fae 100644 --- a/api_docs/kbn_core_saved_objects_migration_server_internal.devdocs.json +++ b/api_docs/kbn_core_saved_objects_migration_server_internal.devdocs.json @@ -25,7 +25,7 @@ "tags": [], "label": "DocumentMigrator", "description": [ - "\nA concrete implementation of the VersionedTransformer interface." + "\nA concrete implementation of the {@link VersionedTransformer} interface." ], "signature": [ { @@ -83,14 +83,15 @@ }, { "parentPluginId": "@kbn/core-saved-objects-migration-server-internal", - "id": "def-common.DocumentMigrator.migrationVersion", - "type": "Object", + "id": "def-common.DocumentMigrator.getMigrationVersion", + "type": "Function", "tags": [], - "label": "migrationVersion", + "label": "getMigrationVersion", "description": [ - "\nGets the latest version of each migrate-able property." + "\nGets the latest pending version of each type.\nSome migration objects won't have a latest migration version (they only contain reference transforms that are applied from other types)." ], "signature": [ + "({ includeDeferred, migrationType, }?: MigrationVersionParams) => ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", @@ -101,7 +102,25 @@ ], "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-migration-server-internal", + "id": "def-common.DocumentMigrator.getMigrationVersion.$1", + "type": "Object", + "tags": [], + "label": "{\n includeDeferred = true,\n migrationType = 'type',\n }", + "description": [], + "signature": [ + "MigrationVersionParams" + ], + "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/core-saved-objects-migration-server-internal", @@ -139,7 +158,9 @@ "section": "def-common.SavedObjectUnsanitizedDoc", "text": "SavedObjectUnsanitizedDoc" }, - ") => ", + ", { allowDowngrade }?: ", + "DocumentMigrateOptions", + ") => ", { "pluginId": "@kbn/core-saved-objects-server", "scope": "common", @@ -174,58 +195,16 @@ "deprecated": false, "trackAdoption": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/core-saved-objects-migration-server-internal", - "id": "def-common.DocumentMigrator.migrateAndConvert", - "type": "Function", - "tags": [], - "label": "migrateAndConvert", - "description": [ - "\nMigrates a document to the latest version and applies type conversions if applicable. Also returns any additional document(s) that may\nhave been created during the transformation process." - ], - "signature": [ - "(doc: ", - { - "pluginId": "@kbn/core-saved-objects-server", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsServerPluginApi", - "section": "def-common.SavedObjectUnsanitizedDoc", - "text": "SavedObjectUnsanitizedDoc" }, - ") => ", - { - "pluginId": "@kbn/core-saved-objects-server", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsServerPluginApi", - "section": "def-common.SavedObjectUnsanitizedDoc", - "text": "SavedObjectUnsanitizedDoc" - }, - "[]" - ], - "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "@kbn/core-saved-objects-migration-server-internal", - "id": "def-common.DocumentMigrator.migrateAndConvert.$1", - "type": "CompoundType", + "id": "def-common.DocumentMigrator.migrate.$2", + "type": "Object", "tags": [], - "label": "doc", + "label": "{ allowDowngrade = false }", "description": [], "signature": [ - { - "pluginId": "@kbn/core-saved-objects-server", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsServerPluginApi", - "section": "def-common.SavedObjectUnsanitizedDoc", - "text": "SavedObjectUnsanitizedDoc" - }, - "" + "DocumentMigrateOptions" ], "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.ts", "deprecated": false, @@ -237,11 +216,13 @@ }, { "parentPluginId": "@kbn/core-saved-objects-migration-server-internal", - "id": "def-common.DocumentMigrator.transformDown", + "id": "def-common.DocumentMigrator.migrateAndConvert", "type": "Function", "tags": [], - "label": "transformDown", - "description": [], + "label": "migrateAndConvert", + "description": [ + "\nMigrates a document to the latest version and applies type conversions if applicable. Also returns any additional document(s) that may\nhave been created during the transformation process." + ], "signature": [ "(doc: ", { @@ -251,7 +232,7 @@ "section": "def-common.SavedObjectUnsanitizedDoc", "text": "SavedObjectUnsanitizedDoc" }, - ", options: { targetTypeVersion: string; }) => ", + ") => ", { "pluginId": "@kbn/core-saved-objects-server", "scope": "common", @@ -259,7 +240,7 @@ "section": "def-common.SavedObjectUnsanitizedDoc", "text": "SavedObjectUnsanitizedDoc" }, - "" + "[]" ], "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.ts", "deprecated": false, @@ -267,7 +248,7 @@ "children": [ { "parentPluginId": "@kbn/core-saved-objects-migration-server-internal", - "id": "def-common.DocumentMigrator.transformDown.$1", + "id": "def-common.DocumentMigrator.migrateAndConvert.$1", "type": "CompoundType", "tags": [], "label": "doc", @@ -286,30 +267,6 @@ "deprecated": false, "trackAdoption": false, "isRequired": true - }, - { - "parentPluginId": "@kbn/core-saved-objects-migration-server-internal", - "id": "def-common.DocumentMigrator.transformDown.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/core-saved-objects-migration-server-internal", - "id": "def-common.DocumentMigrator.transformDown.$2.targetTypeVersion", - "type": "string", - "tags": [], - "label": "targetTypeVersion", - "description": [], - "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.ts", - "deprecated": false, - "trackAdoption": false - } - ] } ], "returnComment": [] @@ -507,7 +464,9 @@ "section": "def-common.SavedObjectUnsanitizedDoc", "text": "SavedObjectUnsanitizedDoc" }, - ") => ", + ", { allowDowngrade }?: ", + "MigrateDocumentOptions", + ") => ", { "pluginId": "@kbn/core-saved-objects-server", "scope": "common", @@ -542,6 +501,21 @@ "deprecated": false, "trackAdoption": false, "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-migration-server-internal", + "id": "def-common.KibanaMigrator.migrateDocument.$2", + "type": "Object", + "tags": [], + "label": "{ allowDowngrade = false }", + "description": [], + "signature": [ + "MigrateDocumentOptions" + ], + "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/kibana_migrator.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true } ], "returnComment": [] @@ -1370,7 +1344,7 @@ "section": "def-common.ElasticsearchClient", "text": "ElasticsearchClient" }, - ", index: string) => ", + ", index: string, batchSize: number) => ", "TaskEither", "<", "RetryableEsClientError", @@ -1423,6 +1397,21 @@ "deprecated": false, "trackAdoption": false, "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-migration-server-internal", + "id": "def-common.pickupUpdatedMappings.$3", + "type": "number", + "tags": [], + "label": "batchSize", + "description": [], + "signature": [ + "number" + ], + "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/pickup_updated_mappings.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true } ], "returnComment": [], @@ -1520,7 +1509,7 @@ "\nReindex documents from the `sourceIndex` into the `targetIndex`. Returns a\ntask ID which can be tracked for progress.\n" ], "signature": [ - "({ client, sourceIndex, targetIndex, reindexScript, requireAlias, excludeOnUpgradeQuery, }: ", + "({ client, sourceIndex, targetIndex, reindexScript, requireAlias, excludeOnUpgradeQuery, batchSize, }: ", "ReindexParams", ") => ", "TaskEither", @@ -1539,7 +1528,7 @@ "id": "def-common.reindex.$1", "type": "Object", "tags": [], - "label": "{\n client,\n sourceIndex,\n targetIndex,\n reindexScript,\n requireAlias,\n excludeOnUpgradeQuery,\n }", + "label": "{\n client,\n sourceIndex,\n targetIndex,\n reindexScript,\n requireAlias,\n excludeOnUpgradeQuery,\n batchSize,\n }", "description": [], "signature": [ "ReindexParams" @@ -1747,7 +1736,7 @@ "\nUpdates an index's mappings and runs an pickupUpdatedMappings task so that the mapping\nchanges are \"picked up\". Returns a taskId to track progress." ], "signature": [ - "({ client, index, mappings, }: ", + "({ client, index, mappings, batchSize, }: ", "UpdateAndPickupMappingsParams", ") => ", "TaskEither", @@ -1766,7 +1755,7 @@ "id": "def-common.updateAndPickupMappings.$1", "type": "Object", "tags": [], - "label": "{\n client,\n index,\n mappings,\n}", + "label": "{\n client,\n index,\n mappings,\n batchSize,\n}", "description": [], "signature": [ "UpdateAndPickupMappingsParams" diff --git a/api_docs/kbn_core_saved_objects_migration_server_internal.mdx b/api_docs/kbn_core_saved_objects_migration_server_internal.mdx index 32c19c173aae7..e3a719903da8b 100644 --- a/api_docs/kbn_core_saved_objects_migration_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_migration_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-migration-server-internal title: "@kbn/core-saved-objects-migration-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-migration-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-migration-server-internal'] --- import kbnCoreSavedObjectsMigrationServerInternalObj from './kbn_core_saved_objects_migration_server_internal.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 120 | 0 | 86 | 44 | +| 120 | 0 | 86 | 45 | ## Common diff --git a/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx b/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx index 7ffaabb3f915d..ed231e2c7711b 100644 --- a/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-migration-server-mocks title: "@kbn/core-saved-objects-migration-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-migration-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-migration-server-mocks'] --- import kbnCoreSavedObjectsMigrationServerMocksObj from './kbn_core_saved_objects_migration_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_server.devdocs.json b/api_docs/kbn_core_saved_objects_server.devdocs.json index 4ad48a1f76dc2..e1923cbb9f68d 100644 --- a/api_docs/kbn_core_saved_objects_server.devdocs.json +++ b/api_docs/kbn_core_saved_objects_server.devdocs.json @@ -6581,7 +6581,7 @@ "tags": [], "label": "SavedObjectMigrationMap", "description": [ - "\nA map of {@link SavedObjectMigrationFn | migration functions} to be used for a given type.\nThe map's keys must be valid semver versions, and they cannot exceed the current Kibana version.\n\nFor a given document, only migrations with a higher version number than that of the document will be applied.\nMigrations are executed in order, starting from the lowest version and ending with the highest one.\n" + "\nA map of {@link SavedObjectMigration | migrations} to be used for a given type.\nThe map's keys must be valid semver versions, and they cannot exceed the current Kibana version.\n\nFor a given document, only migrations with a higher version number than that of the document will be applied.\nMigrations are executed in order, starting from the lowest version and ending with the highest one.\n" ], "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", "deprecated": false, @@ -6592,7 +6592,7 @@ "id": "def-common.SavedObjectMigrationMap.Unnamed", "type": "IndexSignature", "tags": [], - "label": "[version: string]: SavedObjectMigrationFn", + "label": "[version: string]: SavedObjectMigration", "description": [], "signature": [ "[version: string]: ", @@ -6600,8 +6600,8 @@ "pluginId": "@kbn/core-saved-objects-server", "scope": "common", "docId": "kibKbnCoreSavedObjectsServerPluginApi", - "section": "def-common.SavedObjectMigrationFn", - "text": "SavedObjectMigrationFn" + "section": "def-common.SavedObjectMigration", + "text": "SavedObjectMigration" }, "" ], @@ -6612,6 +6612,135 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectMigrationParams", + "type": "Interface", + "tags": [], + "label": "SavedObjectMigrationParams", + "description": [ + "\nSaved Objects migration with parameters." + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigrationParams", + "text": "SavedObjectMigrationParams" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectMigrationParams.deferred", + "type": "boolean", + "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" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectMigrationParams.transform", + "type": "Function", + "tags": [], + "label": "transform", + "description": [ + "{@inheritDoc SavedObjectMigrationFn}" + ], + "signature": [ + "(doc: ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectUnsanitizedDoc", + "text": "SavedObjectUnsanitizedDoc" + }, + ", context: ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigrationContext", + "text": "SavedObjectMigrationContext" + }, + ") => ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectUnsanitizedDoc", + "text": "SavedObjectUnsanitizedDoc" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectMigrationParams.transform.$1", + "type": "CompoundType", + "tags": [], + "label": "doc", + "description": [], + "signature": [ + "SavedObjectDoc & { references?: ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[] | undefined; }" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectMigrationParams.transform.$2", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigrationContext", + "text": "SavedObjectMigrationContext" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectModelBidirectionalTransformation", @@ -8066,7 +8195,7 @@ "tags": [], "label": "schemas", "description": [ - "\nThe {@link SavedObjectsModelVersionSchemaDefinitions} associated with this version.\n" + "\nThe {@link SavedObjectsModelVersionSchemaDefinitions | schemas} associated with this version.\n\nSchemas are used to validate / convert the shape and/or content of the documents at various stages of their usages." ], "signature": [ { @@ -8137,20 +8266,22 @@ "children": [ { "parentPluginId": "@kbn/core-saved-objects-server", - "id": "def-common.SavedObjectsModelVersionSchemaDefinitions.create", - "type": "Object", + "id": "def-common.SavedObjectsModelVersionSchemaDefinitions.forwardCompatibility", + "type": "CompoundType", "tags": [], - "label": "create", - "description": [], + "label": "forwardCompatibility", + "description": [ + "\nThe schema applied when retrieving documents of a higher version from the cluster.\nUsed for multi-version compatibility in managed environments.\n\nWhen retrieving a savedObject document from an index, if the version of the document\nis higher than the latest version known of the Kibana instance, the document will go\nthrough the `forwardCompatibility` schema of the associated model version.\n\nE.g a Kibana instance with model version `2` for type `foo` types fetches a `foo` document\nat model version `3`. The document will then go through the `forwardCompatibility`\nof the model version 2 (if present).\n\nSee {@link SavedObjectModelVersionForwardCompatibilitySchema} for more info." + ], "signature": [ { "pluginId": "@kbn/core-saved-objects-server", "scope": "common", "docId": "kibKbnCoreSavedObjectsServerPluginApi", - "section": "def-common.SavedObjectModelVersionCreateSchema", - "text": "SavedObjectModelVersionCreateSchema" + "section": "def-common.SavedObjectModelVersionForwardCompatibilitySchema", + "text": "SavedObjectModelVersionForwardCompatibilitySchema" }, - " | undefined" + " | undefined" ], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/schemas.ts", "deprecated": false, @@ -10150,7 +10281,7 @@ "references": [ { "plugin": "@kbn/core-saved-objects-migration-server-internal", - "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts" + "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/utils.ts" }, { "plugin": "@kbn/core-saved-objects-migration-server-internal", @@ -10162,7 +10293,7 @@ }, { "plugin": "@kbn/core-saved-objects-migration-server-internal", - "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts" + "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts" }, { "plugin": "@kbn/core-saved-objects-migration-server-internal", @@ -10170,7 +10301,7 @@ }, { "plugin": "@kbn/core-saved-objects-migration-server-internal", - "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/utils.ts" + "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts" }, { "plugin": "actions", @@ -10364,10 +10495,6 @@ "plugin": "@kbn/core-saved-objects-migration-server-internal", "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migration.test.ts" }, - { - "plugin": "@kbn/core-saved-objects-migration-server-internal", - "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migration.test.ts" - }, { "plugin": "@kbn/core-saved-objects-migration-server-internal", "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migration.test.ts" @@ -11077,6 +11204,38 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectMigration", + "type": "Type", + "tags": [], + "label": "SavedObjectMigration", + "description": [ + "\nSaved Objects migration.\nIt can be either a {@link SavedObjectMigrationFn | migration function} or a {@link SavedObjectMigrationParams | migration object}." + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigrationFn", + "text": "SavedObjectMigrationFn" + }, + " | ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigrationParams", + "text": "SavedObjectMigrationParams" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectMigrationFn", @@ -11362,11 +11521,47 @@ }, { "parentPluginId": "@kbn/core-saved-objects-server", - "id": "def-common.SavedObjectModelVersionCreateSchema", + "id": "def-common.SavedObjectModelVersionForwardCompatibilityFn", "type": "Type", "tags": [], - "label": "SavedObjectModelVersionCreateSchema", - "description": [], + "label": "SavedObjectModelVersionForwardCompatibilityFn", + "description": [ + "\nPlain javascript function alternative for {@link SavedObjectModelVersionForwardCompatibilitySchema}" + ], + "signature": [ + "(attributes: InAttrs) => OutAttrs" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/schemas.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectModelVersionForwardCompatibilityFn.$1", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "InAttrs" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/schemas.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectModelVersionForwardCompatibilitySchema", + "type": "Type", + "tags": [], + "label": "SavedObjectModelVersionForwardCompatibilitySchema", + "description": [ + "\nSchema used when retrieving a document of a higher version to convert them to the older version.\n\nThese schemas can be defined in multiple ways:\n- A `@kbn/config-schema`'s Object schema, that will receive the document's attributes\n- An arbitrary function that will receive the document's attributes as parameter and should return the converted attributes\n" + ], "signature": [ { "pluginId": "@kbn/config-schema", @@ -11375,7 +11570,15 @@ "section": "def-common.ObjectType", "text": "ObjectType" }, - "" + " | ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectModelVersionForwardCompatibilityFn", + "text": "SavedObjectModelVersionForwardCompatibilityFn" + }, + "" ], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/schemas.ts", "deprecated": false, diff --git a/api_docs/kbn_core_saved_objects_server.mdx b/api_docs/kbn_core_saved_objects_server.mdx index 645150d39a278..ee9ba463d1b3e 100644 --- a/api_docs/kbn_core_saved_objects_server.mdx +++ b/api_docs/kbn_core_saved_objects_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server title: "@kbn/core-saved-objects-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server'] --- import kbnCoreSavedObjectsServerObj from './kbn_core_saved_objects_server.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 525 | 1 | 115 | 4 | +| 533 | 1 | 116 | 4 | ## Common diff --git a/api_docs/kbn_core_saved_objects_server_internal.mdx b/api_docs/kbn_core_saved_objects_server_internal.mdx index 8cfceb9b7f94e..f308570c20460 100644 --- a/api_docs/kbn_core_saved_objects_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server-internal title: "@kbn/core-saved-objects-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server-internal'] --- import kbnCoreSavedObjectsServerInternalObj from './kbn_core_saved_objects_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_server_mocks.mdx b/api_docs/kbn_core_saved_objects_server_mocks.mdx index 7b2dc131b65b4..1c43afccef5ae 100644 --- a/api_docs/kbn_core_saved_objects_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server-mocks title: "@kbn/core-saved-objects-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server-mocks'] --- import kbnCoreSavedObjectsServerMocksObj from './kbn_core_saved_objects_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_utils_server.devdocs.json b/api_docs/kbn_core_saved_objects_utils_server.devdocs.json index 6410d1a27e5ea..a3b2fb6203fb4 100644 --- a/api_docs/kbn_core_saved_objects_utils_server.devdocs.json +++ b/api_docs/kbn_core_saved_objects_utils_server.devdocs.json @@ -284,6 +284,67 @@ "returnComment": [ "The ID of the saved object after it is converted." ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-utils-server", + "id": "def-common.SavedObjectsUtils.getMigrationFunction", + "type": "Function", + "tags": [], + "label": "getMigrationFunction", + "description": [ + "\nGets the transform function from a migration object." + ], + "signature": [ + "(migration: ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigration", + "text": "SavedObjectMigration" + }, + ") => ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigrationFn", + "text": "SavedObjectMigrationFn" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-utils-server/src/saved_objects_utils.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-utils-server", + "id": "def-common.SavedObjectsUtils.getMigrationFunction.$1", + "type": "CompoundType", + "tags": [], + "label": "migration", + "description": [ + "Migration object or a migration function." + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigration", + "text": "SavedObjectMigration" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-utils-server/src/saved_objects_utils.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "A migration function." + ] } ], "initialIsOpen": false @@ -381,7 +442,7 @@ "text": "SavedObjectMigrationMap" } ], - "path": "packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migration_maps.ts", + "path": "packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migrations.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -403,7 +464,7 @@ "text": "SavedObjectMigrationMap" } ], - "path": "packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migration_maps.ts", + "path": "packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migrations.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -426,7 +487,7 @@ "text": "SavedObjectMigrationMap" } ], - "path": "packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migration_maps.ts", + "path": "packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migrations.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -437,6 +498,132 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/core-saved-objects-utils-server", + "id": "def-common.mergeSavedObjectMigrations", + "type": "Function", + "tags": [], + "label": "mergeSavedObjectMigrations", + "description": [ + "\nComposes two migrations into a single migration.\n```\nmergeSavedObjectMigrations(outer, inner) -> (doc, context) => outer(inner(doc, context), context) }\n```\n\nIf at least one of the migrations is not deferred, the composed migration will not be deferred.\n" + ], + "signature": [ + "(outer: ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigration", + "text": "SavedObjectMigration" + }, + ", inner: ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigration", + "text": "SavedObjectMigration" + }, + ", rest: ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigration", + "text": "SavedObjectMigration" + }, + "[]) => ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigration", + "text": "SavedObjectMigration" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migrations.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-utils-server", + "id": "def-common.mergeSavedObjectMigrations.$1", + "type": "CompoundType", + "tags": [], + "label": "outer", + "description": [ + "Wrapping migration." + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigration", + "text": "SavedObjectMigration" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migrations.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-utils-server", + "id": "def-common.mergeSavedObjectMigrations.$2", + "type": "CompoundType", + "tags": [], + "label": "inner", + "description": [ + "Wrapped migration." + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigration", + "text": "SavedObjectMigration" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migrations.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-utils-server", + "id": "def-common.mergeSavedObjectMigrations.$3", + "type": "Array", + "tags": [], + "label": "rest", + "description": [ + "Additional wrapped migrations to compose." + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectMigration", + "text": "SavedObjectMigration" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migrations.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "The composed migration can be either a function or an object depending on the input migrations." + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-saved-objects-utils-server", "id": "def-common.setMapsAreEqual", diff --git a/api_docs/kbn_core_saved_objects_utils_server.mdx b/api_docs/kbn_core_saved_objects_utils_server.mdx index 65a4c31c8356c..ad44bca18ae4c 100644 --- a/api_docs/kbn_core_saved_objects_utils_server.mdx +++ b/api_docs/kbn_core_saved_objects_utils_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-utils-server title: "@kbn/core-saved-objects-utils-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-utils-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-utils-server'] --- import kbnCoreSavedObjectsUtilsServerObj from './kbn_core_saved_objects_utils_server.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 30 | 0 | 6 | 0 | +| 36 | 0 | 6 | 0 | ## Common diff --git a/api_docs/kbn_core_status_common.mdx b/api_docs/kbn_core_status_common.mdx index ae3afd9c11b3d..2b74ae1b3f969 100644 --- a/api_docs/kbn_core_status_common.mdx +++ b/api_docs/kbn_core_status_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-common title: "@kbn/core-status-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-common plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-common'] --- import kbnCoreStatusCommonObj from './kbn_core_status_common.devdocs.json'; diff --git a/api_docs/kbn_core_status_common_internal.mdx b/api_docs/kbn_core_status_common_internal.mdx index b4730f7a9b1bf..e835c531fb027 100644 --- a/api_docs/kbn_core_status_common_internal.mdx +++ b/api_docs/kbn_core_status_common_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-common-internal title: "@kbn/core-status-common-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-common-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-common-internal'] --- import kbnCoreStatusCommonInternalObj from './kbn_core_status_common_internal.devdocs.json'; diff --git a/api_docs/kbn_core_status_server.mdx b/api_docs/kbn_core_status_server.mdx index acb9c2678c0e8..b50ac57a7f430 100644 --- a/api_docs/kbn_core_status_server.mdx +++ b/api_docs/kbn_core_status_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server title: "@kbn/core-status-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server'] --- import kbnCoreStatusServerObj from './kbn_core_status_server.devdocs.json'; diff --git a/api_docs/kbn_core_status_server_internal.mdx b/api_docs/kbn_core_status_server_internal.mdx index f92d3d96e8e7e..af38249d01491 100644 --- a/api_docs/kbn_core_status_server_internal.mdx +++ b/api_docs/kbn_core_status_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server-internal title: "@kbn/core-status-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server-internal'] --- import kbnCoreStatusServerInternalObj from './kbn_core_status_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_status_server_mocks.mdx b/api_docs/kbn_core_status_server_mocks.mdx index 556eb834ea4fd..b0301b21aa5f8 100644 --- a/api_docs/kbn_core_status_server_mocks.mdx +++ b/api_docs/kbn_core_status_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server-mocks title: "@kbn/core-status-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server-mocks'] --- import kbnCoreStatusServerMocksObj from './kbn_core_status_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_deprecations_getters.mdx b/api_docs/kbn_core_test_helpers_deprecations_getters.mdx index 962adf5056240..a84ab13a00288 100644 --- a/api_docs/kbn_core_test_helpers_deprecations_getters.mdx +++ b/api_docs/kbn_core_test_helpers_deprecations_getters.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-deprecations-getters title: "@kbn/core-test-helpers-deprecations-getters" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-deprecations-getters plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-deprecations-getters'] --- import kbnCoreTestHelpersDeprecationsGettersObj from './kbn_core_test_helpers_deprecations_getters.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_http_setup_browser.mdx b/api_docs/kbn_core_test_helpers_http_setup_browser.mdx index ac200dc93eb98..c50b9ffc37ec2 100644 --- a/api_docs/kbn_core_test_helpers_http_setup_browser.mdx +++ b/api_docs/kbn_core_test_helpers_http_setup_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-http-setup-browser title: "@kbn/core-test-helpers-http-setup-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-http-setup-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-http-setup-browser'] --- import kbnCoreTestHelpersHttpSetupBrowserObj from './kbn_core_test_helpers_http_setup_browser.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_kbn_server.mdx b/api_docs/kbn_core_test_helpers_kbn_server.mdx index ac1b363e2bb24..27191fd1afa29 100644 --- a/api_docs/kbn_core_test_helpers_kbn_server.mdx +++ b/api_docs/kbn_core_test_helpers_kbn_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-kbn-server title: "@kbn/core-test-helpers-kbn-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-kbn-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-kbn-server'] --- import kbnCoreTestHelpersKbnServerObj from './kbn_core_test_helpers_kbn_server.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_so_type_serializer.mdx b/api_docs/kbn_core_test_helpers_so_type_serializer.mdx index c5dde3c22c1d3..e3afc78bf0a41 100644 --- a/api_docs/kbn_core_test_helpers_so_type_serializer.mdx +++ b/api_docs/kbn_core_test_helpers_so_type_serializer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-so-type-serializer title: "@kbn/core-test-helpers-so-type-serializer" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-so-type-serializer plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-so-type-serializer'] --- import kbnCoreTestHelpersSoTypeSerializerObj from './kbn_core_test_helpers_so_type_serializer.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_test_utils.mdx b/api_docs/kbn_core_test_helpers_test_utils.mdx index 4989f3703243d..6abd44115a335 100644 --- a/api_docs/kbn_core_test_helpers_test_utils.mdx +++ b/api_docs/kbn_core_test_helpers_test_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-test-utils title: "@kbn/core-test-helpers-test-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-test-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-test-utils'] --- import kbnCoreTestHelpersTestUtilsObj from './kbn_core_test_helpers_test_utils.devdocs.json'; diff --git a/api_docs/kbn_core_theme_browser.mdx b/api_docs/kbn_core_theme_browser.mdx index 7497ce8036506..8a2acba29742f 100644 --- a/api_docs/kbn_core_theme_browser.mdx +++ b/api_docs/kbn_core_theme_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser title: "@kbn/core-theme-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-theme-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser'] --- import kbnCoreThemeBrowserObj from './kbn_core_theme_browser.devdocs.json'; diff --git a/api_docs/kbn_core_theme_browser_internal.mdx b/api_docs/kbn_core_theme_browser_internal.mdx index 60414b8864b48..94b6460a22cac 100644 --- a/api_docs/kbn_core_theme_browser_internal.mdx +++ b/api_docs/kbn_core_theme_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-internal title: "@kbn/core-theme-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-theme-browser-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-internal'] --- import kbnCoreThemeBrowserInternalObj from './kbn_core_theme_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_theme_browser_mocks.mdx b/api_docs/kbn_core_theme_browser_mocks.mdx index 03f47e9d9a669..fc47aecc7c1fa 100644 --- a/api_docs/kbn_core_theme_browser_mocks.mdx +++ b/api_docs/kbn_core_theme_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-mocks title: "@kbn/core-theme-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-theme-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-mocks'] --- import kbnCoreThemeBrowserMocksObj from './kbn_core_theme_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_browser.mdx b/api_docs/kbn_core_ui_settings_browser.mdx index f6ac7bbedaa3b..8bc457586402e 100644 --- a/api_docs/kbn_core_ui_settings_browser.mdx +++ b/api_docs/kbn_core_ui_settings_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser title: "@kbn/core-ui-settings-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser'] --- import kbnCoreUiSettingsBrowserObj from './kbn_core_ui_settings_browser.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_browser_internal.mdx b/api_docs/kbn_core_ui_settings_browser_internal.mdx index 68cbcbf8096c9..f98de61c942f0 100644 --- a/api_docs/kbn_core_ui_settings_browser_internal.mdx +++ b/api_docs/kbn_core_ui_settings_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser-internal title: "@kbn/core-ui-settings-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-browser-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser-internal'] --- import kbnCoreUiSettingsBrowserInternalObj from './kbn_core_ui_settings_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_browser_mocks.mdx b/api_docs/kbn_core_ui_settings_browser_mocks.mdx index 0dc043b58f656..ec4fc93af3ad2 100644 --- a/api_docs/kbn_core_ui_settings_browser_mocks.mdx +++ b/api_docs/kbn_core_ui_settings_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser-mocks title: "@kbn/core-ui-settings-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-browser-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser-mocks'] --- import kbnCoreUiSettingsBrowserMocksObj from './kbn_core_ui_settings_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_common.mdx b/api_docs/kbn_core_ui_settings_common.mdx index 6231b1aa1654f..6a9a8feaa17f0 100644 --- a/api_docs/kbn_core_ui_settings_common.mdx +++ b/api_docs/kbn_core_ui_settings_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-common title: "@kbn/core-ui-settings-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-common plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-common'] --- import kbnCoreUiSettingsCommonObj from './kbn_core_ui_settings_common.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_server.mdx b/api_docs/kbn_core_ui_settings_server.mdx index d6309c816c6c4..0deb7012fbaca 100644 --- a/api_docs/kbn_core_ui_settings_server.mdx +++ b/api_docs/kbn_core_ui_settings_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server title: "@kbn/core-ui-settings-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server'] --- import kbnCoreUiSettingsServerObj from './kbn_core_ui_settings_server.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_server_internal.mdx b/api_docs/kbn_core_ui_settings_server_internal.mdx index 135913566785b..da0197c677985 100644 --- a/api_docs/kbn_core_ui_settings_server_internal.mdx +++ b/api_docs/kbn_core_ui_settings_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server-internal title: "@kbn/core-ui-settings-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server-internal'] --- import kbnCoreUiSettingsServerInternalObj from './kbn_core_ui_settings_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_server_mocks.mdx b/api_docs/kbn_core_ui_settings_server_mocks.mdx index 1ce7afcac925c..e520a3c10dcd9 100644 --- a/api_docs/kbn_core_ui_settings_server_mocks.mdx +++ b/api_docs/kbn_core_ui_settings_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server-mocks title: "@kbn/core-ui-settings-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server-mocks'] --- import kbnCoreUiSettingsServerMocksObj from './kbn_core_ui_settings_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_usage_data_server.mdx b/api_docs/kbn_core_usage_data_server.mdx index 8a05ef39e95d3..596098e68a76d 100644 --- a/api_docs/kbn_core_usage_data_server.mdx +++ b/api_docs/kbn_core_usage_data_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server title: "@kbn/core-usage-data-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-usage-data-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server'] --- import kbnCoreUsageDataServerObj from './kbn_core_usage_data_server.devdocs.json'; diff --git a/api_docs/kbn_core_usage_data_server_internal.mdx b/api_docs/kbn_core_usage_data_server_internal.mdx index d89b1d43fbf47..73f177bfb8e1a 100644 --- a/api_docs/kbn_core_usage_data_server_internal.mdx +++ b/api_docs/kbn_core_usage_data_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server-internal title: "@kbn/core-usage-data-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-usage-data-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server-internal'] --- import kbnCoreUsageDataServerInternalObj from './kbn_core_usage_data_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_usage_data_server_mocks.mdx b/api_docs/kbn_core_usage_data_server_mocks.mdx index b276159095433..54b80d5fd8996 100644 --- a/api_docs/kbn_core_usage_data_server_mocks.mdx +++ b/api_docs/kbn_core_usage_data_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server-mocks title: "@kbn/core-usage-data-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-usage-data-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server-mocks'] --- import kbnCoreUsageDataServerMocksObj from './kbn_core_usage_data_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_user_settings_server.mdx b/api_docs/kbn_core_user_settings_server.mdx index 78c411126831c..e8f94750ec196 100644 --- a/api_docs/kbn_core_user_settings_server.mdx +++ b/api_docs/kbn_core_user_settings_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-settings-server title: "@kbn/core-user-settings-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-settings-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-settings-server'] --- import kbnCoreUserSettingsServerObj from './kbn_core_user_settings_server.devdocs.json'; diff --git a/api_docs/kbn_core_user_settings_server_internal.mdx b/api_docs/kbn_core_user_settings_server_internal.mdx index 4cfef558b8360..a0279df3a4a05 100644 --- a/api_docs/kbn_core_user_settings_server_internal.mdx +++ b/api_docs/kbn_core_user_settings_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-settings-server-internal title: "@kbn/core-user-settings-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-settings-server-internal plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-settings-server-internal'] --- import kbnCoreUserSettingsServerInternalObj from './kbn_core_user_settings_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_user_settings_server_mocks.mdx b/api_docs/kbn_core_user_settings_server_mocks.mdx index 76d5891e340bd..c147c6c666b17 100644 --- a/api_docs/kbn_core_user_settings_server_mocks.mdx +++ b/api_docs/kbn_core_user_settings_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-settings-server-mocks title: "@kbn/core-user-settings-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-settings-server-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-settings-server-mocks'] --- import kbnCoreUserSettingsServerMocksObj from './kbn_core_user_settings_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_crypto.mdx b/api_docs/kbn_crypto.mdx index 4a7f599320e6b..eac20a16f3a10 100644 --- a/api_docs/kbn_crypto.mdx +++ b/api_docs/kbn_crypto.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-crypto title: "@kbn/crypto" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/crypto plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto'] --- import kbnCryptoObj from './kbn_crypto.devdocs.json'; diff --git a/api_docs/kbn_crypto_browser.mdx b/api_docs/kbn_crypto_browser.mdx index a40bd4871d3aa..64af55a47797c 100644 --- a/api_docs/kbn_crypto_browser.mdx +++ b/api_docs/kbn_crypto_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-crypto-browser title: "@kbn/crypto-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/crypto-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto-browser'] --- import kbnCryptoBrowserObj from './kbn_crypto_browser.devdocs.json'; diff --git a/api_docs/kbn_cypress_config.mdx b/api_docs/kbn_cypress_config.mdx index 943f866032971..73b91fa38d6db 100644 --- a/api_docs/kbn_cypress_config.mdx +++ b/api_docs/kbn_cypress_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cypress-config title: "@kbn/cypress-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cypress-config plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cypress-config'] --- import kbnCypressConfigObj from './kbn_cypress_config.devdocs.json'; diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index 3c31a77db7c62..f4b147e52e0d4 100644 --- a/api_docs/kbn_datemath.mdx +++ b/api_docs/kbn_datemath.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-datemath title: "@kbn/datemath" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/datemath plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] --- import kbnDatemathObj from './kbn_datemath.devdocs.json'; diff --git a/api_docs/kbn_dev_cli_errors.mdx b/api_docs/kbn_dev_cli_errors.mdx index 3c9e183b2641b..33769614c6779 100644 --- a/api_docs/kbn_dev_cli_errors.mdx +++ b/api_docs/kbn_dev_cli_errors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-errors title: "@kbn/dev-cli-errors" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-cli-errors plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-errors'] --- import kbnDevCliErrorsObj from './kbn_dev_cli_errors.devdocs.json'; diff --git a/api_docs/kbn_dev_cli_runner.mdx b/api_docs/kbn_dev_cli_runner.mdx index 2577924f5ab2a..1e970c819bec8 100644 --- a/api_docs/kbn_dev_cli_runner.mdx +++ b/api_docs/kbn_dev_cli_runner.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-runner title: "@kbn/dev-cli-runner" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-cli-runner plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-runner'] --- import kbnDevCliRunnerObj from './kbn_dev_cli_runner.devdocs.json'; diff --git a/api_docs/kbn_dev_proc_runner.mdx b/api_docs/kbn_dev_proc_runner.mdx index faf18199951ce..61f271aa914dc 100644 --- a/api_docs/kbn_dev_proc_runner.mdx +++ b/api_docs/kbn_dev_proc_runner.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-proc-runner title: "@kbn/dev-proc-runner" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-proc-runner plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-proc-runner'] --- import kbnDevProcRunnerObj from './kbn_dev_proc_runner.devdocs.json'; diff --git a/api_docs/kbn_dev_utils.mdx b/api_docs/kbn_dev_utils.mdx index 771a184ee531e..b6d2d80d3d450 100644 --- a/api_docs/kbn_dev_utils.mdx +++ b/api_docs/kbn_dev_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-utils title: "@kbn/dev-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] --- import kbnDevUtilsObj from './kbn_dev_utils.devdocs.json'; diff --git a/api_docs/kbn_doc_links.devdocs.json b/api_docs/kbn_doc_links.devdocs.json index 1c0b9751b04a6..7c885d7855813 100644 --- a/api_docs/kbn_doc_links.devdocs.json +++ b/api_docs/kbn_doc_links.devdocs.json @@ -672,7 +672,7 @@ "label": "alerting", "description": [], "signature": [ - "{ readonly guide: string; readonly actionTypes: string; readonly apmRules: string; readonly emailAction: string; readonly emailActionConfig: string; readonly emailExchangeClientSecretConfig: string; readonly emailExchangeClientIdConfig: string; readonly generalSettings: string; readonly indexAction: string; readonly esQuery: string; readonly indexThreshold: string; readonly pagerDutyAction: string; readonly preconfiguredConnectors: string; readonly preconfiguredAlertHistoryConnector: string; readonly serviceNowAction: string; readonly serviceNowSIRAction: string; readonly setupPrerequisites: string; readonly slackAction: string; readonly slackApiAction: string; readonly teamsAction: string; readonly connectors: string; }" + "{ readonly guide: string; readonly actionTypes: string; readonly apmRules: string; readonly emailAction: string; readonly emailActionConfig: string; readonly emailExchangeClientSecretConfig: string; readonly emailExchangeClientIdConfig: string; readonly generalSettings: string; readonly indexAction: string; readonly esQuery: string; readonly indexThreshold: string; readonly maintenanceWindows: string; readonly pagerDutyAction: string; readonly preconfiguredConnectors: string; readonly preconfiguredAlertHistoryConnector: string; readonly serviceNowAction: string; readonly serviceNowSIRAction: string; readonly setupPrerequisites: string; readonly slackAction: string; readonly slackApiAction: string; readonly teamsAction: string; readonly connectors: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false, diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index 8b737f3b89ab2..6f6c566bd176b 100644 --- a/api_docs/kbn_doc_links.mdx +++ b/api_docs/kbn_doc_links.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-doc-links title: "@kbn/doc-links" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/doc-links plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links'] --- import kbnDocLinksObj from './kbn_doc_links.devdocs.json'; diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index 6ef813668db33..c88be56c21c3a 100644 --- a/api_docs/kbn_docs_utils.mdx +++ b/api_docs/kbn_docs_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-docs-utils title: "@kbn/docs-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/docs-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-utils'] --- import kbnDocsUtilsObj from './kbn_docs_utils.devdocs.json'; diff --git a/api_docs/kbn_dom_drag_drop.mdx b/api_docs/kbn_dom_drag_drop.mdx index 9c7a4cb138d34..f84e121534837 100644 --- a/api_docs/kbn_dom_drag_drop.mdx +++ b/api_docs/kbn_dom_drag_drop.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dom-drag-drop title: "@kbn/dom-drag-drop" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dom-drag-drop plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dom-drag-drop'] --- import kbnDomDragDropObj from './kbn_dom_drag_drop.devdocs.json'; diff --git a/api_docs/kbn_ebt_tools.mdx b/api_docs/kbn_ebt_tools.mdx index 9cd680b734443..8128b2afcd282 100644 --- a/api_docs/kbn_ebt_tools.mdx +++ b/api_docs/kbn_ebt_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ebt-tools title: "@kbn/ebt-tools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ebt-tools plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ebt-tools'] --- import kbnEbtToolsObj from './kbn_ebt_tools.devdocs.json'; diff --git a/api_docs/kbn_ecs.mdx b/api_docs/kbn_ecs.mdx index 4682d72f57898..ea4ce055b2ce9 100644 --- a/api_docs/kbn_ecs.mdx +++ b/api_docs/kbn_ecs.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ecs title: "@kbn/ecs" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ecs plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ecs'] --- import kbnEcsObj from './kbn_ecs.devdocs.json'; diff --git a/api_docs/kbn_ecs_data_quality_dashboard.mdx b/api_docs/kbn_ecs_data_quality_dashboard.mdx index a4a78c981c1be..cb18e5e9c1be1 100644 --- a/api_docs/kbn_ecs_data_quality_dashboard.mdx +++ b/api_docs/kbn_ecs_data_quality_dashboard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ecs-data-quality-dashboard title: "@kbn/ecs-data-quality-dashboard" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ecs-data-quality-dashboard plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ecs-data-quality-dashboard'] --- import kbnEcsDataQualityDashboardObj from './kbn_ecs_data_quality_dashboard.devdocs.json'; diff --git a/api_docs/kbn_es.mdx b/api_docs/kbn_es.mdx index 36999ee7365c2..7bb7d5f440b48 100644 --- a/api_docs/kbn_es.mdx +++ b/api_docs/kbn_es.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es title: "@kbn/es" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es'] --- import kbnEsObj from './kbn_es.devdocs.json'; diff --git a/api_docs/kbn_es_archiver.mdx b/api_docs/kbn_es_archiver.mdx index 42f20cdb1dc77..b0558deb886eb 100644 --- a/api_docs/kbn_es_archiver.mdx +++ b/api_docs/kbn_es_archiver.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-archiver title: "@kbn/es-archiver" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-archiver plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-archiver'] --- import kbnEsArchiverObj from './kbn_es_archiver.devdocs.json'; diff --git a/api_docs/kbn_es_errors.mdx b/api_docs/kbn_es_errors.mdx index 65e0b4690ee29..4b840b3d957d8 100644 --- a/api_docs/kbn_es_errors.mdx +++ b/api_docs/kbn_es_errors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-errors title: "@kbn/es-errors" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-errors plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-errors'] --- import kbnEsErrorsObj from './kbn_es_errors.devdocs.json'; diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index e75d1132d2a56..39e809141a63b 100644 --- a/api_docs/kbn_es_query.mdx +++ b/api_docs/kbn_es_query.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-query title: "@kbn/es-query" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-query plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query'] --- import kbnEsQueryObj from './kbn_es_query.devdocs.json'; diff --git a/api_docs/kbn_es_types.mdx b/api_docs/kbn_es_types.mdx index 1c3aefbd12869..1260b3975c3ca 100644 --- a/api_docs/kbn_es_types.mdx +++ b/api_docs/kbn_es_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-types title: "@kbn/es-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-types plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-types'] --- import kbnEsTypesObj from './kbn_es_types.devdocs.json'; diff --git a/api_docs/kbn_eslint_plugin_imports.mdx b/api_docs/kbn_eslint_plugin_imports.mdx index d195fc3aa375f..6d758a676c09d 100644 --- a/api_docs/kbn_eslint_plugin_imports.mdx +++ b/api_docs/kbn_eslint_plugin_imports.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-eslint-plugin-imports title: "@kbn/eslint-plugin-imports" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/eslint-plugin-imports plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] --- import kbnEslintPluginImportsObj from './kbn_eslint_plugin_imports.devdocs.json'; diff --git a/api_docs/kbn_expandable_flyout.mdx b/api_docs/kbn_expandable_flyout.mdx index fc24c4170f948..8ec16a5fd2ebe 100644 --- a/api_docs/kbn_expandable_flyout.mdx +++ b/api_docs/kbn_expandable_flyout.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-expandable-flyout title: "@kbn/expandable-flyout" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/expandable-flyout plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/expandable-flyout'] --- import kbnExpandableFlyoutObj from './kbn_expandable_flyout.devdocs.json'; diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index b38d5dd8caee3..9513799768cf8 100644 --- a/api_docs/kbn_field_types.mdx +++ b/api_docs/kbn_field_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-field-types title: "@kbn/field-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/field-types plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types'] --- import kbnFieldTypesObj from './kbn_field_types.devdocs.json'; diff --git a/api_docs/kbn_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx index cb9685f889f27..d8ca8cb607348 100644 --- a/api_docs/kbn_find_used_node_modules.mdx +++ b/api_docs/kbn_find_used_node_modules.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-find-used-node-modules title: "@kbn/find-used-node-modules" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/find-used-node-modules plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/find-used-node-modules'] --- import kbnFindUsedNodeModulesObj from './kbn_find_used_node_modules.devdocs.json'; diff --git a/api_docs/kbn_ftr_common_functional_services.mdx b/api_docs/kbn_ftr_common_functional_services.mdx index 1f03b428020e3..b6f623f4535b7 100644 --- a/api_docs/kbn_ftr_common_functional_services.mdx +++ b/api_docs/kbn_ftr_common_functional_services.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ftr-common-functional-services title: "@kbn/ftr-common-functional-services" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ftr-common-functional-services plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ftr-common-functional-services'] --- import kbnFtrCommonFunctionalServicesObj from './kbn_ftr_common_functional_services.devdocs.json'; diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx index d788671e057f2..dff03cd30fec9 100644 --- a/api_docs/kbn_generate.mdx +++ b/api_docs/kbn_generate.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate title: "@kbn/generate" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/generate plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] --- import kbnGenerateObj from './kbn_generate.devdocs.json'; diff --git a/api_docs/kbn_generate_csv.mdx b/api_docs/kbn_generate_csv.mdx index 6972820d0e435..b450fc9bcaa54 100644 --- a/api_docs/kbn_generate_csv.mdx +++ b/api_docs/kbn_generate_csv.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate-csv title: "@kbn/generate-csv" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/generate-csv plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate-csv'] --- import kbnGenerateCsvObj from './kbn_generate_csv.devdocs.json'; diff --git a/api_docs/kbn_generate_csv_types.mdx b/api_docs/kbn_generate_csv_types.mdx index 359640c3f4f6a..d7c48c9d1f569 100644 --- a/api_docs/kbn_generate_csv_types.mdx +++ b/api_docs/kbn_generate_csv_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate-csv-types title: "@kbn/generate-csv-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/generate-csv-types plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate-csv-types'] --- import kbnGenerateCsvTypesObj from './kbn_generate_csv_types.devdocs.json'; diff --git a/api_docs/kbn_guided_onboarding.mdx b/api_docs/kbn_guided_onboarding.mdx index 9ab7e66086991..5668e7942bca0 100644 --- a/api_docs/kbn_guided_onboarding.mdx +++ b/api_docs/kbn_guided_onboarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-guided-onboarding title: "@kbn/guided-onboarding" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/guided-onboarding plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/guided-onboarding'] --- import kbnGuidedOnboardingObj from './kbn_guided_onboarding.devdocs.json'; diff --git a/api_docs/kbn_handlebars.mdx b/api_docs/kbn_handlebars.mdx index 28e9ad0e68488..2cdff22179dbf 100644 --- a/api_docs/kbn_handlebars.mdx +++ b/api_docs/kbn_handlebars.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-handlebars title: "@kbn/handlebars" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/handlebars plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/handlebars'] --- import kbnHandlebarsObj from './kbn_handlebars.devdocs.json'; diff --git a/api_docs/kbn_hapi_mocks.mdx b/api_docs/kbn_hapi_mocks.mdx index 598ccaec7a44b..ecad94ab24d68 100644 --- a/api_docs/kbn_hapi_mocks.mdx +++ b/api_docs/kbn_hapi_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-hapi-mocks title: "@kbn/hapi-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/hapi-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/hapi-mocks'] --- import kbnHapiMocksObj from './kbn_hapi_mocks.devdocs.json'; diff --git a/api_docs/kbn_health_gateway_server.mdx b/api_docs/kbn_health_gateway_server.mdx index aa6b7a7a705cc..0d27ca7f94d31 100644 --- a/api_docs/kbn_health_gateway_server.mdx +++ b/api_docs/kbn_health_gateway_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-health-gateway-server title: "@kbn/health-gateway-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/health-gateway-server plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/health-gateway-server'] --- import kbnHealthGatewayServerObj from './kbn_health_gateway_server.devdocs.json'; diff --git a/api_docs/kbn_home_sample_data_card.mdx b/api_docs/kbn_home_sample_data_card.mdx index f592ffae9b08e..ac0074ec440ae 100644 --- a/api_docs/kbn_home_sample_data_card.mdx +++ b/api_docs/kbn_home_sample_data_card.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-home-sample-data-card title: "@kbn/home-sample-data-card" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/home-sample-data-card plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/home-sample-data-card'] --- import kbnHomeSampleDataCardObj from './kbn_home_sample_data_card.devdocs.json'; diff --git a/api_docs/kbn_home_sample_data_tab.mdx b/api_docs/kbn_home_sample_data_tab.mdx index 2e4618cbd4910..6263de926ae7b 100644 --- a/api_docs/kbn_home_sample_data_tab.mdx +++ b/api_docs/kbn_home_sample_data_tab.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-home-sample-data-tab title: "@kbn/home-sample-data-tab" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/home-sample-data-tab plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/home-sample-data-tab'] --- import kbnHomeSampleDataTabObj from './kbn_home_sample_data_tab.devdocs.json'; diff --git a/api_docs/kbn_i18n.mdx b/api_docs/kbn_i18n.mdx index 10d26fda9c83e..9c8c5341454e5 100644 --- a/api_docs/kbn_i18n.mdx +++ b/api_docs/kbn_i18n.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-i18n title: "@kbn/i18n" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/i18n plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n'] --- import kbnI18nObj from './kbn_i18n.devdocs.json'; diff --git a/api_docs/kbn_i18n_react.mdx b/api_docs/kbn_i18n_react.mdx index 96ffc490efaec..1613a1b3e8251 100644 --- a/api_docs/kbn_i18n_react.mdx +++ b/api_docs/kbn_i18n_react.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-i18n-react title: "@kbn/i18n-react" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/i18n-react plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n-react'] --- import kbnI18nReactObj from './kbn_i18n_react.devdocs.json'; diff --git a/api_docs/kbn_import_resolver.mdx b/api_docs/kbn_import_resolver.mdx index 40531c1b903c7..43512ae2c5fd3 100644 --- a/api_docs/kbn_import_resolver.mdx +++ b/api_docs/kbn_import_resolver.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-import-resolver title: "@kbn/import-resolver" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/import-resolver plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] --- import kbnImportResolverObj from './kbn_import_resolver.devdocs.json'; diff --git a/api_docs/kbn_infra_forge.devdocs.json b/api_docs/kbn_infra_forge.devdocs.json new file mode 100644 index 0000000000000..51660ce739fbc --- /dev/null +++ b/api_docs/kbn_infra_forge.devdocs.json @@ -0,0 +1,189 @@ +{ + "id": "@kbn/infra-forge", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/infra-forge", + "id": "def-common.cleanup", + "type": "Function", + "tags": [], + "label": "cleanup", + "description": [], + "signature": [ + "({ esClient, logger }: { esClient: ", + "default", + "; logger: ", + { + "pluginId": "@kbn/tooling-log", + "scope": "common", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-common.ToolingLog", + "text": "ToolingLog" + }, + "; }) => Promise" + ], + "path": "x-pack/packages/kbn-infra-forge/src/run.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/infra-forge", + "id": "def-common.cleanup.$1", + "type": "Object", + "tags": [], + "label": "{ esClient, logger }", + "description": [], + "path": "x-pack/packages/kbn-infra-forge/src/run.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/infra-forge", + "id": "def-common.cleanup.$1.esClient", + "type": "Object", + "tags": [], + "label": "esClient", + "description": [], + "signature": [ + "default" + ], + "path": "x-pack/packages/kbn-infra-forge/src/run.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/infra-forge", + "id": "def-common.cleanup.$1.logger", + "type": "Object", + "tags": [], + "label": "logger", + "description": [], + "signature": [ + { + "pluginId": "@kbn/tooling-log", + "scope": "common", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-common.ToolingLog", + "text": "ToolingLog" + } + ], + "path": "x-pack/packages/kbn-infra-forge/src/run.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/infra-forge", + "id": "def-common.generate", + "type": "Function", + "tags": [], + "label": "generate", + "description": [], + "signature": [ + "({ esClient, lookback, logger, }: { esClient: ", + "default", + "; lookback: string; logger: ", + { + "pluginId": "@kbn/tooling-log", + "scope": "common", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-common.ToolingLog", + "text": "ToolingLog" + }, + "; }) => Promise" + ], + "path": "x-pack/packages/kbn-infra-forge/src/run.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/infra-forge", + "id": "def-common.generate.$1", + "type": "Object", + "tags": [], + "label": "{\n esClient,\n lookback,\n logger,\n}", + "description": [], + "path": "x-pack/packages/kbn-infra-forge/src/run.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/infra-forge", + "id": "def-common.generate.$1.esClient", + "type": "Object", + "tags": [], + "label": "esClient", + "description": [], + "signature": [ + "default" + ], + "path": "x-pack/packages/kbn-infra-forge/src/run.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/infra-forge", + "id": "def-common.generate.$1.lookback", + "type": "string", + "tags": [], + "label": "lookback", + "description": [], + "path": "x-pack/packages/kbn-infra-forge/src/run.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/infra-forge", + "id": "def-common.generate.$1.logger", + "type": "Object", + "tags": [], + "label": "logger", + "description": [], + "signature": [ + { + "pluginId": "@kbn/tooling-log", + "scope": "common", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-common.ToolingLog", + "text": "ToolingLog" + } + ], + "path": "x-pack/packages/kbn-infra-forge/src/run.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_infra_forge.mdx b/api_docs/kbn_infra_forge.mdx new file mode 100644 index 0000000000000..fe5607a78c038 --- /dev/null +++ b/api_docs/kbn_infra_forge.mdx @@ -0,0 +1,30 @@ +--- +#### +#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system. +#### Reach out in #docs-engineering for more info. +#### +id: kibKbnInfraForgePluginApi +slug: /kibana-dev-docs/api/kbn-infra-forge +title: "@kbn/infra-forge" +image: https://source.unsplash.com/400x175/?github +description: API docs for the @kbn/infra-forge plugin +date: 2023-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/infra-forge'] +--- +import kbnInfraForgeObj from './kbn_infra_forge.devdocs.json'; + + + +Contact [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 9 | 0 | 9 | 0 | + +## Common + +### Functions + + diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index 62a5ca1a1bc23..9389fc2ca257d 100644 --- a/api_docs/kbn_interpreter.mdx +++ b/api_docs/kbn_interpreter.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-interpreter title: "@kbn/interpreter" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/interpreter plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter'] --- import kbnInterpreterObj from './kbn_interpreter.devdocs.json'; diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx index b59a5befa9973..4c893d821d4e2 100644 --- a/api_docs/kbn_io_ts_utils.mdx +++ b/api_docs/kbn_io_ts_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-io-ts-utils title: "@kbn/io-ts-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/io-ts-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-utils'] --- import kbnIoTsUtilsObj from './kbn_io_ts_utils.devdocs.json'; diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx index 22f3fe5e60b09..bf7fe659647ac 100644 --- a/api_docs/kbn_jest_serializers.mdx +++ b/api_docs/kbn_jest_serializers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-jest-serializers title: "@kbn/jest-serializers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/jest-serializers plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] --- import kbnJestSerializersObj from './kbn_jest_serializers.devdocs.json'; diff --git a/api_docs/kbn_journeys.mdx b/api_docs/kbn_journeys.mdx index 9323058758b4d..b0962cdcf4b89 100644 --- a/api_docs/kbn_journeys.mdx +++ b/api_docs/kbn_journeys.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-journeys title: "@kbn/journeys" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/journeys plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/journeys'] --- import kbnJourneysObj from './kbn_journeys.devdocs.json'; diff --git a/api_docs/kbn_json_ast.mdx b/api_docs/kbn_json_ast.mdx index 5e053f199ef79..6e56bb09b4a8c 100644 --- a/api_docs/kbn_json_ast.mdx +++ b/api_docs/kbn_json_ast.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-json-ast title: "@kbn/json-ast" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/json-ast plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/json-ast'] --- import kbnJsonAstObj from './kbn_json_ast.devdocs.json'; diff --git a/api_docs/kbn_kibana_manifest_schema.mdx b/api_docs/kbn_kibana_manifest_schema.mdx index 887f1d12d4707..a2597403c65d0 100644 --- a/api_docs/kbn_kibana_manifest_schema.mdx +++ b/api_docs/kbn_kibana_manifest_schema.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-kibana-manifest-schema title: "@kbn/kibana-manifest-schema" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/kibana-manifest-schema plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/kibana-manifest-schema'] --- import kbnKibanaManifestSchemaObj from './kbn_kibana_manifest_schema.devdocs.json'; diff --git a/api_docs/kbn_language_documentation_popover.mdx b/api_docs/kbn_language_documentation_popover.mdx index 7b4f3b6da96d0..f0865c77e38d5 100644 --- a/api_docs/kbn_language_documentation_popover.mdx +++ b/api_docs/kbn_language_documentation_popover.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-language-documentation-popover title: "@kbn/language-documentation-popover" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/language-documentation-popover plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/language-documentation-popover'] --- import kbnLanguageDocumentationPopoverObj from './kbn_language_documentation_popover.devdocs.json'; diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx index 5d72faac25232..da83111d5c3f2 100644 --- a/api_docs/kbn_logging.mdx +++ b/api_docs/kbn_logging.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-logging title: "@kbn/logging" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/logging plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] --- import kbnLoggingObj from './kbn_logging.devdocs.json'; diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index b39d2080f2b5d..fbb1575e37e5a 100644 --- a/api_docs/kbn_logging_mocks.mdx +++ b/api_docs/kbn_logging_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-logging-mocks title: "@kbn/logging-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/logging-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks'] --- import kbnLoggingMocksObj from './kbn_logging_mocks.devdocs.json'; diff --git a/api_docs/kbn_managed_vscode_config.mdx b/api_docs/kbn_managed_vscode_config.mdx index 59521b4701d3e..9446a85ae0de8 100644 --- a/api_docs/kbn_managed_vscode_config.mdx +++ b/api_docs/kbn_managed_vscode_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-managed-vscode-config title: "@kbn/managed-vscode-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/managed-vscode-config plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/managed-vscode-config'] --- import kbnManagedVscodeConfigObj from './kbn_managed_vscode_config.devdocs.json'; diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index 9954dcf6e7dd6..5563316d9b196 100644 --- a/api_docs/kbn_mapbox_gl.mdx +++ b/api_docs/kbn_mapbox_gl.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-mapbox-gl title: "@kbn/mapbox-gl" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/mapbox-gl plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] --- import kbnMapboxGlObj from './kbn_mapbox_gl.devdocs.json'; diff --git a/api_docs/kbn_maps_vector_tile_utils.devdocs.json b/api_docs/kbn_maps_vector_tile_utils.devdocs.json new file mode 100644 index 0000000000000..d9dd62f526990 --- /dev/null +++ b/api_docs/kbn_maps_vector_tile_utils.devdocs.json @@ -0,0 +1,61 @@ +{ + "id": "@kbn/maps-vector-tile-utils", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/maps-vector-tile-utils", + "id": "def-common.getTileUrlParams", + "type": "Function", + "tags": [], + "label": "getTileUrlParams", + "description": [], + "signature": [ + "(params: Record) => string" + ], + "path": "x-pack/packages/maps/vector_tile_utils/src/get_tile_url_params.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/maps-vector-tile-utils", + "id": "def-common.getTileUrlParams.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Record" + ], + "path": "x-pack/packages/maps/vector_tile_utils/src/get_tile_url_params.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_maps_vector_tile_utils.mdx b/api_docs/kbn_maps_vector_tile_utils.mdx new file mode 100644 index 0000000000000..8ba1d3df1d180 --- /dev/null +++ b/api_docs/kbn_maps_vector_tile_utils.mdx @@ -0,0 +1,30 @@ +--- +#### +#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system. +#### Reach out in #docs-engineering for more info. +#### +id: kibKbnMapsVectorTileUtilsPluginApi +slug: /kibana-dev-docs/api/kbn-maps-vector-tile-utils +title: "@kbn/maps-vector-tile-utils" +image: https://source.unsplash.com/400x175/?github +description: API docs for the @kbn/maps-vector-tile-utils plugin +date: 2023-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/maps-vector-tile-utils'] +--- +import kbnMapsVectorTileUtilsObj from './kbn_maps_vector_tile_utils.devdocs.json'; + + + +Contact [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 2 | 0 | 2 | 0 | + +## Common + +### Functions + + diff --git a/api_docs/kbn_ml_agg_utils.mdx b/api_docs/kbn_ml_agg_utils.mdx index e203a662e628b..f475a7c97b215 100644 --- a/api_docs/kbn_ml_agg_utils.mdx +++ b/api_docs/kbn_ml_agg_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-agg-utils title: "@kbn/ml-agg-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-agg-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-agg-utils'] --- import kbnMlAggUtilsObj from './kbn_ml_agg_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_anomaly_utils.mdx b/api_docs/kbn_ml_anomaly_utils.mdx index b8f338efaaf9c..7b6654615b7dd 100644 --- a/api_docs/kbn_ml_anomaly_utils.mdx +++ b/api_docs/kbn_ml_anomaly_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-anomaly-utils title: "@kbn/ml-anomaly-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-anomaly-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-anomaly-utils'] --- import kbnMlAnomalyUtilsObj from './kbn_ml_anomaly_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_date_picker.devdocs.json b/api_docs/kbn_ml_date_picker.devdocs.json index 83b689f7e7183..31d967f9e7585 100644 --- a/api_docs/kbn_ml_date_picker.devdocs.json +++ b/api_docs/kbn_ml_date_picker.devdocs.json @@ -1230,7 +1230,7 @@ "\nAllowed API paths to be passed to `setFullTimeRange`." ], "signature": [ - "\"/internal/file_upload/time_field_range\" | \"/api/ml/fields_service/time_field_range\"" + "\"/internal/file_upload/time_field_range\" | \"/internal/ml/fields_service/time_field_range\"" ], "path": "x-pack/packages/ml/date_picker/src/services/full_time_range_selector_service.ts", "deprecated": false, diff --git a/api_docs/kbn_ml_date_picker.mdx b/api_docs/kbn_ml_date_picker.mdx index ae8883a538a9f..8438026a91c15 100644 --- a/api_docs/kbn_ml_date_picker.mdx +++ b/api_docs/kbn_ml_date_picker.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-date-picker title: "@kbn/ml-date-picker" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-date-picker plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-date-picker'] --- import kbnMlDatePickerObj from './kbn_ml_date_picker.devdocs.json'; diff --git a/api_docs/kbn_ml_error_utils.mdx b/api_docs/kbn_ml_error_utils.mdx index dc08783e4e05a..3775bc9310e8c 100644 --- a/api_docs/kbn_ml_error_utils.mdx +++ b/api_docs/kbn_ml_error_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-error-utils title: "@kbn/ml-error-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-error-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-error-utils'] --- import kbnMlErrorUtilsObj from './kbn_ml_error_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_is_defined.mdx b/api_docs/kbn_ml_is_defined.mdx index abaade678d530..d8dd339efb281 100644 --- a/api_docs/kbn_ml_is_defined.mdx +++ b/api_docs/kbn_ml_is_defined.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-is-defined title: "@kbn/ml-is-defined" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-is-defined plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-is-defined'] --- import kbnMlIsDefinedObj from './kbn_ml_is_defined.devdocs.json'; diff --git a/api_docs/kbn_ml_is_populated_object.mdx b/api_docs/kbn_ml_is_populated_object.mdx index 502f7ddc05c73..1c13a02dedd6a 100644 --- a/api_docs/kbn_ml_is_populated_object.mdx +++ b/api_docs/kbn_ml_is_populated_object.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-is-populated-object title: "@kbn/ml-is-populated-object" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-is-populated-object plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-is-populated-object'] --- import kbnMlIsPopulatedObjectObj from './kbn_ml_is_populated_object.devdocs.json'; diff --git a/api_docs/kbn_ml_local_storage.mdx b/api_docs/kbn_ml_local_storage.mdx index b144f9149c154..32bb2256fb32f 100644 --- a/api_docs/kbn_ml_local_storage.mdx +++ b/api_docs/kbn_ml_local_storage.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-local-storage title: "@kbn/ml-local-storage" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-local-storage plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-local-storage'] --- import kbnMlLocalStorageObj from './kbn_ml_local_storage.devdocs.json'; diff --git a/api_docs/kbn_ml_nested_property.mdx b/api_docs/kbn_ml_nested_property.mdx index 19163d7787033..4967b3e527cbd 100644 --- a/api_docs/kbn_ml_nested_property.mdx +++ b/api_docs/kbn_ml_nested_property.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-nested-property title: "@kbn/ml-nested-property" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-nested-property plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-nested-property'] --- import kbnMlNestedPropertyObj from './kbn_ml_nested_property.devdocs.json'; diff --git a/api_docs/kbn_ml_number_utils.mdx b/api_docs/kbn_ml_number_utils.mdx index c7cde90f718ac..b3b26173ce777 100644 --- a/api_docs/kbn_ml_number_utils.mdx +++ b/api_docs/kbn_ml_number_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-number-utils title: "@kbn/ml-number-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-number-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-number-utils'] --- import kbnMlNumberUtilsObj from './kbn_ml_number_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_query_utils.mdx b/api_docs/kbn_ml_query_utils.mdx index 910f76f1bdfdc..ec9d3eff38208 100644 --- a/api_docs/kbn_ml_query_utils.mdx +++ b/api_docs/kbn_ml_query_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-query-utils title: "@kbn/ml-query-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-query-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-query-utils'] --- import kbnMlQueryUtilsObj from './kbn_ml_query_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_random_sampler_utils.mdx b/api_docs/kbn_ml_random_sampler_utils.mdx index c82c1f8a2c88d..6c9d6e47b3c5f 100644 --- a/api_docs/kbn_ml_random_sampler_utils.mdx +++ b/api_docs/kbn_ml_random_sampler_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-random-sampler-utils title: "@kbn/ml-random-sampler-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-random-sampler-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-random-sampler-utils'] --- import kbnMlRandomSamplerUtilsObj from './kbn_ml_random_sampler_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_route_utils.mdx b/api_docs/kbn_ml_route_utils.mdx index cf4929a702cee..c0e8b0c77b74c 100644 --- a/api_docs/kbn_ml_route_utils.mdx +++ b/api_docs/kbn_ml_route_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-route-utils title: "@kbn/ml-route-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-route-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-route-utils'] --- import kbnMlRouteUtilsObj from './kbn_ml_route_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_string_hash.mdx b/api_docs/kbn_ml_string_hash.mdx index e0c4cacace833..8f6b521696bc9 100644 --- a/api_docs/kbn_ml_string_hash.mdx +++ b/api_docs/kbn_ml_string_hash.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-string-hash title: "@kbn/ml-string-hash" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-string-hash plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-string-hash'] --- import kbnMlStringHashObj from './kbn_ml_string_hash.devdocs.json'; diff --git a/api_docs/kbn_ml_trained_models_utils.mdx b/api_docs/kbn_ml_trained_models_utils.mdx index 0120d1361e426..8a265d4430ec9 100644 --- a/api_docs/kbn_ml_trained_models_utils.mdx +++ b/api_docs/kbn_ml_trained_models_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-trained-models-utils title: "@kbn/ml-trained-models-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-trained-models-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-trained-models-utils'] --- import kbnMlTrainedModelsUtilsObj from './kbn_ml_trained_models_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_url_state.mdx b/api_docs/kbn_ml_url_state.mdx index 30e2c99205b1f..1185f3f6a75b5 100644 --- a/api_docs/kbn_ml_url_state.mdx +++ b/api_docs/kbn_ml_url_state.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-url-state title: "@kbn/ml-url-state" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-url-state plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-url-state'] --- import kbnMlUrlStateObj from './kbn_ml_url_state.devdocs.json'; diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index 8dd666bf6c00b..f32051d80c824 100644 --- a/api_docs/kbn_monaco.mdx +++ b/api_docs/kbn_monaco.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-monaco title: "@kbn/monaco" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/monaco plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco'] --- import kbnMonacoObj from './kbn_monaco.devdocs.json'; diff --git a/api_docs/kbn_object_versioning.mdx b/api_docs/kbn_object_versioning.mdx index f6780cff8d56f..3fcc2e521842f 100644 --- a/api_docs/kbn_object_versioning.mdx +++ b/api_docs/kbn_object_versioning.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-object-versioning title: "@kbn/object-versioning" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/object-versioning plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/object-versioning'] --- import kbnObjectVersioningObj from './kbn_object_versioning.devdocs.json'; diff --git a/api_docs/kbn_observability_alert_details.devdocs.json b/api_docs/kbn_observability_alert_details.devdocs.json index a7f16d862b6d7..e95b623e58f32 100644 --- a/api_docs/kbn_observability_alert_details.devdocs.json +++ b/api_docs/kbn_observability_alert_details.devdocs.json @@ -133,6 +133,42 @@ ], "returnComment": [], "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/observability-alert-details", + "id": "def-common.useAlertsHistory", + "type": "Function", + "tags": [], + "label": "useAlertsHistory", + "description": [], + "signature": [ + "({ featureIds, ruleId, dateRange, http }: ", + "Props", + ") => ", + "UseAlertsHistory" + ], + "path": "x-pack/packages/observability/alert_details/src/hooks/use_alerts_history.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/observability-alert-details", + "id": "def-common.useAlertsHistory.$1", + "type": "Object", + "tags": [], + "label": "{ featureIds, ruleId, dateRange, http }", + "description": [], + "signature": [ + "Props" + ], + "path": "x-pack/packages/observability/alert_details/src/hooks/use_alerts_history.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false } ], "interfaces": [], diff --git a/api_docs/kbn_observability_alert_details.mdx b/api_docs/kbn_observability_alert_details.mdx index d1fc3e26b4c5f..cedae7ac5bbd1 100644 --- a/api_docs/kbn_observability_alert_details.mdx +++ b/api_docs/kbn_observability_alert_details.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-observability-alert-details title: "@kbn/observability-alert-details" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/observability-alert-details plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/observability-alert-details'] --- import kbnObservabilityAlertDetailsObj from './kbn_observability_alert_details.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/actionable-observability](https://github.com/orgs/elastic/team | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 7 | 0 | 7 | 1 | +| 9 | 0 | 9 | 3 | ## Common diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index 31ef55338278c..3847dc116e8bd 100644 --- a/api_docs/kbn_optimizer.mdx +++ b/api_docs/kbn_optimizer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer title: "@kbn/optimizer" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/optimizer plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer'] --- import kbnOptimizerObj from './kbn_optimizer.devdocs.json'; diff --git a/api_docs/kbn_optimizer_webpack_helpers.mdx b/api_docs/kbn_optimizer_webpack_helpers.mdx index 9b602ff109c85..eaeb7dcb75dad 100644 --- a/api_docs/kbn_optimizer_webpack_helpers.mdx +++ b/api_docs/kbn_optimizer_webpack_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer-webpack-helpers title: "@kbn/optimizer-webpack-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/optimizer-webpack-helpers plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer-webpack-helpers'] --- import kbnOptimizerWebpackHelpersObj from './kbn_optimizer_webpack_helpers.devdocs.json'; diff --git a/api_docs/kbn_osquery_io_ts_types.mdx b/api_docs/kbn_osquery_io_ts_types.mdx index 744a7113cba9f..3f1130486a303 100644 --- a/api_docs/kbn_osquery_io_ts_types.mdx +++ b/api_docs/kbn_osquery_io_ts_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-osquery-io-ts-types title: "@kbn/osquery-io-ts-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/osquery-io-ts-types plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/osquery-io-ts-types'] --- import kbnOsqueryIoTsTypesObj from './kbn_osquery_io_ts_types.devdocs.json'; diff --git a/api_docs/kbn_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx index 1ff5084324874..606a2df87883a 100644 --- a/api_docs/kbn_performance_testing_dataset_extractor.mdx +++ b/api_docs/kbn_performance_testing_dataset_extractor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-performance-testing-dataset-extractor title: "@kbn/performance-testing-dataset-extractor" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/performance-testing-dataset-extractor plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/performance-testing-dataset-extractor'] --- import kbnPerformanceTestingDatasetExtractorObj from './kbn_performance_testing_dataset_extractor.devdocs.json'; diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index 0161179eaa946..422cadd69d2bc 100644 --- a/api_docs/kbn_plugin_generator.mdx +++ b/api_docs/kbn_plugin_generator.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-generator title: "@kbn/plugin-generator" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/plugin-generator plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-generator'] --- import kbnPluginGeneratorObj from './kbn_plugin_generator.devdocs.json'; diff --git a/api_docs/kbn_plugin_helpers.mdx b/api_docs/kbn_plugin_helpers.mdx index 1d9a192ac1ea6..1f8bf1f873e2d 100644 --- a/api_docs/kbn_plugin_helpers.mdx +++ b/api_docs/kbn_plugin_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-helpers title: "@kbn/plugin-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/plugin-helpers plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] --- import kbnPluginHelpersObj from './kbn_plugin_helpers.devdocs.json'; diff --git a/api_docs/kbn_random_sampling.mdx b/api_docs/kbn_random_sampling.mdx index c8485a5599a2d..f118b7287055d 100644 --- a/api_docs/kbn_random_sampling.mdx +++ b/api_docs/kbn_random_sampling.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-random-sampling title: "@kbn/random-sampling" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/random-sampling plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/random-sampling'] --- import kbnRandomSamplingObj from './kbn_random_sampling.devdocs.json'; diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx index 857d3233c94a5..0c4edadf0e3f6 100644 --- a/api_docs/kbn_react_field.mdx +++ b/api_docs/kbn_react_field.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-field title: "@kbn/react-field" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/react-field plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] --- import kbnReactFieldObj from './kbn_react_field.devdocs.json'; diff --git a/api_docs/kbn_repo_file_maps.mdx b/api_docs/kbn_repo_file_maps.mdx index c2501766a249c..654692524a7d0 100644 --- a/api_docs/kbn_repo_file_maps.mdx +++ b/api_docs/kbn_repo_file_maps.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-file-maps title: "@kbn/repo-file-maps" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-file-maps plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-file-maps'] --- import kbnRepoFileMapsObj from './kbn_repo_file_maps.devdocs.json'; diff --git a/api_docs/kbn_repo_linter.mdx b/api_docs/kbn_repo_linter.mdx index 669940a17e1fa..b5f578d94a0a3 100644 --- a/api_docs/kbn_repo_linter.mdx +++ b/api_docs/kbn_repo_linter.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-linter title: "@kbn/repo-linter" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-linter plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-linter'] --- import kbnRepoLinterObj from './kbn_repo_linter.devdocs.json'; diff --git a/api_docs/kbn_repo_path.mdx b/api_docs/kbn_repo_path.mdx index 18a487d83e047..6f49554d45693 100644 --- a/api_docs/kbn_repo_path.mdx +++ b/api_docs/kbn_repo_path.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-path title: "@kbn/repo-path" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-path plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-path'] --- import kbnRepoPathObj from './kbn_repo_path.devdocs.json'; diff --git a/api_docs/kbn_repo_source_classifier.mdx b/api_docs/kbn_repo_source_classifier.mdx index 1517885a4d5ed..69583900afbb9 100644 --- a/api_docs/kbn_repo_source_classifier.mdx +++ b/api_docs/kbn_repo_source_classifier.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-source-classifier title: "@kbn/repo-source-classifier" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-source-classifier plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-source-classifier'] --- import kbnRepoSourceClassifierObj from './kbn_repo_source_classifier.devdocs.json'; diff --git a/api_docs/kbn_reporting_common.mdx b/api_docs/kbn_reporting_common.mdx index 0841af1b21cf2..24bdcc43cccaa 100644 --- a/api_docs/kbn_reporting_common.mdx +++ b/api_docs/kbn_reporting_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-common title: "@kbn/reporting-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/reporting-common plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-common'] --- import kbnReportingCommonObj from './kbn_reporting_common.devdocs.json'; diff --git a/api_docs/kbn_rison.mdx b/api_docs/kbn_rison.mdx index 7ed96206fc516..3faa26e97e4b2 100644 --- a/api_docs/kbn_rison.mdx +++ b/api_docs/kbn_rison.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rison title: "@kbn/rison" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/rison plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rison'] --- import kbnRisonObj from './kbn_rison.devdocs.json'; diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index e2df147850219..580c6542dc203 100644 --- a/api_docs/kbn_rule_data_utils.mdx +++ b/api_docs/kbn_rule_data_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rule-data-utils title: "@kbn/rule-data-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/rule-data-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rule-data-utils'] --- import kbnRuleDataUtilsObj from './kbn_rule_data_utils.devdocs.json'; diff --git a/api_docs/kbn_saved_objects_settings.mdx b/api_docs/kbn_saved_objects_settings.mdx index c76d5f31effe8..902903e5f8744 100644 --- a/api_docs/kbn_saved_objects_settings.mdx +++ b/api_docs/kbn_saved_objects_settings.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-saved-objects-settings title: "@kbn/saved-objects-settings" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/saved-objects-settings plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/saved-objects-settings'] --- import kbnSavedObjectsSettingsObj from './kbn_saved_objects_settings.devdocs.json'; diff --git a/api_docs/kbn_security_solution_side_nav.mdx b/api_docs/kbn_security_solution_side_nav.mdx index 2074d7e298a08..9a513b3170bcd 100644 --- a/api_docs/kbn_security_solution_side_nav.mdx +++ b/api_docs/kbn_security_solution_side_nav.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-side-nav title: "@kbn/security-solution-side-nav" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-solution-side-nav plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-side-nav'] --- import kbnSecuritySolutionSideNavObj from './kbn_security_solution_side_nav.devdocs.json'; diff --git a/api_docs/kbn_security_solution_storybook_config.mdx b/api_docs/kbn_security_solution_storybook_config.mdx index 1f82f9ec2eb6a..07918cf8ad5df 100644 --- a/api_docs/kbn_security_solution_storybook_config.mdx +++ b/api_docs/kbn_security_solution_storybook_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-storybook-config title: "@kbn/security-solution-storybook-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-solution-storybook-config plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-storybook-config'] --- import kbnSecuritySolutionStorybookConfigObj from './kbn_security_solution_storybook_config.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index e269fb4d1644d..4a1dc0be4af03 100644 --- a/api_docs/kbn_securitysolution_autocomplete.mdx +++ b/api_docs/kbn_securitysolution_autocomplete.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-autocomplete title: "@kbn/securitysolution-autocomplete" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-autocomplete plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete'] --- import kbnSecuritysolutionAutocompleteObj from './kbn_securitysolution_autocomplete.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_data_table.mdx b/api_docs/kbn_securitysolution_data_table.mdx index d26245c796b5b..61f472e9e8c44 100644 --- a/api_docs/kbn_securitysolution_data_table.mdx +++ b/api_docs/kbn_securitysolution_data_table.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-data-table title: "@kbn/securitysolution-data-table" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-data-table plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-data-table'] --- import kbnSecuritysolutionDataTableObj from './kbn_securitysolution_data_table.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_ecs.mdx b/api_docs/kbn_securitysolution_ecs.mdx index e2f1a9d07777a..cc5a985fce7dd 100644 --- a/api_docs/kbn_securitysolution_ecs.mdx +++ b/api_docs/kbn_securitysolution_ecs.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-ecs title: "@kbn/securitysolution-ecs" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-ecs plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-ecs'] --- import kbnSecuritysolutionEcsObj from './kbn_securitysolution_ecs.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index adce7c1331eb8..6655d42b18a7a 100644 --- a/api_docs/kbn_securitysolution_es_utils.mdx +++ b/api_docs/kbn_securitysolution_es_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-es-utils title: "@kbn/securitysolution-es-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-es-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-es-utils'] --- import kbnSecuritysolutionEsUtilsObj from './kbn_securitysolution_es_utils.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_exception_list_components.mdx b/api_docs/kbn_securitysolution_exception_list_components.mdx index 066e89c9a59fb..a839dfe7f2de9 100644 --- a/api_docs/kbn_securitysolution_exception_list_components.mdx +++ b/api_docs/kbn_securitysolution_exception_list_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-exception-list-components title: "@kbn/securitysolution-exception-list-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-exception-list-components plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-exception-list-components'] --- import kbnSecuritysolutionExceptionListComponentsObj from './kbn_securitysolution_exception_list_components.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_grouping.mdx b/api_docs/kbn_securitysolution_grouping.mdx index 0de3bfd299501..3750d2b4f8a2f 100644 --- a/api_docs/kbn_securitysolution_grouping.mdx +++ b/api_docs/kbn_securitysolution_grouping.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-grouping title: "@kbn/securitysolution-grouping" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-grouping plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-grouping'] --- import kbnSecuritysolutionGroupingObj from './kbn_securitysolution_grouping.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index 3a3ec1e3a8698..673e5768195a2 100644 --- a/api_docs/kbn_securitysolution_hook_utils.mdx +++ b/api_docs/kbn_securitysolution_hook_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-hook-utils title: "@kbn/securitysolution-hook-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-hook-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-hook-utils'] --- import kbnSecuritysolutionHookUtilsObj from './kbn_securitysolution_hook_utils.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx index 38e51ee2cc6aa..ecf5c69e3b5bb 100644 --- a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-alerting-types title: "@kbn/securitysolution-io-ts-alerting-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-alerting-types plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-alerting-types'] --- import kbnSecuritysolutionIoTsAlertingTypesObj from './kbn_securitysolution_io_ts_alerting_types.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx index 23bb7460aac51..613b8233c1baa 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_list_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-list-types title: "@kbn/securitysolution-io-ts-list-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-list-types plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-list-types'] --- import kbnSecuritysolutionIoTsListTypesObj from './kbn_securitysolution_io_ts_list_types.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx index 2b8061ca135c7..603e41c564d71 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-types title: "@kbn/securitysolution-io-ts-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-types plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-types'] --- import kbnSecuritysolutionIoTsTypesObj from './kbn_securitysolution_io_ts_types.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx index aeffca17369c6..776621347a5da 100644 --- a/api_docs/kbn_securitysolution_io_ts_utils.mdx +++ b/api_docs/kbn_securitysolution_io_ts_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-utils title: "@kbn/securitysolution-io-ts-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-utils'] --- import kbnSecuritysolutionIoTsUtilsObj from './kbn_securitysolution_io_ts_utils.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_list_api.mdx b/api_docs/kbn_securitysolution_list_api.mdx index 9175b2b9a3018..3c4829009869f 100644 --- a/api_docs/kbn_securitysolution_list_api.mdx +++ b/api_docs/kbn_securitysolution_list_api.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-api title: "@kbn/securitysolution-list-api" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-api plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api'] --- import kbnSecuritysolutionListApiObj from './kbn_securitysolution_list_api.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index 96afb2869f3cb..9a4b99e71415a 100644 --- a/api_docs/kbn_securitysolution_list_constants.mdx +++ b/api_docs/kbn_securitysolution_list_constants.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-constants title: "@kbn/securitysolution-list-constants" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-constants plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-constants'] --- import kbnSecuritysolutionListConstantsObj from './kbn_securitysolution_list_constants.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx index 1f597952933ce..e0e46593100ae 100644 --- a/api_docs/kbn_securitysolution_list_hooks.mdx +++ b/api_docs/kbn_securitysolution_list_hooks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-hooks title: "@kbn/securitysolution-list-hooks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-hooks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-hooks'] --- import kbnSecuritysolutionListHooksObj from './kbn_securitysolution_list_hooks.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx index 3a2b08b7a3da9..432ec2aab1349 100644 --- a/api_docs/kbn_securitysolution_list_utils.mdx +++ b/api_docs/kbn_securitysolution_list_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-utils title: "@kbn/securitysolution-list-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-utils'] --- import kbnSecuritysolutionListUtilsObj from './kbn_securitysolution_list_utils.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index 2ecce066c7061..0968e252c62b9 100644 --- a/api_docs/kbn_securitysolution_rules.mdx +++ b/api_docs/kbn_securitysolution_rules.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-rules title: "@kbn/securitysolution-rules" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-rules plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-rules'] --- import kbnSecuritysolutionRulesObj from './kbn_securitysolution_rules.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_t_grid.mdx b/api_docs/kbn_securitysolution_t_grid.mdx index 905ba2cef0b43..cea799eddc317 100644 --- a/api_docs/kbn_securitysolution_t_grid.mdx +++ b/api_docs/kbn_securitysolution_t_grid.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-t-grid title: "@kbn/securitysolution-t-grid" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-t-grid plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-t-grid'] --- import kbnSecuritysolutionTGridObj from './kbn_securitysolution_t_grid.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_utils.mdx b/api_docs/kbn_securitysolution_utils.mdx index ab9d9b7f5f49f..4a2b8f568f464 100644 --- a/api_docs/kbn_securitysolution_utils.mdx +++ b/api_docs/kbn_securitysolution_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-utils title: "@kbn/securitysolution-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-utils'] --- import kbnSecuritysolutionUtilsObj from './kbn_securitysolution_utils.devdocs.json'; diff --git a/api_docs/kbn_server_http_tools.mdx b/api_docs/kbn_server_http_tools.mdx index f0fc401cb3d43..e313401ca58b0 100644 --- a/api_docs/kbn_server_http_tools.mdx +++ b/api_docs/kbn_server_http_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-server-http-tools title: "@kbn/server-http-tools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/server-http-tools plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-http-tools'] --- import kbnServerHttpToolsObj from './kbn_server_http_tools.devdocs.json'; diff --git a/api_docs/kbn_server_route_repository.devdocs.json b/api_docs/kbn_server_route_repository.devdocs.json index e9b6b60f30318..f8edeb098ba85 100644 --- a/api_docs/kbn_server_route_repository.devdocs.json +++ b/api_docs/kbn_server_route_repository.devdocs.json @@ -118,7 +118,7 @@ "label": "formatRequest", "description": [], "signature": [ - "(endpoint: string, pathParams: Record) => { method: Method; pathname: string; }" + "(endpoint: string, pathParams: Record) => { method: Method; pathname: string; version: string; }" ], "path": "packages/kbn-server-route-repository/src/format_request.ts", "deprecated": false, @@ -166,7 +166,7 @@ "label": "parseEndpoint", "description": [], "signature": [ - "(endpoint: string) => { method: Method; pathname: string; }" + "(endpoint: string) => { method: Method; pathname: string; version: string; }" ], "path": "packages/kbn-server-route-repository/src/parse_endpoint.ts", "deprecated": false, @@ -232,17 +232,9 @@ "label": "ClientRequestParamsOf", "description": [], "signature": [ - "TServerRouteRepository[TEndpoint] extends ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - " Promise; } & ", "ServerRouteCreateOptions", - "> ? TRouteParamsRT extends ", + " ? TRouteParamsRT extends ", { "pluginId": "@kbn/server-route-repository", "scope": "common", @@ -265,17 +257,9 @@ "label": "DecodedRequestParamsOf", "description": [], "signature": [ - "TServerRouteRepository[TEndpoint] extends ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - " Promise; } & ", "ServerRouteCreateOptions", - "> ? TRouteParamsRT extends ", + " ? TRouteParamsRT extends ", { "pluginId": "@kbn/server-route-repository", "scope": "common", @@ -313,17 +297,9 @@ "label": "ReturnOf", "description": [], "signature": [ - "TServerRouteRepository[TEndpoint] extends ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - " Promise; } & ", "ServerRouteCreateOptions", - "> ? TReturnType : never" + " ? TReturnType : never" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, @@ -446,7 +422,7 @@ "label": "ServerRoute", "description": [], "signature": [ - "{ endpoint: TEndpoint; params?: TRouteParamsRT | undefined; handler: ({}: TRouteHandlerResources & (TRouteParamsRT extends ", + "ValidateEndpoint extends true ? { endpoint: TEndpoint; params?: TRouteParamsRT | undefined; handler: ({}: TRouteHandlerResources & (TRouteParamsRT extends ", { "pluginId": "@kbn/server-route-repository", "scope": "common", @@ -454,7 +430,7 @@ "section": "def-common.RouteParamsRT", "text": "RouteParamsRT" }, - " ? DecodedRequestParamsOfType : {})) => Promise; } & TRouteCreateOptions" + " ? DecodedRequestParamsOfType : {})) => Promise; } & TRouteCreateOptions : never" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, @@ -469,15 +445,7 @@ "label": "ServerRouteRepository", "description": [], "signature": [ - "{ [x: string]: ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - ">; }" + " | undefined; handler: ({}: any) => Promise; } & Record; }" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, diff --git a/api_docs/kbn_server_route_repository.mdx b/api_docs/kbn_server_route_repository.mdx index 004da2cf7b4b1..1204f9baf743c 100644 --- a/api_docs/kbn_server_route_repository.mdx +++ b/api_docs/kbn_server_route_repository.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository title: "@kbn/server-route-repository" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/server-route-repository plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository'] --- import kbnServerRouteRepositoryObj from './kbn_server_route_repository.devdocs.json'; diff --git a/api_docs/kbn_serverless_project_switcher.mdx b/api_docs/kbn_serverless_project_switcher.mdx index ada5e738784c8..c7e290bbf7ff3 100644 --- a/api_docs/kbn_serverless_project_switcher.mdx +++ b/api_docs/kbn_serverless_project_switcher.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-project-switcher title: "@kbn/serverless-project-switcher" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/serverless-project-switcher plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-project-switcher'] --- import kbnServerlessProjectSwitcherObj from './kbn_serverless_project_switcher.devdocs.json'; diff --git a/api_docs/kbn_serverless_storybook_config.mdx b/api_docs/kbn_serverless_storybook_config.mdx index 78da7fa9e6c40..937628ec623e7 100644 --- a/api_docs/kbn_serverless_storybook_config.mdx +++ b/api_docs/kbn_serverless_storybook_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-storybook-config title: "@kbn/serverless-storybook-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/serverless-storybook-config plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-storybook-config'] --- import kbnServerlessStorybookConfigObj from './kbn_serverless_storybook_config.devdocs.json'; diff --git a/api_docs/kbn_shared_svg.mdx b/api_docs/kbn_shared_svg.mdx index 44de5622d9879..762088c12997f 100644 --- a/api_docs/kbn_shared_svg.mdx +++ b/api_docs/kbn_shared_svg.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-svg title: "@kbn/shared-svg" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-svg plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-svg'] --- import kbnSharedSvgObj from './kbn_shared_svg.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_avatar_solution.mdx b/api_docs/kbn_shared_ux_avatar_solution.mdx index 042dabc2f5905..c23118cef0b5f 100644 --- a/api_docs/kbn_shared_ux_avatar_solution.mdx +++ b/api_docs/kbn_shared_ux_avatar_solution.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-avatar-solution title: "@kbn/shared-ux-avatar-solution" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-avatar-solution plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-avatar-solution'] --- import kbnSharedUxAvatarSolutionObj from './kbn_shared_ux_avatar_solution.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx b/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx index 77771b3e82579..da75fa1cf00e4 100644 --- a/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx +++ b/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-avatar-user-profile-components title: "@kbn/shared-ux-avatar-user-profile-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-avatar-user-profile-components plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-avatar-user-profile-components'] --- import kbnSharedUxAvatarUserProfileComponentsObj from './kbn_shared_ux_avatar_user_profile_components.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx index c52197e37180f..52222291e711d 100644 --- a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx +++ b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-exit-full-screen title: "@kbn/shared-ux-button-exit-full-screen" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-button-exit-full-screen plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-exit-full-screen'] --- import kbnSharedUxButtonExitFullScreenObj from './kbn_shared_ux_button_exit_full_screen.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx b/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx index 3393c6df30440..a1c1f74d0360e 100644 --- a/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx +++ b/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-exit-full-screen-mocks title: "@kbn/shared-ux-button-exit-full-screen-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-button-exit-full-screen-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-exit-full-screen-mocks'] --- import kbnSharedUxButtonExitFullScreenMocksObj from './kbn_shared_ux_button_exit_full_screen_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_button_toolbar.mdx b/api_docs/kbn_shared_ux_button_toolbar.mdx index 23e56192c2920..ba1023d958ab4 100644 --- a/api_docs/kbn_shared_ux_button_toolbar.mdx +++ b/api_docs/kbn_shared_ux_button_toolbar.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-toolbar title: "@kbn/shared-ux-button-toolbar" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-button-toolbar plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-toolbar'] --- import kbnSharedUxButtonToolbarObj from './kbn_shared_ux_button_toolbar.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_card_no_data.mdx b/api_docs/kbn_shared_ux_card_no_data.mdx index d9f166e5b26c5..20ec5a7f55453 100644 --- a/api_docs/kbn_shared_ux_card_no_data.mdx +++ b/api_docs/kbn_shared_ux_card_no_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-card-no-data title: "@kbn/shared-ux-card-no-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-card-no-data plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-card-no-data'] --- import kbnSharedUxCardNoDataObj from './kbn_shared_ux_card_no_data.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_card_no_data_mocks.mdx b/api_docs/kbn_shared_ux_card_no_data_mocks.mdx index b5e6eab3af746..ed02e0442cb67 100644 --- a/api_docs/kbn_shared_ux_card_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_card_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-card-no-data-mocks title: "@kbn/shared-ux-card-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-card-no-data-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-card-no-data-mocks'] --- import kbnSharedUxCardNoDataMocksObj from './kbn_shared_ux_card_no_data_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_chrome_navigation.mdx b/api_docs/kbn_shared_ux_chrome_navigation.mdx index 5d71ffc1ecc8f..865903c7ec71e 100644 --- a/api_docs/kbn_shared_ux_chrome_navigation.mdx +++ b/api_docs/kbn_shared_ux_chrome_navigation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-chrome-navigation title: "@kbn/shared-ux-chrome-navigation" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-chrome-navigation plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-chrome-navigation'] --- import kbnSharedUxChromeNavigationObj from './kbn_shared_ux_chrome_navigation.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_context.mdx b/api_docs/kbn_shared_ux_file_context.mdx index 3b64acacfd43d..3e705a314be81 100644 --- a/api_docs/kbn_shared_ux_file_context.mdx +++ b/api_docs/kbn_shared_ux_file_context.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-context title: "@kbn/shared-ux-file-context" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-context plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-context'] --- import kbnSharedUxFileContextObj from './kbn_shared_ux_file_context.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_image.mdx b/api_docs/kbn_shared_ux_file_image.mdx index bc1322d57b158..508acd6e3ed4a 100644 --- a/api_docs/kbn_shared_ux_file_image.mdx +++ b/api_docs/kbn_shared_ux_file_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-image title: "@kbn/shared-ux-file-image" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-image plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-image'] --- import kbnSharedUxFileImageObj from './kbn_shared_ux_file_image.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_image_mocks.mdx b/api_docs/kbn_shared_ux_file_image_mocks.mdx index a5e8ec51ef0e8..48d35d9a995dc 100644 --- a/api_docs/kbn_shared_ux_file_image_mocks.mdx +++ b/api_docs/kbn_shared_ux_file_image_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-image-mocks title: "@kbn/shared-ux-file-image-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-image-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-image-mocks'] --- import kbnSharedUxFileImageMocksObj from './kbn_shared_ux_file_image_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_mocks.mdx b/api_docs/kbn_shared_ux_file_mocks.mdx index db18dbe5a1d55..7ace7b18a0fe9 100644 --- a/api_docs/kbn_shared_ux_file_mocks.mdx +++ b/api_docs/kbn_shared_ux_file_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-mocks title: "@kbn/shared-ux-file-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-mocks'] --- import kbnSharedUxFileMocksObj from './kbn_shared_ux_file_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_picker.mdx b/api_docs/kbn_shared_ux_file_picker.mdx index b2d47a77d8fa1..64d8c8a56e7cf 100644 --- a/api_docs/kbn_shared_ux_file_picker.mdx +++ b/api_docs/kbn_shared_ux_file_picker.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-picker title: "@kbn/shared-ux-file-picker" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-picker plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-picker'] --- import kbnSharedUxFilePickerObj from './kbn_shared_ux_file_picker.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_types.mdx b/api_docs/kbn_shared_ux_file_types.mdx index 7a4da117bac9c..e4607edcce3a1 100644 --- a/api_docs/kbn_shared_ux_file_types.mdx +++ b/api_docs/kbn_shared_ux_file_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-types title: "@kbn/shared-ux-file-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-types plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-types'] --- import kbnSharedUxFileTypesObj from './kbn_shared_ux_file_types.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_upload.mdx b/api_docs/kbn_shared_ux_file_upload.mdx index 1c648ebee4182..00129a70289ac 100644 --- a/api_docs/kbn_shared_ux_file_upload.mdx +++ b/api_docs/kbn_shared_ux_file_upload.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-upload title: "@kbn/shared-ux-file-upload" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-upload plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-upload'] --- import kbnSharedUxFileUploadObj from './kbn_shared_ux_file_upload.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_util.mdx b/api_docs/kbn_shared_ux_file_util.mdx index 957c5367415c8..d20141ae83e87 100644 --- a/api_docs/kbn_shared_ux_file_util.mdx +++ b/api_docs/kbn_shared_ux_file_util.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-util title: "@kbn/shared-ux-file-util" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-util plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-util'] --- import kbnSharedUxFileUtilObj from './kbn_shared_ux_file_util.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_link_redirect_app.mdx b/api_docs/kbn_shared_ux_link_redirect_app.mdx index e2342493131ca..ec5e6427d24a8 100644 --- a/api_docs/kbn_shared_ux_link_redirect_app.mdx +++ b/api_docs/kbn_shared_ux_link_redirect_app.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-link-redirect-app title: "@kbn/shared-ux-link-redirect-app" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-link-redirect-app plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-link-redirect-app'] --- import kbnSharedUxLinkRedirectAppObj from './kbn_shared_ux_link_redirect_app.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx b/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx index e3d4305faf786..edf85da81fd8f 100644 --- a/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx +++ b/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-link-redirect-app-mocks title: "@kbn/shared-ux-link-redirect-app-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-link-redirect-app-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-link-redirect-app-mocks'] --- import kbnSharedUxLinkRedirectAppMocksObj from './kbn_shared_ux_link_redirect_app_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_markdown.mdx b/api_docs/kbn_shared_ux_markdown.mdx index d5ef3d0de276f..8c774dac9a8de 100644 --- a/api_docs/kbn_shared_ux_markdown.mdx +++ b/api_docs/kbn_shared_ux_markdown.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-markdown title: "@kbn/shared-ux-markdown" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-markdown plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-markdown'] --- import kbnSharedUxMarkdownObj from './kbn_shared_ux_markdown.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_markdown_mocks.mdx b/api_docs/kbn_shared_ux_markdown_mocks.mdx index 37504e1b04d2b..2fb920e5a6b45 100644 --- a/api_docs/kbn_shared_ux_markdown_mocks.mdx +++ b/api_docs/kbn_shared_ux_markdown_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-markdown-mocks title: "@kbn/shared-ux-markdown-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-markdown-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-markdown-mocks'] --- import kbnSharedUxMarkdownMocksObj from './kbn_shared_ux_markdown_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx index 63c273abf6092..cfb2067878847 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data title: "@kbn/shared-ux-page-analytics-no-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-analytics-no-data plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data'] --- import kbnSharedUxPageAnalyticsNoDataObj from './kbn_shared_ux_page_analytics_no_data.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx index 7ebc3ac1001a8..22bc50ee2a760 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data-mocks title: "@kbn/shared-ux-page-analytics-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-analytics-no-data-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data-mocks'] --- import kbnSharedUxPageAnalyticsNoDataMocksObj from './kbn_shared_ux_page_analytics_no_data_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx index c3c26b281e75b..3ff9be88c0460 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data title: "@kbn/shared-ux-page-kibana-no-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-no-data plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-no-data'] --- import kbnSharedUxPageKibanaNoDataObj from './kbn_shared_ux_page_kibana_no_data.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx b/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx index 829889811c969..4a7044fc0fd57 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data-mocks title: "@kbn/shared-ux-page-kibana-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-no-data-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-no-data-mocks'] --- import kbnSharedUxPageKibanaNoDataMocksObj from './kbn_shared_ux_page_kibana_no_data_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_kibana_template.mdx b/api_docs/kbn_shared_ux_page_kibana_template.mdx index 7d9af6b6580d3..1a9a6a936be43 100644 --- a/api_docs/kbn_shared_ux_page_kibana_template.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_template.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-template title: "@kbn/shared-ux-page-kibana-template" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-template plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-template'] --- import kbnSharedUxPageKibanaTemplateObj from './kbn_shared_ux_page_kibana_template.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx b/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx index 8c83d4300e223..3e31d17dab600 100644 --- a/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-template-mocks title: "@kbn/shared-ux-page-kibana-template-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-template-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-template-mocks'] --- import kbnSharedUxPageKibanaTemplateMocksObj from './kbn_shared_ux_page_kibana_template_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_no_data.mdx b/api_docs/kbn_shared_ux_page_no_data.mdx index 8f712a96003fd..7521e19c18f3d 100644 --- a/api_docs/kbn_shared_ux_page_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_no_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data title: "@kbn/shared-ux-page-no-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data'] --- import kbnSharedUxPageNoDataObj from './kbn_shared_ux_page_no_data.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_no_data_config.mdx b/api_docs/kbn_shared_ux_page_no_data_config.mdx index 98b85673e337c..7d58e9c5da150 100644 --- a/api_docs/kbn_shared_ux_page_no_data_config.mdx +++ b/api_docs/kbn_shared_ux_page_no_data_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-config title: "@kbn/shared-ux-page-no-data-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data-config plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data-config'] --- import kbnSharedUxPageNoDataConfigObj from './kbn_shared_ux_page_no_data_config.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx b/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx index 8397bb2b63dc1..16fefe60e855f 100644 --- a/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-config-mocks title: "@kbn/shared-ux-page-no-data-config-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data-config-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data-config-mocks'] --- import kbnSharedUxPageNoDataConfigMocksObj from './kbn_shared_ux_page_no_data_config_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_no_data_mocks.mdx b/api_docs/kbn_shared_ux_page_no_data_mocks.mdx index ce1c2277e412e..dd344d0c5e1e6 100644 --- a/api_docs/kbn_shared_ux_page_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-mocks title: "@kbn/shared-ux-page-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data-mocks'] --- import kbnSharedUxPageNoDataMocksObj from './kbn_shared_ux_page_no_data_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_solution_nav.mdx b/api_docs/kbn_shared_ux_page_solution_nav.mdx index e925f9ec2c607..67f52ca7e8b17 100644 --- a/api_docs/kbn_shared_ux_page_solution_nav.mdx +++ b/api_docs/kbn_shared_ux_page_solution_nav.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-solution-nav title: "@kbn/shared-ux-page-solution-nav" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-solution-nav plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-solution-nav'] --- import kbnSharedUxPageSolutionNavObj from './kbn_shared_ux_page_solution_nav.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx index 6d6c01436c533..299b5fa362e2d 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx +++ b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views title: "@kbn/shared-ux-prompt-no-data-views" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-prompt-no-data-views plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views'] --- import kbnSharedUxPromptNoDataViewsObj from './kbn_shared_ux_prompt_no_data_views.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx b/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx index 9009f1da7a40c..04e2e2a70cc4c 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx +++ b/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views-mocks title: "@kbn/shared-ux-prompt-no-data-views-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-prompt-no-data-views-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views-mocks'] --- import kbnSharedUxPromptNoDataViewsMocksObj from './kbn_shared_ux_prompt_no_data_views_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_prompt_not_found.mdx b/api_docs/kbn_shared_ux_prompt_not_found.mdx index 300e4e643e1f8..5fe66a41d5442 100644 --- a/api_docs/kbn_shared_ux_prompt_not_found.mdx +++ b/api_docs/kbn_shared_ux_prompt_not_found.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-not-found title: "@kbn/shared-ux-prompt-not-found" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-prompt-not-found plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-not-found'] --- import kbnSharedUxPromptNotFoundObj from './kbn_shared_ux_prompt_not_found.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_router.mdx b/api_docs/kbn_shared_ux_router.mdx index b9a4108d28be9..82e8431341a2b 100644 --- a/api_docs/kbn_shared_ux_router.mdx +++ b/api_docs/kbn_shared_ux_router.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-router title: "@kbn/shared-ux-router" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-router plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-router'] --- import kbnSharedUxRouterObj from './kbn_shared_ux_router.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_router_mocks.mdx b/api_docs/kbn_shared_ux_router_mocks.mdx index a067833208d82..77c2c937cbff5 100644 --- a/api_docs/kbn_shared_ux_router_mocks.mdx +++ b/api_docs/kbn_shared_ux_router_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-router-mocks title: "@kbn/shared-ux-router-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-router-mocks plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-router-mocks'] --- import kbnSharedUxRouterMocksObj from './kbn_shared_ux_router_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_storybook_config.mdx b/api_docs/kbn_shared_ux_storybook_config.mdx index 9c9b2b0482625..42dd7fbf6b407 100644 --- a/api_docs/kbn_shared_ux_storybook_config.mdx +++ b/api_docs/kbn_shared_ux_storybook_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook-config title: "@kbn/shared-ux-storybook-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-storybook-config plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook-config'] --- import kbnSharedUxStorybookConfigObj from './kbn_shared_ux_storybook_config.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_storybook_mock.mdx b/api_docs/kbn_shared_ux_storybook_mock.mdx index 831d451757626..26ff5823f1bb9 100644 --- a/api_docs/kbn_shared_ux_storybook_mock.mdx +++ b/api_docs/kbn_shared_ux_storybook_mock.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook-mock title: "@kbn/shared-ux-storybook-mock" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-storybook-mock plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook-mock'] --- import kbnSharedUxStorybookMockObj from './kbn_shared_ux_storybook_mock.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx index c8d4dc889fe15..75bdc2b20a703 100644 --- a/api_docs/kbn_shared_ux_utility.mdx +++ b/api_docs/kbn_shared_ux_utility.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-utility title: "@kbn/shared-ux-utility" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-utility plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-utility'] --- import kbnSharedUxUtilityObj from './kbn_shared_ux_utility.devdocs.json'; diff --git a/api_docs/kbn_slo_schema.devdocs.json b/api_docs/kbn_slo_schema.devdocs.json index e24a485b0838a..b7e87ea6550a0 100644 --- a/api_docs/kbn_slo_schema.devdocs.json +++ b/api_docs/kbn_slo_schema.devdocs.json @@ -367,6 +367,36 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/slo-schema", + "id": "def-common.APMTransactionDurationIndicatorSchema", + "type": "Type", + "tags": [], + "label": "APMTransactionDurationIndicatorSchema", + "description": [], + "signature": [ + "{ type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; }" + ], + "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/slo-schema", + "id": "def-common.APMTransactionErrorRateIndicatorSchema", + "type": "Type", + "tags": [], + "label": "APMTransactionErrorRateIndicatorSchema", + "description": [], + "signature": [ + "{ type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; }" + ], + "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/slo-schema", "id": "def-common.BudgetingMethod", @@ -390,7 +420,7 @@ "label": "CreateSLOInput", "description": [], "signature": [ - "{ name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; } & { settings?: { syncDelay?: string | undefined; frequency?: string | undefined; } | undefined; tags?: string[] | undefined; }" + "{ name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; } & { id?: string | undefined; settings?: { syncDelay?: string | undefined; frequency?: string | undefined; } | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -405,7 +435,7 @@ "label": "CreateSLOParams", "description": [], "signature": [ - "{ name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: ", + "{ name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -429,7 +459,7 @@ "section": "def-common.Duration", "text": "Duration" }, - " | undefined; }; } & { settings?: { syncDelay?: ", + " | undefined; }; } & { id?: string | undefined; settings?: { syncDelay?: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -520,7 +550,7 @@ "label": "FindSLOResponse", "description": [], "signature": [ - "{ page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }" + "{ page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -535,7 +565,7 @@ "label": "GetSLOResponse", "description": [], "signature": [ - "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }" + "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -557,6 +587,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/slo-schema", + "id": "def-common.KQLCustomIndicatorSchema", + "type": "Type", + "tags": [], + "label": "KQLCustomIndicatorSchema", + "description": [], + "signature": [ + "{ type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }" + ], + "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/slo-schema", "id": "def-common.ManageSLOParams", @@ -572,6 +617,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/slo-schema", + "id": "def-common.MetricCustomIndicatorSchema", + "type": "Type", + "tags": [], + "label": "MetricCustomIndicatorSchema", + "description": [], + "signature": [ + "{ type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }" + ], + "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/slo-schema", "id": "def-common.SLOResponse", @@ -580,7 +640,7 @@ "label": "SLOResponse", "description": [], "signature": [ - "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }" + "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -595,7 +655,7 @@ "label": "SLOWithSummaryResponse", "description": [], "signature": [ - "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }" + "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -610,7 +670,7 @@ "label": "UpdateSLOInput", "description": [], "signature": [ - "{ name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | undefined; timeWindow?: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; } | undefined; budgetingMethod?: \"occurrences\" | \"timeslices\" | undefined; objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }) | undefined; settings?: { syncDelay?: string | undefined; frequency?: string | undefined; } | undefined; tags?: string[] | undefined; }" + "{ name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; } | undefined; timeWindow?: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; } | undefined; budgetingMethod?: \"occurrences\" | \"timeslices\" | undefined; objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }) | undefined; settings?: { syncDelay?: string | undefined; frequency?: string | undefined; } | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -625,7 +685,7 @@ "label": "UpdateSLOParams", "description": [], "signature": [ - "{ name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | undefined; timeWindow?: { duration: ", + "{ name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; } | undefined; timeWindow?: { duration: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -680,7 +740,7 @@ "label": "UpdateSLOResponse", "description": [], "signature": [ - "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }" + "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -1008,6 +1068,46 @@ "StringC", "; timestampField: ", "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", "; }>; }>]>; timeWindow: ", "UnionC", "<[", @@ -1066,7 +1166,9 @@ }, ", string, unknown>; }>]>; }>, ", "PartialC", - "<{ settings: ", + "<{ id: ", + "StringC", + "; settings: ", "PartialC", "<{ syncDelay: ", "Type", @@ -1436,6 +1538,46 @@ "StringC", "; timestampField: ", "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", "; }>; }>]>; timeWindow: ", "UnionC", "<[", @@ -1712,6 +1854,46 @@ "StringC", "; timestampField: ", "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", "; }>; }>]>; timeWindow: ", "UnionC", "<[", @@ -2008,6 +2190,46 @@ "StringC", "; timestampField: ", "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", "; }>; }>]>" ], "path": "packages/kbn-slo-schema/src/schema/indicators.ts", @@ -2046,7 +2268,9 @@ "LiteralC", "<\"sli.apm.transactionErrorRate\">, ", "LiteralC", - "<\"sli.kql.custom\">]>" + "<\"sli.kql.custom\">, ", + "LiteralC", + "<\"sli.metric.custom\">]>" ], "path": "packages/kbn-slo-schema/src/schema/indicators.ts", "deprecated": false, @@ -2119,6 +2343,76 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/slo-schema", + "id": "def-common.metricCustomIndicatorSchema", + "type": "Object", + "tags": [], + "label": "metricCustomIndicatorSchema", + "description": [], + "signature": [ + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", + "; }>; }>" + ], + "path": "packages/kbn-slo-schema/src/schema/indicators.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/slo-schema", + "id": "def-common.metricCustomIndicatorTypeSchema", + "type": "Object", + "tags": [], + "label": "metricCustomIndicatorTypeSchema", + "description": [], + "signature": [ + "LiteralC", + "<\"sli.metric.custom\">" + ], + "path": "packages/kbn-slo-schema/src/schema/indicators.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/slo-schema", "id": "def-common.objectiveSchema", @@ -2395,6 +2689,46 @@ "StringC", "; timestampField: ", "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", "; }>; }>]>; timeWindow: ", "UnionC", "<[", @@ -2603,6 +2937,46 @@ "StringC", "; timestampField: ", "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", "; }>; }>]>; timeWindow: ", "UnionC", "<[", @@ -2813,6 +3187,46 @@ "StringC", "; timestampField: ", "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", "; }>; }>]>; timeWindow: ", "UnionC", "<[", @@ -3049,6 +3463,46 @@ "StringC", "; timestampField: ", "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", "; }>; }>]>; timeWindow: ", "UnionC", "<[", @@ -3427,6 +3881,46 @@ "StringC", "; timestampField: ", "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", "; }>; }>]>; timeWindow: ", "UnionC", "<[", @@ -3627,6 +4121,46 @@ "StringC", "; timestampField: ", "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", "; }>; }>]>; timeWindow: ", "UnionC", "<[", diff --git a/api_docs/kbn_slo_schema.mdx b/api_docs/kbn_slo_schema.mdx index 4c35bce6e4231..9ff2421837462 100644 --- a/api_docs/kbn_slo_schema.mdx +++ b/api_docs/kbn_slo_schema.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-slo-schema title: "@kbn/slo-schema" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/slo-schema plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/slo-schema'] --- import kbnSloSchemaObj from './kbn_slo_schema.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/actionable-observability](https://github.com/orgs/elastic/team | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 78 | 0 | 78 | 0 | +| 84 | 0 | 84 | 0 | ## Common diff --git a/api_docs/kbn_some_dev_log.mdx b/api_docs/kbn_some_dev_log.mdx index e8fa06077f72c..ffa01472fd58d 100644 --- a/api_docs/kbn_some_dev_log.mdx +++ b/api_docs/kbn_some_dev_log.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-some-dev-log title: "@kbn/some-dev-log" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/some-dev-log plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/some-dev-log'] --- import kbnSomeDevLogObj from './kbn_some_dev_log.devdocs.json'; diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index 0689cd618ff48..daf827d8ed48a 100644 --- a/api_docs/kbn_std.mdx +++ b/api_docs/kbn_std.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-std title: "@kbn/std" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/std plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/std'] --- import kbnStdObj from './kbn_std.devdocs.json'; diff --git a/api_docs/kbn_stdio_dev_helpers.mdx b/api_docs/kbn_stdio_dev_helpers.mdx index 3084d8f8373f5..b35ab12370877 100644 --- a/api_docs/kbn_stdio_dev_helpers.mdx +++ b/api_docs/kbn_stdio_dev_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-stdio-dev-helpers title: "@kbn/stdio-dev-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/stdio-dev-helpers plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/stdio-dev-helpers'] --- import kbnStdioDevHelpersObj from './kbn_stdio_dev_helpers.devdocs.json'; diff --git a/api_docs/kbn_storybook.mdx b/api_docs/kbn_storybook.mdx index 0db3538ca4cbf..b4bc560e25edd 100644 --- a/api_docs/kbn_storybook.mdx +++ b/api_docs/kbn_storybook.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-storybook title: "@kbn/storybook" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/storybook plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/storybook'] --- import kbnStorybookObj from './kbn_storybook.devdocs.json'; diff --git a/api_docs/kbn_telemetry_tools.mdx b/api_docs/kbn_telemetry_tools.mdx index 44373fccac1e2..088a8232aa8c4 100644 --- a/api_docs/kbn_telemetry_tools.mdx +++ b/api_docs/kbn_telemetry_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-telemetry-tools title: "@kbn/telemetry-tools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/telemetry-tools plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/telemetry-tools'] --- import kbnTelemetryToolsObj from './kbn_telemetry_tools.devdocs.json'; diff --git a/api_docs/kbn_test.mdx b/api_docs/kbn_test.mdx index 2a8b7ed6b12ac..64eb145add9bd 100644 --- a/api_docs/kbn_test.mdx +++ b/api_docs/kbn_test.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test title: "@kbn/test" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/test plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] --- import kbnTestObj from './kbn_test.devdocs.json'; diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index ee852a0a3f1d5..a12b559574f46 100644 --- a/api_docs/kbn_test_jest_helpers.mdx +++ b/api_docs/kbn_test_jest_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test-jest-helpers title: "@kbn/test-jest-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/test-jest-helpers plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-jest-helpers'] --- import kbnTestJestHelpersObj from './kbn_test_jest_helpers.devdocs.json'; diff --git a/api_docs/kbn_test_subj_selector.mdx b/api_docs/kbn_test_subj_selector.mdx index 2905aab9bec33..3b2e80cafc458 100644 --- a/api_docs/kbn_test_subj_selector.mdx +++ b/api_docs/kbn_test_subj_selector.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test-subj-selector title: "@kbn/test-subj-selector" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/test-subj-selector plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-subj-selector'] --- import kbnTestSubjSelectorObj from './kbn_test_subj_selector.devdocs.json'; diff --git a/api_docs/kbn_text_based_editor.devdocs.json b/api_docs/kbn_text_based_editor.devdocs.json new file mode 100644 index 0000000000000..60a5a3a4ac391 --- /dev/null +++ b/api_docs/kbn_text_based_editor.devdocs.json @@ -0,0 +1,258 @@ +{ + "id": "@kbn/text-based-editor", + "client": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditor", + "type": "Function", + "tags": [], + "label": "TextBasedLanguagesEditor", + "description": [], + "signature": [ + "React.NamedExoticComponent<", + { + "pluginId": "@kbn/text-based-editor", + "scope": "public", + "docId": "kibKbnTextBasedEditorPluginApi", + "section": "def-public.TextBasedLanguagesEditorProps", + "text": "TextBasedLanguagesEditorProps" + }, + ">" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditor.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditorProps", + "type": "Interface", + "tags": [], + "label": "TextBasedLanguagesEditorProps", + "description": [], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditorProps.query", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "{ sql: string; } | { esql: string; }" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditorProps.onTextLangQueryChange", + "type": "Function", + "tags": [], + "label": "onTextLangQueryChange", + "description": [], + "signature": [ + "(query: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.AggregateQuery", + "text": "AggregateQuery" + }, + ") => void" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditorProps.onTextLangQueryChange.$1", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.AggregateQuery", + "text": "AggregateQuery" + } + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditorProps.onTextLangQuerySubmit", + "type": "Function", + "tags": [], + "label": "onTextLangQuerySubmit", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditorProps.expandCodeEditor", + "type": "Function", + "tags": [], + "label": "expandCodeEditor", + "description": [], + "signature": [ + "(status: boolean) => void" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditorProps.expandCodeEditor.$1", + "type": "boolean", + "tags": [], + "label": "status", + "description": [], + "signature": [ + "boolean" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditorProps.isCodeEditorExpanded", + "type": "boolean", + "tags": [], + "label": "isCodeEditorExpanded", + "description": [], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditorProps.errors", + "type": "Array", + "tags": [], + "label": "errors", + "description": [], + "signature": [ + "Error[] | undefined" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditorProps.isDisabled", + "type": "CompoundType", + "tags": [], + "label": "isDisabled", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditorProps.isDarkMode", + "type": "CompoundType", + "tags": [], + "label": "isDarkMode", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/text-based-editor", + "id": "def-public.TextBasedLanguagesEditorProps.dataTestSubj", + "type": "string", + "tags": [], + "label": "dataTestSubj", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_text_based_editor.mdx b/api_docs/kbn_text_based_editor.mdx new file mode 100644 index 0000000000000..a16abc0a2c8fc --- /dev/null +++ b/api_docs/kbn_text_based_editor.mdx @@ -0,0 +1,33 @@ +--- +#### +#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system. +#### Reach out in #docs-engineering for more info. +#### +id: kibKbnTextBasedEditorPluginApi +slug: /kibana-dev-docs/api/kbn-text-based-editor +title: "@kbn/text-based-editor" +image: https://source.unsplash.com/400x175/?github +description: API docs for the @kbn/text-based-editor plugin +date: 2023-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/text-based-editor'] +--- +import kbnTextBasedEditorObj from './kbn_text_based_editor.devdocs.json'; + + + +Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 14 | 0 | 13 | 0 | + +## Client + +### Functions + + +### Interfaces + + diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index 0efe35c10f789..e295fbf0ead7d 100644 --- a/api_docs/kbn_tooling_log.mdx +++ b/api_docs/kbn_tooling_log.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-tooling-log title: "@kbn/tooling-log" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/tooling-log plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] --- import kbnToolingLogObj from './kbn_tooling_log.devdocs.json'; diff --git a/api_docs/kbn_ts_projects.mdx b/api_docs/kbn_ts_projects.mdx index 632b1bef1cd0b..e8981be691e01 100644 --- a/api_docs/kbn_ts_projects.mdx +++ b/api_docs/kbn_ts_projects.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ts-projects title: "@kbn/ts-projects" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ts-projects plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ts-projects'] --- import kbnTsProjectsObj from './kbn_ts_projects.devdocs.json'; diff --git a/api_docs/kbn_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx index 7a0a8650dc21e..07e0e5cf7a115 100644 --- a/api_docs/kbn_typed_react_router_config.mdx +++ b/api_docs/kbn_typed_react_router_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-typed-react-router-config title: "@kbn/typed-react-router-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/typed-react-router-config plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/typed-react-router-config'] --- import kbnTypedReactRouterConfigObj from './kbn_typed_react_router_config.devdocs.json'; diff --git a/api_docs/kbn_ui_actions_browser.mdx b/api_docs/kbn_ui_actions_browser.mdx index 27a26327b95b0..ef5a2c913d191 100644 --- a/api_docs/kbn_ui_actions_browser.mdx +++ b/api_docs/kbn_ui_actions_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-actions-browser title: "@kbn/ui-actions-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ui-actions-browser plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-actions-browser'] --- import kbnUiActionsBrowserObj from './kbn_ui_actions_browser.devdocs.json'; diff --git a/api_docs/kbn_ui_shared_deps_src.mdx b/api_docs/kbn_ui_shared_deps_src.mdx index bd23a47797c81..c7aec6d5968b1 100644 --- a/api_docs/kbn_ui_shared_deps_src.mdx +++ b/api_docs/kbn_ui_shared_deps_src.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-shared-deps-src title: "@kbn/ui-shared-deps-src" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ui-shared-deps-src plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-shared-deps-src'] --- import kbnUiSharedDepsSrcObj from './kbn_ui_shared_deps_src.devdocs.json'; diff --git a/api_docs/kbn_ui_theme.mdx b/api_docs/kbn_ui_theme.mdx index e502b7a0506c3..6ab99dcef62d7 100644 --- a/api_docs/kbn_ui_theme.mdx +++ b/api_docs/kbn_ui_theme.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-theme title: "@kbn/ui-theme" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ui-theme plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] --- import kbnUiThemeObj from './kbn_ui_theme.devdocs.json'; diff --git a/api_docs/kbn_url_state.mdx b/api_docs/kbn_url_state.mdx index d99362bfd33eb..f2eacd0183469 100644 --- a/api_docs/kbn_url_state.mdx +++ b/api_docs/kbn_url_state.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-url-state title: "@kbn/url-state" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/url-state plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/url-state'] --- import kbnUrlStateObj from './kbn_url_state.devdocs.json'; diff --git a/api_docs/kbn_user_profile_components.mdx b/api_docs/kbn_user_profile_components.mdx index cb86fba67a4c3..5042e94fb4303 100644 --- a/api_docs/kbn_user_profile_components.mdx +++ b/api_docs/kbn_user_profile_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-user-profile-components title: "@kbn/user-profile-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/user-profile-components plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/user-profile-components'] --- import kbnUserProfileComponentsObj from './kbn_user_profile_components.devdocs.json'; diff --git a/api_docs/kbn_utility_types.mdx b/api_docs/kbn_utility_types.mdx index 6071eb0943502..8458bd59f01a9 100644 --- a/api_docs/kbn_utility_types.mdx +++ b/api_docs/kbn_utility_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types title: "@kbn/utility-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/utility-types plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types'] --- import kbnUtilityTypesObj from './kbn_utility_types.devdocs.json'; diff --git a/api_docs/kbn_utility_types_jest.mdx b/api_docs/kbn_utility_types_jest.mdx index 42c56e5d5cf23..844ebeb3e679f 100644 --- a/api_docs/kbn_utility_types_jest.mdx +++ b/api_docs/kbn_utility_types_jest.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types-jest title: "@kbn/utility-types-jest" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/utility-types-jest plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types-jest'] --- import kbnUtilityTypesJestObj from './kbn_utility_types_jest.devdocs.json'; diff --git a/api_docs/kbn_utils.devdocs.json b/api_docs/kbn_utils.devdocs.json index 88821550bc555..c2f4eefd1be61 100644 --- a/api_docs/kbn_utils.devdocs.json +++ b/api_docs/kbn_utils.devdocs.json @@ -19,23 +19,6 @@ "common": { "classes": [], "functions": [ - { - "parentPluginId": "@kbn/utils", - "id": "def-common.buildDataPaths", - "type": "Function", - "tags": [], - "label": "buildDataPaths", - "description": [], - "signature": [ - "() => string[]" - ], - "path": "packages/kbn-utils/src/path/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/utils", "id": "def-common.concatStreamProviders", diff --git a/api_docs/kbn_utils.mdx b/api_docs/kbn_utils.mdx index 76a92d6919dfa..7feb5bf592707 100644 --- a/api_docs/kbn_utils.mdx +++ b/api_docs/kbn_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utils title: "@kbn/utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/utils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utils'] --- import kbnUtilsObj from './kbn_utils.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kiban | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 25 | 0 | 15 | 0 | +| 24 | 0 | 14 | 0 | ## Common diff --git a/api_docs/kbn_yarn_lock_validator.mdx b/api_docs/kbn_yarn_lock_validator.mdx index 3dd342c01a3ad..0e3532fc5d7ca 100644 --- a/api_docs/kbn_yarn_lock_validator.mdx +++ b/api_docs/kbn_yarn_lock_validator.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-yarn-lock-validator title: "@kbn/yarn-lock-validator" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/yarn-lock-validator plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/yarn-lock-validator'] --- import kbnYarnLockValidatorObj from './kbn_yarn_lock_validator.devdocs.json'; diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx index 4c07e941859c1..a94fc6ff9b19d 100644 --- a/api_docs/kibana_overview.mdx +++ b/api_docs/kibana_overview.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaOverview title: "kibanaOverview" image: https://source.unsplash.com/400x175/?github description: API docs for the kibanaOverview plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview'] --- import kibanaOverviewObj from './kibana_overview.devdocs.json'; diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index b7b084baa490c..429e8e2880207 100644 --- a/api_docs/kibana_react.mdx +++ b/api_docs/kibana_react.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaReact title: "kibanaReact" image: https://source.unsplash.com/400x175/?github description: API docs for the kibanaReact plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact'] --- import kibanaReactObj from './kibana_react.devdocs.json'; diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index ce85b900a590a..4998e30fed599 100644 --- a/api_docs/kibana_utils.mdx +++ b/api_docs/kibana_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaUtils title: "kibanaUtils" image: https://source.unsplash.com/400x175/?github description: API docs for the kibanaUtils plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaUtils'] --- import kibanaUtilsObj from './kibana_utils.devdocs.json'; diff --git a/api_docs/kubernetes_security.devdocs.json b/api_docs/kubernetes_security.devdocs.json index 53e8a6806be07..6be2f6084e66f 100644 --- a/api_docs/kubernetes_security.devdocs.json +++ b/api_docs/kubernetes_security.devdocs.json @@ -54,7 +54,38 @@ } ], "enums": [], - "misc": [], + "misc": [ + { + "parentPluginId": "kubernetesSecurity", + "id": "def-public.KUBERNETES_PATH", + "type": "string", + "tags": [], + "label": "KUBERNETES_PATH", + "description": [], + "signature": [ + "\"/kubernetes\"" + ], + "path": "x-pack/plugins/kubernetes_security/common/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "kubernetesSecurity", + "id": "def-public.KUBERNETES_TITLE", + "type": "string", + "tags": [], + "label": "KUBERNETES_TITLE", + "description": [], + "signature": [ + "\"Kubernetes\"" + ], + "path": "x-pack/plugins/kubernetes_security/common/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], "objects": [] }, "server": { diff --git a/api_docs/kubernetes_security.mdx b/api_docs/kubernetes_security.mdx index a647bfe13d246..70ed93ec69371 100644 --- a/api_docs/kubernetes_security.mdx +++ b/api_docs/kubernetes_security.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kubernetesSecurity title: "kubernetesSecurity" image: https://source.unsplash.com/400x175/?github description: API docs for the kubernetesSecurity plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kubernetesSecurity'] --- import kubernetesSecurityObj from './kubernetes_security.devdocs.json'; @@ -21,10 +21,13 @@ Contact [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/ | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3 | 0 | 3 | 1 | +| 5 | 0 | 5 | 1 | ## Client ### Interfaces +### Consts, variables and types + + diff --git a/api_docs/lens.devdocs.json b/api_docs/lens.devdocs.json index 712192b0396e5..e8fa7dcc3b523 100644 --- a/api_docs/lens.devdocs.json +++ b/api_docs/lens.devdocs.json @@ -4788,6 +4788,20 @@ "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.SuggestionRequest.allowMixed", + "type": "CompoundType", + "tags": [], + "label": "allowMixed", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index 298265aa44567..9fee5b8316b40 100644 --- a/api_docs/lens.mdx +++ b/api_docs/lens.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/lens title: "lens" image: https://source.unsplash.com/400x175/?github description: API docs for the lens plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] --- import lensObj from './lens.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 611 | 0 | 515 | 52 | +| 612 | 0 | 516 | 52 | ## Client diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index 0ae219937011d..efaa824daf521 100644 --- a/api_docs/license_api_guard.mdx +++ b/api_docs/license_api_guard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licenseApiGuard title: "licenseApiGuard" image: https://source.unsplash.com/400x175/?github description: API docs for the licenseApiGuard plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard'] --- import licenseApiGuardObj from './license_api_guard.devdocs.json'; diff --git a/api_docs/license_management.mdx b/api_docs/license_management.mdx index a35365218b28f..5967fae0f84ff 100644 --- a/api_docs/license_management.mdx +++ b/api_docs/license_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licenseManagement title: "licenseManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the licenseManagement plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement'] --- import licenseManagementObj from './license_management.devdocs.json'; diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index 5fc3c3305f845..3c5de59a2a4a1 100644 --- a/api_docs/licensing.mdx +++ b/api_docs/licensing.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licensing title: "licensing" image: https://source.unsplash.com/400x175/?github description: API docs for the licensing plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] --- import licensingObj from './licensing.devdocs.json'; diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index 12274a77db533..de65b543dd474 100644 --- a/api_docs/lists.mdx +++ b/api_docs/lists.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/lists title: "lists" image: https://source.unsplash.com/400x175/?github description: API docs for the lists plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] --- import listsObj from './lists.devdocs.json'; diff --git a/api_docs/management.mdx b/api_docs/management.mdx index 4d051f1f0ac6e..a3834cec09573 100644 --- a/api_docs/management.mdx +++ b/api_docs/management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/management title: "management" image: https://source.unsplash.com/400x175/?github description: API docs for the management plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] --- import managementObj from './management.devdocs.json'; diff --git a/api_docs/maps.devdocs.json b/api_docs/maps.devdocs.json index 5b7625d514738..d8772016b2b6e 100644 --- a/api_docs/maps.devdocs.json +++ b/api_docs/maps.devdocs.json @@ -3035,10 +3035,10 @@ }, { "parentPluginId": "maps", - "id": "def-public.IVectorSource.showJoinEditor", + "id": "def-public.IVectorSource.supportsJoins", "type": "Function", "tags": [], - "label": "showJoinEditor", + "label": "supportsJoins", "description": [], "signature": [ "() => boolean" @@ -3049,22 +3049,6 @@ "children": [], "returnComment": [] }, - { - "parentPluginId": "maps", - "id": "def-public.IVectorSource.getJoinsDisabledReason", - "type": "Function", - "tags": [], - "label": "getJoinsDisabledReason", - "description": [], - "signature": [ - "() => string | null" - ], - "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] - }, { "parentPluginId": "maps", "id": "def-public.IVectorSource.getSyncMeta", @@ -4137,7 +4121,7 @@ "label": "SourceEditorArgs", "description": [], "signature": [ - "{ currentLayerType: string; numberOfJoins: number; onChange: (...args: ", + "{ currentLayerType: string; hasSpatialJoins: boolean; numberOfJoins: number; onChange: (...args: ", "OnSourceChangeArgs", "[]) => Promise; onStyleDescriptorChange: (styleDescriptor: ", "StyleDescriptor", @@ -4609,7 +4593,7 @@ "AbstractSourceDescriptor", " & { id: string; indexPatternId: string; geoField?: string | undefined; applyGlobalQuery: boolean; applyGlobalTime: boolean; applyForceRefresh: boolean; } & { metrics: ", "AggDescriptor", - "[]; } & { term: string; whereQuery?: ", + "[]; } & { whereQuery?: ", { "pluginId": "@kbn/es-query", "scope": "common", @@ -4617,7 +4601,7 @@ "section": "def-common.Query", "text": "Query" }, - " | undefined; size?: number | undefined; type: ", + " | undefined; } & { term: string; size?: number | undefined; type: ", { "pluginId": "maps", "scope": "common", @@ -4829,9 +4813,9 @@ "section": "def-common.LAYER_TYPE", "text": "LAYER_TYPE" }, - ".MVT_VECTOR; joins?: ", + ".MVT_VECTOR; joins?: Partial<", "JoinDescriptor", - "[] | undefined; style: ", + ">[] | undefined; style: ", { "pluginId": "maps", "scope": "common", diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index 4c3aca1445243..80ed8c80f7ecb 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/maps title: "maps" image: https://source.unsplash.com/400x175/?github description: API docs for the maps plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] --- import mapsObj from './maps.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 269 | 0 | 268 | 29 | +| 268 | 0 | 267 | 29 | ## Client diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index c760daa16d9ca..c66c3b20d2340 100644 --- a/api_docs/maps_ems.mdx +++ b/api_docs/maps_ems.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/mapsEms title: "mapsEms" image: https://source.unsplash.com/400x175/?github description: API docs for the mapsEms plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] --- import mapsEmsObj from './maps_ems.devdocs.json'; diff --git a/api_docs/ml.devdocs.json b/api_docs/ml.devdocs.json index 79b088407a48e..bb25babafa190 100644 --- a/api_docs/ml.devdocs.json +++ b/api_docs/ml.devdocs.json @@ -719,7 +719,7 @@ "tags": [], "label": "fullJob", "description": [ - "\nUsed in older implementations of the job config, where the datafeed was placed inside the job for convenience.\nThis will be populated if the job's id has been passed to the /api/ml/jobs/jobs_summary endpoint." + "\nUsed in older implementations of the job config, where the datafeed was placed inside the job for convenience.\nThis will be populated if the job's id has been passed to the /internal/ml/jobs/jobs_summary endpoint." ], "signature": [ "CombinedJob", @@ -1607,7 +1607,7 @@ "tags": [], "label": "fullJob", "description": [ - "\nUsed in older implementations of the job config, where the datafeed was placed inside the job for convenience.\nThis will be populated if the job's id has been passed to the /api/ml/jobs/jobs_summary endpoint." + "\nUsed in older implementations of the job config, where the datafeed was placed inside the job for convenience.\nThis will be populated if the job's id has been passed to the /internal/ml/jobs/jobs_summary endpoint." ], "signature": [ "CombinedJob", @@ -2481,7 +2481,7 @@ "tags": [], "label": "fullJob", "description": [ - "\nUsed in older implementations of the job config, where the datafeed was placed inside the job for convenience.\nThis will be populated if the job's id has been passed to the /api/ml/jobs/jobs_summary endpoint." + "\nUsed in older implementations of the job config, where the datafeed was placed inside the job for convenience.\nThis will be populated if the job's id has been passed to the /internal/ml/jobs/jobs_summary endpoint." ], "signature": [ "CombinedJob", diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index 810cb6101f7d5..28ea6210cfda6 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ml title: "ml" image: https://source.unsplash.com/400x175/?github description: API docs for the ml plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] --- import mlObj from './ml.devdocs.json'; diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index 5aca7c6e51d44..c9d3d8b550ee1 100644 --- a/api_docs/monitoring.mdx +++ b/api_docs/monitoring.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/monitoring title: "monitoring" image: https://source.unsplash.com/400x175/?github description: API docs for the monitoring plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoring'] --- import monitoringObj from './monitoring.devdocs.json'; diff --git a/api_docs/monitoring_collection.mdx b/api_docs/monitoring_collection.mdx index 69022ba739ece..2a5a514f2b4d8 100644 --- a/api_docs/monitoring_collection.mdx +++ b/api_docs/monitoring_collection.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/monitoringCollection title: "monitoringCollection" image: https://source.unsplash.com/400x175/?github description: API docs for the monitoringCollection plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoringCollection'] --- import monitoringCollectionObj from './monitoring_collection.devdocs.json'; diff --git a/api_docs/navigation.mdx b/api_docs/navigation.mdx index e3f54b57b2989..835a9e6685b7c 100644 --- a/api_docs/navigation.mdx +++ b/api_docs/navigation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/navigation title: "navigation" image: https://source.unsplash.com/400x175/?github description: API docs for the navigation plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'navigation'] --- import navigationObj from './navigation.devdocs.json'; diff --git a/api_docs/newsfeed.mdx b/api_docs/newsfeed.mdx index ece6634937676..60d4d99999b81 100644 --- a/api_docs/newsfeed.mdx +++ b/api_docs/newsfeed.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/newsfeed title: "newsfeed" image: https://source.unsplash.com/400x175/?github description: API docs for the newsfeed plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed'] --- import newsfeedObj from './newsfeed.devdocs.json'; diff --git a/api_docs/notifications.mdx b/api_docs/notifications.mdx index 1a80b3c4cdc65..8c531789995f6 100644 --- a/api_docs/notifications.mdx +++ b/api_docs/notifications.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/notifications title: "notifications" image: https://source.unsplash.com/400x175/?github description: API docs for the notifications plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'notifications'] --- import notificationsObj from './notifications.devdocs.json'; diff --git a/api_docs/observability.devdocs.json b/api_docs/observability.devdocs.json index e2165052bc0f5..cb678ec100079 100644 --- a/api_docs/observability.devdocs.json +++ b/api_docs/observability.devdocs.json @@ -3,56 +3,6 @@ "client": { "classes": [], "functions": [ - { - "parentPluginId": "observability", - "id": "def-public.ActionMenu", - "type": "Function", - "tags": [], - "label": "ActionMenu", - "description": [], - "signature": [ - "(props: Props) => JSX.Element" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.ActionMenu.$1", - "type": "CompoundType", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "Props" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.ActionMenuDivider", - "type": "Function", - "tags": [], - "label": "ActionMenuDivider", - "description": [], - "signature": [ - "() => JSX.Element" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "observability", "id": "def-public.AlertSummary", @@ -257,39 +207,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "observability", - "id": "def-public.createEsParams", - "type": "Function", - "tags": [], - "label": "createEsParams", - "description": [], - "signature": [ - "(params: T) => T" - ], - "path": "x-pack/plugins/observability/public/hooks/use_es_search.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.createEsParams.$1", - "type": "Uncategorized", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "T" - ], - "path": "x-pack/plugins/observability/public/hooks/use_es_search.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "observability", "id": "def-public.createObservabilityRuleTypeRegistryMock", @@ -332,7 +249,13 @@ "description": [], "signature": [ "() => (options?: ", - "Options", + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.Options", + "text": "Options" + }, ") => ", "LinkProps" ], @@ -351,11 +274,11 @@ "label": "DatePicker", "description": [], "signature": [ - "(props: ", + "({\n rangeFrom,\n rangeTo,\n refreshPaused,\n refreshInterval,\n width = 'restricted',\n onTimeRangeRefresh,\n}: ", "DatePickerProps", ") => JSX.Element" ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", + "path": "x-pack/plugins/observability/public/pages/overview/components/date_picker/date_picker.tsx", "deprecated": false, "trackAdoption": false, "children": [ @@ -364,12 +287,12 @@ "id": "def-public.DatePicker.$1", "type": "Object", "tags": [], - "label": "props", + "label": "{\n rangeFrom,\n rangeTo,\n refreshPaused,\n refreshInterval,\n width = 'restricted',\n onTimeRangeRefresh,\n}", "description": [], "signature": [ "DatePickerProps" ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", + "path": "x-pack/plugins/observability/public/pages/overview/components/date_picker/date_picker.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -388,7 +311,7 @@ "signature": [ "({ children }: { children: React.ReactElement>; }) => JSX.Element" ], - "path": "x-pack/plugins/observability/public/context/date_picker_context.tsx", + "path": "x-pack/plugins/observability/public/context/date_picker_context/date_picker_context.tsx", "deprecated": false, "trackAdoption": false, "children": [ @@ -399,7 +322,7 @@ "tags": [], "label": "{ children }", "description": [], - "path": "x-pack/plugins/observability/public/context/date_picker_context.tsx", + "path": "x-pack/plugins/observability/public/context/date_picker_context/date_picker_context.tsx", "deprecated": false, "trackAdoption": false, "children": [ @@ -413,7 +336,7 @@ "signature": [ "React.ReactElement>" ], - "path": "x-pack/plugins/observability/public/context/date_picker_context.tsx", + "path": "x-pack/plugins/observability/public/context/date_picker_context/date_picker_context.tsx", "deprecated": false, "trackAdoption": false } @@ -423,111 +346,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "observability", - "id": "def-public.FieldValueSelection", - "type": "Function", - "tags": [], - "label": "FieldValueSelection", - "description": [], - "signature": [ - "(props: ", - "FieldValueSelectionProps", - ") => JSX.Element" - ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.FieldValueSelection.$1", - "type": "CompoundType", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "FieldValueSelectionProps" - ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.FieldValueSuggestions", - "type": "Function", - "tags": [], - "label": "FieldValueSuggestions", - "description": [], - "signature": [ - "(props: ", - "FieldValueSuggestionsProps", - ") => JSX.Element" - ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.FieldValueSuggestions.$1", - "type": "CompoundType", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "FieldValueSuggestionsProps" - ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.FilterValueLabel", - "type": "Function", - "tags": [], - "label": "FilterValueLabel", - "description": [], - "signature": [ - "(props: ", - "FilterValueLabelProps", - ") => JSX.Element" - ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.FilterValueLabel.$1", - "type": "Object", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "FilterValueLabelProps" - ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "observability", "id": "def-public.formatAlertEvaluationValue", @@ -769,7 +587,7 @@ "CoreVitalProps", ") => JSX.Element" ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", + "path": "x-pack/plugins/observability/public/components/core_web_vitals/get_core_web_vitals_lazy.tsx", "deprecated": false, "trackAdoption": false, "children": [ @@ -783,42 +601,7 @@ "signature": [ "CoreVitalProps" ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.HeaderMenuPortal", - "type": "Function", - "tags": [], - "label": "HeaderMenuPortal", - "description": [], - "signature": [ - "(props: ", - "HeaderMenuPortalProps", - ") => JSX.Element" - ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.HeaderMenuPortal.$1", - "type": "Object", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "HeaderMenuPortalProps" - ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", + "path": "x-pack/plugins/observability/public/components/core_web_vitals/get_core_web_vitals_lazy.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -827,51 +610,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "observability", - "id": "def-public.InspectorContextProvider", - "type": "Function", - "tags": [], - "label": "InspectorContextProvider", - "description": [], - "signature": [ - "({ children }: { children: React.ReactNode; }) => JSX.Element" - ], - "path": "x-pack/plugins/observability/public/context/inspector/inspector_context.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.InspectorContextProvider.$1", - "type": "Object", - "tags": [], - "label": "{ children }", - "description": [], - "path": "x-pack/plugins/observability/public/context/inspector/inspector_context.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.InspectorContextProvider.$1.children", - "type": "CompoundType", - "tags": [], - "label": "children", - "description": [], - "signature": [ - "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" - ], - "path": "x-pack/plugins/observability/public/context/inspector/inspector_context.tsx", - "deprecated": false, - "trackAdoption": false - } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "observability", "id": "def-public.LazyAlertsFlyout", @@ -932,31 +670,31 @@ }, { "parentPluginId": "observability", - "id": "def-public.LoadWhenInView", + "id": "def-public.ObservabilityAlertSearchBar", "type": "Function", "tags": [], - "label": "LoadWhenInView", + "label": "ObservabilityAlertSearchBar", "description": [], "signature": [ "(props: ", - "LoadWhenInViewProps", + "ObservabilityAlertSearchBarProps", ") => JSX.Element" ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", + "path": "x-pack/plugins/observability/public/components/alert_search_bar/get_alert_search_bar_lazy.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observability", - "id": "def-public.LoadWhenInView.$1", + "id": "def-public.ObservabilityAlertSearchBar.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ - "LoadWhenInViewProps" + "ObservabilityAlertSearchBarProps" ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", + "path": "x-pack/plugins/observability/public/components/alert_search_bar/get_alert_search_bar_lazy.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -967,32 +705,34 @@ }, { "parentPluginId": "observability", - "id": "def-public.NavigationWarningPromptProvider", + "id": "def-public.toQuery", "type": "Function", "tags": [], - "label": "NavigationWarningPromptProvider", + "label": "toQuery", "description": [], "signature": [ - "({ children }: { children?: React.ReactNode; }) => JSX.Element" + "(search: string | undefined) => ", + "ParsedQuery", + "" ], - "path": "x-pack/plugins/observability/public/utils/navigation_warning_prompt/context.tsx", + "path": "x-pack/plugins/observability/public/utils/url.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "observability", - "id": "def-public.NavigationWarningPromptProvider.$1", - "type": "Object", + "id": "def-public.toQuery.$1", + "type": "string", "tags": [], - "label": "{ children }", + "label": "search", "description": [], "signature": [ - "{ children?: React.ReactNode; }" + "string | undefined" ], - "path": "x-pack/plugins/observability/public/utils/navigation_warning_prompt/context.tsx", + "path": "x-pack/plugins/observability/public/utils/url.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [], @@ -1000,768 +740,22 @@ }, { "parentPluginId": "observability", - "id": "def-public.ObservabilityAlertSearchBar", + "id": "def-public.useTimeBuckets", "type": "Function", "tags": [], - "label": "ObservabilityAlertSearchBar", + "label": "useTimeBuckets", "description": [], "signature": [ - "(props: ", - "ObservabilityAlertSearchBarProps", - ") => JSX.Element" + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.TimeBuckets", + "text": "TimeBuckets" + } ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.ObservabilityAlertSearchBar.$1", - "type": "Object", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "ObservabilityAlertSearchBarProps" - ], - "path": "x-pack/plugins/observability/public/components/shared/index.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.Prompt", - "type": "Function", - "tags": [], - "label": "Prompt", - "description": [], - "signature": [ - "({ prompt }: React.PropsWithChildren) => null" - ], - "path": "x-pack/plugins/observability/public/utils/navigation_warning_prompt/prompt.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.Prompt.$1", - "type": "CompoundType", - "tags": [], - "label": "{ prompt }", - "description": [], - "signature": [ - "React.PropsWithChildren" - ], - "path": "x-pack/plugins/observability/public/utils/navigation_warning_prompt/prompt.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.Section", - "type": "Function", - "tags": [], - "label": "Section", - "description": [], - "signature": [ - "string & ", - "StyledComponentBase", - "<\"div\", any, {}, never> & ", - "NonReactStatics", - "" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.SectionLink", - "type": "Function", - "tags": [], - "label": "SectionLink", - "description": [], - "signature": [ - "(props: ", - "EuiListGroupItemProps", - ") => JSX.Element" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.SectionLink.$1", - "type": "CompoundType", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "EuiListGroupItemProps" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.SectionLinks", - "type": "Function", - "tags": [], - "label": "SectionLinks", - "description": [], - "signature": [ - "({ children, ...props }: { children?: React.ReactNode; } & ", - "CommonProps", - " & Omit, \"color\"> & { bordered?: boolean | undefined; flush?: boolean | undefined; gutterSize?: \"m\" | \"none\" | \"s\" | undefined; listItems?: ", - "EuiListGroupItemProps", - "[] | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; size?: \"m\" | \"s\" | \"xs\" | \"l\" | undefined; maxWidth?: boolean | ", - "Property", - ".MaxWidth | undefined; showToolTips?: boolean | undefined; wrapText?: boolean | undefined; ariaLabelledby?: string | undefined; }) => JSX.Element" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.SectionLinks.$1", - "type": "CompoundType", - "tags": [], - "label": "{ children, ...props }", - "description": [], - "signature": [ - "{ children?: React.ReactNode; } & ", - "CommonProps", - " & Omit, \"color\"> & { bordered?: boolean | undefined; flush?: boolean | undefined; gutterSize?: \"m\" | \"none\" | \"s\" | undefined; listItems?: ", - "EuiListGroupItemProps", - "[] | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; size?: \"m\" | \"s\" | \"xs\" | \"l\" | undefined; maxWidth?: boolean | ", - "Property", - ".MaxWidth | undefined; showToolTips?: boolean | undefined; wrapText?: boolean | undefined; ariaLabelledby?: string | undefined; }" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.SectionSpacer", - "type": "Function", - "tags": [], - "label": "SectionSpacer", - "description": [], - "signature": [ - "() => JSX.Element" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.SectionSubtitle", - "type": "Function", - "tags": [], - "label": "SectionSubtitle", - "description": [], - "signature": [ - "({ children }: { children?: React.ReactNode; }) => JSX.Element" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.SectionSubtitle.$1", - "type": "Object", - "tags": [], - "label": "{ children }", - "description": [], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.SectionSubtitle.$1.children", - "type": "CompoundType", - "tags": [], - "label": "children", - "description": [], - "signature": [ - "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false - } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.SectionTitle", - "type": "Function", - "tags": [], - "label": "SectionTitle", - "description": [], - "signature": [ - "({ children }: { children?: React.ReactNode; }) => JSX.Element" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.SectionTitle.$1", - "type": "Object", - "tags": [], - "label": "{ children }", - "description": [], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.SectionTitle.$1.children", - "type": "CompoundType", - "tags": [], - "label": "children", - "description": [], - "signature": [ - "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false - } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.shouldHandleLinkEvent", - "type": "Function", - "tags": [], - "label": "shouldHandleLinkEvent", - "description": [], - "signature": [ - "(e: React.MouseEvent | React.MouseEvent) => boolean" - ], - "path": "x-pack/plugins/observability/public/hooks/use_link_props.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.shouldHandleLinkEvent.$1", - "type": "CompoundType", - "tags": [], - "label": "e", - "description": [], - "signature": [ - "React.MouseEvent | React.MouseEvent" - ], - "path": "x-pack/plugins/observability/public/hooks/use_link_props.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.toQuery", - "type": "Function", - "tags": [], - "label": "toQuery", - "description": [], - "signature": [ - "(search: string | undefined) => ", - "ParsedQuery", - "" - ], - "path": "x-pack/plugins/observability/public/utils/url.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.toQuery.$1", - "type": "string", - "tags": [], - "label": "search", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/observability/public/utils/url.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.useBreadcrumbs", - "type": "Function", - "tags": [], - "label": "useBreadcrumbs", - "description": [], - "signature": [ - "(extraCrumbs: ", - "EuiBreadcrumbProps", - "[], app?: { id: string; label: string; } | undefined) => void" - ], - "path": "x-pack/plugins/observability/public/hooks/use_breadcrumbs.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.useBreadcrumbs.$1", - "type": "Array", - "tags": [], - "label": "extraCrumbs", - "description": [], - "signature": [ - "EuiBreadcrumbProps", - "[]" - ], - "path": "x-pack/plugins/observability/public/hooks/use_breadcrumbs.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "observability", - "id": "def-public.useBreadcrumbs.$2", - "type": "Object", - "tags": [], - "label": "app", - "description": [], - "path": "x-pack/plugins/observability/public/hooks/use_breadcrumbs.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.useBreadcrumbs.$2.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/observability/public/hooks/use_breadcrumbs.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-public.useBreadcrumbs.$2.label", - "type": "string", - "tags": [], - "label": "label", - "description": [], - "path": "x-pack/plugins/observability/public/hooks/use_breadcrumbs.ts", - "deprecated": false, - "trackAdoption": false - } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.useChartTheme", - "type": "Function", - "tags": [], - "label": "useChartTheme", - "description": [], - "signature": [ - "() => ", - "RecursivePartial", - "<", - "Theme", - ">[]" - ], - "path": "x-pack/plugins/observability/public/hooks/use_chart_theme.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.useEsSearch", - "type": "Function", - "tags": [], - "label": "useEsSearch", - "description": [], - "signature": [ - "(params: TParams, fnDeps: any[], options: { inspector?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IInspectorInfo", - "text": "IInspectorInfo" - }, - " | undefined; name: string; }) => { data: ", - { - "pluginId": "@kbn/es-types", - "scope": "common", - "docId": "kibKbnEsTypesPluginApi", - "section": "def-common.ESSearchResponse", - "text": "ESSearchResponse" - }, - "; loading: boolean; }" - ], - "path": "x-pack/plugins/observability/public/hooks/use_es_search.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.useEsSearch.$1", - "type": "Uncategorized", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "TParams" - ], - "path": "x-pack/plugins/observability/public/hooks/use_es_search.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "observability", - "id": "def-public.useEsSearch.$2", - "type": "Array", - "tags": [], - "label": "fnDeps", - "description": [], - "signature": [ - "any[]" - ], - "path": "x-pack/plugins/observability/public/hooks/use_es_search.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "observability", - "id": "def-public.useEsSearch.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "x-pack/plugins/observability/public/hooks/use_es_search.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.useEsSearch.$3.inspector", - "type": "Object", - "tags": [], - "label": "inspector", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IInspectorInfo", - "text": "IInspectorInfo" - }, - " | undefined" - ], - "path": "x-pack/plugins/observability/public/hooks/use_es_search.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-public.useEsSearch.$3.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "x-pack/plugins/observability/public/hooks/use_es_search.ts", - "deprecated": false, - "trackAdoption": false - } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.useFetcher", - "type": "Function", - "tags": [], - "label": "useFetcher", - "description": [], - "signature": [ - "(fn: ({}: { signal: AbortSignal; }) => TReturn, fnDeps: any[], options: { preservePreviousData?: boolean | undefined; }) => ", - "FetcherResult", - "> & { refetch: () => void; }" - ], - "path": "x-pack/plugins/observability/public/hooks/use_fetcher.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.useFetcher.$1", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "({}: { signal: AbortSignal; }) => TReturn" - ], - "path": "x-pack/plugins/observability/public/hooks/use_fetcher.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "observability", - "id": "def-public.useFetcher.$2", - "type": "Array", - "tags": [], - "label": "fnDeps", - "description": [], - "signature": [ - "any[]" - ], - "path": "x-pack/plugins/observability/public/hooks/use_fetcher.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "observability", - "id": "def-public.useFetcher.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "x-pack/plugins/observability/public/hooks/use_fetcher.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.useFetcher.$3.preservePreviousData", - "type": "CompoundType", - "tags": [], - "label": "preservePreviousData", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/observability/public/hooks/use_fetcher.tsx", - "deprecated": false, - "trackAdoption": false - } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.useInspectorContext", - "type": "Function", - "tags": [], - "label": "useInspectorContext", - "description": [], - "signature": [ - "() => ", - "InspectorContextValue" - ], - "path": "x-pack/plugins/observability/public/context/inspector/use_inspector_context.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.useLinkProps", - "type": "Function", - "tags": [], - "label": "useLinkProps", - "description": [], - "signature": [ - "({ app, pathname, hash, search }: ", - { - "pluginId": "observability", - "scope": "public", - "docId": "kibObservabilityPluginApi", - "section": "def-public.LinkDescriptor", - "text": "LinkDescriptor" - }, - ", options?: ", - "Options", - ") => ", - "LinkProps" - ], - "path": "x-pack/plugins/observability/public/hooks/use_link_props.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.useLinkProps.$1", - "type": "Object", - "tags": [], - "label": "{ app, pathname, hash, search }", - "description": [], - "signature": [ - { - "pluginId": "observability", - "scope": "public", - "docId": "kibObservabilityPluginApi", - "section": "def-public.LinkDescriptor", - "text": "LinkDescriptor" - } - ], - "path": "x-pack/plugins/observability/public/hooks/use_link_props.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "observability", - "id": "def-public.useLinkProps.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "Options" - ], - "path": "x-pack/plugins/observability/public/hooks/use_link_props.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.useTheme", - "type": "Function", - "tags": [], - "label": "useTheme", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "kibanaReact", - "scope": "common", - "docId": "kibKibanaReactPluginApi", - "section": "def-common.EuiTheme", - "text": "EuiTheme" - } - ], - "path": "x-pack/plugins/observability/public/hooks/use_theme.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.useTimeBuckets", - "type": "Function", - "tags": [], - "label": "useTimeBuckets", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.TimeBuckets", - "text": "TimeBuckets" - } - ], - "path": "x-pack/plugins/observability/public/hooks/use_time_buckets.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-public.useTimeZone", - "type": "Function", - "tags": [], - "label": "useTimeZone", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/observability/public/hooks/use_time_zone.ts", + "path": "x-pack/plugins/observability/public/hooks/use_time_buckets.ts", "deprecated": false, "trackAdoption": false, "children": [], @@ -2528,73 +1522,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "observability", - "id": "def-public.LinkDescriptor", - "type": "Interface", - "tags": [], - "label": "LinkDescriptor", - "description": [], - "path": "x-pack/plugins/observability/public/hooks/use_link_props.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.LinkDescriptor.app", - "type": "string", - "tags": [], - "label": "app", - "description": [], - "path": "x-pack/plugins/observability/public/hooks/use_link_props.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-public.LinkDescriptor.pathname", - "type": "string", - "tags": [], - "label": "pathname", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/observability/public/hooks/use_link_props.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-public.LinkDescriptor.hash", - "type": "string", - "tags": [], - "label": "hash", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/observability/public/hooks/use_link_props.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-public.LinkDescriptor.search", - "type": "Object", - "tags": [], - "label": "search", - "description": [], - "signature": [ - "Search | undefined" - ], - "path": "x-pack/plugins/observability/public/hooks/use_link_props.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "observability", "id": "def-public.LogsFetchDataResponse", @@ -2982,74 +1909,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "observability", - "id": "def-public.NavigationSection", - "type": "Interface", - "tags": [], - "label": "NavigationSection", - "description": [], - "path": "x-pack/plugins/observability/public/services/navigation_registry.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.NavigationSection.label", - "type": "string", - "tags": [], - "label": "label", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/observability/public/services/navigation_registry.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-public.NavigationSection.sortKey", - "type": "number", - "tags": [], - "label": "sortKey", - "description": [], - "path": "x-pack/plugins/observability/public/services/navigation_registry.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-public.NavigationSection.entries", - "type": "Array", - "tags": [], - "label": "entries", - "description": [], - "signature": [ - "NavigationEntry", - "[]" - ], - "path": "x-pack/plugins/observability/public/services/navigation_registry.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-public.NavigationSection.isBetaFeature", - "type": "CompoundType", - "tags": [], - "label": "isBetaFeature", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/observability/public/services/navigation_registry.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "observability", "id": "def-public.ObservabilityFetchDataResponse", @@ -3320,7 +2179,13 @@ "{ navigation: { registerSections: (sections$: ", "Observable", "<", - "NavigationSection", + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.NavigationSection", + "text": "NavigationSection" + }, "[]>) => void; }; }" ], "path": "x-pack/plugins/observability/public/plugin.ts", @@ -4473,7 +3338,7 @@ "tags": [], "label": "UXMetrics", "description": [], - "path": "x-pack/plugins/observability/public/components/shared/core_web_vitals/index.tsx", + "path": "x-pack/plugins/observability/public/components/core_web_vitals/core_vitals.tsx", "deprecated": false, "trackAdoption": false, "children": [ @@ -4487,7 +3352,7 @@ "signature": [ "number | null" ], - "path": "x-pack/plugins/observability/public/components/shared/core_web_vitals/index.tsx", + "path": "x-pack/plugins/observability/public/components/core_web_vitals/core_vitals.tsx", "deprecated": false, "trackAdoption": false }, @@ -4501,7 +3366,7 @@ "signature": [ "number | null | undefined" ], - "path": "x-pack/plugins/observability/public/components/shared/core_web_vitals/index.tsx", + "path": "x-pack/plugins/observability/public/components/core_web_vitals/core_vitals.tsx", "deprecated": false, "trackAdoption": false }, @@ -4515,7 +3380,7 @@ "signature": [ "number | null | undefined" ], - "path": "x-pack/plugins/observability/public/components/shared/core_web_vitals/index.tsx", + "path": "x-pack/plugins/observability/public/components/core_web_vitals/core_vitals.tsx", "deprecated": false, "trackAdoption": false }, @@ -4526,7 +3391,7 @@ "tags": [], "label": "tbt", "description": [], - "path": "x-pack/plugins/observability/public/components/shared/core_web_vitals/index.tsx", + "path": "x-pack/plugins/observability/public/components/core_web_vitals/core_vitals.tsx", "deprecated": false, "trackAdoption": false }, @@ -4540,7 +3405,7 @@ "signature": [ "number | null | undefined" ], - "path": "x-pack/plugins/observability/public/components/shared/core_web_vitals/index.tsx", + "path": "x-pack/plugins/observability/public/components/core_web_vitals/core_vitals.tsx", "deprecated": false, "trackAdoption": false }, @@ -4551,7 +3416,7 @@ "tags": [], "label": "coreVitalPages", "description": [], - "path": "x-pack/plugins/observability/public/components/shared/core_web_vitals/index.tsx", + "path": "x-pack/plugins/observability/public/components/core_web_vitals/core_vitals.tsx", "deprecated": false, "trackAdoption": false }, @@ -4565,7 +3430,7 @@ "signature": [ "number[]" ], - "path": "x-pack/plugins/observability/public/components/shared/core_web_vitals/index.tsx", + "path": "x-pack/plugins/observability/public/components/core_web_vitals/core_vitals.tsx", "deprecated": false, "trackAdoption": false }, @@ -4579,7 +3444,7 @@ "signature": [ "number[]" ], - "path": "x-pack/plugins/observability/public/components/shared/core_web_vitals/index.tsx", + "path": "x-pack/plugins/observability/public/components/core_web_vitals/core_vitals.tsx", "deprecated": false, "trackAdoption": false }, @@ -4593,7 +3458,7 @@ "signature": [ "number[]" ], - "path": "x-pack/plugins/observability/public/components/shared/core_web_vitals/index.tsx", + "path": "x-pack/plugins/observability/public/components/core_web_vitals/core_vitals.tsx", "deprecated": false, "trackAdoption": false } @@ -4601,64 +3466,8 @@ "initialIsOpen": false } ], - "enums": [ - { - "parentPluginId": "observability", - "id": "def-public.FETCH_STATUS", - "type": "Enum", - "tags": [], - "label": "FETCH_STATUS", - "description": [], - "path": "x-pack/plugins/observability/public/hooks/use_fetcher.tsx", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - } - ], + "enums": [], "misc": [ - { - "parentPluginId": "observability", - "id": "def-public.AddInspectorRequest", - "type": "Type", - "tags": [], - "label": "AddInspectorRequest", - "description": [], - "signature": [ - "(result: ", - "FetcherResult", - "<{ mainStatisticsData?: { _inspect?: ", - "InspectResponse", - " | undefined; } | undefined; _inspect?: ", - "InspectResponse", - " | undefined; }>) => void" - ], - "path": "x-pack/plugins/observability/public/context/inspector/inspector_context.tsx", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "observability", - "id": "def-public.AddInspectorRequest.$1", - "type": "Object", - "tags": [], - "label": "result", - "description": [], - "signature": [ - "FetcherResult", - "<{ mainStatisticsData?: { _inspect?: ", - "InspectResponse", - " | undefined; } | undefined; _inspect?: ", - "InspectResponse", - " | undefined; }>" - ], - "path": "x-pack/plugins/observability/public/context/inspector/inspector_context.tsx", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "observability", "id": "def-public.apmServiceGroupMaxNumberOfServices", @@ -4850,27 +3659,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "observability", - "id": "def-public.LazyObservabilityPageTemplateProps", - "type": "Type", - "tags": [], - "label": "LazyObservabilityPageTemplateProps", - "description": [], - "signature": [ - "Pick<", - "KibanaPageTemplateProps", - ", \"children\" | \"paddingSize\" | \"data-test-subj\" | \"pageHeader\" | \"restrictWidth\" | \"isEmptyState\" | \"noDataConfig\"> & { showSolutionNav?: boolean | undefined; isPageDataLoaded?: boolean | undefined; pageSectionProps?: ", - "EuiPageSectionProps", - " | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ", - "_EuiPageBottomBarProps", - " | undefined; }" - ], - "path": "x-pack/plugins/observability/public/components/shared/page_template/lazy_page_template.tsx", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "observability", "id": "def-public.NumberOrNull", @@ -5002,44 +3790,6 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "observability", - "id": "def-public.SectionLinkProps", - "type": "Type", - "tags": [], - "label": "SectionLinkProps", - "description": [], - "signature": [ - "CommonProps", - " & Omit<(", - "DisambiguateSet", - "<(", - "DisambiguateSet", - ", Omit, \"href\">> & Omit, \"href\">) | (", - "DisambiguateSet", - ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes), React.HTMLAttributes> & React.HTMLAttributes) | (", - "DisambiguateSet", - ", (", - "DisambiguateSet", - ", Omit, \"href\">> & Omit, \"href\">) | (", - "DisambiguateSet", - ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes)> & ((", - "DisambiguateSet", - ", Omit, \"href\">> & Omit, \"href\">) | (", - "DisambiguateSet", - ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes))), \"color\" | \"onClick\" | \"rel\" | \"target\"> & { size?: \"m\" | \"s\" | \"xs\" | \"l\" | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; label: React.ReactNode; isActive?: boolean | undefined; isDisabled?: boolean | undefined; href?: string | undefined; target?: string | undefined; rel?: string | undefined; iconType?: ", - "IconType", - " | undefined; iconProps?: Omit<", - "EuiIconProps", - ", \"type\"> | undefined; icon?: React.ReactElement> | undefined; showToolTip?: boolean | undefined; extraAction?: ", - "EuiListGroupItemExtraActionProps", - " | undefined; onClick?: React.MouseEventHandler | undefined; wrapText?: boolean | undefined; buttonRef?: React.Ref | undefined; toolTipText?: string | undefined; }" - ], - "path": "x-pack/plugins/observability/public/components/shared/action_menu/index.tsx", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "observability", "id": "def-public.StringOrNull", @@ -5153,7 +3903,13 @@ "text": "ObservabilityRuleTypeFormatter" }, " | undefined; list: () => string[]; }; useRulesLink: (options?: ", - "Options", + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.Options", + "text": "Options" + }, ") => ", "LinkProps", "; rulesLocator: ", @@ -5219,7 +3975,13 @@ "text": "ObservabilityRuleTypeFormatter" }, " | undefined; list: () => string[]; }; useRulesLink: (options?: ", - "Options", + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.Options", + "text": "Options" + }, ") => ", "LinkProps", "; }" @@ -8482,15 +7244,7 @@ "label": "AbstractObservabilityServerRouteRepository", "description": [], "signature": [ - "{ [x: string]: ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - ">; }" + " | undefined; handler: ({}: any) => Promise; } & Record; }" ], "path": "x-pack/plugins/observability/server/routes/types.ts", "deprecated": false, @@ -8547,21 +7301,13 @@ "label": "ObservabilityAPIReturnType", "description": [], "signature": [ - "{ \"GET /internal/observability/slos/{id}/_diagnosis\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/observability/slos/{id}/_diagnosis\", ", + "{ \"GET /internal/observability/slos/{id}/_diagnosis\": { endpoint: \"GET /internal/observability/slos/{id}/_diagnosis\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -8569,7 +7315,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { sloResources: { [x: string]: string; \".slo-observability.sli\": string; \".slo-observability.sli-mappings\": string; \".slo-observability.sli-settings\": string; } | undefined; sloSavedObject: string | ", + " & { params: { path: { id: string; }; }; }) => Promise<{ sloResources: { [x: string]: string; \".slo-observability.sli\": string; \".slo-observability.sli-mappings\": string; \".slo-observability.sli-settings\": string; } | undefined; sloSavedObject: string | ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", @@ -8577,13 +7323,13 @@ "section": "def-common.SavedObject", "text": "SavedObject" }, - "<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; sloTransformStats: ", + "<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; sloTransformStats: ", "TransformGetTransformStatsResponse", "; dataSample: string | ", "SearchResponse", ">; }, ", + ">>; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -8591,15 +7337,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"GET /internal/observability/slos/_diagnosis\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/observability/slos/_diagnosis\", undefined, ", + "; \"GET /internal/observability/slos/_diagnosis\": { endpoint: \"GET /internal/observability/slos/_diagnosis\"; params?: undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -8607,11 +7345,11 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { licenseAndFeatures: ", + ") => Promise<{ licenseAndFeatures: ", "PublicLicenseJSON", "; userPrivileges: ", "SecurityGetUserPrivilegesResponse", - "; sloResources: { [x: string]: string; \".slo-observability.sli\": string; \".slo-observability.sli-mappings\": string; \".slo-observability.sli-settings\": string; } | undefined; }, ", + "; sloResources: { [x: string]: string; \".slo-observability.sli\": string; \".slo-observability.sli-mappings\": string; \".slo-observability.sli-settings\": string; } | undefined; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -8619,15 +7357,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"PUT /api/observability/slos/{id}\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"PUT /api/observability/slos/{id}\", ", + "; \"PUT /api/observability/slos/{id} 2023-05-22\": { endpoint: \"PUT /api/observability/slos/{id} 2023-05-22\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -8719,21 +7449,61 @@ "PartialC", "<{ filter: ", "StringC", - "; }>]>; }>, ", + "; }>]>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.kql.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "StringC", + "; total: ", + "StringC", + "; timestampField: ", + "StringC", + "; }>; }>, ", "TypeC", "<{ type: ", "LiteralC", - "<\"sli.kql.custom\">; params: ", + "<\"sli.metric.custom\">; params: ", "TypeC", "<{ index: ", "StringC", "; filter: ", "StringC", "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", "StringC", - "; total: ", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", "StringC", - "; timestampField: ", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", "StringC", "; }>; }>]>; timeWindow: ", "UnionC", @@ -8817,7 +7587,7 @@ "ArrayC", "<", "StringC", - ">; }>; }>, ", + ">; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -8825,7 +7595,47 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }, ", + " & { params: { path: { id: string; }; body: { name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; } | undefined; timeWindow?: { duration: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + "; isRolling: boolean; } | { duration: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + "; isCalendar: boolean; } | undefined; budgetingMethod?: \"occurrences\" | \"timeslices\" | undefined; objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + " | undefined; }) | undefined; settings?: { syncDelay?: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + " | undefined; frequency?: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + " | undefined; } | undefined; tags?: string[] | undefined; }; }; }) => Promise<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -8833,21 +7643,13 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"GET /api/observability/slos/{id}\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /api/observability/slos/{id}\", ", + "; \"GET /api/observability/slos/{id} 2023-05-22\": { endpoint: \"GET /api/observability/slos/{id} 2023-05-22\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -8855,7 +7657,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }, ", + " & { params: { path: { id: string; }; }; }) => Promise<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -8863,15 +7665,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"GET /api/observability/slos\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /api/observability/slos\", ", + "; \"GET /api/observability/slos 2023-05-22\": { endpoint: \"GET /api/observability/slos 2023-05-22\"; params?: ", "PartialC", "<{ query: ", "PartialC", @@ -8895,7 +7689,7 @@ "LiteralC", "<\"asc\">, ", "LiteralC", - "<\"desc\">]>; }>; }>, ", + "<\"desc\">]>; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -8903,7 +7697,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }, ", + " & { params?: { query?: { name?: string | undefined; indicatorTypes?: string[] | undefined; page?: string | undefined; perPage?: string | undefined; sortBy?: \"creationTime\" | \"indicatorType\" | undefined; sortDirection?: \"asc\" | \"desc\" | undefined; } | undefined; } | undefined; }) => Promise<{ page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -8911,15 +7705,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"POST /internal/observability/slos/_historical_summary\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/observability/slos/_historical_summary\", ", + "; \"POST /internal/observability/slos/_historical_summary\": { endpoint: \"POST /internal/observability/slos/_historical_summary\"; params?: ", "TypeC", "<{ body: ", "TypeC", @@ -8927,7 +7713,7 @@ "ArrayC", "<", "StringC", - ">; }>; }>, ", + ">; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -8935,7 +7721,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { [x: string]: ({ date: string; } & { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; })[]; }, ", + " & { params: { body: { sloIds: string[]; }; }; }) => Promise<{ [x: string]: ({ date: string; } & { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; })[]; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -8943,21 +7729,13 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"POST /api/observability/slos/{id}/enable\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /api/observability/slos/{id}/enable\", ", + "; \"POST /api/observability/slos/{id}/enable 2023-05-22\": { endpoint: \"POST /api/observability/slos/{id}/enable 2023-05-22\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -8965,7 +7743,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", void, ", + " & { params: { path: { id: string; }; }; }) => Promise; } & ", { "pluginId": "observability", "scope": "server", @@ -8973,21 +7751,13 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"POST /api/observability/slos/{id}/disable\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /api/observability/slos/{id}/disable\", ", + "; \"POST /api/observability/slos/{id}/disable 2023-05-22\": { endpoint: \"POST /api/observability/slos/{id}/disable 2023-05-22\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -8995,7 +7765,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", void, ", + " & { params: { path: { id: string; }; }; }) => Promise; } & ", { "pluginId": "observability", "scope": "server", @@ -9003,21 +7773,13 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"DELETE /api/observability/slos/{id}\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"DELETE /api/observability/slos/{id}\", ", + "; \"DELETE /api/observability/slos/{id} 2023-05-22\": { endpoint: \"DELETE /api/observability/slos/{id} 2023-05-22\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -9025,7 +7787,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", void, ", + " & { params: { path: { id: string; }; }; }) => Promise; } & ", { "pluginId": "observability", "scope": "server", @@ -9033,15 +7795,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"POST /api/observability/slos\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /api/observability/slos\", ", + "; \"POST /api/observability/slos 2023-05-22\": { endpoint: \"POST /api/observability/slos 2023-05-22\"; params?: ", "TypeC", "<{ body: ", "IntersectionC", @@ -9147,6 +7901,46 @@ "StringC", "; timestampField: ", "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", "; }>; }>]>; timeWindow: ", "UnionC", "<[", @@ -9205,7 +7999,9 @@ }, ", string, unknown>; }>]>; }>, ", "PartialC", - "<{ settings: ", + "<{ id: ", + "StringC", + "; settings: ", "PartialC", "<{ syncDelay: ", "Type", @@ -9231,7 +8027,7 @@ "ArrayC", "<", "StringC", - ">; }>]>; }>, ", + ">; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -9239,7 +8035,47 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { id: string; }, ", + " & { params: { body: { name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + "; isRolling: boolean; } | { duration: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + "; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + " | undefined; }; } & { id?: string | undefined; settings?: { syncDelay?: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + " | undefined; frequency?: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + " | undefined; } | undefined; tags?: string[] | undefined; }; }; }) => Promise<{ id: string; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -9247,15 +8083,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"GET /api/observability/rules/alerts/dynamic_index_pattern\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /api/observability/rules/alerts/dynamic_index_pattern\", ", + "; \"GET /api/observability/rules/alerts/dynamic_index_pattern 2023-05-22\": { endpoint: \"GET /api/observability/rules/alerts/dynamic_index_pattern 2023-05-22\"; params?: ", "TypeC", "<{ query: ", "TypeC", @@ -9265,7 +8093,7 @@ "StringC", ">; namespace: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -9273,7 +8101,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", string[], ", + " & { params: { query: { registrationContexts: string[]; namespace: string; }; }; }) => Promise; } & ", { "pluginId": "observability", "scope": "server", @@ -9281,17 +8109,9 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; }[TEndpoint] extends ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - " Promise; } & ", "ServerRouteCreateOptions", - "> ? TReturnType : never" + " ? TReturnType : never" ], "path": "x-pack/plugins/observability/server/routes/types.ts", "deprecated": false, @@ -9321,21 +8141,13 @@ "label": "ObservabilityServerRouteRepository", "description": [], "signature": [ - "{ \"GET /internal/observability/slos/{id}/_diagnosis\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/observability/slos/{id}/_diagnosis\", ", + "{ \"GET /internal/observability/slos/{id}/_diagnosis\": { endpoint: \"GET /internal/observability/slos/{id}/_diagnosis\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -9343,7 +8155,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { sloResources: { [x: string]: string; \".slo-observability.sli\": string; \".slo-observability.sli-mappings\": string; \".slo-observability.sli-settings\": string; } | undefined; sloSavedObject: string | ", + " & { params: { path: { id: string; }; }; }) => Promise<{ sloResources: { [x: string]: string; \".slo-observability.sli\": string; \".slo-observability.sli-mappings\": string; \".slo-observability.sli-settings\": string; } | undefined; sloSavedObject: string | ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", @@ -9351,13 +8163,13 @@ "section": "def-common.SavedObject", "text": "SavedObject" }, - "<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; sloTransformStats: ", + "<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; sloTransformStats: ", "TransformGetTransformStatsResponse", "; dataSample: string | ", "SearchResponse", ">; }, ", + ">>; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -9365,15 +8177,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"GET /internal/observability/slos/_diagnosis\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /internal/observability/slos/_diagnosis\", undefined, ", + "; \"GET /internal/observability/slos/_diagnosis\": { endpoint: \"GET /internal/observability/slos/_diagnosis\"; params?: undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -9381,11 +8185,11 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { licenseAndFeatures: ", + ") => Promise<{ licenseAndFeatures: ", "PublicLicenseJSON", "; userPrivileges: ", "SecurityGetUserPrivilegesResponse", - "; sloResources: { [x: string]: string; \".slo-observability.sli\": string; \".slo-observability.sli-mappings\": string; \".slo-observability.sli-settings\": string; } | undefined; }, ", + "; sloResources: { [x: string]: string; \".slo-observability.sli\": string; \".slo-observability.sli-mappings\": string; \".slo-observability.sli-settings\": string; } | undefined; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -9393,15 +8197,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"PUT /api/observability/slos/{id}\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"PUT /api/observability/slos/{id}\", ", + "; \"PUT /api/observability/slos/{id} 2023-05-22\": { endpoint: \"PUT /api/observability/slos/{id} 2023-05-22\"; params?: ", "TypeC", "<{ path: ", "TypeC", @@ -9509,6 +8305,46 @@ "StringC", "; timestampField: ", "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", "; }>; }>]>; timeWindow: ", "UnionC", "<[", @@ -9565,11 +8401,57 @@ "section": "def-common.Duration", "text": "Duration" }, - ", string, unknown>; }>]>; settings: ", - "PartialC", - "<{ syncDelay: ", - "Type", - "<", + ", string, unknown>; }>]>; settings: ", + "PartialC", + "<{ syncDelay: ", + "Type", + "<", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + ", string, unknown>; frequency: ", + "Type", + "<", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + ", string, unknown>; }>; tags: ", + "ArrayC", + "<", + "StringC", + ">; }>; }> | undefined; handler: ({}: ", + { + "pluginId": "observability", + "scope": "server", + "docId": "kibObservabilityPluginApi", + "section": "def-server.ObservabilityRouteHandlerResources", + "text": "ObservabilityRouteHandlerResources" + }, + " & { params: { path: { id: string; }; body: { name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; } | undefined; timeWindow?: { duration: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + "; isRolling: boolean; } | { duration: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + "; isCalendar: boolean; } | undefined; budgetingMethod?: \"occurrences\" | \"timeslices\" | undefined; objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -9577,9 +8459,7 @@ "section": "def-common.Duration", "text": "Duration" }, - ", string, unknown>; frequency: ", - "Type", - "<", + " | undefined; }) | undefined; settings?: { syncDelay?: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -9587,19 +8467,15 @@ "section": "def-common.Duration", "text": "Duration" }, - ", string, unknown>; }>; tags: ", - "ArrayC", - "<", - "StringC", - ">; }>; }>, ", + " | undefined; frequency?: ", { - "pluginId": "observability", - "scope": "server", - "docId": "kibObservabilityPluginApi", - "section": "def-server.ObservabilityRouteHandlerResources", - "text": "ObservabilityRouteHandlerResources" + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" }, - ", { id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }, ", + " | undefined; } | undefined; tags?: string[] | undefined; }; }; }) => Promise<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -9607,21 +8483,13 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"GET /api/observability/slos/{id}\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /api/observability/slos/{id}\", ", + "; \"GET /api/observability/slos/{id} 2023-05-22\": { endpoint: \"GET /api/observability/slos/{id} 2023-05-22\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -9629,7 +8497,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }, ", + " & { params: { path: { id: string; }; }; }) => Promise<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -9637,15 +8505,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"GET /api/observability/slos\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /api/observability/slos\", ", + "; \"GET /api/observability/slos 2023-05-22\": { endpoint: \"GET /api/observability/slos 2023-05-22\"; params?: ", "PartialC", "<{ query: ", "PartialC", @@ -9669,7 +8529,7 @@ "LiteralC", "<\"asc\">, ", "LiteralC", - "<\"desc\">]>; }>; }>, ", + "<\"desc\">]>; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -9677,7 +8537,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }, ", + " & { params?: { query?: { name?: string | undefined; indicatorTypes?: string[] | undefined; page?: string | undefined; perPage?: string | undefined; sortBy?: \"creationTime\" | \"indicatorType\" | undefined; sortDirection?: \"asc\" | \"desc\" | undefined; } | undefined; } | undefined; }) => Promise<{ page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -9685,15 +8545,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"POST /internal/observability/slos/_historical_summary\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /internal/observability/slos/_historical_summary\", ", + "; \"POST /internal/observability/slos/_historical_summary\": { endpoint: \"POST /internal/observability/slos/_historical_summary\"; params?: ", "TypeC", "<{ body: ", "TypeC", @@ -9701,7 +8553,7 @@ "ArrayC", "<", "StringC", - ">; }>; }>, ", + ">; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -9709,7 +8561,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { [x: string]: ({ date: string; } & { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; })[]; }, ", + " & { params: { body: { sloIds: string[]; }; }; }) => Promise<{ [x: string]: ({ date: string; } & { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; })[]; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -9717,21 +8569,13 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"POST /api/observability/slos/{id}/enable\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /api/observability/slos/{id}/enable\", ", + "; \"POST /api/observability/slos/{id}/enable 2023-05-22\": { endpoint: \"POST /api/observability/slos/{id}/enable 2023-05-22\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -9739,7 +8583,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", void, ", + " & { params: { path: { id: string; }; }; }) => Promise; } & ", { "pluginId": "observability", "scope": "server", @@ -9747,21 +8591,13 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"POST /api/observability/slos/{id}/disable\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /api/observability/slos/{id}/disable\", ", + "; \"POST /api/observability/slos/{id}/disable 2023-05-22\": { endpoint: \"POST /api/observability/slos/{id}/disable 2023-05-22\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -9769,7 +8605,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", void, ", + " & { params: { path: { id: string; }; }; }) => Promise; } & ", { "pluginId": "observability", "scope": "server", @@ -9777,21 +8613,13 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"DELETE /api/observability/slos/{id}\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"DELETE /api/observability/slos/{id}\", ", + "; \"DELETE /api/observability/slos/{id} 2023-05-22\": { endpoint: \"DELETE /api/observability/slos/{id} 2023-05-22\"; params?: ", "TypeC", "<{ path: ", "TypeC", "<{ id: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -9799,7 +8627,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", void, ", + " & { params: { path: { id: string; }; }; }) => Promise; } & ", { "pluginId": "observability", "scope": "server", @@ -9807,15 +8635,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"POST /api/observability/slos\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"POST /api/observability/slos\", ", + "; \"POST /api/observability/slos 2023-05-22\": { endpoint: \"POST /api/observability/slos 2023-05-22\"; params?: ", "TypeC", "<{ body: ", "IntersectionC", @@ -9921,6 +8741,46 @@ "StringC", "; timestampField: ", "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", "; }>; }>]>; timeWindow: ", "UnionC", "<[", @@ -9979,7 +8839,9 @@ }, ", string, unknown>; }>]>; }>, ", "PartialC", - "<{ settings: ", + "<{ id: ", + "StringC", + "; settings: ", "PartialC", "<{ syncDelay: ", "Type", @@ -10005,7 +8867,7 @@ "ArrayC", "<", "StringC", - ">; }>]>; }>, ", + ">; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -10013,7 +8875,47 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { id: string; }, ", + " & { params: { body: { name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + "; isRolling: boolean; } | { duration: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + "; isCalendar: boolean; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + " | undefined; }; } & { id?: string | undefined; settings?: { syncDelay?: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + " | undefined; frequency?: ", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + " | undefined; } | undefined; tags?: string[] | undefined; }; }; }) => Promise<{ id: string; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -10021,15 +8923,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; \"GET /api/observability/rules/alerts/dynamic_index_pattern\": ", - { - "pluginId": "@kbn/server-route-repository", - "scope": "common", - "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-common.ServerRoute", - "text": "ServerRoute" - }, - "<\"GET /api/observability/rules/alerts/dynamic_index_pattern\", ", + "; \"GET /api/observability/rules/alerts/dynamic_index_pattern 2023-05-22\": { endpoint: \"GET /api/observability/rules/alerts/dynamic_index_pattern 2023-05-22\"; params?: ", "TypeC", "<{ query: ", "TypeC", @@ -10039,7 +8933,7 @@ "StringC", ">; namespace: ", "StringC", - "; }>; }>, ", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -10047,7 +8941,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", string[], ", + " & { params: { query: { registrationContexts: string[]; namespace: string; }; }; }) => Promise; } & ", { "pluginId": "observability", "scope": "server", @@ -10055,7 +8949,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - ">; }" + "; }" ], "path": "x-pack/plugins/observability/server/routes/get_global_observability_server_route_repository.ts", "deprecated": false, @@ -12055,124 +10949,6 @@ } ] }, - { - "parentPluginId": "observability", - "id": "def-server.uiSettings.profilingElasticsearchPlugin", - "type": "Object", - "tags": [], - "label": "[profilingElasticsearchPlugin]", - "description": [], - "path": "x-pack/plugins/observability/server/ui_settings.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-server.uiSettings.profilingElasticsearchPlugin.category", - "type": "Array", - "tags": [], - "label": "category", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/observability/server/ui_settings.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-server.uiSettings.profilingElasticsearchPlugin.name", - "type": "Any", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/plugins/observability/server/ui_settings.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-server.uiSettings.profilingElasticsearchPlugin.description", - "type": "Any", - "tags": [], - "label": "description", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/plugins/observability/server/ui_settings.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-server.uiSettings.profilingElasticsearchPlugin.schema", - "type": "Object", - "tags": [], - "label": "schema", - "description": [], - "signature": [ - { - "pluginId": "@kbn/config-schema", - "scope": "common", - "docId": "kibKbnConfigSchemaPluginApi", - "section": "def-common.Type", - "text": "Type" - }, - "" - ], - "path": "x-pack/plugins/observability/server/ui_settings.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-server.uiSettings.profilingElasticsearchPlugin.value", - "type": "boolean", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "true" - ], - "path": "x-pack/plugins/observability/server/ui_settings.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-server.uiSettings.profilingElasticsearchPlugin.requiresPageReload", - "type": "boolean", - "tags": [], - "label": "requiresPageReload", - "description": [], - "signature": [ - "true" - ], - "path": "x-pack/plugins/observability/server/ui_settings.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-server.uiSettings.profilingElasticsearchPlugin.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"boolean\"" - ], - "path": "x-pack/plugins/observability/server/ui_settings.ts", - "deprecated": false, - "trackAdoption": false - } - ] - }, { "parentPluginId": "observability", "id": "def-server.uiSettings.syntheticsThrottlingEnabled", @@ -13175,21 +11951,6 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "observability", - "id": "def-common.profilingElasticsearchPlugin", - "type": "string", - "tags": [], - "label": "profilingElasticsearchPlugin", - "description": [], - "signature": [ - "\"observability:profilingElasticsearchPlugin\"" - ], - "path": "x-pack/plugins/observability/common/ui_settings_keys.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "observability", "id": "def-common.ruleDetailsLocatorID", diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index e4f96896aebf7..964e2e3115fff 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observability title: "observability" image: https://source.unsplash.com/400x175/?github description: API docs for the observability plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability'] --- import observabilityObj from './observability.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/actionable-observability](https://github.com/orgs/elastic/team | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 555 | 45 | 549 | 25 | +| 472 | 43 | 466 | 14 | ## Client @@ -37,9 +37,6 @@ Contact [@elastic/actionable-observability](https://github.com/orgs/elastic/team ### Interfaces -### Enums - - ### Consts, variables and types diff --git a/api_docs/observability_onboarding.mdx b/api_docs/observability_onboarding.mdx index c993eafe2754f..f436a562aea99 100644 --- a/api_docs/observability_onboarding.mdx +++ b/api_docs/observability_onboarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityOnboarding title: "observabilityOnboarding" image: https://source.unsplash.com/400x175/?github description: API docs for the observabilityOnboarding plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityOnboarding'] --- import observabilityOnboardingObj from './observability_onboarding.devdocs.json'; diff --git a/api_docs/observability_shared.devdocs.json b/api_docs/observability_shared.devdocs.json index dd4de6f05e940..7c927aedde4af 100644 --- a/api_docs/observability_shared.devdocs.json +++ b/api_docs/observability_shared.devdocs.json @@ -58,7 +58,13 @@ "() => { navigation: { registerSections: (sections$: ", "Observable", "<", - "NavigationSection", + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.NavigationSection", + "text": "NavigationSection" + }, "[]>) => void; }; }" ], "path": "x-pack/plugins/observability_shared/public/plugin.ts", @@ -171,6 +177,56 @@ } ], "functions": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.ActionMenu", + "type": "Function", + "tags": [], + "label": "ActionMenu", + "description": [], + "signature": [ + "(props: Props) => JSX.Element" + ], + "path": "x-pack/plugins/observability_shared/public/components/action_menu/action_menu.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.ActionMenu.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "Props" + ], + "path": "x-pack/plugins/observability_shared/public/components/action_menu/action_menu.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.ActionMenuDivider", + "type": "Function", + "tags": [], + "label": "ActionMenuDivider", + "description": [], + "signature": [ + "() => JSX.Element" + ], + "path": "x-pack/plugins/observability_shared/public/components/action_menu/action_menu.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "observabilityShared", "id": "def-public.createEsParams", @@ -453,6 +509,74 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.LoadWhenInView", + "type": "Function", + "tags": [], + "label": "LoadWhenInView", + "description": [], + "signature": [ + "(props: ", + "LoadWhenInViewProps", + ") => JSX.Element" + ], + "path": "x-pack/plugins/observability_shared/public/components/load_when_in_view/get_load_when_in_view_lazy.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.LoadWhenInView.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "LoadWhenInViewProps" + ], + "path": "x-pack/plugins/observability_shared/public/components/load_when_in_view/get_load_when_in_view_lazy.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.NavigationWarningPromptProvider", + "type": "Function", + "tags": [], + "label": "NavigationWarningPromptProvider", + "description": [], + "signature": [ + "({ children }: { children?: React.ReactNode; }) => JSX.Element" + ], + "path": "x-pack/plugins/observability_shared/public/components/navigation_warning_prompt/context.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.NavigationWarningPromptProvider.$1", + "type": "Object", + "tags": [], + "label": "{ children }", + "description": [], + "signature": [ + "{ children?: React.ReactNode; }" + ], + "path": "x-pack/plugins/observability_shared/public/components/navigation_warning_prompt/context.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "observabilityShared", "id": "def-public.noCasesPermissions", @@ -470,6 +594,278 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.Prompt", + "type": "Function", + "tags": [], + "label": "Prompt", + "description": [], + "signature": [ + "({ prompt }: React.PropsWithChildren) => null" + ], + "path": "x-pack/plugins/observability_shared/public/components/navigation_warning_prompt/prompt.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.Prompt.$1", + "type": "CompoundType", + "tags": [], + "label": "{ prompt }", + "description": [], + "signature": [ + "React.PropsWithChildren" + ], + "path": "x-pack/plugins/observability_shared/public/components/navigation_warning_prompt/prompt.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.Section", + "type": "Function", + "tags": [], + "label": "Section", + "description": [], + "signature": [ + "string & ", + "StyledComponentBase", + "<\"div\", any, {}, never> & ", + "NonReactStatics", + "" + ], + "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.SectionLink", + "type": "Function", + "tags": [], + "label": "SectionLink", + "description": [], + "signature": [ + "(props: ", + "EuiListGroupItemProps", + ") => JSX.Element" + ], + "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.SectionLink.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "EuiListGroupItemProps" + ], + "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.SectionLinks", + "type": "Function", + "tags": [], + "label": "SectionLinks", + "description": [], + "signature": [ + "({ children, ...props }: { children?: React.ReactNode; } & ", + "CommonProps", + " & Omit, \"color\"> & { bordered?: boolean | undefined; flush?: boolean | undefined; gutterSize?: \"m\" | \"none\" | \"s\" | undefined; listItems?: ", + "EuiListGroupItemProps", + "[] | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; size?: \"m\" | \"s\" | \"xs\" | \"l\" | undefined; maxWidth?: boolean | ", + "Property", + ".MaxWidth | undefined; showToolTips?: boolean | undefined; wrapText?: boolean | undefined; ariaLabelledby?: string | undefined; }) => JSX.Element" + ], + "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.SectionLinks.$1", + "type": "CompoundType", + "tags": [], + "label": "{ children, ...props }", + "description": [], + "signature": [ + "{ children?: React.ReactNode; } & ", + "CommonProps", + " & Omit, \"color\"> & { bordered?: boolean | undefined; flush?: boolean | undefined; gutterSize?: \"m\" | \"none\" | \"s\" | undefined; listItems?: ", + "EuiListGroupItemProps", + "[] | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; size?: \"m\" | \"s\" | \"xs\" | \"l\" | undefined; maxWidth?: boolean | ", + "Property", + ".MaxWidth | undefined; showToolTips?: boolean | undefined; wrapText?: boolean | undefined; ariaLabelledby?: string | undefined; }" + ], + "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.SectionSpacer", + "type": "Function", + "tags": [], + "label": "SectionSpacer", + "description": [], + "signature": [ + "() => JSX.Element" + ], + "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.SectionSubtitle", + "type": "Function", + "tags": [], + "label": "SectionSubtitle", + "description": [], + "signature": [ + "({ children }: { children?: React.ReactNode; }) => JSX.Element" + ], + "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.SectionSubtitle.$1", + "type": "Object", + "tags": [], + "label": "{ children }", + "description": [], + "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.SectionSubtitle.$1.children", + "type": "CompoundType", + "tags": [], + "label": "children", + "description": [], + "signature": [ + "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" + ], + "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.SectionTitle", + "type": "Function", + "tags": [], + "label": "SectionTitle", + "description": [], + "signature": [ + "({ children }: { children?: React.ReactNode; }) => JSX.Element" + ], + "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.SectionTitle.$1", + "type": "Object", + "tags": [], + "label": "{ children }", + "description": [], + "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.SectionTitle.$1.children", + "type": "CompoundType", + "tags": [], + "label": "children", + "description": [], + "signature": [ + "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" + ], + "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.shouldHandleLinkEvent", + "type": "Function", + "tags": [], + "label": "shouldHandleLinkEvent", + "description": [], + "signature": [ + "(e: React.MouseEvent | React.MouseEvent) => boolean" + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.shouldHandleLinkEvent.$1", + "type": "CompoundType", + "tags": [], + "label": "e", + "description": [], + "signature": [ + "React.MouseEvent | React.MouseEvent" + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "observabilityShared", "id": "def-public.useBreadcrumbs", @@ -541,6 +937,27 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.useChartTheme", + "type": "Function", + "tags": [], + "label": "useChartTheme", + "description": [], + "signature": [ + "() => ", + "RecursivePartial", + "<", + "Theme", + ">[]" + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_chart_theme.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "observabilityShared", "id": "def-public.useEsSearch", @@ -661,7 +1078,13 @@ "description": [], "signature": [ "(fn: ({}: { signal: AbortSignal; }) => TReturn, fnDeps: any[], options: { preservePreviousData?: boolean | undefined; }) => ", - "FetcherResult", + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.FetcherResult", + "text": "FetcherResult" + }, "> & { refetch: () => void; }" ], "path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx", @@ -796,6 +1219,83 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.useLinkProps", + "type": "Function", + "tags": [], + "label": "useLinkProps", + "description": [], + "signature": [ + "({ app, pathname, hash, search }: ", + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.LinkDescriptor", + "text": "LinkDescriptor" + }, + ", options?: ", + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.Options", + "text": "Options" + }, + ") => ", + "LinkProps" + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.useLinkProps.$1", + "type": "Object", + "tags": [], + "label": "{ app, pathname, hash, search }", + "description": [], + "signature": [ + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.LinkDescriptor", + "text": "LinkDescriptor" + } + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.useLinkProps.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.Options", + "text": "Options" + } + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "observabilityShared", "id": "def-public.useObservabilityTourContext", @@ -855,6 +1355,23 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.useTimeZone", + "type": "Function", + "tags": [], + "label": "useTimeZone", + "description": [], + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_time_zone.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "observabilityShared", "id": "def-public.useTrackMetric", @@ -1079,6 +1596,159 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.FetcherResult", + "type": "Interface", + "tags": [], + "label": "FetcherResult", + "description": [], + "signature": [ + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.FetcherResult", + "text": "FetcherResult" + }, + "" + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.FetcherResult.data", + "type": "Uncategorized", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "Data | undefined" + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.FetcherResult.status", + "type": "Enum", + "tags": [], + "label": "status", + "description": [], + "signature": [ + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.FETCH_STATUS", + "text": "FETCH_STATUS" + } + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.FetcherResult.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error | undefined" + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.FetcherResult.loading", + "type": "CompoundType", + "tags": [], + "label": "loading", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_fetcher.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.LinkDescriptor", + "type": "Interface", + "tags": [], + "label": "LinkDescriptor", + "description": [], + "path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.LinkDescriptor.app", + "type": "string", + "tags": [], + "label": "app", + "description": [], + "path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.LinkDescriptor.pathname", + "type": "string", + "tags": [], + "label": "pathname", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.LinkDescriptor.hash", + "type": "string", + "tags": [], + "label": "hash", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.LinkDescriptor.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [], + "signature": [ + "Search | undefined" + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "observabilityShared", "id": "def-public.NavigationEntry", @@ -1260,6 +1930,108 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.NavigationSection", + "type": "Interface", + "tags": [], + "label": "NavigationSection", + "description": [], + "path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.NavigationSection.label", + "type": "string", + "tags": [], + "label": "label", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.NavigationSection.sortKey", + "type": "number", + "tags": [], + "label": "sortKey", + "description": [], + "path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.NavigationSection.entries", + "type": "Array", + "tags": [], + "label": "entries", + "description": [], + "signature": [ + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.NavigationEntry", + "text": "NavigationEntry" + }, + "[]" + ], + "path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.NavigationSection.isBetaFeature", + "type": "CompoundType", + "tags": [], + "label": "isBetaFeature", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/observability_shared/public/components/page_template/page_template.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.Options", + "type": "Interface", + "tags": [], + "label": "Options", + "description": [], + "path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.Options.hrefOnly", + "type": "CompoundType", + "tags": [], + "label": "hrefOnly", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/observability_shared/public/hooks/use_link_props.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "observabilityShared", "id": "def-public.UXMetrics", @@ -1422,6 +2194,53 @@ } ], "misc": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.AddInspectorRequest", + "type": "Type", + "tags": [], + "label": "AddInspectorRequest", + "description": [], + "signature": [ + "(result: ", + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.FetcherResult", + "text": "FetcherResult" + }, + "<{ mainStatisticsData?: { _inspect?: InspectResponse | undefined; } | undefined; _inspect?: InspectResponse | undefined; }>) => void" + ], + "path": "x-pack/plugins/observability_shared/public/contexts/inspector/inspector_context.tsx", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.AddInspectorRequest.$1", + "type": "Object", + "tags": [], + "label": "result", + "description": [], + "signature": [ + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.FetcherResult", + "text": "FetcherResult" + }, + "<{ mainStatisticsData?: { _inspect?: InspectResponse | undefined; } | undefined; _inspect?: InspectResponse | undefined; }>" + ], + "path": "x-pack/plugins/observability_shared/public/contexts/inspector/inspector_context.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "observabilityShared", "id": "def-public.casesFeatureId", @@ -1538,7 +2357,13 @@ "{ navigation: { registerSections: (sections$: ", "Observable", "<", - "NavigationSection", + { + "pluginId": "observabilityShared", + "scope": "public", + "docId": "kibObservabilitySharedPluginApi", + "section": "def-public.NavigationSection", + "text": "NavigationSection" + }, "[]>) => void; }; }" ], "path": "x-pack/plugins/observability_shared/public/plugin.ts", @@ -1581,6 +2406,59 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.observTourStepStorageKey", + "type": "string", + "tags": [], + "label": "observTourStepStorageKey", + "description": [], + "signature": [ + "\"guidedOnboarding.observability.tourStep\"" + ], + "path": "x-pack/plugins/observability_shared/public/components/tour/tour.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.SectionLinkProps", + "type": "Type", + "tags": [], + "label": "SectionLinkProps", + "description": [], + "signature": [ + "CommonProps", + " & Omit<(", + "DisambiguateSet", + "<(", + "DisambiguateSet", + ", Omit, \"href\">> & Omit, \"href\">) | (", + "DisambiguateSet", + ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes), React.HTMLAttributes> & React.HTMLAttributes) | (", + "DisambiguateSet", + ", (", + "DisambiguateSet", + ", Omit, \"href\">> & Omit, \"href\">) | (", + "DisambiguateSet", + ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes)> & ((", + "DisambiguateSet", + ", Omit, \"href\">> & Omit, \"href\">) | (", + "DisambiguateSet", + ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes))), \"color\" | \"onClick\" | \"rel\" | \"target\"> & { size?: \"m\" | \"s\" | \"xs\" | \"l\" | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; label: React.ReactNode; isActive?: boolean | undefined; isDisabled?: boolean | undefined; href?: string | undefined; target?: string | undefined; rel?: string | undefined; iconType?: ", + "IconType", + " | undefined; iconProps?: Omit<", + "EuiIconProps", + ", \"type\"> | undefined; icon?: React.ReactElement> | undefined; showToolTip?: boolean | undefined; extraAction?: ", + "EuiListGroupItemExtraActionProps", + " | undefined; onClick?: React.MouseEventHandler | undefined; wrapText?: boolean | undefined; buttonRef?: React.Ref | undefined; toolTipText?: string | undefined; }" + ], + "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "observabilityShared", "id": "def-public.sloFeatureId", diff --git a/api_docs/observability_shared.mdx b/api_docs/observability_shared.mdx index d6b4f402839d9..98e7fb96e56fb 100644 --- a/api_docs/observability_shared.mdx +++ b/api_docs/observability_shared.mdx @@ -8,20 +8,20 @@ slug: /kibana-dev-docs/api/observabilityShared title: "observabilityShared" image: https://source.unsplash.com/400x175/?github description: API docs for the observabilityShared plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityShared'] --- import observabilitySharedObj from './observability_shared.devdocs.json'; -Contact [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) for questions regarding this plugin. +Contact [@elastic/observability-ui](https://github.com/orgs/elastic/teams/observability-ui) for questions regarding this plugin. **Code health stats** | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 217 | 1 | 216 | 11 | +| 266 | 1 | 265 | 11 | ## Client diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index b952345a9d3b0..35f090db223a8 100644 --- a/api_docs/osquery.mdx +++ b/api_docs/osquery.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/osquery title: "osquery" image: https://source.unsplash.com/400x175/?github description: API docs for the osquery plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery'] --- import osqueryObj from './osquery.devdocs.json'; diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index 2f8cfb0758318..cbde987fdefed 100644 --- a/api_docs/plugin_directory.mdx +++ b/api_docs/plugin_directory.mdx @@ -7,7 +7,7 @@ id: kibDevDocsPluginDirectory slug: /kibana-dev-docs/api-meta/plugin-api-directory title: Directory description: Directory of public APIs available through plugins or packages. -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -15,13 +15,13 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Count | Plugins or Packages with a
public API | Number of teams | |--------------|----------|------------------------| -| 613 | 506 | 37 | +| 617 | 510 | 38 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 69503 | 522 | 59885 | 1351 | +| 69655 | 520 | 59996 | 1347 | ## Plugin Directory @@ -41,7 +41,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 41 | 0 | 11 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | Chat available on Elastic Cloud deployments for quicker assistance. | 1 | 0 | 0 | 0 | | | [@elastic/platform-onboarding](https://github.com/orgs/elastic/teams/platform-onboarding) | Static migration page where self-managed users can see text/copy about migrating to Elastic Cloud | 8 | 1 | 8 | 1 | -| | [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/teams/sec-cloudnative-integrations) | Defend for containers (D4C) | 15 | 0 | 4 | 1 | +| | [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/teams/sec-cloudnative-integrations) | Defend for containers (D4C) | 15 | 0 | 4 | 2 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | Provides the necessary APIs to implement A/B testing scenarios, fetching the variations in configuration and reporting back metrics to track conversion rates of the experiments. | 12 | 0 | 0 | 0 | | cloudFullStory | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | When Kibana runs on Elastic Cloud, this plugin registers FullStory as a shipper for telemetry. | 0 | 0 | 0 | 0 | | cloudGainsight | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | When Kibana runs on Elastic Cloud, this plugin registers Gainsight as a shipper for telemetry. | 0 | 0 | 0 | 0 | @@ -49,7 +49,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-cloud-security-posture](https://github.com/orgs/elastic/teams/kibana-cloud-security-posture) | The cloud security posture plugin | 17 | 0 | 2 | 2 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 13 | 0 | 13 | 1 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Content management app | 149 | 0 | 126 | 6 | -| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 301 | 0 | 294 | 13 | +| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 304 | 0 | 297 | 14 | | crossClusterReplication | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | | customBranding | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Enables customization of Kibana | 0 | 0 | 0 | 0 | | | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 274 | 0 | 255 | 1 | @@ -92,7 +92,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | The file upload plugin contains components and services for uploading a file, analyzing its data, and then importing the data into an Elasticsearch index. Supported file types include CSV, TSV, newline-delimited JSON and GeoJSON. | 62 | 0 | 62 | 2 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | File upload, download, sharing, and serving over HTTP implementation in Kibana. | 239 | 0 | 24 | 9 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Simple UI for managing files in Kibana | 2 | 1 | 2 | 0 | -| | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1118 | 3 | 1013 | 31 | +| | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1159 | 3 | 1045 | 31 | | ftrApis | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 68 | 0 | 14 | 5 | | globalSearchBar | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 0 | 0 | 0 | 0 | @@ -104,7 +104,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Image embeddable | 3 | 0 | 3 | 1 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 4 | 0 | 4 | 0 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 177 | 0 | 172 | 3 | -| | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | This plugin visualizes data from Filebeat and Metricbeat, and integrates with other Observability solutions | 48 | 0 | 45 | 13 | +| | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | This plugin visualizes data from Filebeat and Metricbeat, and integrates with other Observability solutions | 49 | 0 | 46 | 14 | | ingestPipelines | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | | inputControlVis | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Input Control visualization to Kibana | 0 | 0 | 0 | 0 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | - | 123 | 2 | 96 | 4 | @@ -113,15 +113,15 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 185 | 1 | 153 | 5 | | kibanaUsageCollection | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | | | [@elastic/kibana-app-services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 609 | 3 | 416 | 9 | -| | [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/teams/sec-cloudnative-integrations) | - | 3 | 0 | 3 | 1 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 611 | 0 | 515 | 52 | +| | [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/teams/sec-cloudnative-integrations) | - | 5 | 0 | 5 | 1 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 612 | 0 | 516 | 52 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 8 | 0 | 8 | 0 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 4 | 0 | 4 | 1 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 117 | 0 | 42 | 10 | | | [@elastic/security-solution-platform](https://github.com/orgs/elastic/teams/security-solution-platform) | - | 210 | 0 | 94 | 51 | | logstash | [@elastic/logstash](https://github.com/orgs/elastic/teams/logstash) | - | 0 | 0 | 0 | 0 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 43 | 0 | 43 | 6 | -| | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 269 | 0 | 268 | 29 | +| | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 268 | 0 | 267 | 29 | | | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 67 | 0 | 67 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the machine learning features provided by Elastic. | 166 | 3 | 80 | 38 | | | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | - | 15 | 3 | 13 | 1 | @@ -129,9 +129,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 34 | 0 | 34 | 2 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 17 | 0 | 17 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 2 | 0 | 2 | 1 | -| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 555 | 45 | 549 | 25 | +| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 472 | 43 | 466 | 14 | | | [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) | - | 7 | 0 | 7 | 0 | -| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 217 | 1 | 216 | 11 | +| | [@elastic/observability-ui](https://github.com/orgs/elastic/teams/observability-ui) | - | 266 | 1 | 265 | 11 | | | [@elastic/security-defend-workflows](https://github.com/orgs/elastic/teams/security-defend-workflows) | - | 22 | 0 | 22 | 6 | | painlessLab | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 218 | 8 | 164 | 11 | @@ -157,7 +157,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/enterprise-search-frontend](https://github.com/orgs/elastic/teams/enterprise-search-frontend) | Serverless customizations for search. | 6 | 0 | 6 | 0 | | | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | Serverless customizations for security. | 6 | 0 | 6 | 0 | | | [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/teams/sec-cloudnative-integrations) | - | 7 | 0 | 7 | 1 | -| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Adds URL Service and sharing capabilities to Kibana | 118 | 0 | 59 | 10 | +| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Adds URL Service and sharing capabilities to Kibana | 119 | 0 | 60 | 10 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 22 | 1 | 22 | 1 | | | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides the Spaces feature, which allows saved objects to be organized into meaningful categories. | 253 | 0 | 65 | 0 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 12 | 0 | 12 | 2 | @@ -168,6 +168,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 31 | 0 | 26 | 6 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 1 | 0 | 1 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 5 | 0 | 0 | 0 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 16 | 0 | 16 | 0 | | | [@elastic/protections-experience](https://github.com/orgs/elastic/teams/protections-experience) | Elastic threat intelligence helps you see if you are open to or have been subject to current or historical known threats | 35 | 0 | 14 | 5 | | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 257 | 1 | 214 | 20 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the transforms features provided by Elastic. Transforms enable you to convert existing Elasticsearch indices into summarized indices, which provide opportunities for new insights and analytics. | 4 | 0 | 4 | 1 | @@ -197,7 +198,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Contains the vislib visualizations. These are the classical area/line/bar, gauge/goal and heatmap charts. We want to replace them with elastic-charts. | 1 | 0 | 1 | 0 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Contains the new xy-axis chart using the elastic-charts library, which will eventually replace the vislib xy-axis charts including bar, area, and line. | 52 | 0 | 50 | 5 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 122 | 0 | 119 | 4 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 806 | 12 | 776 | 19 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 804 | 12 | 774 | 18 | | watcher | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | ## Package Directory @@ -238,7 +239,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 135 | 3 | 133 | 18 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 6 | 0 | 4 | 4 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 21 | 0 | 14 | 5 | -| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 106 | 1 | 57 | 0 | +| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 177 | 1 | 112 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 0 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 7 | 0 | 7 | 1 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 4 | 0 | @@ -308,8 +309,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 7 | 0 | 7 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 26 | 6 | 26 | 1 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 8 | 0 | 8 | 1 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 440 | 1 | 176 | 0 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 56 | 0 | 50 | 6 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 444 | 1 | 178 | 0 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 57 | 0 | 51 | 6 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 41 | 0 | 40 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 2 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 3 | 0 | 3 | 0 | @@ -356,7 +357,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 111 | 1 | 0 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 351 | 1 | 5 | 1 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 11 | 0 | 11 | 0 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 83 | 0 | 57 | 9 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 85 | 0 | 59 | 11 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 4 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2 | 0 | 1 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 6 | 0 | 6 | 0 | @@ -364,12 +365,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 73 | 0 | 40 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 25 | 0 | 23 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 4 | 0 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 120 | 0 | 86 | 44 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 120 | 0 | 86 | 45 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 12 | 0 | 12 | 0 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 525 | 1 | 115 | 4 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 533 | 1 | 116 | 4 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 69 | 0 | 69 | 4 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 14 | 0 | 14 | 0 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 30 | 0 | 6 | 0 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 36 | 0 | 6 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 12 | 0 | 2 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 19 | 0 | 18 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 20 | 0 | 3 | 0 | @@ -432,6 +433,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 51 | 0 | 48 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 61 | 0 | 1 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 47 | 0 | 40 | 0 | +| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 9 | 0 | 9 | 0 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 52 | 12 | 43 | 0 | | | [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) | - | 39 | 0 | 39 | 4 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 13 | 0 | 13 | 0 | @@ -443,6 +445,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 8 | 0 | 8 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 6 | 0 | 1 | 1 | | | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 534 | 1 | 1 | 0 | +| | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 2 | 0 | 2 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 93 | 2 | 61 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 142 | 3 | 0 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 52 | 0 | 4 | 0 | @@ -460,7 +463,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 31 | 1 | 24 | 1 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 71 | 0 | 69 | 3 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 55 | 1 | 50 | 0 | -| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 7 | 0 | 7 | 1 | +| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 9 | 0 | 9 | 3 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 45 | 0 | 45 | 10 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 51 | 5 | 34 | 0 | | | [@elastic/security-asset-management](https://github.com/orgs/elastic/teams/security-asset-management) | - | 62 | 0 | 62 | 0 | @@ -541,7 +544,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 2 | 0 | 0 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 15 | 0 | 4 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 9 | 0 | 3 | 0 | -| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 78 | 0 | 78 | 0 | +| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 84 | 0 | 84 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 20 | 0 | 12 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 100 | 2 | 64 | 1 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 4 | 0 | 2 | 0 | @@ -550,6 +553,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 271 | 4 | 227 | 12 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 135 | 5 | 103 | 2 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 2 | 0 | 1 | 0 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 14 | 0 | 13 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 72 | 0 | 55 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 39 | 0 | 25 | 1 | | | [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) | - | 86 | 0 | 86 | 1 | @@ -560,6 +564,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | - | 58 | 0 | 5 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 36 | 0 | 15 | 1 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 2 | 0 | 2 | 0 | -| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 25 | 0 | 15 | 0 | +| | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 24 | 0 | 14 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 6 | 0 | 2 | 0 | diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index a2e51819b3a63..0047e65cc48cf 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/presentationUtil title: "presentationUtil" image: https://source.unsplash.com/400x175/?github description: API docs for the presentationUtil plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] --- import presentationUtilObj from './presentation_util.devdocs.json'; diff --git a/api_docs/profiling.devdocs.json b/api_docs/profiling.devdocs.json index 75713ac26cd9b..8a420787b5dac 100644 --- a/api_docs/profiling.devdocs.json +++ b/api_docs/profiling.devdocs.json @@ -104,7 +104,7 @@ "label": "getRoutePaths", "description": [], "signature": [ - "() => { TopN: string; TopNContainers: string; TopNDeployments: string; TopNFunctions: string; TopNHosts: string; TopNThreads: string; TopNTraces: string; Flamechart: string; CacheExecutables: string; CacheStackFrames: string; HasSetupESResources: string; HasSetupDataCollection: string; SetupDataCollectionInstructions: string; }" + "() => { TopN: string; TopNContainers: string; TopNDeployments: string; TopNFunctions: string; TopNHosts: string; TopNThreads: string; TopNTraces: string; Flamechart: string; HasSetupESResources: string; HasSetupDataCollection: string; SetupDataCollectionInstructions: string; }" ], "path": "x-pack/plugins/profiling/common/index.ts", "deprecated": false, diff --git a/api_docs/profiling.mdx b/api_docs/profiling.mdx index d3e9afecea7c6..64384dbf736a7 100644 --- a/api_docs/profiling.mdx +++ b/api_docs/profiling.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/profiling title: "profiling" image: https://source.unsplash.com/400x175/?github description: API docs for the profiling plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'profiling'] --- import profilingObj from './profiling.devdocs.json'; diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index 438cf5d7b9b58..6b8438a2c5077 100644 --- a/api_docs/remote_clusters.mdx +++ b/api_docs/remote_clusters.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/remoteClusters title: "remoteClusters" image: https://source.unsplash.com/400x175/?github description: API docs for the remoteClusters plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'remoteClusters'] --- import remoteClustersObj from './remote_clusters.devdocs.json'; diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx index 2f3f22b151f4a..97ac9e9c8fc5c 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/reporting title: "reporting" image: https://source.unsplash.com/400x175/?github description: API docs for the reporting plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting'] --- import reportingObj from './reporting.devdocs.json'; diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx index 75f399ba421ed..50f4d6ded55c0 100644 --- a/api_docs/rollup.mdx +++ b/api_docs/rollup.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/rollup title: "rollup" image: https://source.unsplash.com/400x175/?github description: API docs for the rollup plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup'] --- import rollupObj from './rollup.devdocs.json'; diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index e8cd613815b33..e624b9d8bc30d 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ruleRegistry title: "ruleRegistry" image: https://source.unsplash.com/400x175/?github description: API docs for the ruleRegistry plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry'] --- import ruleRegistryObj from './rule_registry.devdocs.json'; diff --git a/api_docs/runtime_fields.mdx b/api_docs/runtime_fields.mdx index 54825e384d8e8..09bcc2842fe2b 100644 --- a/api_docs/runtime_fields.mdx +++ b/api_docs/runtime_fields.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/runtimeFields title: "runtimeFields" image: https://source.unsplash.com/400x175/?github description: API docs for the runtimeFields plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'runtimeFields'] --- import runtimeFieldsObj from './runtime_fields.devdocs.json'; diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx index e9dfedb94f918..eb4b73a239ec0 100644 --- a/api_docs/saved_objects.mdx +++ b/api_docs/saved_objects.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjects title: "savedObjects" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjects plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjects'] --- import savedObjectsObj from './saved_objects.devdocs.json'; diff --git a/api_docs/saved_objects_finder.mdx b/api_docs/saved_objects_finder.mdx index 6679b7261b6ae..26d31432068e9 100644 --- a/api_docs/saved_objects_finder.mdx +++ b/api_docs/saved_objects_finder.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsFinder title: "savedObjectsFinder" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsFinder plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsFinder'] --- import savedObjectsFinderObj from './saved_objects_finder.devdocs.json'; diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx index 5c9d3a7a947e1..6b52da6f51c1a 100644 --- a/api_docs/saved_objects_management.mdx +++ b/api_docs/saved_objects_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsManagement title: "savedObjectsManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsManagement plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsManagement'] --- import savedObjectsManagementObj from './saved_objects_management.devdocs.json'; diff --git a/api_docs/saved_objects_tagging.mdx b/api_docs/saved_objects_tagging.mdx index c0c3746b4606b..1ab7d876ed0bf 100644 --- a/api_docs/saved_objects_tagging.mdx +++ b/api_docs/saved_objects_tagging.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsTagging title: "savedObjectsTagging" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsTagging plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTagging'] --- import savedObjectsTaggingObj from './saved_objects_tagging.devdocs.json'; diff --git a/api_docs/saved_objects_tagging_oss.mdx b/api_docs/saved_objects_tagging_oss.mdx index 9c5182b44b974..8007a164b62bd 100644 --- a/api_docs/saved_objects_tagging_oss.mdx +++ b/api_docs/saved_objects_tagging_oss.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsTaggingOss title: "savedObjectsTaggingOss" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsTaggingOss plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss'] --- import savedObjectsTaggingOssObj from './saved_objects_tagging_oss.devdocs.json'; diff --git a/api_docs/saved_search.mdx b/api_docs/saved_search.mdx index a4e540f93388d..6914b0f265653 100644 --- a/api_docs/saved_search.mdx +++ b/api_docs/saved_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedSearch title: "savedSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the savedSearch plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedSearch'] --- import savedSearchObj from './saved_search.devdocs.json'; diff --git a/api_docs/screenshot_mode.mdx b/api_docs/screenshot_mode.mdx index 0323086895861..78561078f4466 100644 --- a/api_docs/screenshot_mode.mdx +++ b/api_docs/screenshot_mode.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/screenshotMode title: "screenshotMode" image: https://source.unsplash.com/400x175/?github description: API docs for the screenshotMode plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode'] --- import screenshotModeObj from './screenshot_mode.devdocs.json'; diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx index afae22de29d6a..cfc58e7876a87 100644 --- a/api_docs/screenshotting.mdx +++ b/api_docs/screenshotting.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/screenshotting title: "screenshotting" image: https://source.unsplash.com/400x175/?github description: API docs for the screenshotting plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting'] --- import screenshottingObj from './screenshotting.devdocs.json'; diff --git a/api_docs/security.mdx b/api_docs/security.mdx index cd6ae5fdb7fe6..1287007ebfc57 100644 --- a/api_docs/security.mdx +++ b/api_docs/security.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/security title: "security" image: https://source.unsplash.com/400x175/?github description: API docs for the security plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security'] --- import securityObj from './security.devdocs.json'; diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index e2e248f6f25a5..b5ac9cbf68eb6 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/securitySolution title: "securitySolution" image: https://source.unsplash.com/400x175/?github description: API docs for the securitySolution plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution'] --- import securitySolutionObj from './security_solution.devdocs.json'; diff --git a/api_docs/serverless.mdx b/api_docs/serverless.mdx index 388c7af361468..7ceeda1a339d9 100644 --- a/api_docs/serverless.mdx +++ b/api_docs/serverless.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/serverless title: "serverless" image: https://source.unsplash.com/400x175/?github description: API docs for the serverless plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'serverless'] --- import serverlessObj from './serverless.devdocs.json'; diff --git a/api_docs/serverless_observability.mdx b/api_docs/serverless_observability.mdx index 5c08e4bbf86ae..e64baa55ed6b2 100644 --- a/api_docs/serverless_observability.mdx +++ b/api_docs/serverless_observability.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/serverlessObservability title: "serverlessObservability" image: https://source.unsplash.com/400x175/?github description: API docs for the serverlessObservability plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'serverlessObservability'] --- import serverlessObservabilityObj from './serverless_observability.devdocs.json'; diff --git a/api_docs/serverless_search.mdx b/api_docs/serverless_search.mdx index b6f19460443a8..27ab954181673 100644 --- a/api_docs/serverless_search.mdx +++ b/api_docs/serverless_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/serverlessSearch title: "serverlessSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the serverlessSearch plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'serverlessSearch'] --- import serverlessSearchObj from './serverless_search.devdocs.json'; diff --git a/api_docs/serverless_security.mdx b/api_docs/serverless_security.mdx index f02e9d9195e89..64fb5e85e09d2 100644 --- a/api_docs/serverless_security.mdx +++ b/api_docs/serverless_security.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/serverlessSecurity title: "serverlessSecurity" image: https://source.unsplash.com/400x175/?github description: API docs for the serverlessSecurity plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'serverlessSecurity'] --- import serverlessSecurityObj from './serverless_security.devdocs.json'; diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index a1dc801def98f..4b6944dc0665c 100644 --- a/api_docs/session_view.mdx +++ b/api_docs/session_view.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/sessionView title: "sessionView" image: https://source.unsplash.com/400x175/?github description: API docs for the sessionView plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sessionView'] --- import sessionViewObj from './session_view.devdocs.json'; diff --git a/api_docs/share.devdocs.json b/api_docs/share.devdocs.json index 6601c08555872..53e4bd286a6ac 100644 --- a/api_docs/share.devdocs.json +++ b/api_docs/share.devdocs.json @@ -878,6 +878,28 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "share", + "id": "def-public.ShareContext.shareableUrlLocatorParams", + "type": "Object", + "tags": [], + "label": "shareableUrlLocatorParams", + "description": [], + "signature": [ + "{ locator: ", + { + "pluginId": "share", + "scope": "common", + "docId": "kibSharePluginApi", + "section": "def-common.LocatorPublic", + "text": "LocatorPublic" + }, + "; params: any; } | undefined" + ], + "path": "src/plugins/share/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "share", "id": "def-public.ShareContext.sharingData", diff --git a/api_docs/share.mdx b/api_docs/share.mdx index 1e8a4144c9f7f..3c717dfa860b3 100644 --- a/api_docs/share.mdx +++ b/api_docs/share.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/share title: "share" image: https://source.unsplash.com/400x175/?github description: API docs for the share plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share'] --- import shareObj from './share.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 118 | 0 | 59 | 10 | +| 119 | 0 | 60 | 10 | ## Client diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index ec4cc1ff5ef43..cc54c620b0185 100644 --- a/api_docs/snapshot_restore.mdx +++ b/api_docs/snapshot_restore.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/snapshotRestore title: "snapshotRestore" image: https://source.unsplash.com/400x175/?github description: API docs for the snapshotRestore plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'snapshotRestore'] --- import snapshotRestoreObj from './snapshot_restore.devdocs.json'; diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx index faef743129fc3..c0b391ba0ff03 100644 --- a/api_docs/spaces.mdx +++ b/api_docs/spaces.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/spaces title: "spaces" image: https://source.unsplash.com/400x175/?github description: API docs for the spaces plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'spaces'] --- import spacesObj from './spaces.devdocs.json'; diff --git a/api_docs/stack_alerts.mdx b/api_docs/stack_alerts.mdx index ddfdc068ad3de..00dd6435c7178 100644 --- a/api_docs/stack_alerts.mdx +++ b/api_docs/stack_alerts.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/stackAlerts title: "stackAlerts" image: https://source.unsplash.com/400x175/?github description: API docs for the stackAlerts plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackAlerts'] --- import stackAlertsObj from './stack_alerts.devdocs.json'; diff --git a/api_docs/stack_connectors.mdx b/api_docs/stack_connectors.mdx index fb62eb043f51d..20879a8213ff7 100644 --- a/api_docs/stack_connectors.mdx +++ b/api_docs/stack_connectors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/stackConnectors title: "stackConnectors" image: https://source.unsplash.com/400x175/?github description: API docs for the stackConnectors plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackConnectors'] --- import stackConnectorsObj from './stack_connectors.devdocs.json'; diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index ff909cab34510..849a51f26d780 100644 --- a/api_docs/task_manager.mdx +++ b/api_docs/task_manager.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/taskManager title: "taskManager" image: https://source.unsplash.com/400x175/?github description: API docs for the taskManager plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] --- import taskManagerObj from './task_manager.devdocs.json'; diff --git a/api_docs/telemetry.devdocs.json b/api_docs/telemetry.devdocs.json index 38561db5d5a0e..ba66ed65c4e78 100644 --- a/api_docs/telemetry.devdocs.json +++ b/api_docs/telemetry.devdocs.json @@ -713,7 +713,7 @@ "section": "def-server.DataTelemetryPayload", "text": "DataTelemetryPayload" }, - " | undefined; kibana: { count: number; indices: number; os: {}; versions: { version: string; count: number; }[]; plugins: { [plugin: string]: Record; }; } | undefined; }; }" + " | undefined; kibana: { count: number; indices: number; os: Record; versions: { version: string; count: number; }[]; plugins: { [plugin: string]: Record; }; } | undefined; }; }" ], "path": "src/plugins/telemetry/server/telemetry_collection/get_local_stats.ts", "deprecated": false, diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index add96b3e995b4..c5bd7796986b4 100644 --- a/api_docs/telemetry.mdx +++ b/api_docs/telemetry.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetry title: "telemetry" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetry plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetry'] --- import telemetryObj from './telemetry.devdocs.json'; diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index e760f02ff79b6..daf135a2dfbe7 100644 --- a/api_docs/telemetry_collection_manager.mdx +++ b/api_docs/telemetry_collection_manager.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionManager title: "telemetryCollectionManager" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetryCollectionManager plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionManager'] --- import telemetryCollectionManagerObj from './telemetry_collection_manager.devdocs.json'; diff --git a/api_docs/telemetry_collection_xpack.mdx b/api_docs/telemetry_collection_xpack.mdx index 39da8f2c3fd89..e99fd30d4ff72 100644 --- a/api_docs/telemetry_collection_xpack.mdx +++ b/api_docs/telemetry_collection_xpack.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionXpack title: "telemetryCollectionXpack" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetryCollectionXpack plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionXpack'] --- import telemetryCollectionXpackObj from './telemetry_collection_xpack.devdocs.json'; diff --git a/api_docs/telemetry_management_section.mdx b/api_docs/telemetry_management_section.mdx index 9ae7c2d5b1152..0663cae80c977 100644 --- a/api_docs/telemetry_management_section.mdx +++ b/api_docs/telemetry_management_section.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryManagementSection title: "telemetryManagementSection" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetryManagementSection plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection'] --- import telemetryManagementSectionObj from './telemetry_management_section.devdocs.json'; diff --git a/api_docs/text_based_languages.devdocs.json b/api_docs/text_based_languages.devdocs.json new file mode 100644 index 0000000000000..581b217b86366 --- /dev/null +++ b/api_docs/text_based_languages.devdocs.json @@ -0,0 +1,309 @@ +{ + "id": "textBasedLanguages", + "client": { + "classes": [], + "functions": [ + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLangEditor", + "type": "Function", + "tags": [], + "label": "TextBasedLangEditor", + "description": [], + "signature": [ + "(props: ", + { + "pluginId": "@kbn/text-based-editor", + "scope": "public", + "docId": "kibKbnTextBasedEditorPluginApi", + "section": "def-public.TextBasedLanguagesEditorProps", + "text": "TextBasedLanguagesEditorProps" + }, + ") => JSX.Element" + ], + "path": "src/plugins/text_based_languages/public/create_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLangEditor.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + { + "pluginId": "@kbn/text-based-editor", + "scope": "public", + "docId": "kibKbnTextBasedEditorPluginApi", + "section": "def-public.TextBasedLanguagesEditorProps", + "text": "TextBasedLanguagesEditorProps" + } + ], + "path": "src/plugins/text_based_languages/public/create_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesEditorProps", + "type": "Interface", + "tags": [], + "label": "TextBasedLanguagesEditorProps", + "description": [], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesEditorProps.query", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "{ sql: string; } | { esql: string; }" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesEditorProps.onTextLangQueryChange", + "type": "Function", + "tags": [], + "label": "onTextLangQueryChange", + "description": [], + "signature": [ + "(query: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.AggregateQuery", + "text": "AggregateQuery" + }, + ") => void" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesEditorProps.onTextLangQueryChange.$1", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.AggregateQuery", + "text": "AggregateQuery" + } + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesEditorProps.onTextLangQuerySubmit", + "type": "Function", + "tags": [], + "label": "onTextLangQuerySubmit", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesEditorProps.expandCodeEditor", + "type": "Function", + "tags": [], + "label": "expandCodeEditor", + "description": [], + "signature": [ + "(status: boolean) => void" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesEditorProps.expandCodeEditor.$1", + "type": "boolean", + "tags": [], + "label": "status", + "description": [], + "signature": [ + "boolean" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesEditorProps.isCodeEditorExpanded", + "type": "boolean", + "tags": [], + "label": "isCodeEditorExpanded", + "description": [], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesEditorProps.errors", + "type": "Array", + "tags": [], + "label": "errors", + "description": [], + "signature": [ + "Error[] | undefined" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesEditorProps.isDisabled", + "type": "CompoundType", + "tags": [], + "label": "isDisabled", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesEditorProps.isDarkMode", + "type": "CompoundType", + "tags": [], + "label": "isDarkMode", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesEditorProps.dataTestSubj", + "type": "string", + "tags": [], + "label": "dataTestSubj", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesPluginStart", + "type": "Interface", + "tags": [], + "label": "TextBasedLanguagesPluginStart", + "description": [], + "path": "src/plugins/text_based_languages/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesPluginStart.Editor", + "type": "CompoundType", + "tags": [], + "label": "Editor", + "description": [], + "signature": [ + "React.ComponentClass<", + { + "pluginId": "@kbn/text-based-editor", + "scope": "public", + "docId": "kibKbnTextBasedEditorPluginApi", + "section": "def-public.TextBasedLanguagesEditorProps", + "text": "TextBasedLanguagesEditorProps" + }, + ", any> | React.FunctionComponent<", + { + "pluginId": "@kbn/text-based-editor", + "scope": "public", + "docId": "kibKbnTextBasedEditorPluginApi", + "section": "def-public.TextBasedLanguagesEditorProps", + "text": "TextBasedLanguagesEditorProps" + }, + ">" + ], + "path": "src/plugins/text_based_languages/public/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/text_based_languages.mdx b/api_docs/text_based_languages.mdx new file mode 100644 index 0000000000000..c938ce47a0855 --- /dev/null +++ b/api_docs/text_based_languages.mdx @@ -0,0 +1,33 @@ +--- +#### +#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system. +#### Reach out in #docs-engineering for more info. +#### +id: kibTextBasedLanguagesPluginApi +slug: /kibana-dev-docs/api/textBasedLanguages +title: "textBasedLanguages" +image: https://source.unsplash.com/400x175/?github +description: API docs for the textBasedLanguages plugin +date: 2023-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'textBasedLanguages'] +--- +import textBasedLanguagesObj from './text_based_languages.devdocs.json'; + + + +Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 16 | 0 | 16 | 0 | + +## Client + +### Functions + + +### Interfaces + + diff --git a/api_docs/threat_intelligence.mdx b/api_docs/threat_intelligence.mdx index a989ea8393d37..7fba067e3ba8e 100644 --- a/api_docs/threat_intelligence.mdx +++ b/api_docs/threat_intelligence.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/threatIntelligence title: "threatIntelligence" image: https://source.unsplash.com/400x175/?github description: API docs for the threatIntelligence plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'threatIntelligence'] --- import threatIntelligenceObj from './threat_intelligence.devdocs.json'; diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index 5c1c0437b8e05..66256dc358f5c 100644 --- a/api_docs/timelines.mdx +++ b/api_docs/timelines.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/timelines title: "timelines" image: https://source.unsplash.com/400x175/?github description: API docs for the timelines plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines'] --- import timelinesObj from './timelines.devdocs.json'; diff --git a/api_docs/transform.mdx b/api_docs/transform.mdx index 9d8b4f352b534..204ab4025b27e 100644 --- a/api_docs/transform.mdx +++ b/api_docs/transform.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/transform title: "transform" image: https://source.unsplash.com/400x175/?github description: API docs for the transform plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform'] --- import transformObj from './transform.devdocs.json'; diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index c09e863fde432..6301282a56a8d 100644 --- a/api_docs/triggers_actions_ui.mdx +++ b/api_docs/triggers_actions_ui.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/triggersActionsUi title: "triggersActionsUi" image: https://source.unsplash.com/400x175/?github description: API docs for the triggersActionsUi plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi'] --- import triggersActionsUiObj from './triggers_actions_ui.devdocs.json'; diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index fb9c109bdedbb..cded1de193f6e 100644 --- a/api_docs/ui_actions.mdx +++ b/api_docs/ui_actions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/uiActions title: "uiActions" image: https://source.unsplash.com/400x175/?github description: API docs for the uiActions plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActions'] --- import uiActionsObj from './ui_actions.devdocs.json'; diff --git a/api_docs/ui_actions_enhanced.mdx b/api_docs/ui_actions_enhanced.mdx index 3b24604fc3d52..b20d36dab2ced 100644 --- a/api_docs/ui_actions_enhanced.mdx +++ b/api_docs/ui_actions_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/uiActionsEnhanced title: "uiActionsEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the uiActionsEnhanced plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] --- import uiActionsEnhancedObj from './ui_actions_enhanced.devdocs.json'; diff --git a/api_docs/unified_field_list.mdx b/api_docs/unified_field_list.mdx index 0dc066e434999..f709a515e9345 100644 --- a/api_docs/unified_field_list.mdx +++ b/api_docs/unified_field_list.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedFieldList title: "unifiedFieldList" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedFieldList plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedFieldList'] --- import unifiedFieldListObj from './unified_field_list.devdocs.json'; diff --git a/api_docs/unified_histogram.devdocs.json b/api_docs/unified_histogram.devdocs.json index 7550ec5192e72..ed12834b728a3 100644 --- a/api_docs/unified_histogram.devdocs.json +++ b/api_docs/unified_histogram.devdocs.json @@ -617,7 +617,15 @@ "Theme", ">; readonly darkModeEnabled$: ", "Observable", - "; useDarkMode: () => boolean; useChartsTheme: () => ", + "<", + { + "pluginId": "@kbn/core-theme-browser", + "scope": "common", + "docId": "kibKbnCoreThemeBrowserPluginApi", + "section": "def-common.CoreTheme", + "text": "CoreTheme" + }, + ">; useDarkMode: () => boolean; useChartsTheme: () => ", "RecursivePartial", "<", "Theme", diff --git a/api_docs/unified_histogram.mdx b/api_docs/unified_histogram.mdx index ff512f74876da..f4bbbb07af66e 100644 --- a/api_docs/unified_histogram.mdx +++ b/api_docs/unified_histogram.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedHistogram title: "unifiedHistogram" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedHistogram plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedHistogram'] --- import unifiedHistogramObj from './unified_histogram.devdocs.json'; diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx index 13a266c424933..2ef2a0973bd41 100644 --- a/api_docs/unified_search.mdx +++ b/api_docs/unified_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedSearch title: "unifiedSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedSearch plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch'] --- import unifiedSearchObj from './unified_search.devdocs.json'; diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx index d6880ae27eb44..91fb071feac8c 100644 --- a/api_docs/unified_search_autocomplete.mdx +++ b/api_docs/unified_search_autocomplete.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedSearch-autocomplete title: "unifiedSearch.autocomplete" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedSearch.autocomplete plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] --- import unifiedSearchAutocompleteObj from './unified_search_autocomplete.devdocs.json'; diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index 06132b8b633c7..531681de896a5 100644 --- a/api_docs/url_forwarding.mdx +++ b/api_docs/url_forwarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/urlForwarding title: "urlForwarding" image: https://source.unsplash.com/400x175/?github description: API docs for the urlForwarding plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'urlForwarding'] --- import urlForwardingObj from './url_forwarding.devdocs.json'; diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx index e164a591be04b..8432d8f5fd275 100644 --- a/api_docs/usage_collection.mdx +++ b/api_docs/usage_collection.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/usageCollection title: "usageCollection" image: https://source.unsplash.com/400x175/?github description: API docs for the usageCollection plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'usageCollection'] --- import usageCollectionObj from './usage_collection.devdocs.json'; diff --git a/api_docs/ux.mdx b/api_docs/ux.mdx index bcf79c4d72b38..a0e382552542a 100644 --- a/api_docs/ux.mdx +++ b/api_docs/ux.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ux title: "ux" image: https://source.unsplash.com/400x175/?github description: API docs for the ux plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ux'] --- import uxObj from './ux.devdocs.json'; diff --git a/api_docs/vis_default_editor.mdx b/api_docs/vis_default_editor.mdx index ed43287922dc7..591047775df2c 100644 --- a/api_docs/vis_default_editor.mdx +++ b/api_docs/vis_default_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visDefaultEditor title: "visDefaultEditor" image: https://source.unsplash.com/400x175/?github description: API docs for the visDefaultEditor plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visDefaultEditor'] --- import visDefaultEditorObj from './vis_default_editor.devdocs.json'; diff --git a/api_docs/vis_type_gauge.mdx b/api_docs/vis_type_gauge.mdx index b7ee84b2187cd..69f95724453cc 100644 --- a/api_docs/vis_type_gauge.mdx +++ b/api_docs/vis_type_gauge.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeGauge title: "visTypeGauge" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeGauge plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeGauge'] --- import visTypeGaugeObj from './vis_type_gauge.devdocs.json'; diff --git a/api_docs/vis_type_heatmap.mdx b/api_docs/vis_type_heatmap.mdx index 2e9813cf88075..46d788ce90929 100644 --- a/api_docs/vis_type_heatmap.mdx +++ b/api_docs/vis_type_heatmap.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeHeatmap title: "visTypeHeatmap" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeHeatmap plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeHeatmap'] --- import visTypeHeatmapObj from './vis_type_heatmap.devdocs.json'; diff --git a/api_docs/vis_type_pie.mdx b/api_docs/vis_type_pie.mdx index 6b6b544bb7e78..cf3667d16a093 100644 --- a/api_docs/vis_type_pie.mdx +++ b/api_docs/vis_type_pie.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypePie title: "visTypePie" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypePie plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypePie'] --- import visTypePieObj from './vis_type_pie.devdocs.json'; diff --git a/api_docs/vis_type_table.mdx b/api_docs/vis_type_table.mdx index 38eed4adabb3f..c089e62584392 100644 --- a/api_docs/vis_type_table.mdx +++ b/api_docs/vis_type_table.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTable title: "visTypeTable" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeTable plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTable'] --- import visTypeTableObj from './vis_type_table.devdocs.json'; diff --git a/api_docs/vis_type_timelion.mdx b/api_docs/vis_type_timelion.mdx index c5c03e68df74f..007af1060cccb 100644 --- a/api_docs/vis_type_timelion.mdx +++ b/api_docs/vis_type_timelion.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTimelion title: "visTypeTimelion" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeTimelion plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimelion'] --- import visTypeTimelionObj from './vis_type_timelion.devdocs.json'; diff --git a/api_docs/vis_type_timeseries.mdx b/api_docs/vis_type_timeseries.mdx index 3046f82bf341c..be65491462729 100644 --- a/api_docs/vis_type_timeseries.mdx +++ b/api_docs/vis_type_timeseries.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTimeseries title: "visTypeTimeseries" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeTimeseries plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimeseries'] --- import visTypeTimeseriesObj from './vis_type_timeseries.devdocs.json'; diff --git a/api_docs/vis_type_vega.mdx b/api_docs/vis_type_vega.mdx index f8ce92dcb56ef..70b615f7f98af 100644 --- a/api_docs/vis_type_vega.mdx +++ b/api_docs/vis_type_vega.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeVega title: "visTypeVega" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeVega plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVega'] --- import visTypeVegaObj from './vis_type_vega.devdocs.json'; diff --git a/api_docs/vis_type_vislib.mdx b/api_docs/vis_type_vislib.mdx index dd4962c7172ea..6c4870ce72be2 100644 --- a/api_docs/vis_type_vislib.mdx +++ b/api_docs/vis_type_vislib.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeVislib title: "visTypeVislib" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeVislib plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVislib'] --- import visTypeVislibObj from './vis_type_vislib.devdocs.json'; diff --git a/api_docs/vis_type_xy.mdx b/api_docs/vis_type_xy.mdx index 791caa811dc45..c57df03252271 100644 --- a/api_docs/vis_type_xy.mdx +++ b/api_docs/vis_type_xy.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeXy title: "visTypeXy" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeXy plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] --- import visTypeXyObj from './vis_type_xy.devdocs.json'; diff --git a/api_docs/visualization_ui_components.mdx b/api_docs/visualization_ui_components.mdx index b951e14d7d2a7..7512e0806e8e4 100644 --- a/api_docs/visualization_ui_components.mdx +++ b/api_docs/visualization_ui_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visualizationUiComponents title: "visualizationUiComponents" image: https://source.unsplash.com/400x175/?github description: API docs for the visualizationUiComponents plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizationUiComponents'] --- import visualizationUiComponentsObj from './visualization_ui_components.devdocs.json'; diff --git a/api_docs/visualizations.devdocs.json b/api_docs/visualizations.devdocs.json index 861de4dd41d4e..bc83278e180ce 100644 --- a/api_docs/visualizations.devdocs.json +++ b/api_docs/visualizations.devdocs.json @@ -6287,21 +6287,6 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "visualizations", - "id": "def-public.VISUALIZE_ENABLE_LABS_SETTING", - "type": "string", - "tags": [], - "label": "VISUALIZE_ENABLE_LABS_SETTING", - "description": [], - "signature": [ - "\"visualize:enableLabs\"" - ], - "path": "src/plugins/visualizations/common/constants.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "visualizations", "id": "def-public.VisualizeEmbeddableContract", @@ -6643,8 +6628,6 @@ "section": "def-public.VisualizeEmbeddable", "text": "VisualizeEmbeddable" }, - " | ", - "DisabledLabEmbeddable", " | undefined>; readonly type: \"visualization\"; inject: (_state: ", { "pluginId": "embeddable", @@ -6741,8 +6724,6 @@ "section": "def-public.VisualizeEmbeddable", "text": "VisualizeEmbeddable" }, - " | ", - "DisabledLabEmbeddable", ">; readonly savedObjectMetaData: ", { "pluginId": "savedObjectsFinder", @@ -7045,23 +7026,7 @@ "functions": [], "interfaces": [], "enums": [], - "misc": [ - { - "parentPluginId": "visualizations", - "id": "def-server.VISUALIZE_ENABLE_LABS_SETTING", - "type": "string", - "tags": [], - "label": "VISUALIZE_ENABLE_LABS_SETTING", - "description": [], - "signature": [ - "\"visualize:enableLabs\"" - ], - "path": "src/plugins/visualizations/common/constants.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - } - ], + "misc": [], "objects": [], "setup": { "parentPluginId": "visualizations", diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index 3cc3fb77b4e20..af512378f09bb 100644 --- a/api_docs/visualizations.mdx +++ b/api_docs/visualizations.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visualizations title: "visualizations" image: https://source.unsplash.com/400x175/?github description: API docs for the visualizations plugin -date: 2023-05-16 +date: 2023-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] --- import visualizationsObj from './visualizations.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 806 | 12 | 776 | 19 | +| 804 | 12 | 774 | 18 | ## Client @@ -57,9 +57,6 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k ### Start -### Consts, variables and types - - ## Common ### Objects diff --git a/config/serverless.es.yml b/config/serverless.es.yml index 2d814e74e0160..e44af8565537b 100644 --- a/config/serverless.es.yml +++ b/config/serverless.es.yml @@ -3,7 +3,7 @@ ## Disable APM and Uptime, enable Enterprise Search xpack.apm.enabled: false xpack.uptime.enabled: false -enterpriseSearch.enabled: true +enterpriseSearch.enabled: false ## Enable the Serverless Search plugin xpack.serverless.search.enabled: true diff --git a/config/serverless.yml b/config/serverless.yml index 6a9c4793dc85d..153ca487205ca 100644 --- a/config/serverless.yml +++ b/config/serverless.yml @@ -17,9 +17,17 @@ xpack.license_management.enabled: false # Other disabled plugins #xpack.canvas.enabled: false #only disabable in dev-mode xpack.reporting.enabled: false +xpack.cloud_integrations.data_migration.enabled: false # Enforce restring access to internal APIs see https://github.com/elastic/kibana/issues/151940 # server.restrictInternalApis: true # Telemetry enabled by default and not disableable via UI telemetry.optIn: true telemetry.allowChangingOptInStatus: false + +# Harden security response headers, see https://github.com/elastic/kibana/issues/150884 +# The browser should remember that a site, including subdomains, is only to be accessed using HTTPS for 1 year +# Can override this setting in kibana.dev.yml, e.g. server.securityResponseHeaders.strictTransportSecurity: null +server.securityResponseHeaders.strictTransportSecurity: max-age=31536000; includeSubDomains +# Disable embedding for serverless MVP +server.securityResponseHeaders.disableEmbedding: true diff --git a/dev_docs/getting_started/setting_up_a_development_env.mdx b/dev_docs/getting_started/setting_up_a_development_env.mdx index 8599adf0e53b3..49b745f9d0f0d 100644 --- a/dev_docs/getting_started/setting_up_a_development_env.mdx +++ b/dev_docs/getting_started/setting_up_a_development_env.mdx @@ -75,11 +75,13 @@ In another terminal tab/window you can start Kibana. yarn start ``` -Include developer examples](https://github.com/elastic/kibana/tree/main/examples) by adding an optional `--run-examples` flag. Read more about the advanced options for [Running Kibana](https://www.elastic.co/guide/en/kibana/current/running-kibana-advanced.html). +Include developer [examples](https://github.com/elastic/kibana/tree/main/examples) by adding an optional `--run-examples` flag. Read more about the advanced options for [Running Kibana](https://www.elastic.co/guide/en/kibana/current/running-kibana-advanced.html). +You will find the development server running on (http://localhost:5601) - and you can log in with the `elastic:changeme` credential pair. ## Code away! -You are now ready to start developing. Changes to the source files should be picked up automatically and either cause the server to restart, or be served to the browser on the next page refresh. +You are now ready to start developing. +Changes to the source files should be picked up automatically and either cause the server to restart, or be served to the browser on the next page refresh. ## Install pre-commit hook (optional) diff --git a/dev_docs/tutorials/saved_objects.mdx b/dev_docs/tutorials/saved_objects.mdx index f6ab46c9a3e8d..26a93631c5324 100644 --- a/dev_docs/tutorials/saved_objects.mdx +++ b/dev_docs/tutorials/saved_objects.mdx @@ -254,6 +254,38 @@ the error should be verbose and informative so that the corrupt document can be **WARNING:** Do not attempt to change the `typeMigrationVersion`, `id`, or `type` fields within a migration function, this is not supported. +### Deferred Migrations +Usually, migrations run during the upgrade process, and sometimes that may block it if there is a huge amount of outdated objects. +In this case, it is recommended to mark some of the migrations to defer their execution. + +```ts +export const dashboardVisualization: SavedObjectsType = { + name: 'dashboard_visualization', [1] + /** ... */ + migrations: { + // Takes a pre 1.1.0 doc, and converts it to 1.1.0 + '1.1.0': { + deferred: true, + transform: migrateDashboardVisualization110, + }, + }, +}; +``` + +By default, all the migrations are not deferred, and in order to make them so, the `deferred` flag should be explicitly set to `true`. +In this case, the documents with only pending deferred migrations will not be migrated during the upgrade process. + +But whenever they are accessed via Saved Object API or repository, all the migrations will be applied to them on the fly: +- On read operations, the stored objects remain untouched and only transformed before returning the result. + If there are some failures during the migration, an exception or 500 server error will be thrown, + so that it is guaranteed that all the returned objects will be up to date. +- On write operations, the objects will be migrated to the latest version before writing them. + +In other words, this flag postpones the write operation until the objects are explicitly modified. + +One important notice: if there is a few pending migrations for a document and not all of them can be deferred, +the document will be migrated during the upgrade process, and all pending migrations will be applied. + ### Testing Migrations Bugs in a migration function cause downtime for our users and therefore have a very high impact. Follow the . diff --git a/docs/CHANGELOG.asciidoc b/docs/CHANGELOG.asciidoc index e84286f34c4a6..4f16d09cfb3c2 100644 --- a/docs/CHANGELOG.asciidoc +++ b/docs/CHANGELOG.asciidoc @@ -170,13 +170,9 @@ To monitor endpoints, pages, and user journeys, go to **{observability}** -> **S Alerting:: * Adds Maintenance Window Task Runner Integration + New AAD/Event Log Fields {kibana-pull}154761[#154761] -* Adds support for file attachments in Cases {kibana-pull}154436[#154436] * Adds support for users authenticated with API keys to manage alerting rules {kibana-pull}154189[#154189] * Adds the ability to control allowed attached file mime types and the maximum file size {kibana-pull}154013[#154013] * Adds query and timeframe params to RuleAction to filter alerts {kibana-pull}152360[#152360] -* Adds the Cases column to the alerts table {kibana-pull}150963[#150963] -* Adds filtering and sorting for the case activity {kibana-pull}149396[#149396] -* Adds the ability to filter user activities with pagination {kibana-pull}152702[#152702] APM:: * Adds group-by feature in APM rules {kibana-pull}155001[#155001] @@ -185,6 +181,12 @@ APM:: * Adds table tabs showing summary of metrics {kibana-pull}153044[#153044] * Adds warning to Edit Rule Flyout when publicUrl is not configured {kibana-pull}149832[#149832] +Cases:: +* Adds support for file attachments in Cases {kibana-pull}154436[#154436] +* Adds the Cases column to the alerts table {kibana-pull}150963[#150963] +* Adds filtering and sorting for the case activity {kibana-pull}149396[#149396] +* Adds the ability to filter user activities with pagination {kibana-pull}152702[#152702] + Dashboard:: Pins the unified search bar and dashboard toolbar to the top of the dashboard page when scrolling {kibana-pull}145628[#145628] @@ -746,15 +748,7 @@ For detailed information about the 8.7.0 release, review the enhancements and bu === Enhancements Alerting:: * Bring flapping status and settings in o11y {kibana-pull}150483[#150483] -* Redesign all cases list select modal {kibana-pull}149851[#149851] * RenderCustomActionsRow with named params instead of args {kibana-pull}149304[#149304] -* Adds new column `Updated on ` in `all cases list ` table. This column can be sorted and can persist sorting options {kibana-pull}149116[#149116] -* Users can now click a button on Case Detail and All Cases List to copy a case's UUID to the clipboard {kibana-pull}148962[#148962] -* Sorting, severity filter and status filter are now persisted in the URL and local storage for the all cases list {kibana-pull}148549[#148549] -* Sorting by status, severity, and title is now allowed in the all-cases list {kibana-pull}148193[#148193] -* See "My recently assigned cases" to the recent cases widget of Security Solution dashboard {kibana-pull}147763[#147763] -* Adds the ability to bulk edit assignees on multiple cases {kibana-pull}146907[#146907] -* Save draft user comment {kibana-pull}146327[#146327] * Ram 145739 use bulk enable disable in UI {kibana-pull}145928[#145928] * Create generic retry if function {kibana-pull}145713[#145713] * Return rules from bulk enable {kibana-pull}145391[#145391] @@ -780,6 +774,16 @@ APM:: * Adds pagination to source map API {kibana-pull}145959[#145959] * Adds ability to offset point labels on maps {kibana-pull}145773[#145773] +Cases:: +* Adds new column `Updated on ` in `all cases list ` table. This column can be sorted and can persist sorting options {kibana-pull}149116[#149116] +* Improves the design of all cases list select modal {kibana-pull}149851[#149851] +* Adds a button to Case Detail and All Cases List to copy case UUIDs to the clipboard {kibana-pull}148962[#148962] +* Adds the ability to persist sorting, severity filter, and status filter in the URL and local storage for the all cases list {kibana-pull}148549[#148549] +* Adds the ability to allow sorting by status, severity, and title in the all-cases list {kibana-pull}148193[#148193] +* See "My recently assigned cases" to the recent cases widget of Overview dashboard in Security {kibana-pull}147763[#147763] +* Adds the ability to bulk edit assignees on multiple cases {kibana-pull}146907[#146907] +* Adds the ability to save draft comments {kibana-pull}146327[#146327] + Dashboard:: * Add new panel settings option to change the title, description, and time range for panels {kibana-pull}148301[#148301] * Anchor time slider to start {kibana-pull}148028[#148028] diff --git a/docs/api-generated/cases/case-apis-passthru.asciidoc b/docs/api-generated/cases/case-apis-passthru.asciidoc index 492d9efe9600c..d983ab1d2a099 100644 --- a/docs/api-generated/cases/case-apis-passthru.asciidoc +++ b/docs/api-generated/cases/case-apis-passthru.asciidoc @@ -24,6 +24,7 @@ Any modifications made to this file will be overwritten.
  • delete /s/{spaceId}/api/cases/{caseId}/comments/{commentId}
  • delete /s/{spaceId}/api/cases/{caseId}/comments
  • get /s/{spaceId}/api/cases/{caseId}/user_actions/_find
  • +
  • get /s/{spaceId}/api/cases/{caseId}/comments/_find
  • get /s/{spaceId}/api/cases/configure/connectors/_find
  • get /s/{spaceId}/api/cases/_find
  • get /s/{spaceId}/api/cases/{caseId}/comments
  • @@ -461,9 +462,9 @@ Any modifications made to this file will be overwritten.
    Query Parameter — The page number to return. default: 1
    perPage (optional)
    -
    Query Parameter — The number of user actions to return per page. default: 20
    sortOrder (optional)
    +
    Query Parameter — The number of items to return. default: 20
    sortOrder (optional)
    -
    Query Parameter — Determines the sort order. default: asc
    types (optional)
    +
    Query Parameter — Determines the sort order. default: desc
    types (optional)
    Query Parameter — Determines the types of user actions to return. default: null
    @@ -530,6 +531,119 @@ Any modifications made to this file will be overwritten. 4xx_response
    +
    +
    + Up +
    get /s/{spaceId}/api/cases/{caseId}/comments/_find
    +
    Retrieves all the user comments from a case. (findCaseComments)
    +
    You must have read privileges for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on the owner of the cases with the comments you're seeking.
    + +

    Path parameters

    +
    +
    caseId (required)
    + +
    Path Parameter — The identifier for the case. To retrieve case IDs, use the find cases API. All non-ASCII characters must be URL encoded. default: null
    spaceId (required)
    + +
    Path Parameter — An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. default: null
    +
    + + + + +

    Query parameters

    +
    +
    page (optional)
    + +
    Query Parameter — The page number to return. default: 1
    perPage (optional)
    + +
    Query Parameter — The number of items to return. default: 20
    sortOrder (optional)
    + +
    Query Parameter — Determines the sort order. default: desc
    +
    + + +

    Return type

    + + + + +

    Example data

    +
    Content-Type: application/json
    +
    {
    +  "owner" : "cases",
    +  "totalComment" : 0,
    +  "settings" : {
    +    "syncAlerts" : true
    +  },
    +  "totalAlerts" : 0,
    +  "closed_at" : "2000-01-23T04:56:07.000+00:00",
    +  "comments" : [ null, null ],
    +  "assignees" : [ {
    +    "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
    +  }, {
    +    "uid" : "u_0wpfV1MqYDaXzLtRVY-gLMrddKDEmfz51Fszhj7hWC8_0"
    +  } ],
    +  "created_at" : "2022-05-13T09:16:17.416Z",
    +  "description" : "A case description.",
    +  "title" : "Case title 1",
    +  "created_by" : {
    +    "full_name" : "full_name",
    +    "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
    +    "email" : "email",
    +    "username" : "elastic"
    +  },
    +  "version" : "WzUzMiwxXQ==",
    +  "closed_by" : {
    +    "full_name" : "full_name",
    +    "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
    +    "email" : "email",
    +    "username" : "elastic"
    +  },
    +  "tags" : [ "tag-1" ],
    +  "duration" : 120,
    +  "updated_at" : "2000-01-23T04:56:07.000+00:00",
    +  "updated_by" : {
    +    "full_name" : "full_name",
    +    "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
    +    "email" : "email",
    +    "username" : "elastic"
    +  },
    +  "id" : "66b9aa00-94fa-11ea-9f74-e7e108796192",
    +  "external_service" : {
    +    "external_title" : "external_title",
    +    "pushed_by" : {
    +      "full_name" : "full_name",
    +      "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
    +      "email" : "email",
    +      "username" : "elastic"
    +    },
    +    "external_url" : "external_url",
    +    "pushed_at" : "2000-01-23T04:56:07.000+00:00",
    +    "connector_id" : "connector_id",
    +    "external_id" : "external_id",
    +    "connector_name" : "connector_name"
    +  }
    +}
    + +

    Produces

    + This API call produces the following media types according to the Accept request header; + the media type will be conveyed by the Content-Type response header. +
      +
    • application/json
    • +
    + +

    Responses

    +

    200

    + Indicates a successful call. + case_response_properties +

    401

    + Authorization information is missing or invalid. + 4xx_response +
    +
    Up @@ -620,7 +734,7 @@ Any modifications made to this file will be overwritten.
    Query Parameter — The page number to return. default: 1
    perPage (optional)
    -
    Query Parameter — The number of cases to return per page. default: 20
    reporters (optional)
    +
    Query Parameter — The number of items to return. default: 20
    reporters (optional)
    Query Parameter — Filters the returned cases by the user name of the reporter. default: null
    search (optional)
    @@ -2880,7 +2994,7 @@ Any modifications made to this file will be overwritten.

    search_fields - Up

    -
    +
    The fields to perform the simple_query_string parsed query against.
    diff --git a/docs/api-generated/rules/rule-apis-passthru.asciidoc b/docs/api-generated/rules/rule-apis-passthru.asciidoc index 08fdcd1d0276a..c4f472c161efe 100644 --- a/docs/api-generated/rules/rule-apis-passthru.asciidoc +++ b/docs/api-generated/rules/rule-apis-passthru.asciidoc @@ -111,6 +111,7 @@ Any modifications made to this file will be overwritten. "warning" : "warning", "outcome" : "succeeded" }, + "api_key_created_by_user" : false, "params" : { "key" : "" }, @@ -118,6 +119,7 @@ Any modifications made to this file will be overwritten. "enabled" : true, "muted_alert_ids" : [ "muted_alert_ids", "muted_alert_ids" ], "rule_type_id" : "monitoring_alert_cluster_health", + "revision" : 5, "tags" : [ "tags", "tags" ], "running" : true, "api_key_owner" : "elastic", @@ -142,6 +144,7 @@ Any modifications made to this file will be overwritten. "params" : { "key" : "" }, + "uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61", "connector_type_id" : ".server-log", "frequency" : { "summary" : true, @@ -154,6 +157,7 @@ Any modifications made to this file will be overwritten. "params" : { "key" : "" }, + "uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61", "connector_type_id" : ".server-log", "frequency" : { "summary" : true, @@ -407,6 +411,7 @@ Any modifications made to this file will be overwritten. "warning" : "warning", "outcome" : "succeeded" }, + "api_key_created_by_user" : false, "params" : { "key" : "" }, @@ -414,6 +419,7 @@ Any modifications made to this file will be overwritten. "enabled" : true, "muted_alert_ids" : [ "muted_alert_ids", "muted_alert_ids" ], "rule_type_id" : "monitoring_alert_cluster_health", + "revision" : 5, "tags" : [ "tags", "tags" ], "running" : true, "api_key_owner" : "elastic", @@ -438,6 +444,7 @@ Any modifications made to this file will be overwritten. "params" : { "key" : "" }, + "uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61", "connector_type_id" : ".server-log", "frequency" : { "summary" : true, @@ -450,6 +457,7 @@ Any modifications made to this file will be overwritten. "params" : { "key" : "" }, + "uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61", "connector_type_id" : ".server-log", "frequency" : { "summary" : true, @@ -473,6 +481,7 @@ Any modifications made to this file will be overwritten. "warning" : "warning", "outcome" : "succeeded" }, + "api_key_created_by_user" : false, "params" : { "key" : "" }, @@ -480,6 +489,7 @@ Any modifications made to this file will be overwritten. "enabled" : true, "muted_alert_ids" : [ "muted_alert_ids", "muted_alert_ids" ], "rule_type_id" : "monitoring_alert_cluster_health", + "revision" : 5, "tags" : [ "tags", "tags" ], "running" : true, "api_key_owner" : "elastic", @@ -504,6 +514,7 @@ Any modifications made to this file will be overwritten. "params" : { "key" : "" }, + "uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61", "connector_type_id" : ".server-log", "frequency" : { "summary" : true, @@ -516,6 +527,7 @@ Any modifications made to this file will be overwritten. "params" : { "key" : "" }, + "uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61", "connector_type_id" : ".server-log", "frequency" : { "summary" : true, @@ -654,6 +666,7 @@ Any modifications made to this file will be overwritten. "warning" : "warning", "outcome" : "succeeded" }, + "api_key_created_by_user" : false, "params" : { "key" : "" }, @@ -661,6 +674,7 @@ Any modifications made to this file will be overwritten. "enabled" : true, "muted_alert_ids" : [ "muted_alert_ids", "muted_alert_ids" ], "rule_type_id" : "monitoring_alert_cluster_health", + "revision" : 5, "tags" : [ "tags", "tags" ], "running" : true, "api_key_owner" : "elastic", @@ -685,6 +699,7 @@ Any modifications made to this file will be overwritten. "params" : { "key" : "" }, + "uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61", "connector_type_id" : ".server-log", "frequency" : { "summary" : true, @@ -697,6 +712,7 @@ Any modifications made to this file will be overwritten. "params" : { "key" : "" }, + "uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61", "connector_type_id" : ".server-log", "frequency" : { "summary" : true, @@ -2012,6 +2028,7 @@ Any modifications made to this file will be overwritten. "warning" : "warning", "outcome" : "succeeded" }, + "api_key_created_by_user" : false, "params" : { "key" : "" }, @@ -2019,6 +2036,7 @@ Any modifications made to this file will be overwritten. "enabled" : true, "muted_alert_ids" : [ "muted_alert_ids", "muted_alert_ids" ], "rule_type_id" : "monitoring_alert_cluster_health", + "revision" : 5, "tags" : [ "tags", "tags" ], "running" : true, "api_key_owner" : "elastic", @@ -2043,6 +2061,7 @@ Any modifications made to this file will be overwritten. "params" : { "key" : "" }, + "uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61", "connector_type_id" : ".server-log", "frequency" : { "summary" : true, @@ -2055,6 +2074,7 @@ Any modifications made to this file will be overwritten. "params" : { "key" : "" }, + "uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61", "connector_type_id" : ".server-log", "frequency" : { "summary" : true, @@ -2231,6 +2251,7 @@ Any modifications made to this file will be overwritten.
    group (optional)
    String The group name for the actions. If you don't need to group actions, set to default.
    id (optional)
    String The identifier for the connector saved object.
    params (optional)
    map[String, oas_any_type_not_mapped] The parameters for the action, which are sent to the connector. The params are handled as Mustache templates and passed a default set of context.
    +
    uuid (optional)
    String A universally unique identifier (UUID) for the action.
    @@ -2566,7 +2587,8 @@ Any modifications made to this file will be overwritten.
    actions
    -
    api_key_owner
    +
    api_key_created_by_user (optional)
    Boolean Indicates whether the API key that is associated with the rule was created by the user.
    +
    api_key_owner
    String The owner of the API key that is associated with the rule and used to run background tasks.
    consumer
    String The application or feature that owns the rule. For example, alerts, apm, discover, infrastructure, logs, metrics, ml, monitoring, securitySolution, siem, stackAlerts, or uptime.
    created_at
    Date The date and time that the rule was created. format: date-time
    created_by
    String The identifier for the user that created the rule.
    @@ -2580,6 +2602,7 @@ Any modifications made to this file will be overwritten.
    next_run (optional)
    Date format: date-time
    notify_when (optional)
    params
    map[String, oas_any_type_not_mapped] The parameters for the rule.
    +
    revision (optional)
    Integer The rule revision number.
    rule_type_id
    String The identifier for the type of rule. For example, .es-query, .index-threshold, logs.alert.document.count, monitoring_alert_cluster_health, siem.thresholdRule, or xpack.ml.anomaly_detection_alert.
    running (optional)
    Boolean Indicates whether the rule is running.
    schedule
    diff --git a/docs/api/spaces-management/update_objects_spaces.asciidoc b/docs/api/spaces-management/update_objects_spaces.asciidoc index dec846fd6fee0..5938ddb4e4315 100644 --- a/docs/api/spaces-management/update_objects_spaces.asciidoc +++ b/docs/api/spaces-management/update_objects_spaces.asciidoc @@ -36,6 +36,15 @@ Updates one or more saved objects to add and/or remove them from specified space `spacesToRemove`:: (Required, string array) The IDs of the spaces the specified objects should be removed from. +[[spaces-api-update-objects-spaces-response-codes]] +==== Response codes + +`200`:: + Indicates a successful call. + +`404`:: + Indicates that the request failed because one or more of the objects specified could not be found. A list of the unresolved objects are included in the 404 response attributes. + [role="child_attributes"] [[spaces-api-update-objects-spaces-response-body]] ==== {api-response-body-title} diff --git a/docs/concepts/data-views.asciidoc b/docs/concepts/data-views.asciidoc index d2155820545f9..f75012e8d69f4 100644 --- a/docs/concepts/data-views.asciidoc +++ b/docs/concepts/data-views.asciidoc @@ -40,7 +40,8 @@ image::images/discover-data-view.png[How to set the {data-source} in Discover, w . Give your {data-source} a name. . Start typing in the *Index pattern* field, and {kib} looks for the names of -indices, data streams, and aliases that match your input. +indices, data streams, and aliases that match your input. You can +view all available sources or only the sources that the data view targets. + [role="screenshot"] image:management/index-patterns/images/create-data-view.png["Create data view"] diff --git a/docs/concepts/kuery.asciidoc b/docs/concepts/kuery.asciidoc index 4eb95fa444058..8c14333b0e1f3 100644 --- a/docs/concepts/kuery.asciidoc +++ b/docs/concepts/kuery.asciidoc @@ -178,13 +178,17 @@ http.request.method: (GET OR POST OR DELETE) === Matching multiple fields Wildcards can also be used to query multiple fields. For example, to search for -documents where any sub-field of `http.response` contains “error”, use the following: +documents where any sub-field of `datastream` contains “logs”, use the following: [source,yaml] ------------------- -http.response.*: error +datastream.*: logs ------------------- +NOTE: When using wildcards to query multiple fields, errors might occur if the fields are of +different types. For example, if `datastream.*` matches both numeric and string fields, the +above query will result in an error because numeric fields cannot be queried for string values. + [discrete] === Querying nested fields diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index e218387d64341..e61452529e4c8 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -300,6 +300,10 @@ generating deep links to other apps using locators, and creating short URLs. |This plugin adds the Advanced Settings section for the Usage and Security Data collection (aka Telemetry). +|{kib-repo}blob/{branch}/src/plugins/text_based_languages/README.md[textBasedLanguages] +|The editor accepts the following properties: + + |<> |UI Actions plugins provides API to manage *triggers* and *actions*. diff --git a/docs/discover/document-explorer.asciidoc b/docs/discover/document-explorer.asciidoc index 2576cd1e3ae6d..071c9f9875028 100644 --- a/docs/discover/document-explorer.asciidoc +++ b/docs/discover/document-explorer.asciidoc @@ -5,7 +5,7 @@ Fine tune your explorations by customizing *Discover* to bring out the the best Adjust the chart height, modify the document table, and look inside a document. [role="screenshot"] -image:images/discover.png[A view of the Discover app] +image::images/hello-field.png[A view of the Discover app] [float] diff --git a/docs/discover/images/customer.png b/docs/discover/images/customer.png index 3163d8458e12c..4a60460b7bca6 100644 Binary files a/docs/discover/images/customer.png and b/docs/discover/images/customer.png differ diff --git a/docs/discover/images/discover-add-icon.png b/docs/discover/images/discover-add-icon.png index aa9f3ac40f440..21876b81a6533 100644 Binary files a/docs/discover/images/discover-add-icon.png and b/docs/discover/images/discover-add-icon.png differ diff --git a/docs/discover/images/discover-context.png b/docs/discover/images/discover-context.png index e02171e3f8572..8f3d90603779b 100644 Binary files a/docs/discover/images/discover-context.png and b/docs/discover/images/discover-context.png differ diff --git a/docs/discover/images/discover-day-of-week.png b/docs/discover/images/discover-day-of-week.png new file mode 100644 index 0000000000000..c95e908deaa32 Binary files /dev/null and b/docs/discover/images/discover-day-of-week.png differ diff --git a/docs/discover/images/discover-from-visualize.png b/docs/discover/images/discover-from-visualize.png index 2a3ba610299b6..4fb2bfbcbbf1a 100644 Binary files a/docs/discover/images/discover-from-visualize.png and b/docs/discover/images/discover-from-visualize.png differ diff --git a/docs/discover/images/discover-search-for-relevance.png b/docs/discover/images/discover-search-for-relevance.png index 2157604ddec30..16be07dce5fb8 100644 Binary files a/docs/discover/images/discover-search-for-relevance.png and b/docs/discover/images/discover-search-for-relevance.png differ diff --git a/docs/discover/images/discover-sidebar-available-fields.png b/docs/discover/images/discover-sidebar-available-fields.png index a5c24f27a0ed2..6bc9f04c9ba70 100644 Binary files a/docs/discover/images/discover-sidebar-available-fields.png and b/docs/discover/images/discover-sidebar-available-fields.png differ diff --git a/docs/discover/images/document-explorer-compare-data.png b/docs/discover/images/document-explorer-compare-data.png index aa14375a4f1ff..36560dcabd13e 100644 Binary files a/docs/discover/images/document-explorer-compare-data.png and b/docs/discover/images/document-explorer-compare-data.png differ diff --git a/docs/discover/images/document-explorer-row-height.png b/docs/discover/images/document-explorer-row-height.png index d274d8de338c2..19b30b0af9e54 100644 Binary files a/docs/discover/images/document-explorer-row-height.png and b/docs/discover/images/document-explorer-row-height.png differ diff --git a/docs/discover/images/document-table-expanded.png b/docs/discover/images/document-table-expanded.png index d0b85010c5b7d..a6fee908b668f 100644 Binary files a/docs/discover/images/document-table-expanded.png and b/docs/discover/images/document-table-expanded.png differ diff --git a/docs/discover/images/document-table.png b/docs/discover/images/document-table.png index f2a9e57a38cbc..8fbabe4703b24 100644 Binary files a/docs/discover/images/document-table.png and b/docs/discover/images/document-table.png differ diff --git a/docs/discover/images/hello-field.png b/docs/discover/images/hello-field.png index 8d8d5943ba76a..261cb00acfa4c 100644 Binary files a/docs/discover/images/hello-field.png and b/docs/discover/images/hello-field.png differ diff --git a/docs/discover/images/log-pattern-analysis-available-fields.png b/docs/discover/images/log-pattern-analysis-available-fields.png new file mode 100644 index 0000000000000..9ac267c58bbd3 Binary files /dev/null and b/docs/discover/images/log-pattern-analysis-available-fields.png differ diff --git a/docs/discover/images/log-pattern-analysis-results.png b/docs/discover/images/log-pattern-analysis-results.png new file mode 100644 index 0000000000000..8071c9bb9d05b Binary files /dev/null and b/docs/discover/images/log-pattern-analysis-results.png differ diff --git a/docs/discover/log-pattern-analysis.asciidoc b/docs/discover/log-pattern-analysis.asciidoc new file mode 100644 index 0000000000000..f3aff8549a01a --- /dev/null +++ b/docs/discover/log-pattern-analysis.asciidoc @@ -0,0 +1,38 @@ +[[run-pattern-analysis-discover]] +== Run a pattern analysis on your log data + +preview::[] + +include::../user/ml/index.asciidoc[tag=log-pattern-analysis-intro] +Log pattern analysis works on every text field. + +This example uses the <>, or you +can use your own data. + +. Open the main menu, and click *Discover*. + +. Expand the {data-source} dropdown, and select *Kibana Sample Data Logs*. + +. If you don't see any results, expand the time range, for example, to +*Last 15 days*. + +. Click the `message` field in the **Available fields** list sidebar and click +**Run pattern analysis**. ++ +-- +[role="screenshot"] +image::images/log-pattern-analysis-available-fields.png["Available fields view in Discover showing the message field selected."] + +The pattern analysis starts. The results are displayed in a flyout when the +analysis is complete. + +[role="screenshot"] +image::images/log-pattern-analysis-results.png["Log pattern analysis results in Discover."] +-- + +. (optional) Apply filters to one or more patterns. *Discover* only displays +documents that match the selected patterns. Additionally, you can remove +selected patterns from *Discover*, resulting in the display of only those +documents that don't match the selected pattern. These options enable you to +remove unimportant messages and focus on the more important, actionable data +during troubleshooting. \ No newline at end of file diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index 709763dd6a03f..9282acc02c5f8 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -545,10 +545,6 @@ The maximum number of buckets a datasource can return. High numbers can have a n [[visualization-visualize-heatmapChartslibrary]]`visualization:visualize:legacyHeatmapChartsLibrary`:: Disable this option if you prefer to use the new heatmap charts with improved performance, legend settings, and more.. -[[visualize-enablelabs]]`visualize:enableLabs`:: -Enables users to create, view, and edit experimental visualizations. When disabled, -only production-ready visualizations are available to users. - [float] [[kibana-telemetry-settings]] ==== Usage Data diff --git a/docs/management/connectors/action-types/index.asciidoc b/docs/management/connectors/action-types/index.asciidoc index d674ba868686e..87c7494df23ea 100644 --- a/docs/management/connectors/action-types/index.asciidoc +++ b/docs/management/connectors/action-types/index.asciidoc @@ -26,8 +26,7 @@ image::management/connectors/images/index-connector.png[Index connector] [[index-connector-configuration]] ==== Connector configuration -Index connectors must have a name and an {es} index. You can optionally set the -{ref}/docs-refresh.html[refresh] policy and the time field, which contains the +Index connectors must have a name and an {es} index. You can optionally set the time field, which contains the details about when each alert condition was detected. [float] @@ -46,10 +45,8 @@ xpack.actions.preconfigured: actionTypeId: .index config: index: .kibana - refresh: true <1> executionTimeField: my-field -- -<1> By default, the {ref}/docs-refresh.html[refresh] policy is `false`. For more information, go to <>. diff --git a/docs/management/connectors/images/index-connector.png b/docs/management/connectors/images/index-connector.png index 438aac772c409..4ef698b860946 100644 Binary files a/docs/management/connectors/images/index-connector.png and b/docs/management/connectors/images/index-connector.png differ diff --git a/docs/management/index-patterns/images/create-data-view.png b/docs/management/index-patterns/images/create-data-view.png index af5b01111cd2e..b099995d90853 100644 Binary files a/docs/management/index-patterns/images/create-data-view.png and b/docs/management/index-patterns/images/create-data-view.png differ diff --git a/docs/management/maintenance-windows/images/create-maintenance-window.png b/docs/management/maintenance-windows/images/create-maintenance-window.png new file mode 100644 index 0000000000000..aa6132afbeaf9 Binary files /dev/null and b/docs/management/maintenance-windows/images/create-maintenance-window.png differ diff --git a/docs/management/maintenance-windows/maintenance-windows.asciidoc b/docs/management/maintenance-windows/maintenance-windows.asciidoc new file mode 100644 index 0000000000000..ba630092016b2 --- /dev/null +++ b/docs/management/maintenance-windows/maintenance-windows.asciidoc @@ -0,0 +1,52 @@ +[[maintenance-windows]] +== Maintenance windows + +:frontmatter-description: Maintenance windows enable you to suppress rule notifications. +:frontmatter-tags-products: [kibana, alerting] +:frontmatter-tags-content-type: [overview] +:frontmatter-tags-user-goals: [manage] + +preview::[] + +You can schedule single or recurring maintenance windows to temporarily reduce rule notifications. +For example, a maintenance window prevents false alarms during planned outages. + +Maintenance windows affect all rules in all {kib} apps and spaces. +Alerts continue to be generated, however notifications are suppressed as follows: + +- When an alert occurs during a maintenance window, there are no notifications. +When the alert recovers, there are no notifications--even if the recovery occurs after the maintenance window ends. +- When an alert occurs before a maintenance window and recovers during or after the maintenance window, notifications are sent as usual. + +[discrete] +[[setup-maintenance-windows]] +== Configure access to maintenance windows + +To use maintenance windows, you must have the appropriate {subscriptions}[subscription] and {kib} feature privileges. + +- To have full access to maintenance windows, you must have `All` privileges for the *Management > Maintenance Windows* feature. +- To have view-only access to maintenance windows, you must have `Read` privileges for the **Management > Maintenance Windows* feature. + +For more details, refer to <>. + +[discrete] +[[manage-maintenance-windows]] +== Create and manange maintenance windows + +In *Management > {stack-manage-app} > Maintenance Windows*, you can create, edit, and archive maintenance windows. + +When you create a maintenance window, you must provide a name and a schedule. +You can optionally configure it to repeat daily, monthly, yearly, or on a custom interval. + +[role="screenshot"] +image::images/create-maintenance-window.png[The Create Maintenance Window user interface in {kib}] +// NOTE: This is an autogenerated screenshot. Do not edit it directly. + +A maintenance window can have any one of the following statuses: + +- `Upcoming`: It will run at the scheduled date and time. +- `Running`: It is running. +- `Finished`: It ended and does not have a repeat schedule. +- `Archived`: It is archived. In a future release, archived maintenance windows will be queued for deletion. + +When you <> in {kib}, each alert shows unique identifiers for maintenance windows that affected it. \ No newline at end of file diff --git a/docs/management/manage-data-views.asciidoc b/docs/management/manage-data-views.asciidoc index 4505fbc71935f..0f51a04359d25 100644 --- a/docs/management/manage-data-views.asciidoc +++ b/docs/management/manage-data-views.asciidoc @@ -1,7 +1,8 @@ [[managing-data-views]] == Manage data views -:keywords: administrator, data view, data views, management, runtime fields, runtime fields in Kibana, scripted fields, field formatters, data fields, index pattern, index patterns -:description: Conceptual and step-by-step procedures for using runtime fields, scripted fields, and field formatters. + +:frontmatter-description: Conceptual and step-by-step procedures for using runtime fields, scripted fields, and field formatters. +:frontmatter-tags-products: [kibana] To customize the data fields in your data view, you can add runtime fields to the existing documents, diff --git a/docs/settings/alert-action-settings.asciidoc b/docs/settings/alert-action-settings.asciidoc index ba41d20112ad1..7cebc648ca139 100644 --- a/docs/settings/alert-action-settings.asciidoc +++ b/docs/settings/alert-action-settings.asciidoc @@ -4,10 +4,10 @@ Alerting and action settings ++++ -:description: Learn about the settings that affect {kib} {alert-features}. -:tags-products: [kibana, alerting] -:tags-content-type: [reference] -:tags-user-goals: [configure] +:frontmatter-description: Learn about the settings that affect {kib} {alert-features}. +:frontmatter-tags-products: [kibana, alerting] +:frontmatter-tags-content-type: [reference] +:frontmatter-tags-user-goals: [configure] Alerting and actions are enabled by default in {kib}, but require you to configure the following: diff --git a/docs/settings/reporting-settings.asciidoc b/docs/settings/reporting-settings.asciidoc index 7a5ef51a2a710..77f1b01cc21b4 100644 --- a/docs/settings/reporting-settings.asciidoc +++ b/docs/settings/reporting-settings.asciidoc @@ -4,8 +4,11 @@ ++++ Reporting settings ++++ -:keywords: administrator, reference, setup, reporting -:description: A reference of the reporting settings administrators configure in kibana.yml. + +:frontmatter-description: A reference of the reporting settings administrators configure in kibana.yml. +:frontmatter-tags-products: [kibana] +:frontmatter-tags-content-type: [reference] +:frontmatter-tags-user-goals: [configure] You can configure `xpack.reporting` settings in your `kibana.yml` to: diff --git a/docs/setup/docker.asciidoc b/docs/setup/docker.asciidoc index 3f9cc2bca309f..f8ad122d7e865 100644 --- a/docs/setup/docker.asciidoc +++ b/docs/setup/docker.asciidoc @@ -34,13 +34,39 @@ endif::[] ifeval::["{release-state}"!="unreleased"] +.. Create a new Docker network for {es} and {kib}: ++ [source,sh,subs="attributes"] ---- docker network create elastic +---- + +.. Pull the {es} Docker image: ++ +[source,sh,subs="attributes"] +---- docker pull {es-docker-image} +---- + +.. Optional: Verify the {es} Docker image signature:: ++ +[source,sh,subs="attributes"] +---- +wget https://artifacts.elastic.co/cosign.pub +cosign verify --key cosign.pub {docker-repo}:{version} +---- ++ +For details about this step, refer to {ref}/docker.html#docker-verify-signature[Verify the {es} Docker image signature] in the {es} documentation. + +.. Start {es} in Docker: ++ +[source,sh,subs="attributes"] +---- docker run --name es-node01 --net elastic -p 9200:9200 -p 9300:9300 -t {es-docker-image} ---- + + endif::[] -- @@ -79,6 +105,34 @@ docker pull {docker-image} docker run --name kib-01 --net elastic -p 5601:5601 {docker-image} ---- +.. Pull the {kib} Docker image: ++ +[source,sh,subs="attributes"] +---- +docker pull {docker-image} +---- + +.. Optional: Verify the {kib} Docker image signature:: ++ +[source,sh,subs="attributes"] +---- +wget https://artifacts.elastic.co/cosign.pub +cosign verify --key cosign.pub {docker-repo}:{version} +---- ++ +For details about this step, refer to {ref}/docker.html#docker-verify-signature[Verify the {es} Docker image signature] in the {es} documentation. + +.. Start {kib} in Docker: ++ +[source,sh,subs="attributes"] +---- +docker run --name kib-01 --net elastic -p 5601:5601 {docker-image} +---- + + + + + endif::[] -- + diff --git a/docs/setup/upgrade/resolving-migration-failures.asciidoc b/docs/setup/upgrade/resolving-migration-failures.asciidoc index 63264cb4f0963..d81a577a19a88 100644 --- a/docs/setup/upgrade/resolving-migration-failures.asciidoc +++ b/docs/setup/upgrade/resolving-migration-failures.asciidoc @@ -8,8 +8,8 @@ with the new version. ==== Saved object migration failures If {kib} unexpectedly terminates while migrating a saved object index, {kib} automatically attempts to -perform the migration again when the process restarts. Do not delete any saved objects indices to -fix a failed migration. Unlike previous versions, {kib} 7.12.0 and later does not require deleting +perform the migration again when the process restarts. Do not delete any saved objects indices to +fix a failed migration. Unlike previous versions, {kib} 7.12.0 and later does not require deleting indices to release a failed migration lock. If upgrade migrations fail repeatedly, refer to @@ -19,14 +19,6 @@ When you address the root cause for the migration failure, If you're unable to resolve a failed migration, contact Support. -[float] -[[upgrade-migrations-old-indices]] -==== Old `.kibana_N` indices - -After the migrations complete, multiple {kib} indices are created in {es}: (`.kibana_1`, `.kibana_2`, `.kibana_7.12.0` etc). -{kib} only uses the index that the `.kibana` and `.kibana_task_manager` aliases point to. -The other {kib} indices can be safely deleted, but are left around as a matter of historical record, and to facilitate rolling {kib} back to a previous version. - [float] ==== Known issues with {fleet} beta If you see a`timeout_exception` or `receive_timeout_transport_exception` error, diff --git a/docs/setup/upgrade/saved-objects-migration.asciidoc b/docs/setup/upgrade/saved-objects-migration.asciidoc index 3dac6a02c96ef..1f4ed9a7fff09 100644 --- a/docs/setup/upgrade/saved-objects-migration.asciidoc +++ b/docs/setup/upgrade/saved-objects-migration.asciidoc @@ -8,34 +8,66 @@ To access the assistant, go to *Stack Management > Upgrade Assistant*. WARNING: {kib} 7.12.0 and later uses a new migration process and index naming scheme. Before you upgrade, read the documentation for your version of {kib}. -WARNING: The following instructions assumes {kib} is using the default index names. If the `kibana.index` or `xpack.tasks.index` configuration settings are different from the default, adapt the instructions accordingly. +WARNING: The `kibana.index` and `xpack.tasks.index` configuration settings are obsolete and no longer taken into account in 8.x. If you are using custom index names, please perform the necessary adaptations before attempting to upgrade to 8.x. [float] [[upgrade-migrations-process]] ==== How saved objects migrations work -Saved objects are stored in two indices: - -* `.kibana_{kibana_version}_001`, e.g. for {kib} 7.12.0 `.kibana_7.12.0_001`. -* `.kibana_task_manager_{kibana_version}_001`, e.g. for {kib} 7.12.0 `.kibana_task_manager_7.12.0_001`. - -The index aliases `.kibana` and `.kibana_task_manager` always point to -the most up-to-date saved object indices. - When you start a new {kib} installation, an upgrade migration is performed before starting plugins or serving HTTP traffic. Before you upgrade, shut down old nodes to prevent losing acknowledged writes. To reduce the likelihood of old nodes losing acknowledged writes, {kib} 7.12.0 and later adds a write block to the outdated index. -The following tables lists the saved objects indices used by previous {kib} versions. +Saved objects are stored in multiple indices. Whilst all of them start with the `.kibana*` prefix, other `.kibana*` indices exist, which are not used to store saved objects. The following tables lists the saved objects indices used by each {kib} version. .Saved object indices and aliases per {kib} version [options="header"] |======================= -|Upgrading from version | Outdated index (alias) -| 6.5.0 through 7.3.x | `.kibana_N` (`.kibana` alias) +|Upgrading from version | Index | Aliases +| 6.5.0 through 7.3.x +| `.kibana_N` +| `.kibana` | 7.4.0 through 7.11.x -| `.kibana_N` (`.kibana` alias) - -`.kibana_task_manager_N` (`.kibana_task_manager` alias) +| `.kibana_N` + +`.kibana_task_manager_N` +| `.kibana` + +`.kibana_task_manager` +| 7.11.x through 8.7.x +| `.kibana_{kibana_version}_001` + +`.kibana_task_manager_{kibana_version}_001` +| `.kibana`, `.kibana_{kibana_version}` + +`.kibana_task_manager`, `.kibana_task_manager_{kibana_version}` +| 8.8.0+ +| `.kibana_{kibana_version}_001` + +`.kibana_alerting_cases_{kibana_version}_001` +`.kibana_analytics_{kibana_version}_001` +`.kibana_ingest_{kibana_version}_001` +`.kibana_task_manager_{kibana_version}_001` +`.kibana_security_solution_{kibana_version}_001` +| `.kibana`, `.kibana_{kibana_version}` + +`.kibana_alerting_cases`, `.kibana_alerting_cases_{kibana_version}` +`.kibana_analytics`, `.kibana_analytics_{kibana_version}` +`.kibana_ingest`, `.kibana_ingest_{kibana_version}` +`.kibana_task_manager`, `.kibana_task_manager_{kibana_version}` +`.kibana_security_solution`, `.kibana_security_solution_{kibana_version}` |======================= + +Starting on 7.11.0, each of the saved objects indices has a couple of aliases, e.g. the `.kibana_8.8.0_001` index has a _default_ alias `.kibana` and a _version_ alias `.kibana_8.8.0`. The _default_ aliases (e.g. `.kibana` and `.kibana_task_manager`) always point to +the most up-to-date saved object indices. Then, _version_ aliases are aligned with the deployed {kib} version. + + +Starting on 8.6.0, index names aren't necessarily aligned with the deployed {kib} version. When updates on a certain index are compatible, {kib} will keep the existing index instead of creating a new one. This allows for a more efficient upgrade process. The following example illustrates a completely valid state for a 8.8.0 deployment: + +* `.kibana_8.8.0_001` index, with `.kibana` and `.kibana_8.8.0` aliases. +* `.kibana_task_manager_8.7.0_001` index, with `.kibana_task_manager` and `.kibana_task_manager_8.8.0` aliases. + +Starting on 8.8.0, {kib} splits the main saved object index into multiple ones, as depicted on the table above. When upgrading from a previous version, the {kib} migration process will reindex some saved objects from the `.kibana` index into the new indices, depending on their types. Note that the `.kibana` index still exists, and it continues to store multiple saved object types. + +[float] +[[upgrade-migrations-old-indices]] +==== Old {kib} indices + +As a deployment is gradually upgraded, multiple {kib} indices are created in {es}: (`.kibana_1`, `.kibana_2`, `.kibana_7.12.0_001`, `.kibana_7.13.0_001`, `.kibana_8.0.0_001` etc). +{kib} only uses those indices that the _default_ and _version_ aliases point to. +The other, older {kib} saved object indices can be safely deleted, but are left around as a matter of historical record, and to facilitate rolling {kib} back to a previous version. diff --git a/docs/user/alerting/alerting-getting-started.asciidoc b/docs/user/alerting/alerting-getting-started.asciidoc index b7ca2f3c58b55..3e6787370ff2f 100644 --- a/docs/user/alerting/alerting-getting-started.asciidoc +++ b/docs/user/alerting/alerting-getting-started.asciidoc @@ -77,6 +77,9 @@ Rather than repeatedly entering connection information and credentials for each The _action frequency_ defines when the action runs (for example, only when the alert status changes or at specific time intervals). Each rule type also has a set of the _action groups_ that affects when the action runs (for example, when the threshold is met or when the alert is recovered). If you want to reduce the number of notifications you receive without affecting their timeliness, some rule types support alert summaries. You can set the action frequency such that you receive notifications that summarize the new, ongoing, and recovered alerts at your preferred time intervals. +Some types of rules enable you to further refine the conditions under which actions run. +For example, you can specify that actions run only when an alert occurs within a specific time frame or when it matches a KQL query. + Each action definition is therefore a template: all the parameters needed to invoke a service are supplied except for specific values that are only known at the time the rule condition is detected. In the server monitoring example, the `email` connector type is used, and `server` is mapped to the body of the email, using the template string `CPU on {{server}} is high`. diff --git a/docs/user/alerting/create-and-manage-rules.asciidoc b/docs/user/alerting/create-and-manage-rules.asciidoc index 2640ba46de062..88060edab5437 100644 --- a/docs/user/alerting/create-and-manage-rules.asciidoc +++ b/docs/user/alerting/create-and-manage-rules.asciidoc @@ -1,6 +1,10 @@ [role="xpack"] [[create-and-manage-rules]] == Create and manage rules +:frontmatter-description: Set up alerting in the {kib} {stack-manage-app} app and manage your rules. +:frontmatter-tags-products: [kibana, alerting] +:frontmatter-tags-content-type: [how-to] +:frontmatter-tags-user-goals: [manage] The *{stack-manage-app}* > *{rules-ui}* UI provides a cross-app view of alerting. Different {kib} apps like {observability-guide}/create-alerts.html[*{observability}*], @@ -77,6 +81,9 @@ Alternatively, you can set the action frequency such that the action runs for ea image::images/rule-flyout-action-details.png[UI for defining an email action,500] // NOTE: This is an autogenerated screenshot. Do not edit it directly. +If you create rules in the {security-app}, you can further refine when actions run by adding time frame and query filters. +For more details, refer to {security-guide}/rules-ui-create.html[Create a detection rule]. + Each connector enables different action properties. For example, an email connector enables you to set the recipients, the subject, and a message body in markdown format. For more information about connectors, refer to <>. [[alerting-concepts-suppressing-duplicate-notifications]] @@ -134,6 +141,7 @@ image:images/snooze-panel.png[Snooze notifications for a rule] When a rule is in a snoozed state, you can cancel or change the duration of this state. +preview:[] To temporarily suppress notifications for _all_ rules, create a <>. [float] [[importing-and-exporting-rules]] @@ -182,6 +190,9 @@ When an alert is created, it generates actions. If the conditions that caused th NOTE: The `flapping` state is possible only if you have enabled alert flapping detection in *{stack-manage-app}* > *{rules-ui}* > *Settings*. For each space, you can choose a look back window and threshold that are used to determine whether alerts are flapping. For example, you can specify that the alert must change status at least 6 times in the last 10 runs. If the rule has actions that run when the alert status changes, those actions are suppressed while the alert is flapping. +If an alert was affected by a maintenance window, its identifier appears in the *Maintenance windows* column. +For more information about their impact on alert notifications, refer to <>. + You can suppress future actions for a specific alert by turning on the *Mute* toggle. If a muted alert no longer meets the rule conditions, it stays in the list to avoid generating actions if the conditions recur. You can also disable a rule, which stops it from running checks and clears any alerts it was tracking. You may want to disable rules that are not currently needed to reduce the load on {kib} and {es}. [role="screenshot"] diff --git a/docs/user/alerting/images/rule-details-alerts-active.png b/docs/user/alerting/images/rule-details-alerts-active.png index deb2feff7993e..295cb263c40eb 100644 Binary files a/docs/user/alerting/images/rule-details-alerts-active.png and b/docs/user/alerting/images/rule-details-alerts-active.png differ diff --git a/docs/user/dashboard/dashboard.asciidoc b/docs/user/dashboard/dashboard.asciidoc index f4f3aa74a8c8f..5da14bc58572d 100644 --- a/docs/user/dashboard/dashboard.asciidoc +++ b/docs/user/dashboard/dashboard.asciidoc @@ -333,47 +333,42 @@ Copy panels from one dashboard to another dashboard. . On the *Copy to dashboard* window, select the dashboard, then click *Copy and go to dashboard*. [float] -[[search-or-filter-your-data]] -== Search and filter your data - -{kib} supports several ways to search your data and apply {es} filters. You can combine the filters with any panel -filter to display the data want to you see. +[[add-dashboard-settings]] +== Add the dashboard settings -For more information about {kib} and {es} filters, refer to <>. +Add the title, tags, design options, and more to the dashboard. -To apply a panel-level time filter: +. In the toolbar, click *Settings*. -. Open the panel menu, then select *More > Edit panel settings*. - -. Select *Apply a custom time range*. +. On the *Dashboard settings* flyout, enter the *Title* and an optional *Description*. -. Enter the time range you want to view, then click *Save*. +. Add any applicable <>. -To view and edit panel-level filters: +. Specify the following settings: -. On the panel, click image:images/dashboard_panelFiltersButton_8.7.0.png[Panel filters button on panel header]. +* *Store time with dashboard* — Saves the specified time filter. -. To edit, click *Edit filters*. +* *Use margins between panels* — Adds a margin of space between each panel. -[float] -[[apply-design-options]] -== Apply design options +* *Show panel titles* — Displays the titles in the panel headers. -Apply a set of design options to the entire dashboard. +* *Sync color palettes across panels* — Applies the same color palette to all panels on the dashboard. -. If you're in view mode, click *Edit* in the toolbar. +* *Sync cursor across panels* — When you hover your cursor over a *Lens*, *TSVB*, aggregation-based, or *Timelion* XY or heatmap chart, the cursor on all other related dashboard charts automatically appears. -. In the toolbar, click *Settings*, to open the *Dashboard settings* flyout, then use the following options: +* *Sync tooltips across panels* — When you hover your cursor over a *Lens*, *TSVB*, aggregation-based, or *Timelion* XY chart, the tooltips on all other related dashboard charts automatically appears. -* *Use margins between panels* — Adds a margin of space between each panel. +. Click *Apply*. -* *Show panel titles* — Displays the titles in the panels headers. +[float] +[[reset-the-dashboard]] +== Reset the dashboard -* *Sync color pallettes across panels* — Applies the same color palette to all panels on the dashboard. +To remove any dashboard changes you've made, reset the dashboard to the last saved changes. -* *Sync cursor across panels* — When you hover your cursor over a *Lens*, *TSVB*, aggregation-based, or *Timelion* XY chart and a heatmap chart, the cursor on all other related dashboard charts automatically appear. +. In the toolbar, click *Reset*. -* *Sync tooltips across panels* — When you hover your cursor over a *Lens*, *TSVB*, aggregation-based, or *Timelion* XY chart, the tooltips on all other related dashboard charts automatically appear. +. On the *Reset dashboard* window, click *Reset dashboard*. [float] [[save-dashboards]] @@ -381,21 +376,32 @@ Apply a set of design options to the entire dashboard. When you've finished making changes to the dashboard, save it. -If you are saving a new dashboard: - . In the toolbar, click *Save*. -. On the *Save dashboard* window, enter the *Title* and an optional *Description*. +. To exit *Edit* mode, click *Switch to view mode*. -. Add any applicable <>. +[float] +[[search-or-filter-your-data]] +== Search and filter your data + +{kib} supports several ways to search your data and apply {es} filters. You can combine the filters with any panel +filter to display the data want to you see. -. To save the time filter to the dashboard, select *Store time with dashboard*. +For more information about {kib} and {es} filters, refer to <>. -. Click *Save*. +To apply a panel-level time filter: -If you are saving an existing dashboard, click *Save*. +. Open the panel menu, then select *More > Edit panel settings*. + +. Select *Apply a custom time range*. + +. Enter the time range you want to view, then click *Save*. -To exit *Edit* mode, click *Switch to view mode*. +To view and edit panel-level filters: + +. On the panel, click image:images/dashboard_panelFiltersButton_8.7.0.png[Panel filters button on panel header]. + +. To edit, click *Edit filters*. [float] [[download-csv]] diff --git a/docs/user/dashboard/images/formula_reference.png b/docs/user/dashboard/images/formula_reference.png index dff574120c2a1..7b385e7749880 100644 Binary files a/docs/user/dashboard/images/formula_reference.png and b/docs/user/dashboard/images/formula_reference.png differ diff --git a/docs/user/dashboard/images/lens_visualizationModifierPopup_8.8.0.png b/docs/user/dashboard/images/lens_visualizationModifierPopup_8.8.0.png new file mode 100644 index 0000000000000..d3252fa9c16f0 Binary files /dev/null and b/docs/user/dashboard/images/lens_visualizationModifierPopup_8.8.0.png differ diff --git a/docs/user/dashboard/lens.asciidoc b/docs/user/dashboard/lens.asciidoc index eafe5cbf076c3..38a21cf3e97c8 100644 --- a/docs/user/dashboard/lens.asciidoc +++ b/docs/user/dashboard/lens.asciidoc @@ -175,18 +175,35 @@ Compare your real-time data to the results that are offset by a time increment. For a time shift example, refer to <>. [float] -[[multi-metric-partition-chart]] -==== Build a partition chart from multiple metrics +[[create-partition-charts-with-multiple-metrics]] +==== Create partition charts with multiple metrics -By default, partition charts (e.g. pie) are built from one or more "slice-by" dimensions to define the partitions and a single metric dimension to define their size. However, you can also build a partition chart from multiple metric dimensions. +To create partition charts, such as pie charts, configure one or more *Slice by* dimensions to define the partitions, and a *Metric* dimension to define the size. +To create partition charts with multiple metrics, use the layer settings. Multiple metrics are unsupported for mosaic visualizations. -. Open the layer context menu at the top right of the layer panel. +. In the layer pane, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu for the partition visualization layer], then select *Layer settings*. -. Click *Layer settings*. +. Select *Multiple metrics*. -. Click the switch labeled *Multiple metrics*. +. Click *X*. -Note: this option is not available for mosaic charts. +[float] +[[improve-visualization-loading-time]] +=== Improve visualization loading time + +preview::[] + +Data sampling allows you to improve the visualization loading time. To decrease the loading time, use a lower sampling percentage, which also decreases the accuracy. +Use low sampling percentages on large datasets. + +. In the layer pane, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu for the partition visualization layer], then select *Layer settings*. + +. To select the *Sampling* percentage, use the slider. + +. Click *X*. ++ +When you add the visualization to dashboards, image:dashboard/images/lens_visualizationModifierPopup_8.8.0.png[Visualization modifier popup] appears, +which allows you to view settings changes to the visualization. [float] [[add-annotations]] @@ -214,6 +231,9 @@ Create the annotation layer. . From the fields list, drag a field to the *Add an annotation* field. . To use global filters in the annotation, click image:dashboard/images/lens_layerActions_8.5.0.png[Actions menu for the annotations layer], then select *Keep global filters* from the dropdown. ++ +When you add the visualization to dashboards, image:dashboard/images/lens_visualizationModifierPopup_8.8.0.png[Visualization modifier popup] appears, +which allows you to view settings changes to the visualization. Create static annotations. diff --git a/docs/user/dashboard/make-dashboards-interactive.asciidoc b/docs/user/dashboard/make-dashboards-interactive.asciidoc index e66e7c33b4be4..1ebcc2ca2402f 100644 --- a/docs/user/dashboard/make-dashboards-interactive.asciidoc +++ b/docs/user/dashboard/make-dashboards-interactive.asciidoc @@ -2,10 +2,10 @@ [[drilldowns]] == Make dashboards interactive -:keywords: administrator, analyst, concept, task, analyze, dashboard, controls, range slider, options list, author, drilldowns -:description: Add interactive capabilities to your dashboard, such as controls that allow \ -you to apply dashboard-level filters, and drilldowns that allow you to navigate to other \ -dashboards and external websites. +:frontmatter-description: Add interactive filter and navigation capabilities to your dashboard. +:frontmatter-tags-products: [kibana] +:frontmatter-tags-content-type: [how-to] +:frontmatter-tags-user-goals: [analyze, visualize] Add interactive capabilities to your dashboard, such as interactive filter controls, and drilldowns that allow you to navigate to *Discover*, other dashboards, and external websites. diff --git a/docs/user/discover.asciidoc b/docs/user/discover.asciidoc index 17cde2abcba6b..6f35e9a9d59ba 100644 --- a/docs/user/discover.asciidoc +++ b/docs/user/discover.asciidoc @@ -82,21 +82,23 @@ that shows all the documents that match your search. By default, the document table includes a column for the time field and a column that lists all other fields in the document. You’ll modify the document table to display your fields of interest. -. In the sidebar, enter `ma` to in the search field to find the `manufacturer` field. +. In the sidebar, enter `ma` in the search field to find the `manufacturer` field. + [role="screenshot"] image:images/discover-sidebar-available-fields.png[Fields list that displays the top five search results, width=50%] ++ +NOTE: You can use wildcards in field searches. For example, `goe*dest` finds `geo.dest` and `geo.src.dest`. . In the *Available fields* list, click `manufacturer` to view its most popular values. + **Discover** shows the top 10 values and the number of records used to calculate those values. . Click image:images/add-icon.png[Add icon] to toggle the field into the document table. +You can also drag the field from the *Available fields* list into the document table. + [role="screenshot"] image::images/discover-add-icon.png[How to add a field as a column in the table, width="50%"] - . Find the `customer_first_name` and `customer_last_name` fields and add them to the document table. Your table should look similar to this: + @@ -111,15 +113,19 @@ column header, and then select *Move left* or *Move right*. + * To copy the name or values in a column to the clipboard, click the column header and select the desired **Copy** option. + -* For keyboard shortcuts on the document table, click -image:images/keyboard-shortcut-icon.png[icon button for opening list of keyboard shortcuts, width=24px]. -+ * To view more of the document table, click image:images/chart-icon.png[icon button for opening Show/Hide chart menu, width=24px] to open the *Chart options* menu, and then select *Hide chart*. + +* For keyboard shortcuts on the document table, click +image:images/keyboard-shortcut-icon.png[icon button for opening list of keyboard shortcuts, width=24px]. ++ +* To set the row height to one or more lines, or automatically +adjust the height to fit the contents, click +image:images/row-height-icon.png[icon to open the Row height pop-up, width=24px]. ++ * To toggle the table in and out of fullscreen mode, click the fullscreen icon image:images/fullscreen-icon.png[icon to display the document table in fullscreen mode]. @@ -270,6 +276,10 @@ If a field can be {ref}/search-aggregations.html[aggregated], you can quickly visualize it from **Discover**. . In the sidebar, find and then click `day_of_week`. ++ +[role="screenshot"] +image:images/discover-day-of-week.png[Top values for the day_of_week field, plus Visualize button, width=50%] + . In the popup, click **Visualize**. + @@ -334,4 +344,6 @@ include::{kib-repo-dir}/discover/save-search.asciidoc[] include::{kib-repo-dir}/discover/field-statistics.asciidoc[] -include::{kib-repo-dir}/discover/search-sessions.asciidoc[] +include::{kib-repo-dir}/discover/log-pattern-analysis.asciidoc[] + +include::{kib-repo-dir}/discover/search-sessions.asciidoc[] \ No newline at end of file diff --git a/docs/user/management.asciidoc b/docs/user/management.asciidoc index 5c78d91183861..0d49ad2a1ef55 100644 --- a/docs/user/management.asciidoc +++ b/docs/user/management.asciidoc @@ -97,6 +97,9 @@ Viewer or Anomaly Explorer to see your {anomaly-detect} results. For example, you might create an alert when the maximum total CPU usage on a machine goes above a certain percentage. +| <> +| Suppress rule notifications for scheduled periods of time. + |=== [float] @@ -184,6 +187,8 @@ include::{kib-repo-dir}/management/action-types.asciidoc[] include::{kib-repo-dir}/management/managing-licenses.asciidoc[] +include::{kib-repo-dir}/management/maintenance-windows/maintenance-windows.asciidoc[] + include::{kib-repo-dir}/management/manage-data-views.asciidoc[] include::{kib-repo-dir}/management/numeral.asciidoc[] diff --git a/docs/user/ml/index.asciidoc b/docs/user/ml/index.asciidoc index 5307375f31958..6372ef4e02bc3 100644 --- a/docs/user/ml/index.asciidoc +++ b/docs/user/ml/index.asciidoc @@ -151,11 +151,14 @@ image::user/ml/images/ml-explain-log-rate.png[Log rate spike explained] preview::[] +// The following intro is used on the `run-pattern-analysis-discover` page. +//tag::log-pattern-analysis-intro[] Log pattern analysis helps you to find patterns in unstructured log messages and makes it easier to examine your data. It performs categorization analysis on a selected field of a {data-source}, creates categories based on the data and displays them together with a chart that shows the distribution of each category and an example document that matches the category. +//end::log-pattern-analysis-intro[] You can find log pattern analysis under **{ml-app}** > **AIOps Labs** where you can select the {data-source} or saved search that you want to analyze, or in diff --git a/docs/user/production-considerations/reporting-production-considerations.asciidoc b/docs/user/production-considerations/reporting-production-considerations.asciidoc index 20ea82be9c6e4..db972e1bbf368 100644 --- a/docs/user/production-considerations/reporting-production-considerations.asciidoc +++ b/docs/user/production-considerations/reporting-production-considerations.asciidoc @@ -5,8 +5,9 @@ ++++ Reporting ++++ -:keywords: administrator, analyst, concept, setup, reporting -:description: Consider the production components that are used to generate reports. + +:frontmatter-description: Consider the production components that are used to generate reports. +:frontmatter-tags-products: [kibana] To generate reports, {kib} uses the Chromium web browser, which runs on the server in headless mode. Chromium is an open-source project not related to Elastic, and is embedded into {kib}. Chromium may require additional OS dependencies to run properly. diff --git a/docs/user/production-considerations/security-production-considerations.asciidoc b/docs/user/production-considerations/security-production-considerations.asciidoc index 0a7a3988f1c7b..1c6d7f50e8fae 100644 --- a/docs/user/production-considerations/security-production-considerations.asciidoc +++ b/docs/user/production-considerations/security-production-considerations.asciidoc @@ -5,8 +5,9 @@ ++++ Security ++++ -:keywords: administrator, analyst, concept, setup, security -:description: Consider the production components for {kib} security. + +:frontmatter-description: Consider the production components for {kib} security. +:frontmatter-tags-products: [kibana] To secure your {kib} installation in production, consider these high-priority topics to ensure that only authorized users can access {kib}. diff --git a/docs/user/reporting/index.asciidoc b/docs/user/reporting/index.asciidoc index e85c46d04ed38..8d53018dec572 100644 --- a/docs/user/reporting/index.asciidoc +++ b/docs/user/reporting/index.asciidoc @@ -1,31 +1,31 @@ -[role="xpack"] [[reporting-getting-started]] = Reporting and sharing [partintro] -- - -:keywords: analyst, concept, task, reporting -:description: {kib} provides you with several options to share *Discover* saved searches, dashboards, *Visualize Library* visualizations, and *Canvas* workpads with others, or on a website. +:frontmatter-description: {kib} provides you with several options to share *Discover* saved searches, dashboards, *Visualize Library* visualizations, and *Canvas* workpads with others, or on a website. +:frontmatter-tags-products: [kibana] {kib} provides you with several options to share *Discover* saved searches, dashboards, *Visualize Library* visualizations, and *Canvas* workpads. You access the options from the *Share* menu in the toolbar. The sharing options include the following: -* *PDF Reports* — Generate and download a PDF file of a dashboard, visualization, or *Canvas* workpad. PDF reports are a link:https://www.elastic.co/subscriptions[subscription feature]. +* *PDF Reports* — Generate and download PDF files of dashboards, visualizations, and *Canvas* workpads. PDF reports are a link:https://www.elastic.co/subscriptions[subscription feature]. + +* *PNG Reports* — Generate and download PNG files of dashboards and visualizations. PNG reports are a link:https://www.elastic.co/subscriptions[subscription feature]. -* *PNG Reports* — Generate and download a PNG file of a dashboard or visualization. PNG reports are a link:https://www.elastic.co/subscriptions[subscription feature]. +* *CSV Reports* — Generate and download CSV files of saved searches. -* *CSV Reports* — Generate and download a CSV file of a *Discover* saved search. +* *CSV Download* — Generate and download CSV files of *Lens* visualizations. -* *Get links* — Share a direct link to a *Discover* saved search, dashboard, or visualization. +* *Get links* — Share direct links to saved searches, dashboards, and visualizations. -* *Download as JSON* — Generate and download a JSON file of a *Canvas* workpad. +* *Download as JSON* — Generate and download JSON files of *Canvas* workpads. * beta[] *Share on a website* — Download and securely share *Canvas* workpads on any website. -* *Embed code* — Embed a fully interactive dashboard as an iframe on a web page. +* *Embed code* — Embed fully interactive dashboards as an iframe on web pages. [[reporting-on-cloud-resource-requirements]] NOTE: For Elastic Cloud deployments, {kib} instances require a minimum of 2GB RAM to generate PDF or PNG reports. To @@ -51,19 +51,13 @@ image::user/reporting/images/shareable-container.png["Shareable Container"] . Open the main menu, then open the saved search, dashboard, visualization, or workpad you want to share. -. From the toolbar, click *Share*, then select one of the following options: - -** **PDF Reports** — Generates a PDF file of the dashboard, visualization, or workpad. +. From the toolbar, click *Share*, then select the report option. -** **PNG Reports** — Generates a PNG file of the dashboard or visualization. - -** **CSV Reports** — Generates a CSV report of the saved search. - -. If you are creating a PDF report of a dashboard, select *Optimize for printing* to create a printer-friendly PDF with multiple A4 portrait pages and two visualizations per page. +* If you are creating dashboard PDFs, select *Optimize for printing* to create printer-friendly PDFs with multiple A4 portrait pages and two visualizations per page. + NOTE: When you create a dashboard report that includes a data table or saved search, the PDF includes only the visible data. -. If you are creating a PDF report of a workpad, select *Full page layout* to create a PDF without margins that surround the workpad. +* If you are creating workpad PDFs, select *Full page layout* to create PDFs without margins that surround the workpad. . Generate the report. @@ -78,9 +72,9 @@ more about {ilm-init} policies, refer to the {es} [float] [[share-a-direct-link]] -== Share a direct link +== Share direct links -Share a direct link to a saved search, dashboard, or visualization. To access the shared object, authentication is required. +Create and share direct links to saved searches, dashboards, and visualizations. To access the shared object, authentication is required. . Open the main menu, then open the saved search, dashboard, or visualization you want to share. @@ -105,9 +99,9 @@ NOTE: *Public URL* is available only when anonymous access is configured and you [float] [[download-as-json]] -== Create a JSON file +== Create JSON files -Create a JSON file for a workpad. +Create and share JSON files for workpads. . Open the main menu, then click *Canvas*. @@ -119,8 +113,7 @@ Create a JSON file for a workpad. [[add-workpad-website]] == Share workpads on a website -beta[] *Canvas* allows you to create _shareables_, which are workpads that you download and securely share on a website. -To customize the behavior of the workpad on your website, you can choose to autoplay the pages or hide the workpad toolbar. +beta[] Create and securely share static *Canvas* workpads on a website. To customize the behavior of the workpad on your website, you can choose to autoplay the pages or hide the workpad toolbar. . Open the main menu, then click *Canvas*. @@ -128,8 +121,6 @@ To customize the behavior of the workpad on your website, you can choose to auto . Click *Share > Share on a website*. -. Follow the instructions. - . To customize the workpad behavior to autoplay the pages or hide the toolbar, use the inline parameters. + To make sure that your data remains secure, the data in the JSON file is not connected to {kib}. *Canvas* does not display elements that manipulate the data on the workpad. @@ -142,9 +133,9 @@ NOTE: Shareable workpads encode the current state of the workpad in a JSON file. [[embed-code]] == Embed code -Display your dashboard on an internal company website or personal web page with an iframe. Embedding other {kib} objects is generally supported, but you might need to manually craft the proper HTML code. +Display your dashboards on an internal company website or personal web page with an iframe. To embed other {kib} objects, manually create the HTML code. -Some users might not have access to the dashboard or visualization. For more information, refer to <> and <>. +For information about granting access to embedded dashboards, refer to <>. . Open the main menu, then open the dashboard you want to share. @@ -152,11 +143,11 @@ Some users might not have access to the dashboard or visualization. For more inf . Specify how you want to generate the code: -* To display only the current state, select *Snapshot*. +* To display the current state, select *Snapshot*. * To display up-to-date changes, select *Saved object*. -* Select the dashboard components you want to include. +* Select the dashboard components you want to share. * To generate a shortened link, select *Short URL*. diff --git a/docs/user/security/authentication/index.asciidoc b/docs/user/security/authentication/index.asciidoc index d0280ca8e2f40..8d1e054ecf470 100644 --- a/docs/user/security/authentication/index.asciidoc +++ b/docs/user/security/authentication/index.asciidoc @@ -1,11 +1,11 @@ -[role="xpack"] [[kibana-authentication]] === Authentication in {kib} ++++ Authentication ++++ -:keywords: administrator, concept, security, authentication -:description: A list of the supported authentication mechanisms in {kib}. + +:frontmatter-description: A list of the supported authentication mechanisms in {kib}. +:frontmatter-tags-products: [kibana] {kib} supports the following authentication mechanisms: diff --git a/fleet_packages.json b/fleet_packages.json index f82b1f0606385..df5bf532ba390 100644 --- a/fleet_packages.json +++ b/fleet_packages.json @@ -24,7 +24,7 @@ [ { "name": "apm", - "version": "8.9.0-preview-1683859066", + "version": "8.9.0-preview-1684289323", "forceAlignStackVersion": true, "allowSyncToPrerelease": true }, diff --git a/package.json b/package.json index cfc7f7f80e9d2..13eb7b8374c80 100644 --- a/package.json +++ b/package.json @@ -97,7 +97,7 @@ "@elastic/datemath": "5.0.3", "@elastic/elasticsearch": "npm:@elastic/elasticsearch-canary@8.6.0-canary.3", "@elastic/ems-client": "8.4.0", - "@elastic/eui": "79.0.1", + "@elastic/eui": "80.0.0", "@elastic/filesaver": "1.1.2", "@elastic/node-crypto": "1.2.1", "@elastic/numeral": "^2.5.1", @@ -473,6 +473,7 @@ "@kbn/maps-custom-raster-source-plugin": "link:x-pack/examples/third_party_maps_source_example", "@kbn/maps-ems-plugin": "link:src/plugins/maps_ems", "@kbn/maps-plugin": "link:x-pack/plugins/maps", + "@kbn/maps-vector-tile-utils": "link:x-pack/packages/maps/vector_tile_utils", "@kbn/ml-agg-utils": "link:x-pack/packages/ml/agg_utils", "@kbn/ml-anomaly-utils": "link:x-pack/packages/ml/anomaly_utils", "@kbn/ml-date-picker": "link:x-pack/packages/ml/date_picker", @@ -660,6 +661,8 @@ "@kbn/telemetry-test-plugin": "link:test/plugin_functional/plugins/telemetry", "@kbn/test-feature-usage-plugin": "link:x-pack/test/licensing_plugin/plugins/test_feature_usage", "@kbn/testing-embedded-lens-plugin": "link:x-pack/examples/testing_embedded_lens", + "@kbn/text-based-editor": "link:packages/kbn-text-based-editor", + "@kbn/text-based-languages": "link:src/plugins/text_based_languages", "@kbn/third-party-lens-navigation-prompt-plugin": "link:x-pack/examples/third_party_lens_navigation_prompt", "@kbn/third-party-vis-lens-example-plugin": "link:x-pack/examples/third_party_vis_lens_example", "@kbn/threat-intelligence-plugin": "link:x-pack/plugins/threat_intelligence", @@ -788,7 +791,7 @@ "deepmerge": "^4.2.2", "del": "^6.1.0", "elastic-apm-http-client": "^11.0.1", - "elastic-apm-node": "^3.45.0", + "elastic-apm-node": "^3.46.0", "email-addresses": "^5.0.0", "execa": "^4.0.2", "expiry-js": "0.1.7", @@ -964,7 +967,7 @@ "vega-tooltip": "^0.28.0", "vinyl": "^2.2.0", "whatwg-fetch": "^3.0.0", - "xml2js": "^0.4.22", + "xml2js": "^0.5.0", "xstate": "^4.37.2", "xterm": "^5.1.0", "yauzl": "^2.10.0", @@ -1315,7 +1318,7 @@ "@types/webpack-merge": "^4.1.5", "@types/webpack-sources": "^0.1.4", "@types/xml-crypto": "^1.4.2", - "@types/xml2js": "^0.4.5", + "@types/xml2js": "^0.4.11", "@types/yargs": "^15.0.0", "@types/yauzl": "^2.9.1", "@types/yazl": "^2.4.2", @@ -1364,7 +1367,7 @@ "delete-empty": "^2.0.0", "dependency-check": "^4.1.0", "diff": "^4.0.1", - "dpdm": "3.5.0", + "dpdm": "3.9.0", "ejs": "^3.1.8", "enzyme": "^3.11.0", "enzyme-to-json": "^3.6.2", diff --git a/packages/core/chrome/core-chrome-browser-internal/src/ui/header/header.tsx b/packages/core/chrome/core-chrome-browser-internal/src/ui/header/header.tsx index 5449ee34bb662..f1867cbea256d 100644 --- a/packages/core/chrome/core-chrome-browser-internal/src/ui/header/header.tsx +++ b/packages/core/chrome/core-chrome-browser-internal/src/ui/header/header.tsx @@ -42,7 +42,7 @@ import { HeaderBreadcrumbs } from './header_breadcrumbs'; import { HeaderHelpMenu } from './header_help_menu'; import { HeaderLogo } from './header_logo'; import { HeaderNavControls } from './header_nav_controls'; -import { HeaderActionMenu } from './header_action_menu'; +import { HeaderActionMenu, useHeaderActionMenuMounter } from './header_action_menu'; import { HeaderExtension } from './header_extension'; import { HeaderTopBanner } from './header_top_banner'; import { HeaderMenuButton } from './header_menu_button'; @@ -92,6 +92,7 @@ export function Header({ const [isNavOpen, setIsNavOpen] = useState(false); const [navId] = useState(htmlIdGenerator()()); const breadcrumbsAppendExtension = useObservable(breadcrumbsAppendExtension$); + const headerActionMenuMounter = useHeaderActionMenuMounter(application.currentActionMenu$); if (!isVisible) { return ( @@ -235,7 +236,7 @@ export function Header({ - + diff --git a/packages/core/chrome/core-chrome-browser-internal/src/ui/header/header_action_menu.test.tsx b/packages/core/chrome/core-chrome-browser-internal/src/ui/header/header_action_menu.test.tsx index a582091145cac..9a7b4fa5a8b14 100644 --- a/packages/core/chrome/core-chrome-browser-internal/src/ui/header/header_action_menu.test.tsx +++ b/packages/core/chrome/core-chrome-browser-internal/src/ui/header/header_action_menu.test.tsx @@ -11,7 +11,7 @@ import { mount, ReactWrapper } from 'enzyme'; import { BehaviorSubject } from 'rxjs'; import { act } from 'react-dom/test-utils'; import type { MountPoint, UnmountCallback } from '@kbn/core-mount-utils-browser'; -import { HeaderActionMenu } from './header_action_menu'; +import { HeaderActionMenu, useHeaderActionMenuMounter } from './header_action_menu'; type MockedUnmount = jest.MockedFunction; @@ -26,7 +26,7 @@ describe('HeaderActionMenu', () => { }); const refresh = () => { - new Promise(async (resolve, reject) => { + new Promise((resolve, reject) => { try { if (component) { act(() => { @@ -53,26 +53,35 @@ describe('HeaderActionMenu', () => { return unmount; }; - it('mounts the current value of the provided observable', async () => { - component = mount(); + it('mounts the current value of the provided observable', () => { + const TestComponent = () => { + const mounter = useHeaderActionMenuMounter(menuMount$); + return ; + }; + component = mount(); act(() => { menuMount$.next(createMountPoint('FOO')); }); - await refresh(); + refresh(); expect(component.html()).toMatchInlineSnapshot( `"
    FOO
    "` ); }); - it('clears the content of the component when emitting undefined', async () => { - component = mount(); + it('clears the content of the component when emitting undefined', () => { + const TestComponent = () => { + const mounter = useHeaderActionMenuMounter(menuMount$); + return ; + }; + + component = mount(); act(() => { menuMount$.next(createMountPoint('FOO')); }); - await refresh(); + refresh(); expect(component.html()).toMatchInlineSnapshot( `"
    FOO
    "` @@ -81,20 +90,24 @@ describe('HeaderActionMenu', () => { act(() => { menuMount$.next(undefined); }); - await refresh(); + refresh(); expect(component.html()).toMatchInlineSnapshot( `"
    "` ); }); - it('updates the dom when a new mount point is emitted', async () => { - component = mount(); + it('updates the dom when a new mount point is emitted', () => { + const TestComponent = () => { + const mounter = useHeaderActionMenuMounter(menuMount$); + return ; + }; + component = mount(); act(() => { menuMount$.next(createMountPoint('FOO')); }); - await refresh(); + refresh(); expect(component.html()).toMatchInlineSnapshot( `"
    FOO
    "` @@ -103,20 +116,24 @@ describe('HeaderActionMenu', () => { act(() => { menuMount$.next(createMountPoint('BAR')); }); - await refresh(); + refresh(); expect(component.html()).toMatchInlineSnapshot( `"
    BAR
    "` ); }); - it('calls the previous mount point `unmount` when mounting a new mount point', async () => { - component = mount(); + it('calls the previous mount point `unmount` when mounting a new mount point', () => { + const TestComponent = () => { + const mounter = useHeaderActionMenuMounter(menuMount$); + return ; + }; + component = mount(); act(() => { menuMount$.next(createMountPoint('FOO')); }); - await refresh(); + refresh(); expect(Object.keys(unmounts)).toEqual(['FOO']); expect(unmounts.FOO).not.toHaveBeenCalled(); @@ -124,7 +141,7 @@ describe('HeaderActionMenu', () => { act(() => { menuMount$.next(createMountPoint('BAR')); }); - await refresh(); + refresh(); expect(Object.keys(unmounts)).toEqual(['FOO', 'BAR']); expect(unmounts.FOO).toHaveBeenCalledTimes(1); diff --git a/packages/core/chrome/core-chrome-browser-internal/src/ui/header/header_action_menu.tsx b/packages/core/chrome/core-chrome-browser-internal/src/ui/header/header_action_menu.tsx index aabf2cf11307f..ec2a06266a0fe 100644 --- a/packages/core/chrome/core-chrome-browser-internal/src/ui/header/header_action_menu.tsx +++ b/packages/core/chrome/core-chrome-browser-internal/src/ui/header/header_action_menu.tsx @@ -11,10 +11,12 @@ import { Observable } from 'rxjs'; import type { MountPoint, UnmountCallback } from '@kbn/core-mount-utils-browser'; interface HeaderActionMenuProps { - actionMenu$: Observable; + mounter: { mount: MountPoint | undefined }; } -export const HeaderActionMenu: FC = ({ actionMenu$ }) => { +export const useHeaderActionMenuMounter = ( + actionMenu$: Observable | undefined> +) => { // useObservable relies on useState under the hood. The signature is type SetStateAction = S | ((prevState: S) => S); // As we got a Observable here, React's setState setter assume he's getting a `(prevState: S) => S` signature, // therefore executing the mount method, causing everything to crash. @@ -29,6 +31,10 @@ export const HeaderActionMenu: FC = ({ actionMenu$ }) => return () => s.unsubscribe(); }, [actionMenu$]); + return mounter; +}; + +export const HeaderActionMenu: FC = ({ mounter }) => { const elementRef = useRef(null); const unmountRef = useRef(null); diff --git a/packages/core/chrome/core-chrome-browser-internal/src/ui/header/screen_reader_a11y.test.tsx b/packages/core/chrome/core-chrome-browser-internal/src/ui/header/screen_reader_a11y.test.tsx index b468eefd51d79..327fbbe8c46c1 100644 --- a/packages/core/chrome/core-chrome-browser-internal/src/ui/header/screen_reader_a11y.test.tsx +++ b/packages/core/chrome/core-chrome-browser-internal/src/ui/header/screen_reader_a11y.test.tsx @@ -24,7 +24,7 @@ describe('ScreenReaderRouteAnnouncements', () => { expect(component).toMatchSnapshot(); }); - it('does not set the focusOnRegionOnTextChange for canvas or discover', () => { + it('does not set the focusOnRegionOnTextChange for canvas', () => { const noFocusComponentCanvas = mount( { breadcrumbs$={new BehaviorSubject([])} /> ); - const noFocusComponentDiscover = mount( - - ); expect( noFocusComponentCanvas .debug() .includes('') ).toBeTruthy(); - - expect( - noFocusComponentDiscover - .debug() - .includes('') - ).toBeTruthy(); }); it('sets the focusOnRegionOnTextChange to true for other apps', () => { diff --git a/packages/core/chrome/core-chrome-browser-internal/src/ui/header/screen_reader_a11y.tsx b/packages/core/chrome/core-chrome-browser-internal/src/ui/header/screen_reader_a11y.tsx index f879e896297dc..1971c38977f8b 100644 --- a/packages/core/chrome/core-chrome-browser-internal/src/ui/header/screen_reader_a11y.tsx +++ b/packages/core/chrome/core-chrome-browser-internal/src/ui/header/screen_reader_a11y.tsx @@ -45,10 +45,8 @@ export const ScreenReaderRouteAnnouncements: FC<{ // 1. Canvas dynamically updates breadcrumbs *and* page title/history on every name onChange, // which leads to focus fighting if this is enabled - // 2. Discover has custom h1 focus behavior on route change, which should probably - // be removed in favor of this for a more consistent SR experience const appId = useObservable(appId$); - const disableFocusForApps = ['canvas', 'discover']; + const disableFocusForApps = ['canvas']; const focusRegionOnTextChange = !disableFocusForApps.includes(appId || ''); return ( diff --git a/packages/core/chrome/core-chrome-browser-internal/src/ui/project/header.tsx b/packages/core/chrome/core-chrome-browser-internal/src/ui/project/header.tsx index 208f3aac7100d..9b7ad144055e7 100644 --- a/packages/core/chrome/core-chrome-browser-internal/src/ui/project/header.tsx +++ b/packages/core/chrome/core-chrome-browser-internal/src/ui/project/header.tsx @@ -6,20 +6,30 @@ * Side Public License, v 1. */ -import React from 'react'; +import React, { createRef, useState } from 'react'; import { Router } from 'react-router-dom'; -import { EuiHeader, EuiHeaderLogo, EuiHeaderSection, EuiHeaderSectionItem } from '@elastic/eui'; +import { + EuiHeader, + EuiHeaderLogo, + EuiHeaderSection, + EuiHeaderSectionItem, + EuiHeaderSectionItemButton, + EuiIcon, + htmlIdGenerator, +} from '@elastic/eui'; import { ChromeBreadcrumb, ChromeGlobalHelpExtensionMenuLink, ChromeHelpExtension, ChromeNavControl, } from '@kbn/core-chrome-browser/src'; +import useLocalStorage from 'react-use/lib/useLocalStorage'; +import { i18n } from '@kbn/i18n'; import { Observable } from 'rxjs'; import { MountPoint } from '@kbn/core-mount-utils-browser'; import { InternalApplicationStart } from '@kbn/core-application-browser-internal'; import { HeaderBreadcrumbs } from '../header/header_breadcrumbs'; -import { HeaderActionMenu } from '../header/header_action_menu'; +import { HeaderActionMenu, useHeaderActionMenuMounter } from '../header/header_action_menu'; import { HeaderHelpMenu } from '../header/header_help_menu'; import { HeaderNavControls } from '../header/header_nav_controls'; import { ProjectNavigation } from './navigation'; @@ -37,6 +47,8 @@ interface Props { children: React.ReactNode; } +const LOCAL_STORAGE_IS_OPEN_KEY = 'PROJECT_NAVIGATION_OPEN' as const; + export const ProjectHeader = ({ application, kibanaDocLink, @@ -44,6 +56,10 @@ export const ProjectHeader = ({ children, ...observables }: Props) => { + const [navId] = useState(htmlIdGenerator()()); + const [isOpen, setIsOpen] = useLocalStorage(LOCAL_STORAGE_IS_OPEN_KEY, true); + const toggleCollapsibleNavRef = createRef void }>(); + const renderLogo = () => ( ); + const headerActionMenuMounter = useHeaderActionMenuMounter(observables.actionMenu$); + return ( <> - {renderLogo()} + + + { + setIsOpen(false); + if (toggleCollapsibleNavRef.current) { + toggleCollapsibleNavRef.current.focus(); + } + }} + button={ + setIsOpen(!isOpen)} + aria-expanded={isOpen!} + aria-pressed={isOpen!} + aria-controls={navId} + ref={toggleCollapsibleNavRef} + > + + + } + > + {children} + + + + {renderLogo()} @@ -73,18 +121,25 @@ export const ProjectHeader = ({ navigateToUrl={application.navigateToUrl} /> - - - - - {children} - + {headerActionMenuMounter.mount && ( + + {/* TODO: This puts a group of nav menu items on the right edge of the screen, + but it should be possible for apps customize the layout in a grid and use spacers between items. + https://github.com/elastic/kibana/issues/158034 */} + + + + + + + + )} ); }; diff --git a/packages/core/chrome/core-chrome-browser-internal/src/ui/project/navigation.tsx b/packages/core/chrome/core-chrome-browser-internal/src/ui/project/navigation.tsx index 649318a26d15e..f22a8acb067ed 100644 --- a/packages/core/chrome/core-chrome-browser-internal/src/ui/project/navigation.tsx +++ b/packages/core/chrome/core-chrome-browser-internal/src/ui/project/navigation.tsx @@ -6,67 +6,52 @@ * Side Public License, v 1. */ -import React, { useCallback } from 'react'; -import useLocalStorage from 'react-use/lib/useLocalStorage'; +import React from 'react'; import { css } from '@emotion/react'; - -import { i18n } from '@kbn/i18n'; -import { EuiButtonIcon, EuiCollapsibleNav } from '@elastic/eui'; - -const LOCAL_STORAGE_IS_OPEN_KEY = 'PROJECT_NAVIGATION_OPEN' as const; -const SIZE_OPEN = 248; -const SIZE_CLOSED = 40; - -const buttonCSS = css` - margin-left: -32px; - margin-top: 12px; - position: fixed; - z-index: 1000; -`; - -const openAriaLabel = i18n.translate('core.ui.chrome.projectNav.collapsibleNavOpenAriaLabel', { - defaultMessage: 'Close navigation', -}); - -const closedAriaLabel = i18n.translate('core.ui.chrome.projectNav.collapsibleNavClosedAriaLabel', { - defaultMessage: 'Open navigation', -}); - -export const ProjectNavigation: React.FC = ({ children }) => { - const [isOpen, setIsOpen] = useLocalStorage(LOCAL_STORAGE_IS_OPEN_KEY, true); - - const toggleOpen = useCallback(() => { - setIsOpen(!isOpen); - }, [isOpen, setIsOpen]); - +import { EuiCollapsibleNav, EuiCollapsibleNavProps, useIsWithinMinBreakpoint } from '@elastic/eui'; + +const SIZE_EXPANDED = 248; +const SIZE_COLLAPSED = 48; + +export interface ProjectNavigationProps { + isOpen: boolean; + closeNav: () => void; + button: EuiCollapsibleNavProps['button']; +} + +export const ProjectNavigation: React.FC = ({ + children, + isOpen, + closeNav, + button, +}) => { const collabsibleNavCSS = css` border-inline-end-width: 1, display: flex, flex-direction: row, `; + // on small screen isOpen hides the nav, + // on larger screen isOpen makes it smaller + const DOCKED_BREAKPOINT = 's' as const; + const isCollapsible = useIsWithinMinBreakpoint(DOCKED_BREAKPOINT); + const isVisible = isCollapsible ? true : isOpen; + const isCollapsed = isCollapsible ? !isOpen : false; + return ( - - - } + button={button} > - {isOpen && children} + {!isCollapsed && children} ); }; diff --git a/packages/core/chrome/core-chrome-browser/src/project_navigation.ts b/packages/core/chrome/core-chrome-browser/src/project_navigation.ts index da5140d55266c..deea1a9cb3d52 100644 --- a/packages/core/chrome/core-chrome-browser/src/project_navigation.ts +++ b/packages/core/chrome/core-chrome-browser/src/project_navigation.ts @@ -25,7 +25,6 @@ export interface ChromeProjectNavigationNode { id?: string; link?: ChromeProjectNavigationLink; children?: ChromeProjectNavigationNode[]; - title?: string; icon?: string; } diff --git a/packages/core/http/core-http-router-server-internal/src/versioned_router/validate.ts b/packages/core/http/core-http-router-server-internal/src/versioned_router/validate.ts index b1923f4f452c9..37443209e4508 100644 --- a/packages/core/http/core-http-router-server-internal/src/versioned_router/validate.ts +++ b/packages/core/http/core-http-router-server-internal/src/versioned_router/validate.ts @@ -18,8 +18,8 @@ export function validate( ): { body: unknown; params: unknown; query: unknown } { const validator = RouteValidator.from(runtimeSchema); return { - body: validator.getBody(data.body, `get ${version} body`), - params: validator.getParams(data.params, `get ${version} params`), - query: validator.getQuery(data.query, `get ${version} query`), + params: validator.getParams(data.params, 'request params'), + query: validator.getQuery(data.query, 'request query'), + body: validator.getBody(data.body, 'request body'), }; } diff --git a/packages/core/http/core-http-server-internal/src/__snapshots__/http_config.test.ts.snap b/packages/core/http/core-http-server-internal/src/__snapshots__/http_config.test.ts.snap index 87a5efcc5d279..b8d605bd75824 100644 --- a/packages/core/http/core-http-server-internal/src/__snapshots__/http_config.test.ts.snap +++ b/packages/core/http/core-http-server-internal/src/__snapshots__/http_config.test.ts.snap @@ -56,6 +56,16 @@ Object { "enabled": false, }, "customResponseHeaders": Object {}, + "eluMonitor": Object { + "enabled": true, + "logging": Object { + "enabled": false, + "threshold": Object { + "ela": 250, + "elu": 0.15, + }, + }, + }, "host": "localhost", "keepaliveTimeout": 120000, "maxPayload": ByteSizeValue { diff --git a/packages/core/http/core-http-server-internal/src/http_config.ts b/packages/core/http/core-http-server-internal/src/http_config.ts index 53417d9c533f8..be45c8a700231 100644 --- a/packages/core/http/core-http-server-internal/src/http_config.ts +++ b/packages/core/http/core-http-server-internal/src/http_config.ts @@ -16,6 +16,7 @@ import { hostname } from 'os'; import url from 'url'; import type { Duration } from 'moment'; +import { IHttpEluMonitorConfig } from '@kbn/core-http-server/src/elu_monitor'; import { CspConfigType, CspConfig } from './csp'; import { ExternalUrlConfig } from './external_url'; import { @@ -137,6 +138,21 @@ const configSchema = schema.object( { defaultValue: [] } ), }), + eluMonitor: schema.object({ + enabled: schema.boolean({ defaultValue: true }), + logging: schema.object({ + enabled: schema.conditional( + schema.contextRef('dist'), + false, + schema.boolean({ defaultValue: true }), + schema.boolean({ defaultValue: false }) + ), + threshold: schema.object({ + elu: schema.number({ defaultValue: 0.15, min: 0, max: 1 }), + ela: schema.number({ defaultValue: 250, min: 0 }), + }), + }), + }), requestId: schema.object( { allowFromAnyIp: schema.boolean({ defaultValue: false }), @@ -226,6 +242,8 @@ export class HttpConfig implements IHttpConfig { public shutdownTimeout: Duration; public restrictInternalApis: boolean; + public eluMonitor: IHttpEluMonitorConfig; + /** * @internal */ @@ -244,12 +262,12 @@ export class HttpConfig implements IHttpConfig { this.securityResponseHeaders = securityResponseHeaders; this.customResponseHeaders = Object.entries(rawHttpConfig.customResponseHeaders ?? {}).reduce( (headers, [key, value]) => { - return { - ...headers, - [key]: Array.isArray(value) ? value.map((e) => convertHeader(e)) : convertHeader(value), - }; + headers[key] = Array.isArray(value) + ? value.map((e) => convertHeader(e)) + : convertHeader(value); + return headers; }, - {} + {} as Record ); this.maxPayload = rawHttpConfig.maxPayload; this.name = rawHttpConfig.name; @@ -265,7 +283,9 @@ export class HttpConfig implements IHttpConfig { this.xsrf = rawHttpConfig.xsrf; this.requestId = rawHttpConfig.requestId; this.shutdownTimeout = rawHttpConfig.shutdownTimeout; + this.restrictInternalApis = rawHttpConfig.restrictInternalApis; + this.eluMonitor = rawHttpConfig.eluMonitor; } } diff --git a/packages/core/http/core-http-server-internal/src/http_server.ts b/packages/core/http/core-http-server-internal/src/http_server.ts index 2bdf76ee23310..747c477d1b41d 100644 --- a/packages/core/http/core-http-server-internal/src/http_server.ts +++ b/packages/core/http/core-http-server-internal/src/http_server.ts @@ -43,6 +43,10 @@ import type { HttpAuth, IAuthHeadersStorage, } from '@kbn/core-http-server'; +import { performance } from 'perf_hooks'; +import { isBoom } from '@hapi/boom'; +import { identity } from 'lodash'; +import { IHttpEluMonitorConfig } from '@kbn/core-http-server/src/elu_monitor'; import { HttpConfig } from './http_config'; import { adoptToHapiAuthFormat } from './lifecycle/auth'; import { adoptToHapiOnPreAuth } from './lifecycle/on_pre_auth'; @@ -55,6 +59,62 @@ import { AuthHeadersStorage } from './auth_headers_storage'; import { BasePath } from './base_path_service'; import { getEcsResponseLog } from './logging'; +/** + * Adds ELU timings for the executed function to the current's context transaction + * + * @param path The request path + * @param log Logger + */ +function startEluMeasurement( + path: string, + log: Logger, + eluMonitorOptions: IHttpEluMonitorConfig | undefined +): () => void { + if (!eluMonitorOptions?.enabled) { + return identity; + } + + const startUtilization = performance.eventLoopUtilization(); + const start = performance.now(); + + return function stopEluMeasurement() { + const { active, utilization } = performance.eventLoopUtilization(startUtilization); + + apm.currentTransaction?.addLabels( + { + event_loop_utilization: utilization, + event_loop_active: active, + }, + false + ); + + const duration = performance.now() - start; + + const { elu: eluThreshold, ela: elaThreshold } = eluMonitorOptions.logging.threshold; + + if ( + eluMonitorOptions.logging.enabled && + active >= eluMonitorOptions.logging.threshold.ela && + utilization >= eluMonitorOptions.logging.threshold.elu + ) { + log.warn( + `Event loop utilization for ${path} exceeded threshold of ${elaThreshold}ms (${Math.round( + active + )}ms out of ${Math.round(duration)}ms) and ${eluThreshold * 100}% (${Math.round( + utilization * 100 + )}%) `, + { + labels: { + request_path: path, + event_loop_active: active, + event_loop_utilization: utilization, + }, + } + ); + } + }; +} + /** @internal */ export interface HttpServerSetup { server: Server; @@ -350,7 +410,27 @@ export class HttpServer { config: HttpConfig, executionContext?: InternalExecutionContextSetup ) { + this.server!.ext('onPreResponse', (request, responseToolkit) => { + const stop = (request.app as KibanaRequestState).measureElu; + + if (!stop) { + return responseToolkit.continue; + } + + if (isBoom(request.response)) { + stop(); + } else { + request.response.events.once('finish', () => { + stop(); + }); + } + + return responseToolkit.continue; + }); + this.server!.ext('onRequest', (request, responseToolkit) => { + const stop = startEluMeasurement(request.path, this.log, this.config?.eluMonitor); + const requestId = getRequestId(request, config.requestId); const parentContext = executionContext?.getParentContextFrom(request.headers); @@ -366,6 +446,7 @@ export class HttpServer { ...(request.app ?? {}), requestId, requestUuid: uuidv4(), + measureElu: stop, // Kibana stores trace.id until https://github.com/elastic/apm-agent-nodejs/issues/2353 is resolved // The current implementation of the APM agent ends a request transaction before "response" log is emitted. traceId: apm.currentTraceIds['trace.id'], diff --git a/packages/core/http/core-http-server/index.ts b/packages/core/http/core-http-server/index.ts index de373db4c27de..043f18e131628 100644 --- a/packages/core/http/core-http-server/index.ts +++ b/packages/core/http/core-http-server/index.ts @@ -107,6 +107,8 @@ export type { ICspConfig } from './src/csp'; export type { IExternalUrlConfig } from './src/external_url'; +export type { IHttpEluMonitorConfig } from './src/elu_monitor'; + export type { IBasePath } from './src/base_path'; export type { diff --git a/packages/core/http/core-http-server/src/elu_monitor.ts b/packages/core/http/core-http-server/src/elu_monitor.ts new file mode 100644 index 0000000000000..6ccb140d3746e --- /dev/null +++ b/packages/core/http/core-http-server/src/elu_monitor.ts @@ -0,0 +1,36 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +/** + * HTTP request ELU monitor config + * @public + */ +export interface IHttpEluMonitorConfig { + /** + * Whether the monitoring of event loop utilization for HTTP requests is enabled. + */ + readonly enabled: boolean; + + readonly logging: { + /** + * Whether to log ELU + ELA violations. Both `.elu` and `.ela` need to be exceeded for it to be considered a violation. + */ + readonly enabled: boolean; + + readonly threshold: { + /** + * The minimum percentage of the request duration that needs to be exceeded (needs to be between 0 and 1) + */ + readonly elu: number; + /** + * The minimum number of milliseconds the event loop was active for the duration of the request. + */ + readonly ela: number; + }; + }; +} diff --git a/packages/core/http/core-http-server/src/router/request.ts b/packages/core/http/core-http-server/src/router/request.ts index e0664cb1ea29a..a92f2d496705a 100644 --- a/packages/core/http/core-http-server/src/router/request.ts +++ b/packages/core/http/core-http-server/src/router/request.ts @@ -30,6 +30,7 @@ export interface KibanaRequestState extends RequestApplicationState { requestUuid: string; rewrittenUrl?: URL; traceId?: string; + measureElu?: () => void; } /** diff --git a/packages/core/node/core-node-server-internal/src/node_service.ts b/packages/core/node/core-node-server-internal/src/node_service.ts index d84582d57e892..c8b3618aee611 100644 --- a/packages/core/node/core-node-server-internal/src/node_service.ts +++ b/packages/core/node/core-node-server-internal/src/node_service.ts @@ -70,7 +70,8 @@ export class NodeService { // We assume the combination of node roles has been validated and avoid doing additional checks here. this.roles = NODE_ALL_ROLES.reduce((acc, curr) => { - return { ...acc, [camelCase(curr)]: (roles as string[]).includes(curr) }; + acc[camelCase(curr) as keyof NodeRoles] = (roles as string[]).includes(curr); + return acc; }, {} as NodeRoles); return { diff --git a/packages/core/rendering/core-rendering-browser-internal/src/app_containers.test.tsx b/packages/core/rendering/core-rendering-browser-internal/src/app_containers.test.tsx index 10f5f3f1c138f..5ab8ded943aa0 100644 --- a/packages/core/rendering/core-rendering-browser-internal/src/app_containers.test.tsx +++ b/packages/core/rendering/core-rendering-browser-internal/src/app_containers.test.tsx @@ -21,6 +21,7 @@ describe('AppWrapper', () => { expect(component.getDOMNode()).toMatchInlineSnapshot(`
    app-content
    @@ -31,6 +32,7 @@ describe('AppWrapper', () => { expect(component.getDOMNode()).toMatchInlineSnapshot(`
    app-content
    @@ -41,6 +43,7 @@ describe('AppWrapper', () => { expect(component.getDOMNode()).toMatchInlineSnapshot(`
    app-content
    diff --git a/packages/core/rendering/core-rendering-browser-internal/src/app_containers.tsx b/packages/core/rendering/core-rendering-browser-internal/src/app_containers.tsx index 73eea36592207..6e55757ee543c 100644 --- a/packages/core/rendering/core-rendering-browser-internal/src/app_containers.tsx +++ b/packages/core/rendering/core-rendering-browser-internal/src/app_containers.tsx @@ -17,7 +17,10 @@ export const AppWrapper: React.FunctionComponent<{ }> = ({ chromeVisible$, children }) => { const visible = useObservable(chromeVisible$); return ( -
    +
    {children}
    ); diff --git a/packages/core/rendering/core-rendering-browser-internal/src/rendering_service.test.tsx b/packages/core/rendering/core-rendering-browser-internal/src/rendering_service.test.tsx index 5dcde921837b1..09589ebb0a40d 100644 --- a/packages/core/rendering/core-rendering-browser-internal/src/rendering_service.test.tsx +++ b/packages/core/rendering/core-rendering-browser-internal/src/rendering_service.test.tsx @@ -61,6 +61,7 @@ describe('RenderingService#start', () => { expect(targetDomElement.querySelector('div.kbnAppWrapper')).toMatchInlineSnapshot(`
    { - it('UserSettings value should override the space setting', async () => { + it('UserSettings darkMode === true should override the space setting', async () => { mockRenderingSetupDeps.userSettings.getUserSettingDarkMode.mockReturnValueOnce( Promise.resolve(true) ); @@ -235,6 +235,32 @@ function renderDarkModeTestCases( }); }); + it('UserSettings darkMode === false should override the space setting', async () => { + mockRenderingSetupDeps.userSettings.getUserSettingDarkMode.mockReturnValueOnce( + Promise.resolve(false) + ); + + getSettingValueMock.mockImplementation((settingName: string) => { + if (settingName === 'theme:darkMode') { + return true; + } + return settingName; + }); + + const settings = { 'theme:darkMode': { userValue: false } }; + uiSettings.client.getUserProvided.mockResolvedValue(settings); + + const [render] = await getRender(); + await render(createKibanaRequest(), uiSettings); + + expect(getStylesheetPathsMock).toHaveBeenCalledWith({ + darkMode: false, + themeVersion: 'v8', + basePath: '/mock-server-basepath', + buildNum: expect.any(Number), + }); + }); + it('Space setting value should be used if UsersSettings value is undefined', async () => { mockRenderingSetupDeps.userSettings.getUserSettingDarkMode.mockReturnValueOnce( Promise.resolve(undefined) @@ -258,6 +284,102 @@ function renderDarkModeTestCases( buildNum: expect.any(Number), }); }); + + it('config `theme:darkMode: true` setting should override User Settings theme `darkMode === false', async () => { + mockRenderingSetupDeps.userSettings.getUserSettingDarkMode.mockReturnValueOnce( + Promise.resolve(false) + ); + getSettingValueMock.mockImplementation((settingName: string) => { + if (settingName === 'theme:darkMode') { + return true; + } + return settingName; + }); + + const settings = { 'theme:darkMode': { userValue: true, isOverridden: true } }; + uiSettings.client.getUserProvided.mockResolvedValue(settings); + const [render] = await getRender(); + await render(createKibanaRequest(), uiSettings); + + expect(getStylesheetPathsMock).toHaveBeenCalledWith({ + darkMode: true, + themeVersion: 'v8', + basePath: '/mock-server-basepath', + buildNum: expect.any(Number), + }); + }); + + it('config `theme:darkMode: false` setting should override User Settings theme `darkMode === true', async () => { + mockRenderingSetupDeps.userSettings.getUserSettingDarkMode.mockReturnValueOnce( + Promise.resolve(true) + ); + getSettingValueMock.mockImplementation((settingName: string) => { + if (settingName === 'theme:darkMode') { + return false; + } + return settingName; + }); + + const settings = { 'theme:darkMode': { userValue: false, isOverridden: true } }; + uiSettings.client.getUserProvided.mockResolvedValue(settings); + const [render] = await getRender(); + await render(createKibanaRequest(), uiSettings); + + expect(getStylesheetPathsMock).toHaveBeenCalledWith({ + darkMode: false, + themeVersion: 'v8', + basePath: '/mock-server-basepath', + buildNum: expect.any(Number), + }); + }); + + it('config `theme:darkMode: false` setting should override User Settings theme `darkMode === undefined', async () => { + mockRenderingSetupDeps.userSettings.getUserSettingDarkMode.mockReturnValueOnce( + Promise.resolve(undefined) + ); + getSettingValueMock.mockImplementation((settingName: string) => { + if (settingName === 'theme:darkMode') { + return false; + } + return settingName; + }); + + const settings = { 'theme:darkMode': { userValue: false, isOverridden: true } }; + uiSettings.client.getUserProvided.mockResolvedValue(settings); + const [render] = await getRender(); + await render(createKibanaRequest(), uiSettings); + + expect(getStylesheetPathsMock).toHaveBeenCalledWith({ + darkMode: false, + themeVersion: 'v8', + basePath: '/mock-server-basepath', + buildNum: expect.any(Number), + }); + }); + + it('config `theme:darkMode: true` setting should override User Settings theme `darkMode === undefined', async () => { + mockRenderingSetupDeps.userSettings.getUserSettingDarkMode.mockReturnValueOnce( + Promise.resolve(undefined) + ); + getSettingValueMock.mockImplementation((settingName: string) => { + if (settingName === 'theme:darkMode') { + return true; + } + return settingName; + }); + + const settings = { 'theme:darkMode': { userValue: true, isOverridden: true } }; + uiSettings.client.getUserProvided.mockResolvedValue(settings); + const [render] = await getRender(); + await render(createKibanaRequest(), uiSettings); + + expect(getStylesheetPathsMock).toHaveBeenCalledWith({ + darkMode: true, + themeVersion: 'v8', + basePath: '/mock-server-basepath', + buildNum: expect.any(Number), + }); + }); }); }); } diff --git a/packages/core/rendering/core-rendering-server-internal/src/rendering_service.tsx b/packages/core/rendering/core-rendering-server-internal/src/rendering_service.tsx index d2854059e8508..854202e4aebc4 100644 --- a/packages/core/rendering/core-rendering-server-internal/src/rendering_service.tsx +++ b/packages/core/rendering/core-rendering-server-internal/src/rendering_service.tsx @@ -167,7 +167,9 @@ export class RenderingService { let darkMode: boolean; - if (userSettingDarkMode) { + const isThemeOverridden = settings.user['theme:darkMode']?.isOverridden ?? false; + + if (userSettingDarkMode !== undefined && !isThemeOverridden) { darkMode = userSettingDarkMode; } else { darkMode = getSettingValue('theme:darkMode', settings, Boolean); diff --git a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/bulk_get.ts b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/bulk_get.ts index 745f61784416d..c2d23e3d7c094 100644 --- a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/bulk_get.ts +++ b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/bulk_get.ts @@ -46,7 +46,15 @@ type ExpectedBulkGetResult = Either< export const performBulkGet = async ( { objects, options }: PerformBulkGetParams, - { helpers, allowedTypes, client, serializer, registry, extensions = {} }: ApiExecutionContext + { + helpers, + allowedTypes, + client, + migrator, + serializer, + registry, + extensions = {}, + }: ApiExecutionContext ): Promise> => { const { common: commonHelper, @@ -192,9 +200,12 @@ export const performBulkGet = async ( } // @ts-expect-error MultiGetHit._source is optional - return getSavedObjectFromSource(registry, type, id, doc, { + const document = getSavedObjectFromSource(registry, type, id, doc, { migrationVersionCompatibility, }); + const migrated = migrator.migrateDocument(document); + + return migrated; }), }; diff --git a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/bulk_resolve.ts b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/bulk_resolve.ts index 74ab7026eb177..a18b69ec29bf6 100644 --- a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/bulk_resolve.ts +++ b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/bulk_resolve.ts @@ -32,6 +32,7 @@ export const performBulkResolve = async ( helpers, allowedTypes, client, + migrator, serializer, extensions = {}, } = apiExecutionContext; @@ -43,6 +44,7 @@ export const performBulkResolve = async ( registry, allowedTypes, client, + migrator, serializer, getIndexForType: commonHelper.getIndexForType.bind(commonHelper), incrementCounterInternal: (type, id, counterFields, opts = {}) => diff --git a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/find.ts b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/find.ts index 697af05ce4eb4..c13743221af36 100644 --- a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/find.ts +++ b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/find.ts @@ -13,6 +13,7 @@ import { SavedObjectsErrorHelpers, type SavedObjectsRawDoc, CheckAuthorizationResult, + type SavedObject, SavedObjectsRawDocSource, } from '@kbn/core-saved-objects-server'; import { @@ -48,7 +49,6 @@ export const performFind = async ( allowedTypes: rawAllowedTypes, mappings, client, - serializer, migrator, extensions = {}, }: ApiExecutionContext @@ -229,22 +229,32 @@ export const performFind = async ( return SavedObjectsUtils.createEmptyFindResponse(options); } - const result = { - ...(body.aggregations ? { aggregations: body.aggregations as unknown as A } : {}), - page, - per_page: perPage, - total: body.hits.total, - saved_objects: body.hits.hits.map( - (hit: estypes.SearchHit): SavedObjectsFindResult => ({ - ...serializerHelper.rawToSavedObject(hit as SavedObjectsRawDoc, { - migrationVersionCompatibility, - }), - score: hit._score!, - sort: hit.sort, - }) - ), - pit_id: body.pit_id, - } as SavedObjectsFindResponse; + let result: SavedObjectsFindResponse; + try { + result = { + ...(body.aggregations ? { aggregations: body.aggregations as unknown as A } : {}), + page, + per_page: perPage, + total: body.hits.total, + saved_objects: body.hits.hits.map( + (hit: estypes.SearchHit): SavedObjectsFindResult => ({ + ...(migrator.migrateDocument( + serializerHelper.rawToSavedObject(hit as SavedObjectsRawDoc, { + migrationVersionCompatibility, + }) + ) as SavedObject), + score: hit._score!, + sort: hit.sort, + }) + ), + pit_id: body.pit_id, + } as typeof result; + } catch (error) { + throw SavedObjectsErrorHelpers.decorateGeneralError( + error, + 'Failed to migrate document to the latest version.' + ); + } if (disableExtensions) { return result; diff --git a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/get.ts b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/get.ts index d2fbe46fc6c85..e515728fa19db 100644 --- a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/get.ts +++ b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/get.ts @@ -24,7 +24,15 @@ export interface PerformGetParams { export const performGet = async ( { type, id, options }: PerformGetParams, - { registry, helpers, allowedTypes, client, serializer, extensions = {} }: ApiExecutionContext + { + registry, + helpers, + allowedTypes, + client, + migrator, + serializer, + extensions = {}, + }: ApiExecutionContext ): Promise> => { const { common: commonHelper, encryption: encryptionHelper } = helpers; const { securityExtension } = extensions; @@ -68,12 +76,22 @@ export const performGet = async ( throw SavedObjectsErrorHelpers.createGenericNotFoundError(type, id); } - const result = getSavedObjectFromSource(registry, type, id, body, { + const document = getSavedObjectFromSource(registry, type, id, body, { migrationVersionCompatibility, }); + let migrated: SavedObject; + try { + migrated = migrator.migrateDocument(document) as SavedObject; + } catch (error) { + throw SavedObjectsErrorHelpers.decorateGeneralError( + error, + 'Failed to migrate document to the latest version.' + ); + } + return encryptionHelper.optionallyDecryptAndRedactSingleResult( - result, + migrated, authorizationResult?.typeMap ); }; diff --git a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/internals/internal_bulk_resolve.test.ts b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/internals/internal_bulk_resolve.test.ts index 4b619764a042c..fe3cdc5ba5583 100644 --- a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/internals/internal_bulk_resolve.test.ts +++ b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/internals/internal_bulk_resolve.test.ts @@ -31,6 +31,7 @@ import { type ISavedObjectTypeRegistry, type SavedObject, SavedObjectsErrorHelpers, + type SavedObjectUnsanitizedDoc, } from '@kbn/core-saved-objects-server'; import { enforceError, @@ -38,6 +39,7 @@ import { setupAuthorizeAndRedactInternalBulkResolveSuccess, } from '../../../test_helpers/repository.test.common'; import { savedObjectsExtensionsMock } from '../../../mocks/saved_objects_extensions.mock'; +import { kibanaMigratorMock } from '../../../mocks'; const VERSION_PROPS = { _seq_no: 1, _primary_term: 1 }; const OBJ_TYPE = 'obj-type'; @@ -57,6 +59,7 @@ beforeEach(() => { describe('internalBulkResolve', () => { let client: ReturnType; + let migrator: ReturnType; let serializer: SavedObjectsSerializer; let incrementCounterInternal: jest.Mock; let registry: jest.Mocked; @@ -72,11 +75,13 @@ describe('internalBulkResolve', () => { ): InternalBulkResolveParams { registry = typeRegistryMock.create(); client = elasticsearchClientMock.createElasticsearchClient(); + migrator = kibanaMigratorMock.create(); serializer = new SavedObjectsSerializer(registry); incrementCounterInternal = jest.fn().mockRejectedValue(new Error('increment error')); // mock error to implicitly test that it is caught and swallowed return { registry, allowedTypes: [OBJ_TYPE, ENCRYPTED_TYPE], + migrator, client, serializer, getIndexForType: (type: string) => `index-for-${type}`, @@ -223,7 +228,7 @@ describe('internalBulkResolve', () => { }; } - for (const namespace of [undefined, 'default', 'space-x']) { + describe.each([undefined, 'default', 'space-x'])(`with namespace '%s'`, (namespace) => { const expectedNamespaceString = SavedObjectsUtils.namespaceIdToString(namespace); it('throws if mget call results in non-ES-originated 404 error', async () => { @@ -362,7 +367,29 @@ describe('internalBulkResolve', () => { expectConflictResult({ id: '7', alias_target_id: '7-newId', alias_purpose: 'y' }), ]); }); - } + + it('migrates the resolved objects', async () => { + const objects = [ + { type: OBJ_TYPE, id: '1' }, + { type: OBJ_TYPE, id: '2' }, + ]; + const params = setup(objects, { namespace }); + mockBulkResults({ found: false }, { found: false }); + mockMgetResults({ found: true }, { found: true }); + migrator.migrateDocument.mockImplementation( + (doc) => `migrated-${doc}` as unknown as SavedObjectUnsanitizedDoc + ); + + await expect(internalBulkResolve(params)).resolves.toHaveProperty('resolved_objects', [ + expect.objectContaining({ saved_object: 'migrated-mock-obj-for-1' }), + expect.objectContaining({ saved_object: 'migrated-mock-obj-for-2' }), + ]); + + expect(migrator.migrateDocument).toHaveBeenCalledTimes(2); + expect(migrator.migrateDocument).nthCalledWith(1, 'mock-obj-for-1'); + expect(migrator.migrateDocument).nthCalledWith(2, 'mock-obj-for-2'); + }); + }); describe('with encryption extension', () => { const namespace = 'foo'; diff --git a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/internals/internal_bulk_resolve.ts b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/internals/internal_bulk_resolve.ts index 6e143004dfb3a..ed77fbe69b2f8 100644 --- a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/internals/internal_bulk_resolve.ts +++ b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/internals/internal_bulk_resolve.ts @@ -27,6 +27,7 @@ import { SavedObjectsErrorHelpers, } from '@kbn/core-saved-objects-server'; import { + type IKibanaMigrator, LEGACY_URL_ALIAS_TYPE, type LegacyUrlAlias, } from '@kbn/core-saved-objects-base-server-internal'; @@ -59,6 +60,7 @@ const MAX_CONCURRENT_RESOLVE = 10; */ export interface InternalBulkResolveParams { registry: ISavedObjectTypeRegistry; + migrator: IKibanaMigrator; allowedTypes: string[]; client: RepositoryEsClient; serializer: ISavedObjectsSerializer; @@ -98,6 +100,7 @@ export async function internalBulkResolve( ): Promise> { const { registry, + migrator, allowedTypes, client, serializer, @@ -184,10 +187,12 @@ export async function internalBulkResolve( const object = getSavedObjectFromSource(registry, objectType, objectId, doc, { migrationVersionCompatibility, }); - if (!encryptionExtension?.isEncryptableType(object.type)) { - return object; + const migrated = migrator.migrateDocument(object) as SavedObject; + + if (!encryptionExtension?.isEncryptableType(migrated.type)) { + return migrated; } - return encryptionExtension.decryptOrStripResponseAttributes(object); + return encryptionExtension.decryptOrStripResponseAttributes(migrated); } // map function for pMap below @@ -211,28 +216,39 @@ export async function internalBulkResolve( const { type, id } = either.value; let result: SavedObjectsResolveResponse | null = null; - if (foundExactMatch && foundAliasMatch) { - result = { - saved_object: await getSavedObject(type, id, exactMatchDoc!), - outcome: 'conflict', - alias_target_id: aliasInfo!.targetId, - alias_purpose: aliasInfo!.purpose, - }; - resolveCounter.recordOutcome(REPOSITORY_RESOLVE_OUTCOME_STATS.CONFLICT); - } else if (foundExactMatch) { - result = { - saved_object: await getSavedObject(type, id, exactMatchDoc!), - outcome: 'exactMatch', - }; - resolveCounter.recordOutcome(REPOSITORY_RESOLVE_OUTCOME_STATS.EXACT_MATCH); - } else if (foundAliasMatch) { - result = { - saved_object: await getSavedObject(type, aliasInfo!.targetId, aliasMatchDoc!), - outcome: 'aliasMatch', - alias_target_id: aliasInfo!.targetId, - alias_purpose: aliasInfo!.purpose, + try { + if (foundExactMatch && foundAliasMatch) { + result = { + saved_object: await getSavedObject(type, id, exactMatchDoc!), + outcome: 'conflict', + alias_target_id: aliasInfo!.targetId, + alias_purpose: aliasInfo!.purpose, + }; + resolveCounter.recordOutcome(REPOSITORY_RESOLVE_OUTCOME_STATS.CONFLICT); + } else if (foundExactMatch) { + result = { + saved_object: await getSavedObject(type, id, exactMatchDoc!), + outcome: 'exactMatch', + }; + resolveCounter.recordOutcome(REPOSITORY_RESOLVE_OUTCOME_STATS.EXACT_MATCH); + } else if (foundAliasMatch) { + result = { + saved_object: await getSavedObject(type, aliasInfo!.targetId, aliasMatchDoc!), + outcome: 'aliasMatch', + alias_target_id: aliasInfo!.targetId, + alias_purpose: aliasInfo!.purpose, + }; + resolveCounter.recordOutcome(REPOSITORY_RESOLVE_OUTCOME_STATS.ALIAS_MATCH); + } + } catch (error) { + return { + id, + type, + error: SavedObjectsErrorHelpers.decorateGeneralError( + error, + 'Failed to migrate document to the latest version.' + ), }; - resolveCounter.recordOutcome(REPOSITORY_RESOLVE_OUTCOME_STATS.ALIAS_MATCH); } if (result !== null) { diff --git a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/resolve.ts b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/resolve.ts index 884afc573262d..50de472546344 100644 --- a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/resolve.ts +++ b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/apis/resolve.ts @@ -29,6 +29,7 @@ export const performResolve = async ( helpers, allowedTypes, client, + migrator, serializer, extensions = {}, } = apiExecutionContext; @@ -39,6 +40,7 @@ export const performResolve = async ( registry, allowedTypes, client, + migrator, serializer, getIndexForType: commonHelper.getIndexForType.bind(commonHelper), incrementCounterInternal: (t, i, counterFields, opts = {}) => diff --git a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/repository.security_extension.test.ts b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/repository.security_extension.test.ts index d9dfc0ed3d596..3e81c09d1df9f 100644 --- a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/repository.security_extension.test.ts +++ b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/repository.security_extension.test.ts @@ -742,6 +742,9 @@ describe('SavedObjectsRepository Security Extension', () => { attributes: doc._source![doc._source!.type], references: [], namespaces: doc._source!.type === NAMESPACE_AGNOSTIC_TYPE ? undefined : [namespace], + coreMigrationVersion: expect.any(String), + typeMigrationVersion: expect.any(String), + managed: expect.any(Boolean), }); }); }); @@ -795,6 +798,9 @@ describe('SavedObjectsRepository Security Extension', () => { attributes: doc._source![doc._source!.type], references: [], namespaces: doc._source!.type === NAMESPACE_AGNOSTIC_TYPE ? undefined : [namespace], + coreMigrationVersion: expect.any(String), + typeMigrationVersion: expect.any(String), + managed: expect.any(Boolean), }); }); }); @@ -849,6 +855,9 @@ describe('SavedObjectsRepository Security Extension', () => { attributes: doc._source![doc._source!.type], references: [], namespaces: doc._source!.type === NAMESPACE_AGNOSTIC_TYPE ? undefined : [namespace], + coreMigrationVersion: expect.any(String), + typeMigrationVersion: expect.any(String), + managed: expect.any(Boolean), }); }); }); diff --git a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/repository.test.ts b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/repository.test.ts index d64d41abaef59..2a27208956591 100644 --- a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/repository.test.ts +++ b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/repository.test.ts @@ -1316,7 +1316,9 @@ describe('SavedObjectsRepository', () => { version: encodeHitVersion(doc), attributes: doc._source![type], references: doc._source!.references || [], - migrationVersion: doc._source!.migrationVersion, + coreMigrationVersion: expect.any(String), + typeMigrationVersion: expect.any(String), + managed: expect.any(Boolean), }); it(`returns early for empty objects argument`, async () => { @@ -1389,6 +1391,24 @@ describe('SavedObjectsRepository', () => { ], }); }); + + it('migrates the fetched documents', async () => { + const response = getMockMgetResponse(registry, [obj1, obj2]); + client.mget.mockResolvedValueOnce( + elasticsearchClientMock.createSuccessTransportRequestPromise(response) + ); + migrator.migrateDocument.mockReturnValue( + 'migrated' as unknown as ReturnType + ); + + await expect(bulkGet(repository, [obj1, obj2])).resolves.toHaveProperty('saved_objects', [ + 'migrated', + 'migrated', + ]); + expect(migrator.migrateDocument).toHaveBeenCalledTimes(2); + expect(migrator.migrateDocument).nthCalledWith(1, expect.objectContaining({ id: obj1.id })); + expect(migrator.migrateDocument).nthCalledWith(2, expect.objectContaining({ id: obj2.id })); + }); }); }); @@ -3910,6 +3930,9 @@ describe('SavedObjectsRepository', () => { attributes: doc._source![doc._source!.type], references: [], namespaces: doc._source!.type === NAMESPACE_AGNOSTIC_TYPE ? undefined : ['default'], + coreMigrationVersion: expect.any(String), + typeMigrationVersion: expect.any(String), + managed: expect.any(Boolean), }); }); }); @@ -3937,6 +3960,9 @@ describe('SavedObjectsRepository', () => { attributes: doc._source![doc._source!.type], references: [], namespaces: doc._source!.type === NAMESPACE_AGNOSTIC_TYPE ? undefined : [namespace], + coreMigrationVersion: expect.any(String), + typeMigrationVersion: expect.any(String), + managed: expect.any(Boolean), }); }); }); @@ -3952,6 +3978,30 @@ describe('SavedObjectsRepository', () => { await test(HIDDEN_TYPE); await test(['unknownType', HIDDEN_TYPE]); }); + + it('migrates the found document', async () => { + const noNamespaceSearchResults = generateIndexPatternSearchResults(); + client.search.mockResolvedValueOnce( + elasticsearchClientMock.createSuccessTransportRequestPromise(noNamespaceSearchResults) + ); + migrator.migrateDocument.mockImplementationOnce((doc) => ({ ...doc, migrated: true })); + await expect(repository.find({ type })).resolves.toHaveProperty( + 'saved_objects.0.migrated', + true + ); + expect(migrator.migrateDocument).toHaveBeenCalledTimes( + noNamespaceSearchResults.hits.hits.length + ); + expect(migrator.migrateDocument).toHaveBeenCalledWith( + expect.objectContaining({ + type, + id: noNamespaceSearchResults.hits.hits[0]._id.replace( + /(index-pattern|config|globalType)\:/, + '' + ), + }) + ); + }); }); describe('search dsl', () => { @@ -4272,6 +4322,9 @@ describe('SavedObjectsRepository', () => { }, references: [], namespaces: ['default'], + coreMigrationVersion: expect.any(String), + typeMigrationVersion: expect.any(String), + managed: expect.any(Boolean), }); }); @@ -4300,6 +4353,20 @@ describe('SavedObjectsRepository', () => { expect(result).toMatchObject({ originId }); }); }); + + it('migrates the fetched document', async () => { + migrator.migrateDocument.mockReturnValueOnce( + 'migrated' as unknown as ReturnType + ); + await expect(getSuccess(client, repository, registry, type, id)).resolves.toBe('migrated'); + expect(migrator.migrateDocument).toHaveBeenCalledTimes(1); + expect(migrator.migrateDocument).toHaveBeenCalledWith( + expect.objectContaining({ + id, + type, + }) + ); + }); }); describe('#resolve', () => { diff --git a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/search/aggregations/validation.ts b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/search/aggregations/validation.ts index 214aba9a4a434..d5dfbb8e8cb1d 100644 --- a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/search/aggregations/validation.ts +++ b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/search/aggregations/validation.ts @@ -194,11 +194,9 @@ const recursiveRewrite = ( newValue = recursiveRewrite(value, nestedContext, [...parents, key]); } - return { - ...memo, - [newKey]: newValue, - }; - }, {}); + memo[newKey] = newValue; + return memo; + }, {} as Record); }; const childContext = (context: ValidationContext, path: string): ValidationContext => { diff --git a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/search/search_dsl/query_params.ts b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/search/search_dsl/query_params.ts index 8ff7bb229be36..dd7fdb272d072 100644 --- a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/search/search_dsl/query_params.ts +++ b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/lib/search/search_dsl/query_params.ts @@ -290,7 +290,7 @@ const getMatchPhrasePrefixFields = ({ fields = types.reduce((typeFields, type) => { const defaultSearchField = registry.getType(type)?.management?.defaultSearchField; if (defaultSearchField) { - return [...typeFields, `${type}.${defaultSearchField}`]; + typeFields.push(`${type}.${defaultSearchField}`); } return typeFields; }, [] as string[]); diff --git a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/test_helpers/repository.test.common.ts b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/test_helpers/repository.test.common.ts index 78d81a8b86be1..2cb4f32f441cb 100644 --- a/packages/core/saved-objects/core-saved-objects-api-server-internal/src/test_helpers/repository.test.common.ts +++ b/packages/core/saved-objects/core-saved-objects-api-server-internal/src/test_helpers/repository.test.common.ts @@ -582,6 +582,9 @@ export const expectBulkGetResult = ( attributes: doc._source![type], references: doc._source!.references || [], migrationVersion: doc._source!.migrationVersion, + managed: expect.any(Boolean), + coreMigrationVersion: expect.any(String), + typeMigrationVersion: expect.any(String), }); export const getMockBulkCreateResponse = ( diff --git a/packages/core/saved-objects/core-saved-objects-base-server-internal/index.ts b/packages/core/saved-objects/core-saved-objects-base-server-internal/index.ts index 6c260887614a7..5d14a4f9e4cbb 100644 --- a/packages/core/saved-objects/core-saved-objects-base-server-internal/index.ts +++ b/packages/core/saved-objects/core-saved-objects-base-server-internal/index.ts @@ -39,10 +39,12 @@ export type { KibanaMigratorStatus, MigrationResult, MigrationStatus, + MigrateDocumentOptions, } from './src/migration'; export { parseObjectKey, getObjectKey, getIndexForType } from './src/utils'; export { modelVersionVirtualMajor, + globalSwitchToModelVersionAt, assertValidModelVersion, isVirtualModelVersion, virtualVersionToModelVersion, @@ -64,4 +66,5 @@ export { getModelVersionDelta, buildModelVersionTransformFn, aggregateMappingAdditions, + convertModelVersionBackwardConversionSchema, } from './src/model_version'; diff --git a/packages/core/saved-objects/core-saved-objects-base-server-internal/src/migration/index.ts b/packages/core/saved-objects/core-saved-objects-base-server-internal/src/migration/index.ts index fe33846c41545..aa54e37f0d91a 100644 --- a/packages/core/saved-objects/core-saved-objects-base-server-internal/src/migration/index.ts +++ b/packages/core/saved-objects/core-saved-objects-base-server-internal/src/migration/index.ts @@ -11,4 +11,5 @@ export type { KibanaMigratorStatus, MigrationStatus, MigrationResult, + MigrateDocumentOptions, } from './kibana_migrator'; diff --git a/packages/core/saved-objects/core-saved-objects-base-server-internal/src/migration/kibana_migrator.ts b/packages/core/saved-objects/core-saved-objects-base-server-internal/src/migration/kibana_migrator.ts index de569332ff9ce..18a03a7fcbf54 100644 --- a/packages/core/saved-objects/core-saved-objects-base-server-internal/src/migration/kibana_migrator.ts +++ b/packages/core/saved-objects/core-saved-objects-base-server-internal/src/migration/kibana_migrator.ts @@ -49,7 +49,22 @@ export interface IKibanaMigrator { * @param doc - The saved object to migrate * @returns `doc` with all registered migrations applied. */ - migrateDocument(doc: SavedObjectUnsanitizedDoc): SavedObjectUnsanitizedDoc; + migrateDocument( + doc: SavedObjectUnsanitizedDoc, + options?: MigrateDocumentOptions + ): SavedObjectUnsanitizedDoc; +} + +/** + * Options for {@link IKibanaMigrator.migrateDocument} + * @internal + */ +export interface MigrateDocumentOptions { + /** + * Defines whether it is allowed to convert documents from an higher version or not. + * Defaults to `false`. + */ + allowDowngrade?: boolean; } /** @internal */ diff --git a/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/backward_conversion_schema.test.ts b/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/backward_conversion_schema.test.ts new file mode 100644 index 0000000000000..d70f86c37b6de --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/backward_conversion_schema.test.ts @@ -0,0 +1,131 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { schema } from '@kbn/config-schema'; +import { convertModelVersionBackwardConversionSchema } from './backward_conversion_schema'; +import type { + SavedObjectUnsanitizedDoc, + SavedObjectModelVersionForwardCompatibilityFn, +} from '@kbn/core-saved-objects-server'; + +describe('convertModelVersionBackwardConversionSchema', () => { + const createDoc = ( + parts: Partial> + ): SavedObjectUnsanitizedDoc => ({ + id: 'id', + type: 'type', + attributes: {}, + ...parts, + }); + + describe('using functions', () => { + it('converts the schema', () => { + const conversionSchema: jest.MockedFunction = + jest.fn(); + conversionSchema.mockImplementation((attrs) => attrs); + + const doc = createDoc({ attributes: { foo: 'bar' } }); + const converted = convertModelVersionBackwardConversionSchema(conversionSchema); + + const output = converted(doc); + + expect(conversionSchema).toHaveBeenCalledTimes(1); + expect(conversionSchema).toHaveBeenCalledWith({ foo: 'bar' }); + expect(output).toEqual(doc); + }); + + it('returns the document with the updated properties', () => { + const conversionSchema: jest.MockedFunction< + SavedObjectModelVersionForwardCompatibilityFn + > = jest.fn(); + conversionSchema.mockImplementation((attrs) => ({ foo: attrs.foo })); + + const doc = createDoc({ attributes: { foo: 'bar', hello: 'dolly' } }); + const converted = convertModelVersionBackwardConversionSchema(conversionSchema); + + const output = converted(doc); + + expect(output).toEqual({ + ...doc, + attributes: { foo: 'bar' }, + }); + }); + + it('throws if the function throws', () => { + const conversionSchema: jest.MockedFunction< + SavedObjectModelVersionForwardCompatibilityFn + > = jest.fn(); + conversionSchema.mockImplementation(() => { + throw new Error('dang'); + }); + + const doc = createDoc({}); + const converted = convertModelVersionBackwardConversionSchema(conversionSchema); + + expect(() => converted(doc)).toThrowErrorMatchingInlineSnapshot(`"dang"`); + }); + }); + + describe('using config-schemas', () => { + it('converts the schema', () => { + const conversionSchema = schema.object( + { + foo: schema.maybe(schema.string()), + }, + { unknowns: 'ignore' } + ); + const validateSpy = jest.spyOn(conversionSchema, 'validate'); + + const doc = createDoc({ attributes: { foo: 'bar' } }); + const converted = convertModelVersionBackwardConversionSchema(conversionSchema); + + const output = converted(doc); + + expect(validateSpy).toHaveBeenCalledTimes(1); + expect(validateSpy).toHaveBeenCalledWith({ foo: 'bar' }, {}); + expect(output).toEqual(doc); + }); + + it('returns the document with the updated properties', () => { + const conversionSchema = schema.object( + { + foo: schema.maybe(schema.string()), + }, + { unknowns: 'ignore' } + ); + + const doc = createDoc({ attributes: { foo: 'bar', hello: 'dolly' } }); + const converted = convertModelVersionBackwardConversionSchema(conversionSchema); + + const output = converted(doc); + + expect(output).toEqual({ + ...doc, + attributes: { + foo: 'bar', + }, + }); + }); + + it('throws if the validation throws', () => { + const conversionSchema = schema.object( + { + foo: schema.maybe(schema.string()), + }, + { unknowns: 'forbid' } + ); + + const doc = createDoc({ attributes: { foo: 'bar', hello: 'dolly' } }); + const converted = convertModelVersionBackwardConversionSchema(conversionSchema); + + expect(() => converted(doc)).toThrowErrorMatchingInlineSnapshot( + `"[hello]: definition for this key is missing"` + ); + }); + }); +}); diff --git a/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/backward_conversion_schema.ts b/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/backward_conversion_schema.ts new file mode 100644 index 0000000000000..c3b7664b61ada --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/backward_conversion_schema.ts @@ -0,0 +1,43 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { isConfigSchema, type ObjectType } from '@kbn/config-schema'; +import type { + SavedObjectUnsanitizedDoc, + SavedObjectModelVersionForwardCompatibilitySchema, +} from '@kbn/core-saved-objects-server'; + +function isObjectType( + schema: SavedObjectModelVersionForwardCompatibilitySchema +): schema is ObjectType { + return isConfigSchema(schema); +} + +export type ConvertedSchema = (doc: SavedObjectUnsanitizedDoc) => SavedObjectUnsanitizedDoc; + +export const convertModelVersionBackwardConversionSchema = ( + schema: SavedObjectModelVersionForwardCompatibilitySchema +): ConvertedSchema => { + if (isObjectType(schema)) { + return (doc) => { + const attrs = schema.validate(doc.attributes, {}); + return { + ...doc, + attributes: attrs, + }; + }; + } else { + return (doc) => { + const attrs = schema(doc.attributes); + return { + ...doc, + attributes: attrs, + }; + }; + } +}; diff --git a/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/constants.ts b/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/constants.ts index f3f8ace3a142b..8a749f6dc1399 100644 --- a/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/constants.ts +++ b/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/constants.ts @@ -10,3 +10,8 @@ * The major version that is used to represent model versions. */ export const modelVersionVirtualMajor = 10; + +/** + * The stack version where all types will be forced to switch to using the model version system. + */ +export const globalSwitchToModelVersionAt = '8.10.0'; diff --git a/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/index.ts b/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/index.ts index c3899e91a38d2..350ab86ca2980 100644 --- a/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/index.ts +++ b/packages/core/saved-objects/core-saved-objects-base-server-internal/src/model_version/index.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -export { modelVersionVirtualMajor } from './constants'; +export { modelVersionVirtualMajor, globalSwitchToModelVersionAt } from './constants'; export { assertValidModelVersion, isVirtualModelVersion, @@ -36,3 +36,4 @@ export { export { getModelVersionDelta } from './get_version_delta'; export { buildModelVersionTransformFn } from './build_transform_fn'; export { aggregateMappingAdditions } from './aggregate_model_changes'; +export { convertModelVersionBackwardConversionSchema } from './backward_conversion_schema'; diff --git a/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/saved_objects_importer.ts b/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/saved_objects_importer.ts index 2c87395c255cd..d6ceeb7fd87cb 100644 --- a/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/saved_objects_importer.ts +++ b/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/saved_objects_importer.ts @@ -41,10 +41,7 @@ export class SavedObjectsImporter implements ISavedObjectsImporter { this.#importSizeLimit = importSizeLimit; this.#importHooks = typeRegistry.getAllTypes().reduce((hooks, type) => { if (type.management?.onImport) { - return { - ...hooks, - [type.name]: [type.management.onImport], - }; + hooks[type.name] = [type.management.onImport]; } return hooks; }, {} as Record); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/__snapshots__/get_outdated_documents_query.test.ts.snap b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/__snapshots__/get_outdated_documents_query.test.ts.snap new file mode 100644 index 0000000000000..d077876f72bb2 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/__snapshots__/get_outdated_documents_query.test.ts.snap @@ -0,0 +1,175 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`getOutdatedDocumentsQuery should not select documents if there are no migrations 1`] = ` +Object { + "bool": Object { + "should": Array [], + }, +} +`; + +exports[`getOutdatedDocumentsQuery should select documents with outdated both core and type migration versions 1`] = ` +Object { + "bool": Object { + "should": Array [ + Object { + "bool": Object { + "must": Array [ + Object { + "term": Object { + "type": "dashboard", + }, + }, + Object { + "bool": Object { + "should": Array [ + Object { + "range": Object { + "coreMigrationVersion": Object { + "lt": "8.8.0", + }, + }, + }, + Object { + "bool": Object { + "must_not": Array [ + Object { + "exists": Object { + "field": "typeMigrationVersion", + }, + }, + Object { + "exists": Object { + "field": "migrationVersion.dashboard", + }, + }, + ], + }, + }, + Object { + "bool": Object { + "must": Object { + "exists": Object { + "field": "migrationVersion", + }, + }, + "must_not": Object { + "term": Object { + "migrationVersion.dashboard": "7.7.0", + }, + }, + }, + }, + Object { + "range": Object { + "typeMigrationVersion": Object { + "lt": "7.7.0", + }, + }, + }, + ], + }, + }, + ], + }, + }, + ], + }, +} +`; + +exports[`getOutdatedDocumentsQuery should select documents with outdated core migration version 1`] = ` +Object { + "bool": Object { + "should": Array [ + Object { + "bool": Object { + "must": Array [ + Object { + "term": Object { + "type": "dashboard", + }, + }, + Object { + "bool": Object { + "should": Array [ + Object { + "range": Object { + "coreMigrationVersion": Object { + "lt": "8.8.0", + }, + }, + }, + ], + }, + }, + ], + }, + }, + ], + }, +} +`; + +exports[`getOutdatedDocumentsQuery should select documents with outdated type migration version 1`] = ` +Object { + "bool": Object { + "should": Array [ + Object { + "bool": Object { + "must": Array [ + Object { + "term": Object { + "type": "dashboard", + }, + }, + Object { + "bool": Object { + "should": Array [ + Object { + "bool": Object { + "must_not": Array [ + Object { + "exists": Object { + "field": "typeMigrationVersion", + }, + }, + Object { + "exists": Object { + "field": "migrationVersion.dashboard", + }, + }, + ], + }, + }, + Object { + "bool": Object { + "must": Object { + "exists": Object { + "field": "migrationVersion", + }, + }, + "must_not": Object { + "term": Object { + "migrationVersion.dashboard": "7.7.0", + }, + }, + }, + }, + Object { + "range": Object { + "typeMigrationVersion": Object { + "lt": "7.7.0", + }, + }, + }, + ], + }, + }, + ], + }, + }, + ], + }, +} +`; diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/cleanup_unknown_and_excluded.mocks.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/cleanup_unknown_and_excluded.mocks.ts index 1b0e0a49e5062..54fb9902cc53e 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/cleanup_unknown_and_excluded.mocks.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/cleanup_unknown_and_excluded.mocks.ts @@ -97,6 +97,11 @@ export const initialExcludeOnUpgradeQueryMock = { type: 'ml-telemetry', }, }, + { + term: { + type: 'osquery-manager-usage-metric', + }, + }, { term: { type: 'osquery-usage-metric', diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/create_index.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/create_index.ts index 0e68b0cef14c5..399be22d6b678 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/create_index.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/create_index.ts @@ -146,25 +146,21 @@ export const createIndex = ({ AcknowledgeResponse, 'create_index_succeeded' >((res) => { - if (res.acknowledged && res.shardsAcknowledged) { - // If the cluster state was updated and all shards started we're done - return TaskEither.right('create_index_succeeded'); - } else { - // Otherwise, wait until the target index has a 'green' status meaning - // the primary (and on multi node clusters) the replica has been started - return pipe( - waitForIndexStatus({ - client, - index: indexName, - timeout: DEFAULT_TIMEOUT, - status: 'green', - }), - TaskEither.map(() => { - /** When the index status is 'green' we know that all shards were started */ - return 'create_index_succeeded'; - }) - ); - } + // Systematicaly wait until the target index has a 'green' status meaning + // the primary (and on multi node clusters) the replica has been started + // see https://github.com/elastic/kibana/issues/157968 + return pipe( + waitForIndexStatus({ + client, + index: indexName, + timeout: DEFAULT_TIMEOUT, + status: 'green', + }), + TaskEither.map(() => { + /** When the index status is 'green' we know that all shards were started */ + return 'create_index_succeeded'; + }) + ); }) ); }; diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/read_with_pit.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/read_with_pit.test.ts index 3092561c7ba0b..181ae3d8b6a98 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/read_with_pit.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/read_with_pit.test.ts @@ -79,7 +79,7 @@ describe('readWithPit', () => { } await expect(task()).resolves.toEqual({ _tag: 'Left', - left: { type: 'es_response_too_large' }, + left: { contentLength: 536870889, type: 'es_response_too_large' }, }); }); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/reindex.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/reindex.test.ts index d5d03bbabb405..50f1b039ef1c1 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/reindex.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/reindex.test.ts @@ -18,19 +18,18 @@ describe('reindex', () => { jest.clearAllMocks(); }); - // Create a mock client that rejects all methods with a 503 status code - // response. - const retryableError = new EsErrors.ResponseError( - elasticsearchClientMock.createApiResponse({ - statusCode: 503, - body: { error: { type: 'es_type', reason: 'es_reason' } }, - }) - ); - const client = elasticsearchClientMock.createInternalClient( - elasticsearchClientMock.createErrorTransportRequestPromise(retryableError) - ); - it('calls catchRetryableEsClientErrors when the promise rejects', async () => { + // Create a mock client that rejects all methods with a 503 status code + // response. + const retryableError = new EsErrors.ResponseError( + elasticsearchClientMock.createApiResponse({ + statusCode: 503, + body: { error: { type: 'es_type', reason: 'es_reason' } }, + }) + ); + const client = elasticsearchClientMock.createInternalClient( + elasticsearchClientMock.createErrorTransportRequestPromise(retryableError) + ); const task = reindex({ client, sourceIndex: 'my_source_index', @@ -47,4 +46,47 @@ describe('reindex', () => { } expect(catchRetryableEsClientErrors).toHaveBeenCalledWith(retryableError); }); + + it('passes options to Elasticsearch client', async () => { + const client = elasticsearchClientMock.createInternalClient( + elasticsearchClientMock.createSuccessTransportRequestPromise({ + hits: { + total: 0, + hits: [], + }, + }) + ); + const task = reindex({ + client, + sourceIndex: 'my_source_index', + targetIndex: 'my_target_index', + reindexScript: Option.some('my script'), + requireAlias: false, + excludeOnUpgradeQuery: { match_all: {} }, + batchSize: 99, + }); + try { + await task(); + } catch (e) { + /** ignore */ + } + expect(client.reindex).toHaveBeenCalledTimes(1); + expect(client.reindex).toHaveBeenCalledWith( + expect.objectContaining({ + body: { + conflicts: 'proceed', + source: { + index: 'my_source_index', + size: 99, + query: { match_all: {} }, + }, + dest: { + index: 'my_target_index', + op_type: 'create', + }, + script: { lang: 'painless', source: 'my script' }, + }, + }) + ); + }); }); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/reindex.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/reindex.ts index b64631d3b87f6..6ce4d74e728c0 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/reindex.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/reindex.ts @@ -33,6 +33,7 @@ export interface ReindexParams { * index for backup purposes, but won't be available in the upgraded index. */ excludeOnUpgradeQuery: QueryDslQueryContainer; + /** Number of documents Elasticsearch will read/write in each batch */ batchSize: number; } diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/build_types_mappings.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/build_types_mappings.ts index 6c78ae52550c5..18aa689149c24 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/build_types_mappings.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/build_types_mappings.ts @@ -15,14 +15,12 @@ import type { SavedObjectsTypeMappingDefinitions } from '@kbn/core-saved-objects export const buildTypesMappings = ( types: SavedObjectsType[] ): SavedObjectsTypeMappingDefinitions => { - return types.reduce((acc, { name: type, mappings }) => { + return types.reduce((acc, { name: type, mappings }) => { const duplicate = acc.hasOwnProperty(type); if (duplicate) { throw new Error(`Type ${type} is already defined.`); } - return { - ...acc, - [type]: mappings, - }; + acc[type] = mappings; + return acc; }, {}); }; diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.test.mocks.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.test.mocks.ts index ef63b7834e433..1fa2bd5f84c7c 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.test.mocks.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.test.mocks.ts @@ -17,9 +17,11 @@ jest.doMock('./internal_transforms', () => ({ })); export const getModelVersionTransformsMock = jest.fn(); +export const getModelVersionSchemasMock = jest.fn(); jest.doMock('./model_version', () => ({ getModelVersionTransforms: getModelVersionTransformsMock, + getModelVersionSchemas: getModelVersionSchemasMock, })); export const validateTypeMigrationsMock = jest.fn(); @@ -33,5 +35,6 @@ export const resetAllMocks = () => { getReferenceTransformsMock.mockReset().mockReturnValue([]); getConversionTransformsMock.mockReset().mockReturnValue([]); getModelVersionTransformsMock.mockReset().mockReturnValue([]); + getModelVersionSchemasMock.mockReset().mockReturnValue({}); validateTypeMigrationsMock.mockReset(); }; diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.test.ts index 5837e9860456e..af71b8d369bd9 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.test.ts @@ -10,6 +10,7 @@ import { getCoreTransformsMock, getConversionTransformsMock, getModelVersionTransformsMock, + getModelVersionSchemasMock, getReferenceTransformsMock, resetAllMocks, validateTypeMigrationsMock, @@ -39,17 +40,20 @@ describe('buildActiveMigrations', () => { ...parts, }); - const transform = (type: TransformType, version: string): Transform => ({ + const transform = (type: TransformType, version: string, deferred?: boolean): Transform => ({ + ...(deferred != null ? { deferred } : {}), version, transformType: type, transform: jest.fn(), }); - const expectTransform = (type: TransformType, version: string): Transform => ({ - version, - transformType: type, - transform: expect.any(Function), - }); + const expectTransform = (type: TransformType, version: string, deferred?: boolean): Transform => + expect.objectContaining({ + ...(deferred != null ? { deferred } : {}), + version, + transformType: type, + transform: expect.any(Function), + }); const addType = (parts: Partial) => { typeRegistry.registerType(createType(parts)); @@ -123,7 +127,14 @@ describe('buildActiveMigrations', () => { migrations: { '7.12.0': jest.fn(), '7.16.0': jest.fn(), - '8.3.0': jest.fn(), + '8.3.0': { + transform: jest.fn(), + }, + '8.4.0': { + // @ts-expect-error + deferred: true, + transform: jest.fn(), + }, }, }); @@ -131,9 +142,10 @@ describe('buildActiveMigrations', () => { expect(Object.keys(migrations).sort()).toEqual(['foo']); expect(migrations.foo.transforms).toEqual([ - expectTransform(TransformType.Migrate, '7.12.0'), - expectTransform(TransformType.Migrate, '7.16.0'), - expectTransform(TransformType.Migrate, '8.3.0'), + expectTransform(TransformType.Migrate, '7.12.0', false), + expectTransform(TransformType.Migrate, '7.16.0', false), + expectTransform(TransformType.Migrate, '8.3.0', false), + expectTransform(TransformType.Migrate, '8.4.0', true), ]); }); }); @@ -184,6 +196,60 @@ describe('buildActiveMigrations', () => { }); }); + describe('model version schemas', () => { + it('calls getModelVersionSchemas with the correct parameters', () => { + const foo = createType({ name: 'foo' }); + const bar = createType({ name: 'bar' }); + + addType(foo); + addType(bar); + + buildMigrations(); + + expect(getModelVersionSchemasMock).toHaveBeenCalledTimes(2); + expect(getModelVersionSchemasMock).toHaveBeenNthCalledWith(1, { + typeDefinition: foo, + }); + expect(getModelVersionSchemasMock).toHaveBeenNthCalledWith(2, { + typeDefinition: bar, + }); + }); + + it('adds the schemas from getModelVersionSchemas to each type', () => { + const foo = createType({ name: 'foo' }); + const bar = createType({ name: 'bar' }); + + addType(foo); + addType(bar); + + getModelVersionSchemasMock.mockImplementation( + ({ typeDefinition }: { typeDefinition: SavedObjectsType }) => { + if (typeDefinition.name === 'foo') { + return { + '7.10.0': jest.fn(), + }; + } else { + return { + '8.3.0': jest.fn(), + '8.4.0': jest.fn(), + }; + } + } + ); + + const migrations = buildMigrations(); + + expect(Object.keys(migrations).sort()).toEqual(['bar', 'foo']); + expect(migrations.foo.versionSchemas).toEqual({ + '7.10.0': expect.any(Function), + }); + expect(migrations.bar.versionSchemas).toEqual({ + '8.3.0': expect.any(Function), + '8.4.0': expect.any(Function), + }); + }); + }); + describe('internal transforms', () => { it('calls getReferenceTransforms with the correct parameters', () => { const foo = createType({ name: 'foo' }); @@ -339,4 +405,71 @@ describe('buildActiveMigrations', () => { ]); }); }); + + describe('versions', () => { + it('returns the latest migrations versions', () => { + addType({ + name: 'foo', + migrations: { + '7.12.0': jest.fn(), + '7.16.0': jest.fn(), + '8.3.0': jest.fn(), + }, + }); + getCoreTransformsMock.mockReturnValue([ + transform(TransformType.Core, '8.8.0'), + transform(TransformType.Core, '8.9.0'), + ]); + getReferenceTransformsMock.mockReturnValue([ + transform(TransformType.Reference, '7.12.0'), + transform(TransformType.Reference, '7.17.3'), + ]); + getConversionTransformsMock.mockReturnValue([ + transform(TransformType.Convert, '7.14.0'), + transform(TransformType.Convert, '7.15.0'), + ]); + + expect(buildMigrations()).toHaveProperty( + 'foo.latestVersion', + expect.objectContaining({ + [TransformType.Convert]: '7.15.0', + [TransformType.Core]: '8.9.0', + [TransformType.Migrate]: '8.3.0', + [TransformType.Reference]: '7.17.3', + }) + ); + }); + + it('returns the latest not deferred migrations versions', () => { + addType({ + name: 'foo', + migrations: { + '7.12.0': { + // @ts-expect-error + deferred: true, + transform: jest.fn(), + }, + '7.16.0': jest.fn(), + '8.3.0': { + // @ts-expect-error + deferred: true, + transform: jest.fn(), + }, + }, + }); + getCoreTransformsMock.mockReturnValue([ + transform(TransformType.Core, '8.7.0', true), + transform(TransformType.Core, '8.8.0'), + transform(TransformType.Core, '8.9.0', true), + ]); + + expect(buildMigrations()).toHaveProperty( + 'foo.immediateVersion', + expect.objectContaining({ + [TransformType.Core]: '8.8.0', + [TransformType.Migrate]: '7.16.0', + }) + ); + }); + }); }); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.ts index d09e9996be64d..879616fe26869 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.ts @@ -17,7 +17,7 @@ import { } from './internal_transforms'; import { validateTypeMigrations } from './validate_migrations'; import { transformComparator, convertMigrationFunction } from './utils'; -import { getModelVersionTransforms } from './model_version'; +import { getModelVersionTransforms, getModelVersionSchemas } from './model_version'; /** * Converts migrations from a format that is convenient for callers to a format that @@ -36,7 +36,6 @@ export function buildActiveMigrations({ convertVersion?: string; log: Logger; }): ActiveMigrations { - const coreTransforms = getCoreTransforms(); const referenceTransforms = getReferenceTransforms(typeRegistry); return typeRegistry.getAllTypes().reduce((migrations, type) => { @@ -46,31 +45,25 @@ export function buildActiveMigrations({ type, log, kibanaVersion, - coreTransforms, referenceTransforms, }); - if (!typeTransforms.transforms.length) { - return migrations; + if (typeTransforms.transforms.length || Object.keys(typeTransforms.versionSchemas).length) { + migrations[type.name] = typeTransforms; } - return { - ...migrations, - [type.name]: typeTransforms, - }; + return migrations; }, {} as ActiveMigrations); } const buildTypeTransforms = ({ type, log, - coreTransforms, referenceTransforms, }: { type: SavedObjectsType; kibanaVersion: string; log: Logger; - coreTransforms: Transform[]; referenceTransforms: Transform[]; }): TypeTransforms => { const migrationsMap = @@ -79,11 +72,13 @@ const buildTypeTransforms = ({ const migrationTransforms = Object.entries(migrationsMap ?? {}).map( ([version, transform]) => ({ version, + deferred: !_.isFunction(transform) && !!transform.deferred, transform: convertMigrationFunction(version, type, transform, log), transformType: TransformType.Migrate, }) ); + const coreTransforms = getCoreTransforms({ log, type }); const modelVersionTransforms = getModelVersionTransforms({ log, typeDefinition: type }); const conversionTransforms = getConversionTransforms(type); @@ -95,11 +90,26 @@ const buildTypeTransforms = ({ ...modelVersionTransforms, ].sort(transformComparator); + const modelVersionSchemas = getModelVersionSchemas({ typeDefinition: type }); + return { + immediateVersion: _.chain(transforms) + .groupBy('transformType') + .mapValues((items) => + _.chain(items) + .filter(({ deferred }) => !deferred) + .last() + .get('version') + .value() + ) + .value() as Record, latestVersion: _.chain(transforms) .groupBy('transformType') .mapValues((items) => _.last(items)?.version) .value() as Record, transforms, + versionSchemas: { + ...modelVersionSchemas, + }, }; }; diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts index a17e7965bacde..2e3a99b4b463e 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts @@ -25,18 +25,18 @@ const mockLoggerFactory = loggingSystemMock.create(); const mockLogger = mockLoggerFactory.get('mock logger'); const kibanaVersion = '25.2.3'; +const createType = (parts: Partial): SavedObjectsType => ({ + name: 'unknown', + namespaceType: 'single', + hidden: false, + mappings: { properties: {} }, + migrations: {}, + ...parts, +}); + const createRegistry = (...types: Array>) => { const registry = new SavedObjectTypeRegistry(); - types.forEach((type) => - registry.registerType({ - name: 'unknown', - namespaceType: 'single', - hidden: false, - mappings: { properties: {} }, - migrations: {}, - ...type, - }) - ); + types.forEach((type) => registry.registerType(createType(type))); registry.registerType({ name: LEGACY_URL_ALIAS_TYPE, namespaceType: 'agnostic', @@ -635,7 +635,7 @@ describe('DocumentMigrator', () => { ), }); migrator.prepareMigrations(); - expect(migrator.migrationVersion).toEqual({ + expect(migrator.getMigrationVersion()).toEqual({ aaa: '10.4.0', bbb: '3.2.3', ccc: '11.0.0', @@ -643,6 +643,47 @@ describe('DocumentMigrator', () => { }); }); + test('extracts the latest non-deferred migration version info', () => { + const migrator = new DocumentMigrator({ + ...testOpts(), + typeRegistry: createRegistry({ + name: 'aaa', + migrations: { + '1.2.3': (doc: SavedObjectUnsanitizedDoc) => doc, + '2.2.1': (doc: SavedObjectUnsanitizedDoc) => doc, + '10.4.0': { + // @ts-expect-error + deferred: true, + transform: (doc: SavedObjectUnsanitizedDoc) => doc, + }, + }, + }), + }); + migrator.prepareMigrations(); + expect(migrator.getMigrationVersion({ includeDeferred: false })).toHaveProperty( + 'aaa', + '2.2.1' + ); + }); + + test('extracts the latest core migration version info', () => { + const migrator = new DocumentMigrator({ + ...testOpts(), + typeRegistry: createRegistry({ + name: 'aaa', + migrations: { + '1.2.3': (doc: SavedObjectUnsanitizedDoc) => doc, + '2.2.1': (doc: SavedObjectUnsanitizedDoc) => doc, + }, + }), + }); + migrator.prepareMigrations(); + expect(migrator.getMigrationVersion({ migrationType: 'core' })).toHaveProperty( + 'aaa', + '8.8.0' + ); + }); + describe('conversion to multi-namespace type', () => { it('assumes documents w/ undefined typeMigrationVersion and correct coreMigrationVersion are up to date', () => { const migrator = new DocumentMigrator({ @@ -1336,6 +1377,95 @@ describe('DocumentMigrator', () => { }); }); }); + + describe('down migration', () => { + it('accepts to downgrade the document if `allowDowngrade` is true', () => { + const registry = createRegistry({}); + + const fooType = createType({ + name: 'foo', + switchToModelVersionAt: '8.5.0', + modelVersions: { + 1: { + changes: [], + schemas: { + forwardCompatibility: (attrs: any) => { + return { + foo: attrs.foo, + }; + }, + }, + }, + }, + }); + registry.registerType(fooType); + + const migrator = new DocumentMigrator({ + ...testOpts(), + typeRegistry: registry, + }); + migrator.prepareMigrations(); + + const document: SavedObjectUnsanitizedDoc = { + id: 'smelly', + type: 'foo', + attributes: { + foo: 'bar', + hello: 'dolly', + }, + typeMigrationVersion: '10.2.0', + }; + + const migrated = migrator.migrate(document, { allowDowngrade: true }); + + expect(migrated).toHaveProperty('typeMigrationVersion', '10.1.0'); + expect(migrated.attributes).toEqual({ foo: 'bar' }); + }); + + it('throws when trying to downgrade if `allowDowngrade` is false', () => { + const registry = createRegistry({}); + + const fooType = createType({ + name: 'foo', + switchToModelVersionAt: '8.5.0', + modelVersions: { + 1: { + changes: [], + schemas: { + forwardCompatibility: (attrs: any) => { + return { + foo: attrs.foo, + }; + }, + }, + }, + }, + }); + registry.registerType(fooType); + + const migrator = new DocumentMigrator({ + ...testOpts(), + typeRegistry: registry, + }); + migrator.prepareMigrations(); + + const document: SavedObjectUnsanitizedDoc = { + id: 'smelly', + type: 'foo', + attributes: { + foo: 'bar', + hello: 'dolly', + }, + typeMigrationVersion: '10.2.0', + }; + + expect(() => + migrator.migrate(document, { allowDowngrade: false }) + ).toThrowErrorMatchingInlineSnapshot( + `"Document \\"smelly\\" belongs to a more recent version of Kibana [10.2.0] when the last known version is [10.1.0]."` + ); + }); + }); }); function renameAttr(path: string, newPath: string) { diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.ts index 2d10ff278e7c6..8ca15093d5827 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +import Boom from '@hapi/boom'; import type { Logger } from '@kbn/logging'; import type { SavedObjectsMigrationVersion } from '@kbn/core-saved-objects-common'; import type { @@ -16,9 +17,25 @@ import type { ActiveMigrations } from './types'; import { maxVersion } from './pipelines/utils'; import { buildActiveMigrations } from './build_active_migrations'; import { DocumentUpgradePipeline, DocumentDowngradePipeline } from './pipelines'; +import { downgradeRequired } from './utils'; +import { TransformType } from './types'; + +/** + * Options for {@link VersionedTransformer.migrate} + */ +export interface DocumentMigrateOptions { + /** + * Defines whether it is allowed to convert documents from an higher version or not. + * - If `true`, documents from higher versions will go though the downgrade pipeline. + * - If `false`, an error will be thrown when trying to process a document with an higher type version. + * Defaults to `false`. + */ + allowDowngrade?: boolean; +} interface TransformOptions { convertNamespaceTypes?: boolean; + allowDowngrade?: boolean; } interface DocumentMigratorOptions { @@ -28,6 +45,20 @@ interface DocumentMigratorOptions { log: Logger; } +interface MigrationVersionParams { + /** + * Include deferred migrations in the migrationVersion. + * @default true + */ + includeDeferred?: boolean; + + /** + * Migration type to use in the migrationVersion. + * @default 'type' + */ + migrationType?: 'core' | 'type'; +} + /** * Manages transformations of individual documents. */ @@ -35,23 +66,23 @@ export interface VersionedTransformer { /** * Migrates a document to its latest version. */ - migrate: (doc: SavedObjectUnsanitizedDoc) => SavedObjectUnsanitizedDoc; + migrate( + doc: SavedObjectUnsanitizedDoc, + options?: DocumentMigrateOptions + ): SavedObjectUnsanitizedDoc; + /** * Migrates a document to the latest version and applies type conversions if applicable. * Also returns any additional document(s) that may have been created during the transformation process. + * + * @remark This only be used by the savedObject migration during upgrade. For all other scenarios, + * {@link VersionedTransformer#migrate} should be used instead. */ - migrateAndConvert: (doc: SavedObjectUnsanitizedDoc) => SavedObjectUnsanitizedDoc[]; - /** - * Converts a document down to the specified version. - */ - transformDown: ( - doc: SavedObjectUnsanitizedDoc, - options: { targetTypeVersion: string } - ) => SavedObjectUnsanitizedDoc; + migrateAndConvert(doc: SavedObjectUnsanitizedDoc): SavedObjectUnsanitizedDoc[]; } /** - * A concrete implementation of the VersionedTransformer interface. + * A concrete implementation of the {@link VersionedTransformer} interface. */ export class DocumentMigrator implements VersionedTransformer { private options: DocumentMigratorOptions; @@ -68,30 +99,42 @@ export class DocumentMigrator implements VersionedTransformer { */ constructor(options: DocumentMigratorOptions) { this.options = options; + this.migrate = (...args) => this.constructor.prototype.migrate.apply(this, args); + this.migrateAndConvert = (...args) => + this.constructor.prototype.migrateAndConvert.apply(this, args); } /** - * Gets the latest version of each migrate-able property. + * Gets the latest pending version of each type. + * Some migration objects won't have a latest migration version (they only contain reference transforms that are applied from other types). */ - public get migrationVersion(): SavedObjectsMigrationVersion { + public getMigrationVersion({ + includeDeferred = true, + migrationType = 'type', + }: MigrationVersionParams = {}): SavedObjectsMigrationVersion { if (!this.migrations) { throw new Error('Migrations are not ready. Make sure prepareMigrations is called first.'); } - return Object.entries(this.migrations).reduce((acc, [prop, { latestVersion }]) => { - // some migration objects won't have a latest migration version (they only contain reference transforms that are applied from other types) - const latestMigrationVersion = maxVersion(latestVersion.migrate, latestVersion.convert); - if (latestMigrationVersion) { - return { ...acc, [prop]: latestMigrationVersion }; - } - return acc; - }, {}); + return Object.entries(this.migrations).reduce( + (acc, [type, { latestVersion, immediateVersion }]) => { + const version = includeDeferred ? latestVersion : immediateVersion; + const latestMigrationVersion = + migrationType === 'core' ? version.core : maxVersion(version.migrate, version.convert); + + if (latestMigrationVersion) { + acc[type] = latestMigrationVersion; + } + return acc; + }, + {} + ); } /** * Prepares active migrations and document transformer function. */ - public prepareMigrations = () => { + public prepareMigrations() { const { typeRegistry, kibanaVersion, log, convertVersion } = this.options; this.migrations = buildActiveMigrations({ typeRegistry, @@ -99,48 +142,58 @@ export class DocumentMigrator implements VersionedTransformer { log, convertVersion, }); - }; + } /** * Migrates a document to the latest version. */ - public migrate = (doc: SavedObjectUnsanitizedDoc): SavedObjectUnsanitizedDoc => { - const { document } = this.transform(doc); - + public migrate( + doc: SavedObjectUnsanitizedDoc, + { allowDowngrade = false }: DocumentMigrateOptions = {} + ): SavedObjectUnsanitizedDoc { + const { document } = this.transform(doc, { + allowDowngrade, + }); return document; - }; + } /** * Migrates a document to the latest version and applies type conversions if applicable. Also returns any additional document(s) that may * have been created during the transformation process. */ - public migrateAndConvert = (doc: SavedObjectUnsanitizedDoc): SavedObjectUnsanitizedDoc[] => { - const { document, additionalDocs } = this.transform(doc, { convertNamespaceTypes: true }); - + public migrateAndConvert(doc: SavedObjectUnsanitizedDoc): SavedObjectUnsanitizedDoc[] { + const { document, additionalDocs } = this.transform(doc, { + convertNamespaceTypes: true, + allowDowngrade: false, + }); return [document, ...additionalDocs]; - }; + } - public transformDown = ( + private transform( doc: SavedObjectUnsanitizedDoc, - options: { targetTypeVersion: string } - ): SavedObjectUnsanitizedDoc => { + { convertNamespaceTypes = false, allowDowngrade = false }: TransformOptions = {} + ) { if (!this.migrations) { throw new Error('Migrations are not ready. Make sure prepareMigrations is called first.'); } + const typeMigrations = this.migrations[doc.type]; + if (downgradeRequired(doc, typeMigrations?.latestVersion ?? {})) { + const currentVersion = doc.typeMigrationVersion ?? doc.migrationVersion?.[doc.type]; + const latestVersion = this.migrations[doc.type].latestVersion[TransformType.Migrate]; + if (!allowDowngrade) { + throw Boom.badData( + `Document "${doc.id}" belongs to a more recent version of Kibana [${currentVersion}] when the last known version is [${latestVersion}].` + ); + } + return this.transformDown(doc, { targetTypeVersion: latestVersion! }); + } else { + return this.transformUp(doc, { convertNamespaceTypes }); + } + } - const pipeline = new DocumentDowngradePipeline({ - document: doc, - typeTransforms: this.migrations[doc.type], - kibanaVersion: this.options.kibanaVersion, - targetTypeVersion: options.targetTypeVersion, - }); - const { document } = pipeline.run(); - return document; - }; - - private transform( + private transformUp( doc: SavedObjectUnsanitizedDoc, - { convertNamespaceTypes = false }: TransformOptions = {} + { convertNamespaceTypes }: { convertNamespaceTypes: boolean } ) { if (!this.migrations) { throw new Error('Migrations are not ready. Make sure prepareMigrations is called first.'); @@ -156,4 +209,23 @@ export class DocumentMigrator implements VersionedTransformer { return { document, additionalDocs }; } + + private transformDown = ( + doc: SavedObjectUnsanitizedDoc, + { targetTypeVersion }: { targetTypeVersion: string } + ) => { + if (!this.migrations) { + throw new Error('Migrations are not ready. Make sure prepareMigrations is called first.'); + } + + const pipeline = new DocumentDowngradePipeline({ + document: doc, + targetTypeVersion, + typeTransforms: this.migrations[doc.type], + kibanaVersion: this.options.kibanaVersion, + }); + const { document } = pipeline.run(); + const additionalDocs: SavedObjectUnsanitizedDoc[] = []; + return { document, additionalDocs }; + }; } diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts index a913139665567..762fa20342c49 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +import { isFunction } from 'lodash'; import { ISavedObjectTypeRegistry, SavedObjectsType, @@ -16,16 +17,25 @@ import { LEGACY_URL_ALIAS_TYPE, LegacyUrlAlias, } from '@kbn/core-saved-objects-base-server-internal'; +import { Logger } from '@kbn/logging'; import { migrations as coreMigrationsMap } from './migrations'; import { type Transform, TransformType } from './types'; +import { convertMigrationFunction } from './utils'; /** * Returns all available core transforms for all object types. */ -export function getCoreTransforms(): Transform[] { +export function getCoreTransforms({ + type, + log, +}: { + type: SavedObjectsType; + log: Logger; +}): Transform[] { return Object.entries(coreMigrationsMap).map(([version, transform]) => ({ version, - transform, + deferred: !isFunction(transform) && !!transform.deferred, + transform: convertMigrationFunction(version, type, transform, log), transformType: TransformType.Core, })); } diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/index.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/index.ts index 04b33a5cc2ac2..f3289bf97379e 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/index.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/index.ts @@ -6,17 +6,11 @@ * Side Public License, v 1. */ -import { flow } from 'lodash'; -import get from 'lodash/fp/get'; -import { TransformFn } from '../types'; +import type { SavedObjectMigrationMap } from '@kbn/core-saved-objects-server'; +import { mergeSavedObjectMigrations } from '@kbn/core-saved-objects-utils-server'; import { transformMigrationVersion } from './transform_migration_version'; import { transformSetManagedDefault } from './transform_set_managed_default'; -export const migrations = { - '8.8.0': flow( - transformMigrationVersion, - // extract transformedDoc from TransformResult as input to next transform - get('transformedDoc'), - transformSetManagedDefault - ), -} as Record; +export const migrations: SavedObjectMigrationMap = { + '8.8.0': mergeSavedObjectMigrations(transformMigrationVersion, transformSetManagedDefault), +}; diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_migration_version.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_migration_version.test.ts index 1a5275401e513..c7f6427870a17 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_migration_version.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_migration_version.test.ts @@ -6,12 +6,16 @@ * Side Public License, v 1. */ +import { unary } from 'lodash'; +import { SavedObjectsUtils } from '@kbn/core-saved-objects-utils-server'; import { transformMigrationVersion } from './transform_migration_version'; +const transform = unary(SavedObjectsUtils.getMigrationFunction(transformMigrationVersion)); + describe('transformMigrationVersion', () => { it('should extract the correct version from the `migrationVersion` property', () => { expect( - transformMigrationVersion({ + transform({ id: 'a', attributes: {}, type: 'something', @@ -20,12 +24,12 @@ describe('transformMigrationVersion', () => { previous: '2.0.0', }, }) - ).toHaveProperty('transformedDoc.typeMigrationVersion', '1.0.0'); + ).toHaveProperty('typeMigrationVersion', '1.0.0'); }); it('should remove the original `migrationVersion` property', () => { expect( - transformMigrationVersion({ + transform({ id: 'a', attributes: {}, type: 'something', @@ -34,27 +38,27 @@ describe('transformMigrationVersion', () => { previous: '2.0.0', }, }) - ).not.toHaveProperty('transformedDoc.migrationVersion'); + ).not.toHaveProperty('migrationVersion'); }); it('should not add `typeMigrationVersion` if there is no `migrationVersion`', () => { expect( - transformMigrationVersion({ + transform({ id: 'a', attributes: {}, type: 'something', }) - ).not.toHaveProperty('transformedDoc.typeMigrationVersion'); + ).not.toHaveProperty('typeMigrationVersion'); }); it('should add empty `typeMigrationVersion` if there is no related value in `migrationVersion`', () => { expect( - transformMigrationVersion({ + transform({ id: 'a', attributes: {}, type: 'something', migrationVersion: {}, }) - ).toHaveProperty('transformedDoc.typeMigrationVersion', ''); + ).toHaveProperty('typeMigrationVersion', ''); }); }); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_migration_version.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_migration_version.ts index 6131610cea412..f7e0c8bb7a35b 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_migration_version.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_migration_version.ts @@ -6,14 +6,14 @@ * Side Public License, v 1. */ -import { TransformFn } from '../types'; +import type { SavedObjectMigration } from '@kbn/core-saved-objects-server'; -export const transformMigrationVersion: TransformFn = ({ migrationVersion, ...doc }) => { - return { - transformedDoc: { - ...doc, - ...(migrationVersion ? { typeMigrationVersion: migrationVersion[doc.type] ?? '' } : {}), - }, - additionalDocs: [], - }; +export const transformMigrationVersion: SavedObjectMigration = { + // @todo Remove when deferred migrations are publicly available. + // @ts-expect-error + deferred: true, + transform: ({ migrationVersion, ...doc }) => ({ + ...doc, + ...(migrationVersion ? { typeMigrationVersion: migrationVersion[doc.type] ?? '' } : {}), + }), }; diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_set_managed_default.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_set_managed_default.test.ts index 1b355a176ab6f..cc896e5b13536 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_set_managed_default.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_set_managed_default.test.ts @@ -6,35 +6,39 @@ * Side Public License, v 1. */ +import { unary } from 'lodash'; +import { SavedObjectsUtils } from '@kbn/core-saved-objects-utils-server'; import { transformSetManagedDefault } from './transform_set_managed_default'; +const transform = unary(SavedObjectsUtils.getMigrationFunction(transformSetManagedDefault)); + describe('transformAddManaged', () => { it('should add managed if not defined', () => { expect( - transformSetManagedDefault({ + transform({ id: 'a', attributes: {}, type: 'something', }) - ).toHaveProperty('transformedDoc.managed'); + ).toHaveProperty('managed'); }); it('should not change managed if already defined', () => { - const docWithManagedFalse = transformSetManagedDefault({ + const docWithManagedFalse = transform({ id: 'a', attributes: {}, type: 'something', managed: false, }); - const docWithManagedTrue = transformSetManagedDefault({ + const docWithManagedTrue = transform({ id: 'a', attributes: {}, type: 'something', managed: true, }); [docWithManagedFalse, docWithManagedTrue].forEach((doc) => { - expect(doc.transformedDoc.managed).toBeDefined(); + expect(doc.managed).toBeDefined(); }); - expect(docWithManagedFalse.transformedDoc.managed).not.toBeTruthy(); - expect(docWithManagedTrue.transformedDoc.managed).toBeTruthy(); + expect(docWithManagedFalse.managed).not.toBeTruthy(); + expect(docWithManagedTrue.managed).toBeTruthy(); }); }); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_set_managed_default.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_set_managed_default.ts index 8e3e1b82bc8cd..d0981a4740bd3 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_set_managed_default.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/migrations/transform_set_managed_default.ts @@ -6,9 +6,11 @@ * Side Public License, v 1. */ -import { SavedObjectUnsanitizedDoc } from '@kbn/core-saved-objects-server'; +import type { SavedObjectMigration } from '@kbn/core-saved-objects-server'; -export const transformSetManagedDefault = (doc: SavedObjectUnsanitizedDoc) => ({ - transformedDoc: { ...doc, managed: doc.managed ?? false }, - additionalDocs: [], -}); +export const transformSetManagedDefault: SavedObjectMigration = { + // @todo Remove when deferred migrations are publicly available. + // @ts-expect-error + deferred: true, + transform: ({ managed, ...doc }) => ({ ...doc, managed: managed ?? false }), +}; diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/model_version.test.mocks.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/model_version.test.mocks.ts new file mode 100644 index 0000000000000..ebb81f0172fee --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/model_version.test.mocks.ts @@ -0,0 +1,17 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export const convertModelVersionBackwardConversionSchemaMock = jest.fn(); + +jest.doMock('@kbn/core-saved-objects-base-server-internal', () => { + const actual = jest.requireActual('@kbn/core-saved-objects-base-server-internal'); + return { + ...actual, + convertModelVersionBackwardConversionSchema: convertModelVersionBackwardConversionSchemaMock, + }; +}); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/model_version.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/model_version.test.ts index bc0a0d5a8b5bd..0eead169ae106 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/model_version.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/model_version.test.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +import { convertModelVersionBackwardConversionSchemaMock } from './model_version.test.mocks'; import { loggerMock, MockedLogger } from '@kbn/logging-mocks'; import type { SavedObjectsType, @@ -15,7 +16,19 @@ import type { } from '@kbn/core-saved-objects-server'; import { modelVersionToVirtualVersion } from '@kbn/core-saved-objects-base-server-internal'; import { Transform, TransformType } from './types'; -import { getModelVersionTransforms, convertModelVersionTransformFn } from './model_version'; +import { + getModelVersionTransforms, + convertModelVersionTransformFn, + getModelVersionSchemas, +} from './model_version'; + +const createType = (parts: Partial): SavedObjectsType => ({ + name: 'test', + hidden: false, + namespaceType: 'single', + mappings: { properties: {} }, + ...parts, +}); describe('getModelVersionTransforms', () => { let log: MockedLogger; @@ -26,14 +39,6 @@ describe('getModelVersionTransforms', () => { transform: expect.any(Function), }); - const createType = (parts: Partial): SavedObjectsType => ({ - name: 'test', - hidden: false, - namespaceType: 'single', - mappings: { properties: {} }, - ...parts, - }); - beforeEach(() => { log = loggerMock.create(); }); @@ -208,3 +213,77 @@ describe('convertModelVersionTransformFn', () => { }); }); }); + +describe('getModelVersionSchemas', () => { + beforeEach(() => { + convertModelVersionBackwardConversionSchemaMock.mockReset(); + convertModelVersionBackwardConversionSchemaMock.mockImplementation(() => jest.fn()); + }); + + it('calls convertModelVersionBackwardConversionSchema with the correct parameters', () => { + const schema1 = jest.fn(); + const schema3 = jest.fn(); + + const typeDefinition = createType({ + name: 'foo', + modelVersions: { + 1: { + changes: [], + schemas: { + forwardCompatibility: schema1, + }, + }, + 2: { + changes: [], + schemas: {}, + }, + 3: { + changes: [], + schemas: { + forwardCompatibility: schema3, + }, + }, + }, + }); + + getModelVersionSchemas({ typeDefinition }); + + expect(convertModelVersionBackwardConversionSchemaMock).toHaveBeenCalledTimes(2); + expect(convertModelVersionBackwardConversionSchemaMock).toHaveBeenCalledWith(schema1); + expect(convertModelVersionBackwardConversionSchemaMock).toHaveBeenCalledWith(schema3); + }); + + it('generate schemas for correct model versions', () => { + const schema1 = jest.fn(); + const schema3 = jest.fn(); + + const typeDefinition = createType({ + name: 'foo', + modelVersions: { + 1: { + changes: [], + schemas: { + forwardCompatibility: schema1, + }, + }, + 2: { + changes: [], + schemas: {}, + }, + 3: { + changes: [], + schemas: { + forwardCompatibility: schema3, + }, + }, + }, + }); + + const schemas = getModelVersionSchemas({ typeDefinition }); + + expect(schemas).toEqual({ + [modelVersionToVirtualVersion(1)]: expect.any(Function), + [modelVersionToVirtualVersion(3)]: expect.any(Function), + }); + }); +}); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/model_version.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/model_version.ts index a4fec9bf3f76e..5801bfe56f162 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/model_version.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/model_version.ts @@ -17,9 +17,31 @@ import { modelVersionToVirtualVersion, assertValidModelVersion, buildModelVersionTransformFn, + convertModelVersionBackwardConversionSchema, } from '@kbn/core-saved-objects-base-server-internal'; import { TransformSavedObjectDocumentError } from '../core'; -import { type Transform, type TransformFn, TransformType } from './types'; +import { type Transform, type TransformFn, TransformType, type TypeVersionSchema } from './types'; + +export const getModelVersionSchemas = ({ + typeDefinition, +}: { + typeDefinition: SavedObjectsType; +}): Record => { + const modelVersionMap = + typeof typeDefinition.modelVersions === 'function' + ? typeDefinition.modelVersions() + : typeDefinition.modelVersions ?? {}; + + return Object.entries(modelVersionMap).reduce((map, [rawModelVersion, versionDefinition]) => { + const schema = versionDefinition.schemas?.forwardCompatibility; + if (schema) { + const modelVersion = assertValidModelVersion(rawModelVersion); + const virtualVersion = modelVersionToVirtualVersion(modelVersion); + map[virtualVersion] = convertModelVersionBackwardConversionSchema(schema); + } + return map; + }, {} as Record); +}; export const getModelVersionTransforms = ({ typeDefinition, diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/pipelines/downgrade_pipeline.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/pipelines/downgrade_pipeline.test.ts index 3041197ec56a2..07cd38151bdda 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/pipelines/downgrade_pipeline.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/pipelines/downgrade_pipeline.test.ts @@ -8,7 +8,7 @@ import _ from 'lodash'; import type { SavedObjectUnsanitizedDoc } from '@kbn/core-saved-objects-server'; -import { Transform, TransformType, TypeTransforms, TransformFn } from '../types'; +import { Transform, TransformType, TypeTransforms, TransformFn, TypeVersionSchema } from '../types'; import { DocumentDowngradePipeline } from './downgrade_pipeline'; // snake case is way better for migration function names in this very specific scenario. @@ -28,6 +28,10 @@ describe('DocumentMigratorPipeline', () => { ...parts, }); + const createSchema = (): jest.MockedFunction => { + return jest.fn().mockImplementation((doc: unknown) => doc); + }; + const latestVersions = ( parts: Partial> = {} ): Record => ({ @@ -46,7 +50,9 @@ describe('DocumentMigratorPipeline', () => { return { transforms, + immediateVersion: latestVersions(versions), latestVersion: latestVersions(versions), + versionSchemas: {}, }; }; @@ -179,7 +185,7 @@ describe('DocumentMigratorPipeline', () => { expect(outputDoc.typeMigrationVersion).toEqual('8.7.0'); }); - it('throws trying to apply a transform without down fn', () => { + it('skips transforms without down fn', () => { const document = createDoc({ id: 'foo-1', type: 'foo', @@ -219,9 +225,10 @@ describe('DocumentMigratorPipeline', () => { targetTypeVersion: '8.5.0', }); - expect(() => pipeline.run()).toThrowErrorMatchingInlineSnapshot( - `"Could not apply transformation migrate:8.7.0: no down conversion registered"` - ); + pipeline.run(); + + expect(migrate8_6_0_down).toHaveBeenCalledTimes(1); + expect(migrate8_8_0_down).toHaveBeenCalledTimes(1); }); it('throws trying to downgrade to a higher version', () => { @@ -603,4 +610,113 @@ describe('DocumentMigratorPipeline', () => { expect(outputDoc.coreMigrationVersion).toEqual('8.7.0'); }); + + it('accepts converting documents from higher versions than the last known', () => { + const document = createDoc({ + id: 'foo-1', + type: 'foo', + typeMigrationVersion: '8.10.0', + }); + + const migrate8_8_0_up = createTransformFn(); + const migrate8_8_0_down = createTransformFn(); + + const fooTransforms = getTypeTransforms([ + { + transformType: TransformType.Migrate, + version: '8.8.0', + transform: migrate8_8_0_up, + transformDown: migrate8_8_0_down, + }, + ]); + + const pipeline = new DocumentDowngradePipeline({ + document, + kibanaVersion: '8.8.0', + typeTransforms: fooTransforms, + targetTypeVersion: '8.7.0', + }); + + const { document: outputDoc } = pipeline.run(); + + expect(migrate8_8_0_up).not.toHaveBeenCalled(); + + expect(migrate8_8_0_down).toHaveBeenCalledTimes(1); + expect(migrate8_8_0_down).toHaveBeenCalledWith(document); + + expect(outputDoc.typeMigrationVersion).toEqual('8.7.0'); + }); + + describe('version schemas', () => { + it('apply the correct version schema', () => { + const document = createDoc({ + id: 'foo-1', + type: 'foo', + typeMigrationVersion: '8.9.0', + }); + + const schema_8_7_0 = createSchema(); + const schema_8_8_0 = createSchema(); + const schema_8_9_0 = createSchema(); + + const transforms: TypeTransforms = { + transforms: [], + latestVersion: latestVersions(), + immediateVersion: latestVersions(), + versionSchemas: { + '8.7.0': schema_8_7_0, + '8.8.0': schema_8_8_0, + '8.9.0': schema_8_9_0, + }, + }; + + const pipeline = new DocumentDowngradePipeline({ + document, + kibanaVersion: '8.8.0', + typeTransforms: transforms, + targetTypeVersion: '8.7.0', + }); + + const { document: outputDoc } = pipeline.run(); + + expect(outputDoc.typeMigrationVersion).toEqual('8.7.0'); + expect(schema_8_7_0).toHaveBeenCalledTimes(1); + expect(schema_8_8_0).not.toHaveBeenCalled(); + expect(schema_8_9_0).not.toHaveBeenCalled(); + }); + + it('does not apply the schema if the exact version is missing', () => { + const document = createDoc({ + id: 'foo-1', + type: 'foo', + typeMigrationVersion: '8.9.0', + }); + + const schema_8_8_0 = createSchema(); + const schema_8_9_0 = createSchema(); + + const transforms: TypeTransforms = { + transforms: [], + latestVersion: latestVersions(), + immediateVersion: latestVersions(), + versionSchemas: { + '8.8.0': schema_8_8_0, + '8.9.0': schema_8_9_0, + }, + }; + + const pipeline = new DocumentDowngradePipeline({ + document, + kibanaVersion: '8.8.0', + typeTransforms: transforms, + targetTypeVersion: '8.7.0', + }); + + const { document: outputDoc } = pipeline.run(); + + expect(outputDoc.typeMigrationVersion).toEqual('8.7.0'); + expect(schema_8_8_0).not.toHaveBeenCalled(); + expect(schema_8_9_0).not.toHaveBeenCalled(); + }); + }); }); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/pipelines/downgrade_pipeline.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/pipelines/downgrade_pipeline.ts index 95af2a3022598..d32868b15b9c6 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/pipelines/downgrade_pipeline.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/pipelines/downgrade_pipeline.ts @@ -48,9 +48,7 @@ export class DocumentDowngradePipeline implements MigrationPipeline { for (const transform of this.getPendingTransforms()) { if (!transform.transformDown) { - throw new Error( - `Could not apply transformation ${transform.transformType}:${transform.version}: no down conversion registered` - ); + continue; } const { transformedDoc } = transform.transformDown(this.document); if (this.document.type !== this.originalDoc.type) { @@ -60,6 +58,7 @@ export class DocumentDowngradePipeline implements MigrationPipeline { } this.document = this.ensureVersion(this.document); + this.document = this.applyVersionSchema(this.document); return { document: this.document, @@ -103,14 +102,7 @@ export class DocumentDowngradePipeline implements MigrationPipeline { * And that the targetTypeVersion is not greater than the document's */ private assertCompatibility() { - const { id, typeMigrationVersion: currentVersion } = this.document; - const latestVersion = this.typeTransforms.latestVersion.migrate; - - if (currentVersion && Semver.gt(currentVersion, latestVersion)) { - throw new Error( - `Document "${id}" belongs to a more recent version of Kibana [${currentVersion}] when the last known version is [${latestVersion}].` - ); - } + const { typeMigrationVersion: currentVersion } = this.document; if (currentVersion && Semver.gt(this.targetTypeVersion, currentVersion)) { throw new Error( @@ -132,4 +124,13 @@ export class DocumentDowngradePipeline implements MigrationPipeline { ...(coreMigrationVersion ? { coreMigrationVersion } : {}), }; } + + private applyVersionSchema(doc: SavedObjectUnsanitizedDoc): SavedObjectUnsanitizedDoc { + const targetVersion = this.targetTypeVersion; + const versionSchema = this.typeTransforms.versionSchemas[targetVersion]; + if (versionSchema) { + return versionSchema(doc); + } + return doc; + } } diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/pipelines/upgrade_pipeline.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/pipelines/upgrade_pipeline.test.ts index 338c1088d002f..04823a314747a 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/pipelines/upgrade_pipeline.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/pipelines/upgrade_pipeline.test.ts @@ -47,7 +47,9 @@ describe('DocumentMigratorPipeline', () => { return { transforms, + immediateVersion: latestVersions(versions), latestVersion: latestVersions(versions), + versionSchemas: {}, }; }; diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/types.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/types.ts index 257e7bf02fe1b..687cb5c21b753 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/types.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/types.ts @@ -19,10 +19,20 @@ export interface ActiveMigrations { * Structure containing all the required info to perform a type's conversion */ export interface TypeTransforms { - /** Derived from the related transforms */ + /** + * Latest non-deferred version for each transform type. + * This is the version that will be used to query outdated documents. + */ + immediateVersion: Record; + /** + * Latest version for each transform type, including deferred transforms. + * This is the version that will be used to perform the migration. + */ latestVersion: Record; /** Ordered list of transforms registered for the type **/ transforms: Transform[]; + /** Per-version schemas for the given type */ + versionSchemas: Record; } /** @@ -37,6 +47,8 @@ export interface Transform { transform: TransformFn; /** The (optional) downward transformation function */ transformDown?: TransformFn; + /** Whether this transform is deferred */ + deferred?: boolean; } export enum TransformType { @@ -84,3 +96,8 @@ export interface TransformResult { */ additionalDocs: SavedObjectUnsanitizedDoc[]; } + +/** + * per-version persistence schema for {@link TypeTransforms} + */ +export type TypeVersionSchema = (doc: SavedObjectUnsanitizedDoc) => SavedObjectUnsanitizedDoc; diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/utils.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/utils.test.ts index e1b5c7b591835..6734def19d5ce 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/utils.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/utils.test.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ +import type { SavedObjectUnsanitizedDoc } from '@kbn/core-saved-objects-server'; import { type Transform, TransformType } from './types'; -import { transformComparator } from './utils'; +import { transformComparator, downgradeRequired } from './utils'; describe('transformComparator', () => { const core1 = { version: '1.0.0', transformType: TransformType.Core } as Transform; @@ -31,3 +32,126 @@ describe('transformComparator', () => { expect(transforms.sort(transformComparator)).toEqual(expected); }); }); + +describe('downgradeRequired', () => { + const createDoc = (parts: Partial): SavedObjectUnsanitizedDoc => ({ + type: 'type', + id: 'id', + attributes: {}, + ...parts, + }); + + it('returns false when there is an higher convert version than the typeMigrationVersion', () => { + const doc = createDoc({ + typeMigrationVersion: '8.0.0', + }); + const latestVersions = { + [TransformType.Convert]: '8.1.0', + } as Record; + + expect(downgradeRequired(doc, latestVersions)).toEqual(false); + }); + + it('returns false when there is an higher convert version than the migrationVersion', () => { + const doc = createDoc({ + migrationVersion: { + type: '8.0.0', + }, + }); + const latestVersions = { + [TransformType.Convert]: '8.1.0', + } as Record; + + expect(downgradeRequired(doc, latestVersions)).toEqual(false); + }); + + it('returns false when there is an higher migrate version than the typeMigrationVersion', () => { + const doc = createDoc({ + typeMigrationVersion: '8.0.0', + }); + const latestVersions = { + [TransformType.Migrate]: '8.1.0', + } as Record; + + expect(downgradeRequired(doc, latestVersions)).toEqual(false); + }); + + it('returns false when there is an higher migrate version than the migrationVersion', () => { + const doc = createDoc({ + migrationVersion: { + type: '8.0.0', + }, + }); + const latestVersions = { + [TransformType.Migrate]: '8.1.0', + } as Record; + + expect(downgradeRequired(doc, latestVersions)).toEqual(false); + }); + + it('returns true when there is no higher convert version than the typeMigrationVersion', () => { + const doc = createDoc({ + typeMigrationVersion: '8.0.0', + }); + const latestVersions = { + [TransformType.Convert]: '7.1.0', + } as Record; + + expect(downgradeRequired(doc, latestVersions)).toEqual(true); + }); + + it('returns true when there is no higher convert version than the migrationVersion', () => { + const doc = createDoc({ + migrationVersion: { + type: '8.0.0', + }, + }); + const latestVersions = { + [TransformType.Convert]: '7.1.0', + } as Record; + + expect(downgradeRequired(doc, latestVersions)).toEqual(true); + }); + + it('returns true when there is no higher migrate version than the typeMigrationVersion', () => { + const doc = createDoc({ + typeMigrationVersion: '8.0.0', + }); + const latestVersions = { + [TransformType.Migrate]: '7.1.0', + } as Record; + + expect(downgradeRequired(doc, latestVersions)).toEqual(true); + }); + + it('returns true when there is no higher migrate version than the migrationVersion', () => { + const doc = createDoc({ + migrationVersion: { + type: '8.0.0', + }, + }); + const latestVersions = { + [TransformType.Migrate]: '7.1.0', + } as Record; + + expect(downgradeRequired(doc, latestVersions)).toEqual(true); + }); + + it('returns false when the document has no explicit version', () => { + const doc = createDoc({}); + const latestVersions = { + [TransformType.Migrate]: '8.0.0', + } as Record; + + expect(downgradeRequired(doc, latestVersions)).toEqual(false); + }); + + it('returns false when latestVersions no explicit version', () => { + const doc = createDoc({ + typeMigrationVersion: '8.0.0', + }); + const latestVersions = {} as Record; + + expect(downgradeRequired(doc, latestVersions)).toEqual(false); + }); +}); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/utils.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/utils.ts index 63b0462714e02..2082a0361336c 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/utils.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/utils.ts @@ -6,14 +6,16 @@ * Side Public License, v 1. */ +import { isFunction } from 'lodash'; import Semver from 'semver'; -import { - SavedObjectMigrationFn, +import type { + SavedObjectMigration, SavedObjectsType, SavedObjectUnsanitizedDoc, } from '@kbn/core-saved-objects-server'; import { Logger } from '@kbn/logging'; import { MigrationLogger } from '../core/migration_logger'; +import { maxVersion } from './pipelines/utils'; import { TransformSavedObjectDocumentError } from '../core/transform_saved_object_document_error'; import { type Transform, type TransformFn, TransformType } from './types'; @@ -31,7 +33,7 @@ const TRANSFORM_PRIORITY = [ export function convertMigrationFunction( version: string, type: SavedObjectsType, - migrationFn: SavedObjectMigrationFn, + migration: SavedObjectMigration, log: Logger ): TransformFn { const context = Object.freeze({ @@ -43,7 +45,8 @@ export function convertMigrationFunction( return function tryTransformDoc(doc: SavedObjectUnsanitizedDoc) { try { - const result = migrationFn(doc, context); + const transformFn = isFunction(migration) ? migration : migration.transform; + const result = transformFn(doc, context); // A basic check to help migration authors detect basic errors // (e.g. forgetting to return the transformed doc) @@ -83,3 +86,21 @@ export function transformComparator(a: Transform, b: Transform) { return Semver.compare(a.version, b.version) || aPriority - bPriority; } + +/** + * Returns true if the given document has an higher version that the last known version, false otherwise + */ +export function downgradeRequired( + doc: SavedObjectUnsanitizedDoc, + latestVersions: Record +): boolean { + const docTypeVersion = doc.typeMigrationVersion ?? doc.migrationVersion?.[doc.type]; + const latestMigrationVersion = maxVersion( + latestVersions[TransformType.Migrate], + latestVersions[TransformType.Convert] + ); + if (!docTypeVersion || !latestMigrationVersion) { + return false; + } + return Semver.gt(docTypeVersion, latestMigrationVersion); +} diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migration.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migration.test.ts index a8f007722028e..d44932f879232 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migration.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migration.test.ts @@ -70,15 +70,41 @@ describe('validateTypeMigrations', () => { ); }); - it('validates the migration function', () => { + it('throws on the invalid migration type', () => { const type = createType({ name: 'foo', - convertToMultiNamespaceTypeVersion: '3.1.1', - namespaceType: 'multiple', migrations: { '1.2.3': 23 as any }, }); - expect(() => validate({ type })).toThrow(/expected a function, but got 23/i); + expect(() => validate({ type })).toThrow(/expected a function or an object/i); + }); + + it('throws on the invalid migration object', () => { + const type = createType({ + name: 'foo', + migrations: { + '1.2.3': { + deferred: false, + transform: 23 as any, + }, + }, + }); + + expect(() => validate({ type })).toThrow(/expected a function or an object/i); + }); + + it('validates the migration object', () => { + const type = createType({ + name: 'foo', + migrations: { + '1.2.3': { + deferred: false, + transform: jest.fn(), + }, + }, + }); + + expect(() => validate({ type })).not.toThrow(); }); describe('when switchToModelVersionAt is specified', () => { diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts index 2dc93f0e54353..e3c528e0050e0 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts @@ -49,9 +49,9 @@ export function validateTypeMigrations({ `Migrations map for type ${type.name} should be an object like { '2.0.0': (doc) => doc }.` ); - Object.entries(migrationMap).forEach(([version, fn]) => { + Object.entries(migrationMap).forEach(([version, migration]) => { assertValidSemver(kibanaVersion, version, type.name); - assertValidTransform(fn, version, type.name); + assertValidTransform(migration, version, type.name); if (type.switchToModelVersionAt && Semver.gte(version, type.switchToModelVersionAt)) { throw new Error( `Migration for type ${type.name} for version ${version} registered after switchToModelVersionAt (${type.switchToModelVersionAt})` @@ -169,9 +169,14 @@ const assertValidConvertToMultiNamespaceType = ( } }; -const assertValidTransform = (fn: any, version: string, type: string) => { - if (typeof fn !== 'function') { - throw new Error(`Invalid migration ${type}.${version}: expected a function, but got ${fn}.`); +const assertValidTransform = (migration: any, version: string, type: string) => { + if ( + !(typeof migration === 'object' && typeof migration.transform === 'function') && + typeof migration !== 'function' + ) { + throw new Error( + `Invalid migration ${type}.${version}: expected a function or an object, but got ${migration}.` + ); } }; diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/get_outdated_documents_query.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/get_outdated_documents_query.test.ts new file mode 100644 index 0000000000000..cb85800d41276 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/get_outdated_documents_query.test.ts @@ -0,0 +1,26 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { getOutdatedDocumentsQuery } from './get_outdated_documents_query'; + +describe('getOutdatedDocumentsQuery', () => { + it.each` + coreMigrationVersionPerType | migrationVersionPerType | case + ${{}} | ${{}} | ${'should not select documents if there are no migrations'} + ${{ dashboard: '8.8.0' }} | ${{}} | ${'should select documents with outdated core migration version'} + ${{}} | ${{ dashboard: '7.7.0' }} | ${'should select documents with outdated type migration version'} + ${{ dashboard: '8.8.0' }} | ${{ dashboard: '7.7.0' }} | ${'should select documents with outdated both core and type migration versions'} + `('$case', ({ coreMigrationVersionPerType, migrationVersionPerType }) => { + expect( + getOutdatedDocumentsQuery({ + coreMigrationVersionPerType, + migrationVersionPerType, + }) + ).toMatchSnapshot(); + }); +}); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/get_outdated_documents_query.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/get_outdated_documents_query.ts new file mode 100644 index 0000000000000..d1c37f9bdce36 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/get_outdated_documents_query.ts @@ -0,0 +1,76 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/types'; +import { SavedObjectsMigrationVersion } from '@kbn/core-saved-objects-common'; + +export interface OutdatedDocumentsQueryParams { + coreMigrationVersionPerType: SavedObjectsMigrationVersion; + migrationVersionPerType: SavedObjectsMigrationVersion; +} + +export function getOutdatedDocumentsQuery({ + coreMigrationVersionPerType, + migrationVersionPerType, +}: OutdatedDocumentsQueryParams): QueryDslQueryContainer { + const types = [ + ...new Set([ + ...Object.keys(coreMigrationVersionPerType), + ...Object.keys(migrationVersionPerType), + ]).values(), + ]; + return { + bool: { + should: types.map((type) => ({ + bool: { + must: [ + { term: { type } }, + { + bool: { + should: [ + ...(coreMigrationVersionPerType[type] + ? [ + { + range: { + coreMigrationVersion: { lt: coreMigrationVersionPerType[type] }, + }, + }, + ] + : []), + ...(migrationVersionPerType[type] + ? [ + { + bool: { + must_not: [ + { exists: { field: 'typeMigrationVersion' } }, + { exists: { field: `migrationVersion.${type}` } }, + ], + }, + }, + { + bool: { + must: { exists: { field: 'migrationVersion' } }, + must_not: { + term: { [`migrationVersion.${type}`]: migrationVersionPerType[type] }, + }, + }, + }, + { + range: { typeMigrationVersion: { lt: migrationVersionPerType[type] } }, + }, + ] + : []), + ], + }, + }, + ], + }, + })), + }, + }; +} diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/initial_state.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/initial_state.test.ts index 1378dec852e2b..60b47ada7828c 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/initial_state.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/initial_state.test.ts @@ -18,6 +18,8 @@ import { import type { Logger } from '@kbn/logging'; import { loggingSystemMock } from '@kbn/core-logging-server-mocks'; import { createInitialState, type CreateInitialStateParams } from './initial_state'; +import * as getOutdatedDocumentsQueryModule from './get_outdated_documents_query'; +import { getOutdatedDocumentsQuery } from './get_outdated_documents_query'; const mockLogger = loggingSystemMock.create(); @@ -41,6 +43,7 @@ const createInitialStateCommonParams = { dynamic: 'strict', properties: { my_type: { properties: { title: { type: 'text' } } } }, } as IndexMapping, + coreMigrationVersionPerType: {}, migrationVersionPerType: {}, indexPrefix: '.kibana_task_manager', migrationsConfig, @@ -350,10 +353,13 @@ describe('createInitialState', () => { ).toEqual(true); }); it('returns state with an outdatedDocumentsQuery', () => { + jest.spyOn(getOutdatedDocumentsQueryModule, 'getOutdatedDocumentsQuery'); + expect( createInitialState({ ...createInitialStateParams, preMigrationScript: "ctx._id = ctx._source.type + ':' + ctx._id", + coreMigrationVersionPerType: {}, migrationVersionPerType: { my_dashboard: '7.10.1', my_viz: '8.0.0' }, }).outdatedDocumentsQuery ).toMatchInlineSnapshot(` @@ -371,6 +377,22 @@ describe('createInitialState', () => { Object { "bool": Object { "should": Array [ + Object { + "bool": Object { + "must_not": Array [ + Object { + "exists": Object { + "field": "typeMigrationVersion", + }, + }, + Object { + "exists": Object { + "field": "migrationVersion.my_dashboard", + }, + }, + ], + }, + }, Object { "bool": Object { "must": Object { @@ -386,19 +408,10 @@ describe('createInitialState', () => { }, }, Object { - "bool": Object { - "must_not": Array [ - Object { - "exists": Object { - "field": "migrationVersion", - }, - }, - Object { - "term": Object { - "typeMigrationVersion": "7.10.1", - }, - }, - ], + "range": Object { + "typeMigrationVersion": Object { + "lt": "7.10.1", + }, }, }, ], @@ -418,6 +431,22 @@ describe('createInitialState', () => { Object { "bool": Object { "should": Array [ + Object { + "bool": Object { + "must_not": Array [ + Object { + "exists": Object { + "field": "typeMigrationVersion", + }, + }, + Object { + "exists": Object { + "field": "migrationVersion.my_viz", + }, + }, + ], + }, + }, Object { "bool": Object { "must": Object { @@ -433,19 +462,10 @@ describe('createInitialState', () => { }, }, Object { - "bool": Object { - "must_not": Array [ - Object { - "exists": Object { - "field": "migrationVersion", - }, - }, - Object { - "term": Object { - "typeMigrationVersion": "8.0.0", - }, - }, - ], + "range": Object { + "typeMigrationVersion": Object { + "lt": "8.0.0", + }, }, }, ], @@ -458,6 +478,10 @@ describe('createInitialState', () => { }, } `); + expect(getOutdatedDocumentsQuery).toHaveBeenCalledWith({ + coreMigrationVersionPerType: {}, + migrationVersionPerType: { my_dashboard: '7.10.1', my_viz: '8.0.0' }, + }); }); it('initializes the `discardUnknownObjects` flag to false if the flag is not provided in the config', () => { diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/initial_state.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/initial_state.ts index 6bb6c22e3a7f2..0b61d891619c4 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/initial_state.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/initial_state.ts @@ -7,28 +7,29 @@ */ import * as Option from 'fp-ts/Option'; -import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/types'; import type { DocLinksServiceStart } from '@kbn/core-doc-links-server'; import type { Logger } from '@kbn/logging'; -import type { SavedObjectsMigrationVersion } from '@kbn/core-saved-objects-common'; import type { ISavedObjectTypeRegistry } from '@kbn/core-saved-objects-server'; import type { IndexMapping, IndexTypesMap, SavedObjectsMigrationConfigType, } from '@kbn/core-saved-objects-base-server-internal'; +import { + getOutdatedDocumentsQuery, + type OutdatedDocumentsQueryParams, +} from './get_outdated_documents_query'; import type { InitState } from './state'; import { excludeUnusedTypesQuery } from './core'; import { getTempIndexName } from './model/helpers'; -export interface CreateInitialStateParams { +export interface CreateInitialStateParams extends OutdatedDocumentsQueryParams { kibanaVersion: string; waitForMigrationCompletion: boolean; mustRelocateDocuments: boolean; indexTypesMap: IndexTypesMap; targetMappings: IndexMapping; preMigrationScript?: string; - migrationVersionPerType: SavedObjectsMigrationVersion; indexPrefix: string; migrationsConfig: SavedObjectsMigrationConfigType; typeRegistry: ISavedObjectTypeRegistry; @@ -46,6 +47,7 @@ export const createInitialState = ({ indexTypesMap, targetMappings, preMigrationScript, + coreMigrationVersionPerType, migrationVersionPerType, indexPrefix, migrationsConfig, @@ -53,37 +55,10 @@ export const createInitialState = ({ docLinks, logger, }: CreateInitialStateParams): InitState => { - const outdatedDocumentsQuery: QueryDslQueryContainer = { - bool: { - should: Object.entries(migrationVersionPerType).map(([type, latestVersion]) => ({ - bool: { - must: [ - { term: { type } }, - { - bool: { - should: [ - { - bool: { - must: { exists: { field: 'migrationVersion' } }, - must_not: { term: { [`migrationVersion.${type}`]: latestVersion } }, - }, - }, - { - bool: { - must_not: [ - { exists: { field: 'migrationVersion' } }, - { term: { typeMigrationVersion: latestVersion } }, - ], - }, - }, - ], - }, - }, - ], - }, - })), - }, - }; + const outdatedDocumentsQuery = getOutdatedDocumentsQuery({ + coreMigrationVersionPerType, + migrationVersionPerType, + }); const reindexTargetMappings: IndexMapping = { dynamic: false, diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/kibana_migrator.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/kibana_migrator.test.ts index ac3d18817b09f..f9537a584881e 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/kibana_migrator.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/kibana_migrator.test.ts @@ -18,26 +18,9 @@ import { DocumentMigrator } from './document_migrator'; import { ByteSizeValue } from '@kbn/config-schema'; import { docLinksServiceMock } from '@kbn/core-doc-links-server-mocks'; import { lastValueFrom } from 'rxjs'; +import * as runResilientMigratorModule from './run_resilient_migrator'; import { runResilientMigrator } from './run_resilient_migrator'; -jest.mock('./run_resilient_migrator', () => { - const actual = jest.requireActual('./run_resilient_migrator'); - - return { - runResilientMigrator: jest.fn(actual.runResilientMigrator), - }; -}); - -jest.mock('./document_migrator', () => { - return { - // Create a mock for spying on the constructor - DocumentMigrator: jest.fn().mockImplementation((...args) => { - const { DocumentMigrator: RealDocMigrator } = jest.requireActual('./document_migrator'); - return new RealDocMigrator(args[0]); - }), - }; -}); - const mappingsResponseWithoutIndexTypesMap: estypes.IndicesGetMappingResponse = { '.kibana_8.7.0_001': { mappings: { @@ -70,8 +53,8 @@ const createRegistry = (types: Array>) => { describe('KibanaMigrator', () => { beforeEach(() => { - (DocumentMigrator as jest.Mock).mockClear(); - (runResilientMigrator as jest.MockedFunction).mockClear(); + jest.restoreAllMocks(); + jest.spyOn(runResilientMigratorModule, 'runResilientMigrator'); }); describe('getActiveMappings', () => { it('returns full index mappings w/ core properties', () => { @@ -110,13 +93,11 @@ describe('KibanaMigrator', () => { it('calls documentMigrator.migrate', () => { const options = mockOptions(); const kibanaMigrator = new KibanaMigrator(options); - const mockDocumentMigrator = { migrate: jest.fn() }; - // @ts-expect-error `documentMigrator` is readonly. - kibanaMigrator.documentMigrator = mockDocumentMigrator; + jest.spyOn(DocumentMigrator.prototype, 'migrate').mockImplementation((doc) => doc); const doc = {} as any; expect(() => kibanaMigrator.migrateDocument(doc)).not.toThrowError(); - expect(mockDocumentMigrator.migrate).toBeCalledTimes(1); + expect(DocumentMigrator.prototype.migrate).toBeCalledTimes(1); }); }); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/kibana_migrator.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/kibana_migrator.ts index 13805c800a63d..828a873648d70 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/kibana_migrator.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/kibana_migrator.ts @@ -29,6 +29,7 @@ import { type SavedObjectsTypeMappingDefinitions, type SavedObjectsMigrationConfigType, type IKibanaMigrator, + type MigrateDocumentOptions, type KibanaMigratorStatus, type MigrationResult, type IndexTypesMap, @@ -176,7 +177,7 @@ export class KibanaMigrator implements IKibanaMigrator { }); this.log.debug('Applying registered migrations for the following saved object types:'); - Object.entries(this.documentMigrator.migrationVersion) + Object.entries(this.documentMigrator.getMigrationVersion()) .sort(([t1, v1], [t2, v2]) => { return Semver.compare(v1, v2); }) @@ -243,7 +244,13 @@ export class KibanaMigrator implements IKibanaMigrator { migrateDoc: this.documentMigrator.migrateAndConvert, rawDocs, }), - migrationVersionPerType: this.documentMigrator.migrationVersion, + coreMigrationVersionPerType: this.documentMigrator.getMigrationVersion({ + includeDeferred: false, + migrationType: 'core', + }), + migrationVersionPerType: this.documentMigrator.getMigrationVersion({ + includeDeferred: false, + }), indexPrefix: indexName, migrationsConfig: this.soMigrationsConfig, typeRegistry: this.typeRegistry, @@ -260,7 +267,10 @@ export class KibanaMigrator implements IKibanaMigrator { return this.activeMappings; } - public migrateDocument(doc: SavedObjectUnsanitizedDoc): SavedObjectUnsanitizedDoc { - return this.documentMigrator.migrate(doc); + public migrateDocument( + doc: SavedObjectUnsanitizedDoc, + { allowDowngrade = false }: MigrateDocumentOptions = {} + ): SavedObjectUnsanitizedDoc { + return this.documentMigrator.migrate(doc, { allowDowngrade }); } } diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/migrations_state_action_machine.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/migrations_state_action_machine.test.ts index 90b07dc71f8c0..2f734b3a56487 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/migrations_state_action_machine.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/migrations_state_action_machine.test.ts @@ -44,6 +44,7 @@ describe('migrationsStateActionMachine', () => { '.kibana_cases': ['typeD', 'typeE'], }, targetMappings: { properties: {} }, + coreMigrationVersionPerType: {}, migrationVersionPerType: {}, indexPrefix: '.my-so-index', migrationsConfig: { diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/run_resilient_migrator.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/run_resilient_migrator.ts index f3ae3f2c09f75..4438847890b54 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/run_resilient_migrator.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/run_resilient_migrator.ts @@ -57,6 +57,7 @@ export async function runResilientMigrator({ readyToReindex, doneReindexing, transformRawDocs, + coreMigrationVersionPerType, migrationVersionPerType, indexPrefix, migrationsConfig, @@ -74,6 +75,7 @@ export async function runResilientMigrator({ doneReindexing: Defer; logger: Logger; transformRawDocs: TransformRawDocs; + coreMigrationVersionPerType: SavedObjectsMigrationVersion; migrationVersionPerType: SavedObjectsMigrationVersion; indexPrefix: string; migrationsConfig: SavedObjectsMigrationConfigType; @@ -87,6 +89,7 @@ export async function runResilientMigrator({ indexTypesMap, targetMappings, preMigrationScript, + coreMigrationVersionPerType, migrationVersionPerType, indexPrefix, migrationsConfig, diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/zdt/test_helpers/document_migrator.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/zdt/test_helpers/document_migrator.ts index 8e4167d277d67..3dbe48ab2d4e9 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/zdt/test_helpers/document_migrator.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/zdt/test_helpers/document_migrator.ts @@ -12,6 +12,5 @@ export const createDocumentMigrator = (): jest.Mocked => { return { migrate: jest.fn().mockImplementation((doc: unknown) => doc), migrateAndConvert: jest.fn().mockImplementation((doc: unknown) => [doc]), - transformDown: jest.fn().mockImplementation((doc: unknown) => doc), }; }; diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/apply_type_defaults.test.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/apply_type_defaults.test.ts new file mode 100644 index 0000000000000..37d61fa37d67c --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-server-internal/src/apply_type_defaults.test.ts @@ -0,0 +1,61 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectsType } from '@kbn/core-saved-objects-server'; +import { globalSwitchToModelVersionAt } from '@kbn/core-saved-objects-base-server-internal'; +import { applyTypeDefaults } from './apply_type_defaults'; + +const createType = (parts: Partial = {}): SavedObjectsType => ({ + name: 'test', + namespaceType: 'single', + hidden: false, + mappings: { properties: {} }, + ...parts, +}); + +describe('applyTypeDefaults', () => { + describe('switchToModelVersionAt', () => { + it(`keeps the type's switchToModelVersionAt if lesser than the global version`, () => { + const type = createType({ + switchToModelVersionAt: '8.4.0', + }); + + const result = applyTypeDefaults(type); + expect(result.switchToModelVersionAt).toEqual('8.4.0'); + }); + + it(`sets switchToModelVersionAt to the global version if unspecified`, () => { + const type = createType({ + switchToModelVersionAt: undefined, + }); + + const result = applyTypeDefaults(type); + expect(result.switchToModelVersionAt).toEqual(globalSwitchToModelVersionAt); + }); + + it(`throws if switchToModelVersionAt is invalid`, () => { + const type = createType({ + switchToModelVersionAt: 'foobar', + }); + + expect(() => applyTypeDefaults(type)).toThrowErrorMatchingInlineSnapshot( + `"Type test: invalid switchToModelVersionAt provided: foobar"` + ); + }); + + it(`throws if type version is greater than the global version`, () => { + const type = createType({ + switchToModelVersionAt: '9.2.0', + }); + + expect(() => applyTypeDefaults(type)).toThrowErrorMatchingInlineSnapshot( + `"Type test: provided switchToModelVersionAt (9.2.0) is higher than maximum (8.10.0)"` + ); + }); + }); +}); diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/apply_type_defaults.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/apply_type_defaults.ts new file mode 100644 index 0000000000000..7585fe4ccbd7d --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-server-internal/src/apply_type_defaults.ts @@ -0,0 +1,37 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import Semver from 'semver'; +import type { SavedObjectsType } from '@kbn/core-saved-objects-server'; +import { globalSwitchToModelVersionAt } from '@kbn/core-saved-objects-base-server-internal'; + +/** + * Apply global defaults to the provided SO type. + */ +export const applyTypeDefaults = (type: SavedObjectsType): SavedObjectsType => { + let switchToModelVersionAt = type.switchToModelVersionAt; + if (switchToModelVersionAt) { + if (!Semver.valid(switchToModelVersionAt)) { + throw new Error( + `Type ${type.name}: invalid switchToModelVersionAt provided: ${switchToModelVersionAt}` + ); + } + if (Semver.gt(switchToModelVersionAt, globalSwitchToModelVersionAt)) { + throw new Error( + `Type ${type.name}: provided switchToModelVersionAt (${switchToModelVersionAt}) is higher than maximum (${globalSwitchToModelVersionAt})` + ); + } + } else { + switchToModelVersionAt = globalSwitchToModelVersionAt; + } + + return { + ...type, + switchToModelVersionAt, + }; +}; diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.test.mocks.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.test.mocks.ts index 54090e9fb1b18..f1c3fbe9e5f49 100644 --- a/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.test.mocks.ts +++ b/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.test.mocks.ts @@ -50,3 +50,12 @@ export const registerRoutesMock = jest.fn(); jest.doMock('./routes', () => ({ registerRoutes: registerRoutesMock, })); + +export const applyTypeDefaultsMock = jest.fn(); +jest.doMock('./apply_type_defaults', () => { + const actual = jest.requireActual('./apply_type_defaults'); + return { + ...actual, + applyTypeDefaults: applyTypeDefaultsMock, + }; +}); diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.test.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.test.ts index 72e36826bb89e..4369a85184262 100644 --- a/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.test.ts +++ b/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.test.ts @@ -16,6 +16,7 @@ import { migratorInstanceMock, registerRoutesMock, typeRegistryInstanceMock, + applyTypeDefaultsMock, } from './saved_objects_service.test.mocks'; import { BehaviorSubject, firstValueFrom } from 'rxjs'; import { skip } from 'rxjs/operators'; @@ -69,6 +70,7 @@ describe('SavedObjectsService', () => { beforeEach(() => { deprecationsSetup = createDeprecationRegistryProviderMock(); + applyTypeDefaultsMock.mockReset().mockImplementation((type: unknown) => type); }); const createCoreContext = ({ @@ -330,22 +332,50 @@ describe('SavedObjectsService', () => { }); describe('#registerType', () => { - it('registers the type to the internal typeRegistry', async () => { + it('calls `applyTypeDefaults` with the correct parameters', async () => { // we mocked registerCoreObjectTypes above, so this test case only reflects direct calls to the registerType method const coreContext = createCoreContext(); const soService = new SavedObjectsService(coreContext); const setup = await soService.setup(createSetupDeps()); - const type = { + const inputType = { name: 'someType', hidden: false, namespaceType: 'single' as 'single', mappings: { properties: {} }, }; - setup.registerType(type); + + applyTypeDefaultsMock.mockReturnValue(inputType); + + setup.registerType(inputType); + + expect(applyTypeDefaultsMock).toHaveBeenCalledTimes(1); + expect(applyTypeDefaultsMock).toHaveBeenCalledWith(inputType); + }); + + it('registers the type returned by `applyTypeDefaults` to the internal typeRegistry', async () => { + // we mocked registerCoreObjectTypes above, so this test case only reflects direct calls to the registerType method + const coreContext = createCoreContext(); + const soService = new SavedObjectsService(coreContext); + const setup = await soService.setup(createSetupDeps()); + + const inputType = { + name: 'someType', + hidden: false, + namespaceType: 'single' as 'single', + mappings: { properties: {} }, + }; + const returnedType = { + ...inputType, + switchToModelVersionAt: '9.9.9', + }; + + applyTypeDefaultsMock.mockReturnValue(returnedType); + + setup.registerType(inputType); expect(typeRegistryInstanceMock.registerType).toHaveBeenCalledTimes(1); - expect(typeRegistryInstanceMock.registerType).toHaveBeenCalledWith(type); + expect(typeRegistryInstanceMock.registerType).toHaveBeenCalledWith(returnedType); }); }); diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.ts index 1ea6f6b038463..d73073d131084 100644 --- a/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.ts +++ b/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.ts @@ -57,6 +57,7 @@ import { registerRoutes } from './routes'; import { calculateStatus$ } from './status'; import { registerCoreObjectTypes } from './object_types'; import { getSavedObjectsDeprecationsProvider } from './deprecations'; +import { applyTypeDefaults } from './apply_type_defaults'; /** * @internal @@ -194,7 +195,7 @@ export class SavedObjectsService if (this.started) { throw new Error('cannot call `registerType` after service startup.'); } - this.typeRegistry.registerType(type); + this.typeRegistry.registerType(applyTypeDefaults(type)); }, getTypeRegistry: () => this.typeRegistry, getDefaultIndex: () => MAIN_SAVED_OBJECT_INDEX, diff --git a/packages/core/saved-objects/core-saved-objects-server/index.ts b/packages/core/saved-objects/core-saved-objects-server/index.ts index c5aeb1db55db6..be67c64f9b7ce 100644 --- a/packages/core/saved-objects/core-saved-objects-server/index.ts +++ b/packages/core/saved-objects/core-saved-objects-server/index.ts @@ -41,8 +41,10 @@ export type { SavedObjectsMappingProperties, } from './src/mapping_definition'; export type { + SavedObjectMigration, SavedObjectMigrationMap, SavedObjectMigrationContext, + SavedObjectMigrationParams, SavedObjectsMigrationLogger, SavedObjectMigrationFn, } from './src/migration'; @@ -133,7 +135,8 @@ export type { SavedObjectModelTransformationResult, SavedObjectModelDataBackfillFn, SavedObjectsModelVersionSchemaDefinitions, - SavedObjectModelVersionCreateSchema, + SavedObjectModelVersionForwardCompatibilityFn, + SavedObjectModelVersionForwardCompatibilitySchema, } from './src/model_version'; // We re-export the SavedObject types here for convenience. diff --git a/packages/core/saved-objects/core-saved-objects-server/src/migration.ts b/packages/core/saved-objects/core-saved-objects-server/src/migration.ts index 9273009241e04..6bf0093ea3317 100644 --- a/packages/core/saved-objects/core-saved-objects-server/src/migration.ts +++ b/packages/core/saved-objects/core-saved-objects-server/src/migration.ts @@ -47,6 +47,33 @@ export type SavedObjectMigrationFn SavedObjectUnsanitizedDoc; +/** + * Saved Objects migration with parameters. + * @public + */ +export interface SavedObjectMigrationParams< + InputAttributes = unknown, + MigratedAttributes = unknown +> { + /** + * A 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. + * @default false + */ + deferred?: false; + + /** {@inheritDoc SavedObjectMigrationFn} */ + transform: SavedObjectMigrationFn; +} + +/** + * Saved Objects migration. + * It can be either a {@link SavedObjectMigrationFn | migration function} or a {@link SavedObjectMigrationParams | migration object}. + * @public + */ +export type SavedObjectMigration = + | SavedObjectMigrationFn + | SavedObjectMigrationParams; + /** @public */ export interface SavedObjectsMigrationLogger { debug: (msg: string) => void; @@ -81,7 +108,7 @@ export interface SavedObjectMigrationContext { } /** - * A map of {@link SavedObjectMigrationFn | migration functions} to be used for a given type. + * A map of {@link SavedObjectMigration | migrations} to be used for a given type. * The map's keys must be valid semver versions, and they cannot exceed the current Kibana version. * * For a given document, only migrations with a higher version number than that of the document will be applied. @@ -98,5 +125,5 @@ export interface SavedObjectMigrationContext { * @public */ export interface SavedObjectMigrationMap { - [version: string]: SavedObjectMigrationFn; + [version: string]: SavedObjectMigration; } diff --git a/packages/core/saved-objects/core-saved-objects-server/src/model_version/index.ts b/packages/core/saved-objects/core-saved-objects-server/src/model_version/index.ts index e86c006990b4d..8bf11ca83067a 100644 --- a/packages/core/saved-objects/core-saved-objects-server/src/model_version/index.ts +++ b/packages/core/saved-objects/core-saved-objects-server/src/model_version/index.ts @@ -30,5 +30,6 @@ export type { export type { SavedObjectsModelVersionSchemaDefinitions, - SavedObjectModelVersionCreateSchema, + SavedObjectModelVersionForwardCompatibilitySchema, + SavedObjectModelVersionForwardCompatibilityFn, } from './schemas'; diff --git a/packages/core/saved-objects/core-saved-objects-server/src/model_version/model_version.ts b/packages/core/saved-objects/core-saved-objects-server/src/model_version/model_version.ts index 87bb2de4b8384..2b8bde3c8e5b6 100644 --- a/packages/core/saved-objects/core-saved-objects-server/src/model_version/model_version.ts +++ b/packages/core/saved-objects/core-saved-objects-server/src/model_version/model_version.ts @@ -23,9 +23,9 @@ export interface SavedObjectsModelVersion { */ changes: SavedObjectsModelChange[]; /** - * The {@link SavedObjectsModelVersionSchemaDefinitions} associated with this version. + * The {@link SavedObjectsModelVersionSchemaDefinitions | schemas} associated with this version. * - * @remark Currently unimplemented and unused. + * Schemas are used to validate / convert the shape and/or content of the documents at various stages of their usages. */ schemas?: SavedObjectsModelVersionSchemaDefinitions; } diff --git a/packages/core/saved-objects/core-saved-objects-server/src/model_version/schemas.ts b/packages/core/saved-objects/core-saved-objects-server/src/model_version/schemas.ts index a6528591600e5..6ced7b04b5518 100644 --- a/packages/core/saved-objects/core-saved-objects-server/src/model_version/schemas.ts +++ b/packages/core/saved-objects/core-saved-objects-server/src/model_version/schemas.ts @@ -9,17 +9,68 @@ import type { ObjectType } from '@kbn/config-schema'; /** + * The schemas associated with this model version. + * * @public - * @remark Currently unimplemented and unused. */ -export type SavedObjectModelVersionCreateSchema = ObjectType; +export interface SavedObjectsModelVersionSchemaDefinitions { + /** + * The schema applied when retrieving documents of a higher version from the cluster. + * Used for multi-version compatibility in managed environments. + * + * When retrieving a savedObject document from an index, if the version of the document + * is higher than the latest version known of the Kibana instance, the document will go + * through the `forwardCompatibility` schema of the associated model version. + * + * E.g a Kibana instance with model version `2` for type `foo` types fetches a `foo` document + * at model version `3`. The document will then go through the `forwardCompatibility` + * of the model version 2 (if present). + * + * See {@link SavedObjectModelVersionForwardCompatibilitySchema} for more info. + */ + forwardCompatibility?: SavedObjectModelVersionForwardCompatibilitySchema; +} /** - * The schemas associated with this model version. + * Plain javascript function alternative for {@link SavedObjectModelVersionForwardCompatibilitySchema} + * @public + */ +export type SavedObjectModelVersionForwardCompatibilityFn = ( + attributes: InAttrs +) => OutAttrs; + +/** + * Schema used when retrieving a document of a higher version to convert them to the older version. + * + * These schemas can be defined in multiple ways: + * - A `@kbn/config-schema`'s Object schema, that will receive the document's attributes + * - An arbitrary function that will receive the document's attributes as parameter and should return the converted attributes + * + * @remark These conversion mechanism shouldn't assert the data itself, only strip unknown fields to convert + * the document to the *shape* of the document at the given version. + * + * @example using a function: + * ```ts + * const versionSchema: SavedObjectModelVersionEvictionFn = (attributes) => { + * const knownFields = ['someField', 'anotherField']; + * return pick(attributes, knownFields); + * } + * ``` + * + * @example using config-schema: + * ```ts + * const versionSchema = schema.object( + * { + * someField: schema.maybe(schema.string()), + * anotherField: schema.maybe(schema.string()), + * }, + * { unknowns: 'ignore' } + * ); + * ``` * * @public - * @remark Currently unimplemented and unused. */ -export interface SavedObjectsModelVersionSchemaDefinitions { - create?: SavedObjectModelVersionCreateSchema; -} +export type SavedObjectModelVersionForwardCompatibilitySchema< + InAttrs = unknown, + OutAttrs = unknown +> = ObjectType | SavedObjectModelVersionForwardCompatibilityFn; diff --git a/packages/core/saved-objects/core-saved-objects-utils-server/index.ts b/packages/core/saved-objects/core-saved-objects-utils-server/index.ts index 102a0a0d38e80..a68d2991460f1 100644 --- a/packages/core/saved-objects/core-saved-objects-utils-server/index.ts +++ b/packages/core/saved-objects/core-saved-objects-utils-server/index.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -export { mergeSavedObjectMigrationMaps } from './src/merge_migration_maps'; +export { mergeSavedObjectMigrations, mergeSavedObjectMigrationMaps } from './src/merge_migrations'; export { SavedObjectsUtils, ALL_NAMESPACES_STRING, diff --git a/packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migration_maps.test.ts b/packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migration_maps.test.ts deleted file mode 100644 index 28b3ebd3735b4..0000000000000 --- a/packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migration_maps.test.ts +++ /dev/null @@ -1,73 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import type { - SavedObjectMigrationContext, - SavedObjectMigrationMap, - SavedObjectUnsanitizedDoc, -} from '@kbn/core-saved-objects-server'; -import { mergeSavedObjectMigrationMaps } from './merge_migration_maps'; - -describe('mergeSavedObjectMigrationMaps', () => { - const obj1: SavedObjectMigrationMap = { - '7.12.1': (doc, context) => { - context.log.info(''); - return { - ...doc, - attributes: { ...doc.attributes, counter: doc.attributes.counter + 1 }, - }; - }, - '7.12.2': (doc, context) => { - context.log.info(''); - return { - ...doc, - attributes: { ...doc.attributes, counter: doc.attributes.counter + 2 }, - }; - }, - }; - - const obj2: SavedObjectMigrationMap = { - '7.12.0': (doc, context) => { - context.log.info(''); - return { - ...doc, - attributes: { ...doc.attributes, counter: doc.attributes.counter - 2 }, - }; - }, - '7.12.2': (doc, context) => { - context.log.info(''); - return { - ...doc, - attributes: { ...doc.attributes, counter: doc.attributes.counter + 2 }, - }; - }, - }; - - test('correctly merges two saved object migration maps', () => { - const context = { log: { info: jest.fn() } } as unknown as SavedObjectMigrationContext; - - const result = mergeSavedObjectMigrationMaps(obj1, obj2); - expect( - result['7.12.0']({ attributes: { counter: 5 } } as SavedObjectUnsanitizedDoc, context) - .attributes.counter - ).toEqual(3); - expect(context.log.info).toHaveBeenCalledTimes(1); - - expect( - result['7.12.1']({ attributes: { counter: 5 } } as SavedObjectUnsanitizedDoc, context) - .attributes.counter - ).toEqual(6); - expect(context.log.info).toHaveBeenCalledTimes(2); - - expect( - result['7.12.2']({ attributes: { counter: 5 } } as SavedObjectUnsanitizedDoc, context) - .attributes.counter - ).toEqual(9); - expect(context.log.info).toHaveBeenCalledTimes(4); - }); -}); diff --git a/packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migration_maps.ts b/packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migration_maps.ts deleted file mode 100644 index 6d7c1c90d25df..0000000000000 --- a/packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migration_maps.ts +++ /dev/null @@ -1,48 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { mergeWith } from 'lodash'; -import type { - SavedObjectMigrationContext, - SavedObjectMigrationFn, - SavedObjectMigrationMap, - SavedObjectUnsanitizedDoc, -} from '@kbn/core-saved-objects-server'; - -/** - * Merges two saved object migration maps. - * - * If there is a migration for a given version on only one of the maps, - * that migration function will be used: - * - * mergeSavedObjectMigrationMaps({ '1.2.3': f }, { '4.5.6': g }) -> { '1.2.3': f, '4.5.6': g } - * - * If there is a migration for a given version on both maps, the migrations will be composed: - * - * mergeSavedObjectMigrationMaps({ '1.2.3': f }, { '1.2.3': g }) -> { '1.2.3': (doc, context) => f(g(doc, context), context) } - * - * @public - * - * @param map1 - The first map to merge - * @param map2 - The second map to merge - * @returns The merged map {@link SavedObjectMigrationMap} - */ -export const mergeSavedObjectMigrationMaps = ( - map1: SavedObjectMigrationMap, - map2: SavedObjectMigrationMap -): SavedObjectMigrationMap => { - const customizer = (objValue: SavedObjectMigrationFn, srcValue: SavedObjectMigrationFn) => { - if (!srcValue || !objValue) { - return srcValue || objValue; - } - return (state: SavedObjectUnsanitizedDoc, context: SavedObjectMigrationContext) => - objValue(srcValue(state, context), context); - }; - - return mergeWith({ ...map1 }, map2, customizer); -}; diff --git a/packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migrations.test.ts b/packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migrations.test.ts new file mode 100644 index 0000000000000..7d31d5062cda8 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migrations.test.ts @@ -0,0 +1,133 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { + SavedObjectMigrationContext, + SavedObjectMigrationMap, + SavedObjectMigrationFn, + SavedObjectUnsanitizedDoc, +} from '@kbn/core-saved-objects-server'; +import { mergeSavedObjectMigrations, mergeSavedObjectMigrationMaps } from './merge_migrations'; + +describe('mergeSavedObjectMigrations', () => { + test('merges migration parameters with a migration function', () => { + // @ts-expect-error + expect(mergeSavedObjectMigrations({ deferred: true, transform: jest.fn() }, jest.fn())).toEqual( + { + deferred: false, + transform: expect.any(Function), + } + ); + }); + + test('returns a function on merging two functions', () => { + expect(mergeSavedObjectMigrations(jest.fn(), jest.fn())).toBeInstanceOf(Function); + }); + + test('merges two deferred migrations', () => { + expect( + mergeSavedObjectMigrations( + // @ts-expect-error + { deferred: true, transform: jest.fn() }, + { deferred: true, transform: jest.fn() } + ) + ).toEqual({ + deferred: true, + transform: expect.any(Function), + }); + }); + + test('merges two non-deferred migrations', () => { + expect( + mergeSavedObjectMigrations( + { deferred: false, transform: jest.fn() }, + { deferred: false, transform: jest.fn() } + ) + ).toEqual({ + deferred: false, + transform: expect.any(Function), + }); + }); + + test('merges deferred and non-deferred migrations', () => { + expect( + mergeSavedObjectMigrations( + // @ts-expect-error + { deferred: true, transform: jest.fn() }, + { deferred: false, transform: jest.fn() } + ) + ).toEqual({ + deferred: false, + transform: expect.any(Function), + }); + }); +}); + +describe('mergeSavedObjectMigrationMaps', () => { + test('correctly merges two saved object migration maps', () => { + const obj1: SavedObjectMigrationMap = { + '7.12.1': (doc, context) => { + context.log.info(''); + return { + ...doc, + attributes: { ...doc.attributes, counter: doc.attributes.counter + 1 }, + }; + }, + '7.12.2': (doc, context) => { + context.log.info(''); + return { + ...doc, + attributes: { ...doc.attributes, counter: doc.attributes.counter + 2 }, + }; + }, + }; + + const obj2: SavedObjectMigrationMap = { + '7.12.0': (doc, context) => { + context.log.info(''); + return { + ...doc, + attributes: { ...doc.attributes, counter: doc.attributes.counter - 2 }, + }; + }, + '7.12.2': (doc, context) => { + context.log.info(''); + return { + ...doc, + attributes: { ...doc.attributes, counter: doc.attributes.counter + 2 }, + }; + }, + }; + const context = { log: { info: jest.fn() } } as unknown as SavedObjectMigrationContext; + + const result = mergeSavedObjectMigrationMaps(obj1, obj2); + expect( + (result['7.12.0'] as SavedObjectMigrationFn)( + { attributes: { counter: 5 } } as SavedObjectUnsanitizedDoc, + context + ) + ).toHaveProperty('attributes.counter', 3); + expect(context.log.info).toHaveBeenCalledTimes(1); + + expect( + (result['7.12.1'] as SavedObjectMigrationFn)( + { attributes: { counter: 5 } } as SavedObjectUnsanitizedDoc, + context + ) + ).toHaveProperty('attributes.counter', 6); + expect(context.log.info).toHaveBeenCalledTimes(2); + + expect( + (result['7.12.2'] as SavedObjectMigrationFn)( + { attributes: { counter: 5 } } as SavedObjectUnsanitizedDoc, + context + ) + ).toHaveProperty('attributes.counter', 9); + expect(context.log.info).toHaveBeenCalledTimes(4); + }); +}); diff --git a/packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migrations.ts b/packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migrations.ts new file mode 100644 index 0000000000000..748167c62a6d0 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-utils-server/src/merge_migrations.ts @@ -0,0 +1,84 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { ary, isFunction, mergeWith } from 'lodash'; +import type { + SavedObjectMigrationContext, + SavedObjectMigration, + SavedObjectMigrationMap, + SavedObjectUnsanitizedDoc, +} from '@kbn/core-saved-objects-server'; + +/** + * Composes two migrations into a single migration. + * ``` + * mergeSavedObjectMigrations(outer, inner) -> (doc, context) => outer(inner(doc, context), context) } + * ``` + * + * If at least one of the migrations is not deferred, the composed migration will not be deferred. + * + * @public + * @param outer Wrapping migration. + * @param inner Wrapped migration. + * @param rest Additional wrapped migrations to compose. + * @returns The composed migration can be either a function or an object depending on the input migrations. + */ +export function mergeSavedObjectMigrations( + outer: SavedObjectMigration, + inner: SavedObjectMigration, + ...rest: SavedObjectMigration[] +): SavedObjectMigration { + if (rest.length) { + return mergeSavedObjectMigrations( + mergeSavedObjectMigrations(outer, inner), + ...(rest as [SavedObjectMigration, ...SavedObjectMigration[]]) + ); + } + if (!inner || !outer) { + return inner || outer; + } + + const innerMigration = isFunction(inner) ? { transform: inner } : inner; + const outerMigration = isFunction(outer) ? { transform: outer } : outer; + const merged = { + deferred: !!(innerMigration.deferred && outerMigration.deferred), + transform: (state: SavedObjectUnsanitizedDoc, context: SavedObjectMigrationContext) => + outerMigration.transform(innerMigration.transform(state, context), context), + }; + + if (isFunction(inner) && isFunction(outer)) { + return merged.transform; + } + + return merged as SavedObjectMigration; +} + +/** + * Merges two saved object migration maps. + * + * If there is a migration for a given version on only one of the maps, + * that migration function will be used: + * + * mergeSavedObjectMigrationMaps({ '1.2.3': f }, { '4.5.6': g }) -> { '1.2.3': f, '4.5.6': g } + * + * If there is a migration for a given version on both maps, the migrations will be composed: + * + * mergeSavedObjectMigrationMaps({ '1.2.3': f }, { '1.2.3': g }) -> { '1.2.3': (doc, context) => f(g(doc, context), context) } + * + * @public + * + * @param map1 - The first map to merge + * @param map2 - The second map to merge + * @returns The merged map {@link SavedObjectMigrationMap} + */ +export function mergeSavedObjectMigrationMaps( + map1: SavedObjectMigrationMap, + map2: SavedObjectMigrationMap +): SavedObjectMigrationMap { + return mergeWith({ ...map1 }, map2, ary(mergeSavedObjectMigrations, 2)); +} diff --git a/packages/core/saved-objects/core-saved-objects-utils-server/src/saved_objects_utils.test.ts b/packages/core/saved-objects/core-saved-objects-utils-server/src/saved_objects_utils.test.ts index 717b52ef248ca..d2454abaac4fa 100644 --- a/packages/core/saved-objects/core-saved-objects-utils-server/src/saved_objects_utils.test.ts +++ b/packages/core/saved-objects/core-saved-objects-utils-server/src/saved_objects_utils.test.ts @@ -107,4 +107,18 @@ describe('SavedObjectsUtils', () => { expect(mockUuidv5).toHaveBeenCalledWith('namespace:type:oldId', 'DNSUUID'); }); }); + + describe('#getMigrationFunction', () => { + it('should return the migration function when it is a function', () => { + const migration = jest.fn(); + + expect(SavedObjectsUtils.getMigrationFunction(migration)).toBe(migration); + }); + + it('should return the migration function when it is a migration object', () => { + const migration = { transform: jest.fn() }; + + expect(SavedObjectsUtils.getMigrationFunction(migration)).toBe(migration.transform); + }); + }); }); diff --git a/packages/core/saved-objects/core-saved-objects-utils-server/src/saved_objects_utils.ts b/packages/core/saved-objects/core-saved-objects-utils-server/src/saved_objects_utils.ts index f88ea5472fcb4..badfb797292cc 100644 --- a/packages/core/saved-objects/core-saved-objects-utils-server/src/saved_objects_utils.ts +++ b/packages/core/saved-objects/core-saved-objects-utils-server/src/saved_objects_utils.ts @@ -6,11 +6,13 @@ * Side Public License, v 1. */ +import { isFunction } from 'lodash'; import { v1 as uuidv1, v5 as uuidv5 } from 'uuid'; import type { SavedObjectsFindOptions, SavedObjectsFindResponse, } from '@kbn/core-saved-objects-api-server'; +import type { SavedObjectMigration, SavedObjectMigrationFn } from '@kbn/core-saved-objects-server'; export const DEFAULT_NAMESPACE_STRING = 'default'; export const ALL_NAMESPACES_STRING = '*'; @@ -95,4 +97,15 @@ export class SavedObjectsUtils { } return uuidv5(`${namespace}:${type}:${id}`, uuidv5.DNS); // The uuidv5 namespace constant (uuidv5.DNS) is arbitrary. } + + /** + * Gets the transform function from a migration object. + * @param migration Migration object or a migration function. + * @returns A migration function. + */ + public static getMigrationFunction( + migration: SavedObjectMigration + ): SavedObjectMigrationFn { + return isFunction(migration) ? migration : migration.transform; + } } diff --git a/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/extract_migration_info.test.ts b/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/extract_migration_info.test.ts index 3fd289c9b6ca0..2e4cc22032586 100644 --- a/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/extract_migration_info.test.ts +++ b/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/extract_migration_info.test.ts @@ -202,12 +202,18 @@ describe('extractMigrationInfo', () => { changeTypes: ['data_backfill'], hasTransformation: true, newMappings: [], + schemas: { + forwardCompatibility: false, + }, }, { version: '2', changeTypes: ['mappings_addition'], hasTransformation: false, newMappings: ['foo.type'], + schemas: { + forwardCompatibility: false, + }, }, ]); }); @@ -245,12 +251,18 @@ describe('extractMigrationInfo', () => { changeTypes: ['data_backfill'], hasTransformation: true, newMappings: [], + schemas: { + forwardCompatibility: false, + }, }, { version: '2', changeTypes: ['mappings_addition'], hasTransformation: false, newMappings: ['foo.type'], + schemas: { + forwardCompatibility: false, + }, }, ]); }); @@ -263,6 +275,32 @@ describe('extractMigrationInfo', () => { expect(output.modelVersions).toEqual([]); }); + + it('returns the correct values for schemas', () => { + const type = createType({ + switchToModelVersionAt: '8.8.0', + modelVersions: { + 1: { + changes: [], + schemas: { + forwardCompatibility: jest.fn(), + }, + }, + 2: { + changes: [], + schemas: {}, + }, + }, + }); + const output = extractMigrationInfo(type); + + expect(output.modelVersions[0].schemas).toEqual({ + forwardCompatibility: true, + }); + expect(output.modelVersions[1].schemas).toEqual({ + forwardCompatibility: false, + }); + }); }); describe('migrations and modelVersions', () => { @@ -310,12 +348,18 @@ describe('extractMigrationInfo', () => { changeTypes: ['data_backfill'], hasTransformation: true, newMappings: [], + schemas: { + forwardCompatibility: false, + }, }, { version: '2', changeTypes: ['mappings_addition'], hasTransformation: false, newMappings: ['foo.type'], + schemas: { + forwardCompatibility: false, + }, }, ], }) diff --git a/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/extract_migration_info.ts b/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/extract_migration_info.ts index 155310f2ecc3f..d2e88ac22521d 100644 --- a/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/extract_migration_info.ts +++ b/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/extract_migration_info.ts @@ -31,6 +31,9 @@ export interface ModelVersionSummary { changeTypes: string[]; hasTransformation: boolean; newMappings: string[]; + schemas: { + forwardCompatibility: boolean; + }; } /** @@ -53,13 +56,16 @@ export const extractMigrationInfo = (soType: SavedObjectsType): SavedObjectTypeM ? soType.modelVersions() : soType.modelVersions ?? {}; const modelVersionIds = Object.keys(modelVersionMap); - const modelVersions = modelVersionIds.map((version) => { + const modelVersions = modelVersionIds.map((version) => { const entry = modelVersionMap[version]; return { version, changeTypes: entry.changes.map((change) => change.type), hasTransformation: hasTransformation(entry.changes), newMappings: Object.keys(getFlattenedObject(aggregateMappingAdditions(entry.changes))), + schemas: { + forwardCompatibility: !!entry.schemas?.forwardCompatibility, + }, }; }); diff --git a/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/get_migration_hash.test.ts b/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/get_migration_hash.test.ts index bb090f16a01ed..1c931e4649060 100644 --- a/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/get_migration_hash.test.ts +++ b/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/get_migration_hash.test.ts @@ -518,6 +518,29 @@ describe('getMigrationHash', () => { expect(getMigrationHash(typeA)).not.toEqual(getMigrationHash(typeB)); }); + + it('returns different hashes if different schemas are registered', () => { + const typeA = createType({ + modelVersions: { + 1: { + changes: [], + schemas: { + forwardCompatibility: jest.fn(), + }, + }, + }, + }); + const typeB = createType({ + modelVersions: { + 1: { + changes: [], + schemas: {}, + }, + }, + }); + + expect(getMigrationHash(typeA)).not.toEqual(getMigrationHash(typeB)); + }); }); describe('ignored fields', () => { diff --git a/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/get_migration_hash.ts b/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/get_migration_hash.ts index 587620bc43139..f8db21f0e7603 100644 --- a/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/get_migration_hash.ts +++ b/packages/core/test-helpers/core-test-helpers-so-type-serializer/src/get_migration_hash.ts @@ -35,10 +35,12 @@ export const getMigrationHash = (soType: SavedObjectsType): SavedObjectTypeMigra }; const serializeModelVersion = (modelVersion: ModelVersionSummary): string => { + const schemas = [modelVersion.schemas.forwardCompatibility]; return [ modelVersion.version, modelVersion.changeTypes.join(','), modelVersion.hasTransformation, + schemas.join(','), ...modelVersion.newMappings, ].join('|'); }; diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.test.ts index c9f8701adfd2f..77b228cf35df0 100644 --- a/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.test.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.test.ts @@ -380,3 +380,38 @@ describe('ui_settings 8.7.0 migrations', () => { }); }); }); + +describe('ui_settings 8.9.0 migrations', () => { + const migration = migrations['8.9.0']; + + test('returns doc on empty object', () => { + expect(migration({} as SavedObjectUnsanitizedDoc)).toEqual({ + references: [], + }); + }); + + test('removes "visualize:enableLabs" setting', () => { + const doc = { + type: 'config', + id: '8.9.0', + attributes: { + buildNum: 9007199254740991, + 'visualize:enableLabs': true, + }, + references: [], + updated_at: '2020-06-09T20:18:20.349Z', + migrationVersion: {}, + }; + + expect(migration(doc)).toEqual({ + type: 'config', + id: '8.9.0', + attributes: { + buildNum: 9007199254740991, + }, + references: [], + updated_at: '2020-06-09T20:18:20.349Z', + migrationVersion: {}, + }); + }); +}); diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.ts index f8b6e287d4682..2bdac1b6ef48f 100644 --- a/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.ts @@ -183,4 +183,25 @@ export const migrations = { }), references: doc.references || [], }), + '8.9.0': (doc: SavedObjectUnsanitizedDoc): SavedObjectSanitizedDoc => ({ + ...doc, + ...(doc.attributes && { + attributes: Object.keys(doc.attributes).reduce( + (acc, key) => + [ + // owner: Team:Visualizations + 'visualize:enableLabs', + ].includes(key) + ? { + ...acc, + } + : { + ...acc, + [key]: doc.attributes[key], + }, + {} + ), + }), + references: doc.references || [], + }), }; diff --git a/packages/kbn-ambient-ftr-types/kibana.jsonc b/packages/kbn-ambient-ftr-types/kibana.jsonc index 0464c850c1663..3f8a3dbeeceef 100644 --- a/packages/kbn-ambient-ftr-types/kibana.jsonc +++ b/packages/kbn-ambient-ftr-types/kibana.jsonc @@ -1,6 +1,6 @@ { "type": "shared-common", "id": "@kbn/ambient-ftr-types", - "owner": "@elastic/kibana-operations", + "owner": ["@elastic/kibana-operations", "@elastic/appex-qa"], "devOnly": true } diff --git a/packages/kbn-cell-actions/src/actions/copy_to_clipboard/copy_to_clipboard.test.ts b/packages/kbn-cell-actions/src/actions/copy_to_clipboard/copy_to_clipboard.test.ts index 395fbd13cfadf..5037e1cd529f5 100644 --- a/packages/kbn-cell-actions/src/actions/copy_to_clipboard/copy_to_clipboard.test.ts +++ b/packages/kbn-cell-actions/src/actions/copy_to_clipboard/copy_to_clipboard.test.ts @@ -48,5 +48,25 @@ describe('Default createCopyToClipboardActionFactory', () => { expect(mockCopy).toHaveBeenCalledWith('user.name: "the value"'); expect(mockSuccessToast).toHaveBeenCalled(); }); + + it('should escape value', async () => { + await copyToClipboardAction.execute({ + ...context, + field: { ...context.field, value: 'the "value"' }, + }); + expect(mockCopy).toHaveBeenCalledWith('user.name: "the \\"value\\""'); + expect(mockSuccessToast).toHaveBeenCalled(); + }); + + it('should suport multiple values', async () => { + await copyToClipboardAction.execute({ + ...context, + field: { ...context.field, value: ['the "value"', 'another value', 'last value'] }, + }); + expect(mockCopy).toHaveBeenCalledWith( + 'user.name: "the \\"value\\"" AND "another value" AND "last value"' + ); + expect(mockSuccessToast).toHaveBeenCalled(); + }); }); }); diff --git a/packages/kbn-cell-actions/src/actions/copy_to_clipboard/copy_to_clipboard.ts b/packages/kbn-cell-actions/src/actions/copy_to_clipboard/copy_to_clipboard.ts index 9d4860da1c77c..cafbd29d91455 100644 --- a/packages/kbn-cell-actions/src/actions/copy_to_clipboard/copy_to_clipboard.ts +++ b/packages/kbn-cell-actions/src/actions/copy_to_clipboard/copy_to_clipboard.ts @@ -23,6 +23,8 @@ const COPY_TO_CLIPBOARD_SUCCESS = i18n.translate( } ); +const escapeValue = (value: string) => value.replace(/"/g, '\\"'); + export const createCopyToClipboardActionFactory = createCellActionFactory( ({ notifications }: { notifications: NotificationsStart }) => ({ type: COPY_CELL_ACTION_TYPE, @@ -34,8 +36,8 @@ export const createCopyToClipboardActionFactory = createCellActionFactory( let textValue: undefined | string; if (field.value != null) { textValue = Array.isArray(field.value) - ? field.value.map((value) => `"${value}"`).join(', ') - : `"${field.value}"`; + ? field.value.map((value) => `"${escapeValue(value)}"`).join(' AND ') + : `"${escapeValue(field.value)}"`; } const text = textValue ? `${field.name}: ${textValue}` : field.name; const isSuccess = copy(text, { debug: true }); diff --git a/packages/kbn-cell-actions/src/actions/filter/create_filter.test.ts b/packages/kbn-cell-actions/src/actions/filter/create_filter.test.ts index 12ae2fa16a2dd..7d4a2f12a216a 100644 --- a/packages/kbn-cell-actions/src/actions/filter/create_filter.test.ts +++ b/packages/kbn-cell-actions/src/actions/filter/create_filter.test.ts @@ -18,21 +18,17 @@ describe('createFilter', () => { ])('should return filter with $caseName value', ({ caseValue }) => { expect(createFilter({ key: field, value: caseValue, negate: false })).toEqual({ meta: { - alias: null, - disabled: false, type: 'phrase', key: field, negate: false, - value, params: { query: value, }, }, query: { - match: { + match_phrase: { [field]: { query: value, - type: 'phrase', }, }, }, @@ -45,27 +41,48 @@ describe('createFilter', () => { ])('should return negate filter with $caseName value', ({ caseValue }) => { expect(createFilter({ key: field, value: caseValue, negate: true })).toEqual({ meta: { - alias: null, - disabled: false, type: 'phrase', key: field, negate: true, - value, params: { query: value, }, }, query: { - match: { + match_phrase: { [field]: { query: value, - type: 'phrase', }, }, }, }); }); + it.each([ + { caseName: 'non-negated', negate: false }, + { caseName: 'negated', negate: true }, + ])('should return combined filter with multiple $caseName values', ({ negate }) => { + const value2 = 'the-value2'; + expect(createFilter({ key: field, value: [value, value2], negate })).toEqual({ + meta: { + type: 'combined', + relation: 'AND', + key: field, + negate, + params: [ + { + meta: { type: 'phrase', key: field, params: { query: value } }, + query: { match_phrase: { [field]: { query: value } } }, + }, + { + meta: { type: 'phrase', key: field, params: { query: value2 } }, + query: { match_phrase: { [field]: { query: value2 } } }, + }, + ], + }, + }); + }); + it.each([ { caseName: 'null', caseValue: null }, { caseName: 'undefined', caseValue: undefined }, @@ -79,8 +96,6 @@ describe('createFilter', () => { }, }, meta: { - alias: null, - disabled: false, key: field, negate: false, type: 'exists', @@ -102,8 +117,6 @@ describe('createFilter', () => { }, }, meta: { - alias: null, - disabled: false, key: field, negate: true, type: 'exists', diff --git a/packages/kbn-cell-actions/src/actions/filter/create_filter.ts b/packages/kbn-cell-actions/src/actions/filter/create_filter.ts index 1dcb44e2b73e7..36a56d602ed97 100644 --- a/packages/kbn-cell-actions/src/actions/filter/create_filter.ts +++ b/packages/kbn-cell-actions/src/actions/filter/create_filter.ts @@ -5,10 +5,54 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ -import type { Filter } from '@kbn/es-query'; +import { + BooleanRelation, + FILTERS, + type CombinedFilter, + type ExistsFilter, + type PhraseFilter, + type Filter, +} from '@kbn/es-query'; -export const isEmptyFilterValue = (value: string[] | string | null | undefined) => - value == null || value.length === 0; +export const isEmptyFilterValue = ( + value: string[] | string | null | undefined +): value is null | undefined | never[] => value == null || value.length === 0; + +const createExistsFilter = ({ key, negate }: { key: string; negate: boolean }): ExistsFilter => ({ + meta: { key, negate, type: FILTERS.EXISTS, value: 'exists' }, + query: { exists: { field: key } }, +}); + +const createPhraseFilter = ({ + key, + negate, + value, +}: { + value: string; + key: string; + negate?: boolean; +}): PhraseFilter => ({ + meta: { key, negate, type: FILTERS.PHRASE, params: { query: value } }, + query: { match_phrase: { [key]: { query: value } } }, +}); + +const createCombinedFilter = ({ + values, + key, + negate, +}: { + values: string[]; + key: string; + negate: boolean; +}): CombinedFilter => ({ + meta: { + key, + negate, + type: FILTERS.COMBINED, + relation: BooleanRelation.AND, + params: values.map((value) => createPhraseFilter({ key, value })), + }, +}); export const createFilter = ({ key, @@ -19,39 +63,15 @@ export const createFilter = ({ value: string[] | string | null | undefined; negate: boolean; }): Filter => { - const queryValue = !isEmptyFilterValue(value) ? (Array.isArray(value) ? value[0] : value) : null; - const meta = { alias: null, disabled: false, key, negate }; - - if (queryValue == null) { - return { - query: { - exists: { - field: key, - }, - }, - meta: { - ...meta, - type: 'exists', - value: 'exists', - }, - }; + if (isEmptyFilterValue(value)) { + return createExistsFilter({ key, negate }); + } + if (Array.isArray(value)) { + if (value.length > 1) { + return createCombinedFilter({ key, negate, values: value }); + } else { + return createPhraseFilter({ key, negate, value: value[0] }); + } } - return { - meta: { - ...meta, - type: 'phrase', - value: queryValue, - params: { - query: queryValue, - }, - }, - query: { - match: { - [key]: { - query: queryValue, - type: 'phrase', - }, - }, - }, - }; + return createPhraseFilter({ key, negate, value }); }; diff --git a/packages/kbn-check-mappings-update-cli/src/check_additive_only_change.ts b/packages/kbn-check-mappings-update-cli/src/check_additive_only_change.ts index 7fb42f7115233..d13db53b0110d 100644 --- a/packages/kbn-check-mappings-update-cli/src/check_additive_only_change.ts +++ b/packages/kbn-check-mappings-update-cli/src/check_additive_only_change.ts @@ -27,14 +27,14 @@ export function checkAdditiveOnlyChange( next: SavedObjectsTypeMappingDefinitions ) { let checkedCount = 0; - const Os: Array<[path: string[], value: unknown]> = [[[], current]]; + const pathValueTuples: Array<[path: string[], value: unknown]> = [[[], current]]; const missingProps: string[] = []; - while (Os.length) { - const [path, value] = Os.shift()!; + while (pathValueTuples.length) { + const [path, value] = pathValueTuples.shift()!; // "Recurse" into the value if it's an object if (isObject(value)) { - Object.entries(value).forEach(([k, v]) => Os.push([[...path, k], v])); + Object.entries(value).forEach(([k, v]) => pathValueTuples.push([[...path, k], v])); } // If we're at a "properties" object, check that the next mappings have the same field if (path.length > 1 && path[path.length - 2] === 'properties') { @@ -47,7 +47,10 @@ export function checkAdditiveOnlyChange( if (missingProps.length > 0) { const props = JSON.stringify(missingProps, null, 2); throw createFailError( - `Removing mapped properties is disallowed. Properties found in current mappings but not in next mappings:\n${props}` + `Removing mapped properties is disallowed >8.8. Found the following properties in current mappings but not in next mappings: +${props} + +Reach out to the Kibana core team if you have any questions.` ); } diff --git a/packages/kbn-check-mappings-update-cli/src/check_additve_only_change.test.ts b/packages/kbn-check-mappings-update-cli/src/check_additve_only_change.test.ts index 11f9394b9dd5e..6b0ed703b3836 100644 --- a/packages/kbn-check-mappings-update-cli/src/check_additve_only_change.test.ts +++ b/packages/kbn-check-mappings-update-cli/src/check_additve_only_change.test.ts @@ -40,12 +40,14 @@ describe('#checkAdditiveOnlyChange', () => { delete next.bar.properties.number; expect(() => checkAdditiveOnlyChange(log, current, next)).toThrowErrorMatchingInlineSnapshot(` - "Removing mapped properties is disallowed. Properties found in current mappings but not in next mappings: + "Removing mapped properties is disallowed >8.8. Found the following properties in current mappings but not in next mappings: [ \\"foo.properties.text\\", \\"bar.properties.number\\", \\"foo.properties.object.properties.nestedText\\" - ]" + ] + + Reach out to the Kibana core team if you have any questions." `); }); diff --git a/packages/kbn-content-management-utils/src/saved_object_content_storage.ts b/packages/kbn-content-management-utils/src/saved_object_content_storage.ts index c916362578f16..ac8877e5a26da 100644 --- a/packages/kbn-content-management-utils/src/saved_object_content_storage.ts +++ b/packages/kbn-content-management-utils/src/saved_object_content_storage.ts @@ -21,6 +21,7 @@ import type { SavedObjectsUpdateOptions, SavedObjectsFindResult, } from '@kbn/core-saved-objects-api-server'; +import { pick } from 'lodash'; import type { CMCrudTypes, ServicesDefinitionSet, @@ -44,16 +45,19 @@ type PartialSavedObject = Omit>, 'references'> & { function savedObjectToItem( savedObject: SavedObject, + allowedSavedObjectAttributes: string[], partial: false ): Item; function savedObjectToItem( savedObject: PartialSavedObject, + allowedSavedObjectAttributes: string[], partial: true ): PartialItem; function savedObjectToItem( - savedObject: SavedObject | PartialSavedObject + savedObject: SavedObject | PartialSavedObject, + allowedSavedObjectAttributes: string[] ): SOWithMetadata | SOWithMetadataPartial { const { id, @@ -64,6 +68,7 @@ function savedObjectToItem( references, error, namespaces, + version, } = savedObject; return { @@ -71,10 +76,11 @@ function savedObjectToItem( type, updatedAt, createdAt, - attributes, + attributes: pick(attributes, allowedSavedObjectAttributes), references, error, namespaces, + version, }; } @@ -123,6 +129,8 @@ export type UpdateArgsToSoUpdateOptions = ( export interface SOContentStorageConstrutorParams { savedObjectType: string; cmServicesDefinition: ServicesDefinitionSet; + // this is necessary since unexpected saved object attributes could cause schema validation to fail + allowedSavedObjectAttributes: string[]; createArgsToSoCreateOptions?: CreateArgsToSoCreateOptions; updateArgsToSoUpdateOptions?: UpdateArgsToSoUpdateOptions; searchArgsToSOFindOptions?: SearchArgsToSOFindOptions; @@ -144,6 +152,7 @@ export abstract class SOContentStorage updateArgsToSoUpdateOptions, searchArgsToSOFindOptions, enableMSearch, + allowedSavedObjectAttributes, }: SOContentStorageConstrutorParams) { this.savedObjectType = savedObjectType; this.cmServicesDefinition = cmServicesDefinition; @@ -152,6 +161,7 @@ export abstract class SOContentStorage this.updateArgsToSoUpdateOptions = updateArgsToSoUpdateOptions || updateArgsToSoUpdateOptionsDefault; this.searchArgsToSOFindOptions = searchArgsToSOFindOptions || searchArgsToSOFindOptionsDefault; + this.allowedSavedObjectAttributes = allowedSavedObjectAttributes; if (enableMSearch) { this.mSearch = { @@ -163,7 +173,13 @@ export abstract class SOContentStorage const { value, error: resultError } = transforms.mSearch.out.result.down< Types['Item'], Types['Item'] - >(savedObjectToItem(savedObject as SavedObjectsFindResult, false)); + >( + savedObjectToItem( + savedObject as SavedObjectsFindResult, + this.allowedSavedObjectAttributes, + false + ) + ); if (resultError) { throw Boom.badRequest(`Invalid response. ${resultError.message}`); @@ -180,6 +196,7 @@ export abstract class SOContentStorage private createArgsToSoCreateOptions: CreateArgsToSoCreateOptions; private updateArgsToSoUpdateOptions: UpdateArgsToSoUpdateOptions; private searchArgsToSOFindOptions: SearchArgsToSOFindOptions; + private allowedSavedObjectAttributes: string[]; mSearch?: { savedObjectType: string; @@ -199,7 +216,7 @@ export abstract class SOContentStorage } = await soClient.resolve(this.savedObjectType, id); const response: Types['GetOut'] = { - item: savedObjectToItem(savedObject, false), + item: savedObjectToItem(savedObject, this.allowedSavedObjectAttributes, false), meta: { aliasPurpose, aliasTargetId, @@ -264,7 +281,7 @@ export abstract class SOContentStorage Types['CreateOut'], Types['CreateOut'] >({ - item: savedObjectToItem(savedObject, false), + item: savedObjectToItem(savedObject, this.allowedSavedObjectAttributes, false), }); if (resultError) { @@ -315,7 +332,7 @@ export abstract class SOContentStorage Types['UpdateOut'], Types['UpdateOut'] >({ - item: savedObjectToItem(partialSavedObject, true), + item: savedObjectToItem(partialSavedObject, this.allowedSavedObjectAttributes, true), }); if (resultError) { @@ -325,9 +342,14 @@ export abstract class SOContentStorage return value; } - async delete(ctx: StorageContext, id: string): Promise { + async delete( + ctx: StorageContext, + id: string, + // force is necessary to delete saved objects that exist in multiple namespaces + options?: { force: boolean } + ): Promise { const soClient = await savedObjectClientFromRequest(ctx); - await soClient.delete(this.savedObjectType, id); + await soClient.delete(this.savedObjectType, id, { force: options?.force ?? false }); return { success: true }; } @@ -361,7 +383,9 @@ export abstract class SOContentStorage Types['SearchOut'], Types['SearchOut'] >({ - hits: response.saved_objects.map((so) => savedObjectToItem(so, false)), + hits: response.saved_objects.map((so) => + savedObjectToItem(so, this.allowedSavedObjectAttributes, false) + ), pagination: { total: response.total, }, diff --git a/packages/kbn-content-management-utils/src/types.ts b/packages/kbn-content-management-utils/src/types.ts index 970aefd9a0058..ad9f805bc0998 100644 --- a/packages/kbn-content-management-utils/src/types.ts +++ b/packages/kbn-content-management-utils/src/types.ts @@ -176,7 +176,7 @@ export interface SavedObjectUpdateOptions { } /** Return value for Saved Object get, T is item returned */ -export type GetResultSO = GetResult< +export type GetResultSO = GetResult< T, { outcome: 'exactMatch' | 'aliasMatch' | 'conflict'; diff --git a/packages/kbn-doc-links/src/get_doc_links.ts b/packages/kbn-doc-links/src/get_doc_links.ts index 08b1560c16936..79570d804a20d 100644 --- a/packages/kbn-doc-links/src/get_doc_links.ts +++ b/packages/kbn-doc-links/src/get_doc_links.ts @@ -382,7 +382,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => { gettingStarted: `${SECURITY_SOLUTION_DOCS}index.html`, privileges: `${SECURITY_SOLUTION_DOCS}sec-requirements.html`, ml: `${SECURITY_SOLUTION_DOCS}machine-learning.html`, - ruleChangeLog: `${SECURITY_SOLUTION_DOCS}prebuilt-rules-changelog.html`, + ruleChangeLog: `${SECURITY_SOLUTION_DOCS}prebuilt-rules-downloadable-updates.html`, detectionsReq: `${SECURITY_SOLUTION_DOCS}detections-permissions-section.html`, networkMap: `${SECURITY_SOLUTION_DOCS}conf-map-ui.html`, troubleshootGaps: `${SECURITY_SOLUTION_DOCS}alerts-ui-monitor.html#troubleshoot-gaps`, @@ -511,6 +511,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => { indexAction: `${KIBANA_DOCS}index-action-type.html`, esQuery: `${KIBANA_DOCS}rule-type-es-query.html`, indexThreshold: `${KIBANA_DOCS}rule-type-index-threshold.html`, + maintenanceWindows: `${KIBANA_DOCS}maintenance-windows.html`, pagerDutyAction: `${KIBANA_DOCS}pagerduty-action-type.html`, preconfiguredConnectors: `${KIBANA_DOCS}pre-configured-connectors.html`, preconfiguredAlertHistoryConnector: `${KIBANA_DOCS}index-action-type.html#preconfigured-connector-alert-history`, diff --git a/packages/kbn-doc-links/src/types.ts b/packages/kbn-doc-links/src/types.ts index b1025c0cfdfff..baddae7bb5e37 100644 --- a/packages/kbn-doc-links/src/types.ts +++ b/packages/kbn-doc-links/src/types.ts @@ -393,6 +393,7 @@ export interface DocLinks { indexAction: string; esQuery: string; indexThreshold: string; + maintenanceWindows: string; pagerDutyAction: string; preconfiguredConnectors: string; preconfiguredAlertHistoryConnector: string; diff --git a/packages/kbn-es-archiver/kibana.jsonc b/packages/kbn-es-archiver/kibana.jsonc index d8cc353c56356..1bf6c53d4bb54 100644 --- a/packages/kbn-es-archiver/kibana.jsonc +++ b/packages/kbn-es-archiver/kibana.jsonc @@ -2,5 +2,5 @@ "type": "shared-common", "id": "@kbn/es-archiver", "devOnly": true, - "owner": "@elastic/kibana-operations" + "owner": ["@elastic/kibana-operations", "@elastic/appex-qa"], } diff --git a/packages/kbn-expect/kibana.jsonc b/packages/kbn-expect/kibana.jsonc index 86eae76001f8c..6f2732af83e64 100644 --- a/packages/kbn-expect/kibana.jsonc +++ b/packages/kbn-expect/kibana.jsonc @@ -2,5 +2,5 @@ "type": "shared-common", "id": "@kbn/expect", "devOnly": true, - "owner": "@elastic/kibana-operations" + "owner": ["@elastic/kibana-operations", "@elastic/appex-qa"], } diff --git a/packages/kbn-failed-test-reporter-cli/kibana.jsonc b/packages/kbn-failed-test-reporter-cli/kibana.jsonc index 9dbfec546ed11..f35af8544fefc 100644 --- a/packages/kbn-failed-test-reporter-cli/kibana.jsonc +++ b/packages/kbn-failed-test-reporter-cli/kibana.jsonc @@ -1,6 +1,6 @@ { "type": "shared-common", "id": "@kbn/failed-test-reporter-cli", - "owner": "@elastic/kibana-operations", + "owner": ["@elastic/kibana-operations", "@elastic/appex-qa"], "devOnly": true } diff --git a/packages/kbn-ftr-common-functional-services/kibana.jsonc b/packages/kbn-ftr-common-functional-services/kibana.jsonc index c8f706e5acf38..68f45c75c6a80 100644 --- a/packages/kbn-ftr-common-functional-services/kibana.jsonc +++ b/packages/kbn-ftr-common-functional-services/kibana.jsonc @@ -1,6 +1,6 @@ { "type": "shared-common", "id": "@kbn/ftr-common-functional-services", - "owner": "@elastic/kibana-operations", + "owner": ["@elastic/kibana-operations", "@elastic/appex-qa"], "devOnly": true } diff --git a/packages/kbn-ftr-screenshot-filename/kibana.jsonc b/packages/kbn-ftr-screenshot-filename/kibana.jsonc index 5429602d9c0ed..c4d6004ed83db 100644 --- a/packages/kbn-ftr-screenshot-filename/kibana.jsonc +++ b/packages/kbn-ftr-screenshot-filename/kibana.jsonc @@ -1,6 +1,6 @@ { "type": "shared-common", "id": "@kbn/ftr-screenshot-filename", - "owner": "@elastic/kibana-operations", + "owner": ["@elastic/kibana-operations", "@elastic/appex-qa"], "devOnly": true } diff --git a/packages/kbn-journeys/kibana.jsonc b/packages/kbn-journeys/kibana.jsonc index f27a7c228cb41..b90e3b548d1ef 100644 --- a/packages/kbn-journeys/kibana.jsonc +++ b/packages/kbn-journeys/kibana.jsonc @@ -1,6 +1,6 @@ { "type": "shared-common", "id": "@kbn/journeys", - "owner": "@elastic/kibana-operations", + "owner": ["@elastic/kibana-operations", "@elastic/appex-qa"], "devOnly": true } diff --git a/packages/kbn-optimizer/limits.yml b/packages/kbn-optimizer/limits.yml index 7896616cf76c4..422130eca5608 100644 --- a/packages/kbn-optimizer/limits.yml +++ b/packages/kbn-optimizer/limits.yml @@ -117,7 +117,7 @@ pageLoadAssetSize: securitySolution: 66738 serverless: 16573 serverlessObservability: 30000 - serverlessSearch: 25600 + serverlessSearch: 30000 serverlessSecurity: 41807 sessionView: 77750 share: 71239 @@ -128,6 +128,7 @@ pageLoadAssetSize: synthetics: 40958 telemetry: 51957 telemetryManagementSection: 38586 + textBasedLanguages: 37000 threatIntelligence: 44299 timelines: 327300 transform: 41007 diff --git a/packages/kbn-repo-packages/modern/get_git_repo_root.js b/packages/kbn-repo-packages/modern/get_git_repo_root.js index b365b6b8870c9..344bf0e74296f 100644 --- a/packages/kbn-repo-packages/modern/get_git_repo_root.js +++ b/packages/kbn-repo-packages/modern/get_git_repo_root.js @@ -26,6 +26,7 @@ function getGitRepoRootSync(repoRoot) { cwd: repoRoot, encoding: 'utf8', maxBuffer: Infinity, + stdio: 'pipe', }); const firstLine = stdout.split('\n')[0]; diff --git a/packages/kbn-securitysolution-autocomplete/src/field/__tests__/__snapshots__/index.test.tsx.snap b/packages/kbn-securitysolution-autocomplete/src/field/__tests__/__snapshots__/index.test.tsx.snap index d70949aaf3641..daa0fc69771ef 100644 --- a/packages/kbn-securitysolution-autocomplete/src/field/__tests__/__snapshots__/index.test.tsx.snap +++ b/packages/kbn-securitysolution-autocomplete/src/field/__tests__/__snapshots__/index.test.tsx.snap @@ -251,24 +251,6 @@ Object { />
    -
    - -
    @@ -316,24 +298,6 @@ Object { /> -
    - -
    @@ -629,20 +593,6 @@ Object { class="euiLoadingSpinner emotion-euiLoadingSpinner-m" role="progressbar" /> - @@ -699,20 +649,6 @@ Object { class="euiLoadingSpinner emotion-euiLoadingSpinner-m" role="progressbar" /> - diff --git a/packages/kbn-securitysolution-grouping/src/components/grouping.tsx b/packages/kbn-securitysolution-grouping/src/components/grouping.tsx index 068b0f7a42ef6..aab42a0804e4c 100644 --- a/packages/kbn-securitysolution-grouping/src/components/grouping.tsx +++ b/packages/kbn-securitysolution-grouping/src/components/grouping.tsx @@ -101,7 +101,7 @@ const GroupingComponent = ({ : undefined; return ( - + = {}) { - const { method, pathname: rawPathname } = parseEndpoint(endpoint); + const { method, pathname: rawPathname, version } = parseEndpoint(endpoint); // replace template variables with path params const pathname = Object.keys(pathParams).reduce((acc, paramName) => { return acc.replace(`{${paramName}}`, pathParams[paramName]); }, rawPathname); - return { method, pathname }; + return { method, pathname, version }; } diff --git a/packages/kbn-server-route-repository/src/parse_endpoint.ts b/packages/kbn-server-route-repository/src/parse_endpoint.ts index fd40489b0f4a5..93c79cf994f51 100644 --- a/packages/kbn-server-route-repository/src/parse_endpoint.ts +++ b/packages/kbn-server-route-repository/src/parse_endpoint.ts @@ -13,10 +13,15 @@ export function parseEndpoint(endpoint: string) { const method = parts[0].trim().toLowerCase() as Method; const pathname = parts[1].trim(); + const version = parts[2]?.trim(); if (!['get', 'post', 'put', 'delete'].includes(method)) { - throw new Error('Endpoint was not prefixed with a valid HTTP method'); + throw new Error(`Endpoint ${endpoint} was not prefixed with a valid HTTP method`); } - return { method, pathname }; + if (!version && pathname.startsWith('/api')) { + throw new Error(`Missing version for public endpoint ${endpoint}`); + } + + return { method, pathname, version }; } diff --git a/packages/kbn-server-route-repository/src/test_types.ts b/packages/kbn-server-route-repository/src/test_types.ts index b1d74936d8aa0..61909be0967be 100644 --- a/packages/kbn-server-route-repository/src/test_types.ts +++ b/packages/kbn-server-route-repository/src/test_types.ts @@ -17,7 +17,7 @@ function assertType(value: TShape) { // If a params codec is not set, its type should not be available in // the request handler. createServerRouteFactory<{}, {}>()({ - endpoint: 'endpoint_without_params', + endpoint: 'GET /internal/endpoint_without_params', handler: async (resources) => { // @ts-expect-error Argument of type '{}' is not assignable to parameter of type '{ params: any; }'. assertType<{ params: any }>(resources); @@ -27,7 +27,7 @@ createServerRouteFactory<{}, {}>()({ // If a params codec is set, its type _should_ be available in the // request handler. createServerRouteFactory<{}, {}>()({ - endpoint: 'endpoint_with_params', + endpoint: 'GET /internal/endpoint_with_params', params: t.type({ path: t.type({ serviceName: t.string, @@ -40,7 +40,7 @@ createServerRouteFactory<{}, {}>()({ // Resources should be passed to the request handler. createServerRouteFactory<{ context: { getSpaceId: () => string } }, {}>()({ - endpoint: 'endpoint_with_params', + endpoint: 'GET /internal/endpoint_with_params', params: t.type({ path: t.type({ serviceName: t.string, @@ -54,7 +54,7 @@ createServerRouteFactory<{ context: { getSpaceId: () => string } }, {}>()({ // Create options are available when registering a route. createServerRouteFactory<{}, { options: { tags: string[] } }>()({ - endpoint: 'endpoint_with_params', + endpoint: 'GET /internal/endpoint_with_params', params: t.type({ path: t.type({ serviceName: t.string, @@ -68,11 +68,31 @@ createServerRouteFactory<{}, { options: { tags: string[] } }>()({ }, }); +// Public APIs should be versioned +createServerRouteFactory<{}, { options: { tags: string[] } }>()({ + // @ts-expect-error + endpoint: 'GET /api/endpoint_with_params', + options: { + // @ts-expect-error + tags: [], + }, + // @ts-expect-error + handler: async (resources) => {}, +}); + +createServerRouteFactory<{}, { options: { tags: string[] } }>()({ + endpoint: 'GET /api/endpoint_with_params 2023-05-22', + options: { + tags: [], + }, + handler: async (resources) => {}, +}); + const createServerRoute = createServerRouteFactory<{}, {}>(); const repository = { ...createServerRoute({ - endpoint: 'endpoint_without_params', + endpoint: 'GET /internal/endpoint_without_params', handler: async () => { return { noParamsForMe: true, @@ -80,7 +100,7 @@ const repository = { }, }), ...createServerRoute({ - endpoint: 'endpoint_with_params', + endpoint: 'GET /internal/endpoint_with_params', params: t.type({ path: t.type({ serviceName: t.string, @@ -93,7 +113,7 @@ const repository = { }, }), ...createServerRoute({ - endpoint: 'endpoint_with_optional_params', + endpoint: 'GET /internal/endpoint_with_optional_params', params: t.partial({ query: t.partial({ serviceName: t.string, @@ -112,9 +132,9 @@ type TestRepository = typeof repository; // EndpointOf should return all valid endpoints of a repository assertType>>([ - 'endpoint_with_params', - 'endpoint_without_params', - 'endpoint_with_optional_params', + 'GET /internal/endpoint_with_params', + 'GET /internal/endpoint_without_params', + 'GET /internal/endpoint_with_optional_params', ]); // @ts-expect-error Type '"this_endpoint_does_not_exist"' is not assignable to type '"endpoint_without_params" | "endpoint_with_params" | "endpoint_with_optional_params"' @@ -122,11 +142,11 @@ assertType>>(['this_endpoint_does_not_exist']); // ReturnOf should return the return type of a request handler. -assertType>({ +assertType>({ noParamsForMe: true, }); -const noParamsInvalid: ReturnOf = { +const noParamsInvalid: ReturnOf = { // @ts-expect-error type '{ paramsForMe: boolean; }' is not assignable to type '{ noParamsForMe: boolean; }'. paramsForMe: true, }; @@ -140,21 +160,21 @@ const client: TestClient = {} as any; // It should respect any additional create options. // @ts-expect-error Property 'timeout' is missing -client('endpoint_without_params', {}); +client('GET /internal/endpoint_without_params', {}); -client('endpoint_without_params', { +client('GET /internal/endpoint_without_params', { timeout: 1, }); // It does not allow params for routes without a params codec -client('endpoint_without_params', { +client('GET /internal/endpoint_without_params', { // @ts-expect-error Object literal may only specify known properties, and 'params' does not exist in type params: {}, timeout: 1, }); // It requires params for routes with a params codec -client('endpoint_with_params', { +client('GET /internal/endpoint_with_params', { params: { // @ts-expect-error property 'serviceName' is missing in type '{}' path: {}, @@ -163,12 +183,12 @@ client('endpoint_with_params', { }); // Params are optional if the codec has no required keys -client('endpoint_with_optional_params', { +client('GET /internal/endpoint_with_optional_params', { timeout: 1, }); // If optional, an error will still occur if the params do not match -client('endpoint_with_optional_params', { +client('GET /internal/endpoint_with_optional_params', { timeout: 1, params: { // @ts-expect-error Object literal may only specify known properties, and 'path' does not exist in type @@ -177,7 +197,7 @@ client('endpoint_with_optional_params', { }); // The return type is correctly inferred -client('endpoint_with_params', { +client('GET /internal/endpoint_with_params', { params: { path: { serviceName: '', diff --git a/packages/kbn-server-route-repository/src/typings.ts b/packages/kbn-server-route-repository/src/typings.ts index 3a86a1091d1bf..94605468202f1 100644 --- a/packages/kbn-server-route-repository/src/typings.ts +++ b/packages/kbn-server-route-repository/src/typings.ts @@ -35,20 +35,32 @@ export interface RouteState { export type ServerRouteHandlerResources = Record; export type ServerRouteCreateOptions = Record; +type ValidateEndpoint = string extends TEndpoint + ? true + : TEndpoint extends `${string} ${string} ${string}` + ? true + : TEndpoint extends `${string} ${infer TPathname}` + ? TPathname extends `/internal/${string}` + ? true + : false + : false; + export type ServerRoute< TEndpoint extends string, TRouteParamsRT extends RouteParamsRT | undefined, TRouteHandlerResources extends ServerRouteHandlerResources, TReturnType, TRouteCreateOptions extends ServerRouteCreateOptions -> = { - endpoint: TEndpoint; - params?: TRouteParamsRT; - handler: ({}: TRouteHandlerResources & - (TRouteParamsRT extends RouteParamsRT - ? DecodedRequestParamsOfType - : {})) => Promise; -} & TRouteCreateOptions; +> = ValidateEndpoint extends true + ? { + endpoint: TEndpoint; + params?: TRouteParamsRT; + handler: ({}: TRouteHandlerResources & + (TRouteParamsRT extends RouteParamsRT + ? DecodedRequestParamsOfType + : {})) => Promise; + } & TRouteCreateOptions + : never; export type ServerRouteRepository = Record< string, diff --git a/packages/kbn-slo-schema/src/rest_specs/slo.ts b/packages/kbn-slo-schema/src/rest_specs/slo.ts index b659fa498a827..5d2bcf2997740 100644 --- a/packages/kbn-slo-schema/src/rest_specs/slo.ts +++ b/packages/kbn-slo-schema/src/rest_specs/slo.ts @@ -21,6 +21,10 @@ import { summarySchema, tagsSchema, timeWindowSchema, + metricCustomIndicatorSchema, + kqlCustomIndicatorSchema, + apmTransactionErrorRateIndicatorSchema, + apmTransactionDurationIndicatorSchema, } from '../schema'; const createSLOParamsSchema = t.type({ @@ -155,6 +159,13 @@ type HistoricalSummaryResponse = t.OutputOf; type BudgetingMethod = t.TypeOf; +type MetricCustomIndicatorSchema = t.TypeOf; +type KQLCustomIndicatorSchema = t.TypeOf; +type APMTransactionErrorRateIndicatorSchema = t.TypeOf< + typeof apmTransactionErrorRateIndicatorSchema +>; +type APMTransactionDurationIndicatorSchema = t.TypeOf; + export { createSLOParamsSchema, deleteSLOParamsSchema, @@ -188,4 +199,8 @@ export type { UpdateSLOInput, UpdateSLOParams, UpdateSLOResponse, + MetricCustomIndicatorSchema, + KQLCustomIndicatorSchema, + APMTransactionDurationIndicatorSchema, + APMTransactionErrorRateIndicatorSchema, }; diff --git a/packages/kbn-slo-schema/src/schema/indicators.ts b/packages/kbn-slo-schema/src/schema/indicators.ts index 23f64018bf05b..afc8e3dfbaeb1 100644 --- a/packages/kbn-slo-schema/src/schema/indicators.ts +++ b/packages/kbn-slo-schema/src/schema/indicators.ts @@ -56,6 +56,31 @@ const kqlCustomIndicatorSchema = t.type({ }), }); +const metricCustomValidAggregations = t.keyof({ + sum: true, +}); +const metricCustomMetricDef = t.type({ + metrics: t.array( + t.type({ + name: t.string, + aggregation: metricCustomValidAggregations, + field: t.string, + }) + ), + equation: t.string, +}); +const metricCustomIndicatorTypeSchema = t.literal('sli.metric.custom'); +const metricCustomIndicatorSchema = t.type({ + type: metricCustomIndicatorTypeSchema, + params: t.type({ + index: t.string, + filter: t.string, + good: metricCustomMetricDef, + total: metricCustomMetricDef, + timestampField: t.string, + }), +}); + const indicatorDataSchema = t.type({ dateRange: dateRangeSchema, good: t.number, @@ -66,6 +91,7 @@ const indicatorTypesSchema = t.union([ apmTransactionDurationIndicatorTypeSchema, apmTransactionErrorRateIndicatorTypeSchema, kqlCustomIndicatorTypeSchema, + metricCustomIndicatorTypeSchema, ]); // Validate that a string is a comma separated list of indicator types, @@ -91,6 +117,7 @@ const indicatorSchema = t.union([ apmTransactionDurationIndicatorSchema, apmTransactionErrorRateIndicatorSchema, kqlCustomIndicatorSchema, + metricCustomIndicatorSchema, ]); export { @@ -100,6 +127,8 @@ export { apmTransactionErrorRateIndicatorTypeSchema, kqlCustomIndicatorSchema, kqlCustomIndicatorTypeSchema, + metricCustomIndicatorTypeSchema, + metricCustomIndicatorSchema, indicatorSchema, indicatorTypesArraySchema, indicatorTypesSchema, diff --git a/packages/kbn-test-jest-helpers/kibana.jsonc b/packages/kbn-test-jest-helpers/kibana.jsonc index 4780aa00d4aa9..fdabbb9780d6c 100644 --- a/packages/kbn-test-jest-helpers/kibana.jsonc +++ b/packages/kbn-test-jest-helpers/kibana.jsonc @@ -2,5 +2,5 @@ "type": "shared-common", "id": "@kbn/test-jest-helpers", "devOnly": true, - "owner": "@elastic/kibana-operations" + "owner": ["@elastic/kibana-operations", "@elastic/appex-qa"], } diff --git a/packages/kbn-test-subj-selector/kibana.jsonc b/packages/kbn-test-subj-selector/kibana.jsonc index 53a90dc467c80..8026708a83e3b 100644 --- a/packages/kbn-test-subj-selector/kibana.jsonc +++ b/packages/kbn-test-subj-selector/kibana.jsonc @@ -1,6 +1,6 @@ { "type": "shared-common", "id": "@kbn/test-subj-selector", - "owner": "@elastic/kibana-operations", + "owner": ["@elastic/kibana-operations", "@elastic/appex-qa"], "devOnly": true } diff --git a/packages/kbn-test/kibana.jsonc b/packages/kbn-test/kibana.jsonc index c38e4f38bf65d..c39f82b52a113 100644 --- a/packages/kbn-test/kibana.jsonc +++ b/packages/kbn-test/kibana.jsonc @@ -2,5 +2,5 @@ "type": "shared-common", "id": "@kbn/test", "devOnly": true, - "owner": "@elastic/kibana-operations" + "owner": ["@elastic/kibana-operations", "@elastic/appex-qa"], } diff --git a/packages/kbn-text-based-editor/.storybook/main.js b/packages/kbn-text-based-editor/.storybook/main.js new file mode 100644 index 0000000000000..b4023e59a9b43 --- /dev/null +++ b/packages/kbn-text-based-editor/.storybook/main.js @@ -0,0 +1,17 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +const defaultConfig = require('@kbn/storybook').defaultConfig; + +module.exports = { + ...defaultConfig, + stories: ['../**/*.stories.+(tsx|mdx)'], + typescript: { + reactDocgen: 'react-docgen-typescript', + }, +}; diff --git a/packages/kbn-text-based-editor/.storybook/preview.js b/packages/kbn-text-based-editor/.storybook/preview.js new file mode 100644 index 0000000000000..85894865f3bbb --- /dev/null +++ b/packages/kbn-text-based-editor/.storybook/preview.js @@ -0,0 +1,14 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export const parameters = { + viewMode: 'docs', + previewTabs: { + canvas: { hidden: true }, + }, +}; diff --git a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/README.md b/packages/kbn-text-based-editor/README.md similarity index 60% rename from src/plugins/unified_search/public/query_string_input/text_based_languages_editor/README.md rename to packages/kbn-text-based-editor/README.md index cd733033e0c6a..2bb9ae5887f24 100644 --- a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/README.md +++ b/packages/kbn-text-based-editor/README.md @@ -1,4 +1,13 @@ -# Unified search text based languages editor +# @kbn/text-based-editor + +Contains the editor for text based languages. Specifically for: + - ESQL, with autocomplete and syntax highlighting + - SQL, with syntax highlighting + +--- + +Contains the ESQL editor with the autocomplete and the autosuggest functionality (based on atlr). +The antlr code can be found in packages/kbn-monaco/src/esql A **monaco** based editor that is part of the unified search experience. It is rendered for all the applications that support text-based languages. In order to enable text based languages on your unified search bar add `textBasedLanguages: ['SQL', 'ESQL', '...']` to the dataViewPicker properties. @@ -6,6 +15,7 @@ In order to enable text based languages on your unified search bar add `textBase ## Languages supported - SQL: based on the Elasticsearch sql api +- ESQL: based on the Elastisearch esql api ## Features @@ -16,31 +26,4 @@ In order to enable text based languages on your unified search bar add `textBase - The editor has a built in way to depict the errors but the user has to submit the query first. The error should be on the inline focuses mode or the expanded mode to view the errors details. - The editor is responsive regardless of the mode selected. - The editor has a built in documentation that dynamically changes based on the language of the query. -- The user can quickly submit the query by pressing CMD/CTRL + Enter. - -## Preview -Run `node scripts/storybook unified_search` for a preview of the unified search bar with the editor. - -## Component properties -The editor is imported to the query_bar_top_row.tsx file. Accepts the following properties: -- query: This is the **AggregateQuery** query. i.e. (`{sql: SELECT * FROM 'DATAVIEW1'}`) -- onTextLangQueryChange: callback that is called every time the query is updated -- expandCodeEditor: flag that opens the editor on the expanded mode -- errors: array of `Error`. -- onTextLangQuerySubmit: callback that is called when the user submits the query - -``` - setCodeEditorIsExpanded(status)} - isCodeEditorExpanded={codeEditorIsExpanded} - errors={props.textBasedLanguageModeErrors} - onTextLangQuerySubmit={() => - onSubmit({ - query: queryRef.current, - dateRange: dateRangeRef.current, - }) - } - /> -``` +- The user can quickly submit the query by pressing CMD/CTRL + Enter. \ No newline at end of file diff --git a/packages/kbn-text-based-editor/index.ts b/packages/kbn-text-based-editor/index.ts new file mode 100644 index 0000000000000..fd7b19839b87f --- /dev/null +++ b/packages/kbn-text-based-editor/index.ts @@ -0,0 +1,14 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type { TextBasedLanguagesEditorProps } from './src/text_based_languages_editor'; +import { TextBasedLanguagesEditor } from './src/text_based_languages_editor'; + +// React.lazy support +// eslint-disable-next-line import/no-default-export +export default TextBasedLanguagesEditor; diff --git a/packages/kbn-text-based-editor/jest.config.js b/packages/kbn-text-based-editor/jest.config.js new file mode 100644 index 0000000000000..dec942367396d --- /dev/null +++ b/packages/kbn-text-based-editor/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../..', + roots: ['/packages/kbn-text-based-editor'], +}; diff --git a/packages/kbn-text-based-editor/kibana.jsonc b/packages/kbn-text-based-editor/kibana.jsonc new file mode 100644 index 0000000000000..c9d3b8a2996ca --- /dev/null +++ b/packages/kbn-text-based-editor/kibana.jsonc @@ -0,0 +1,5 @@ +{ + "type": "shared-browser", + "id": "@kbn/text-based-editor", + "owner": "@elastic/kibana-visualizations", +} \ No newline at end of file diff --git a/packages/kbn-text-based-editor/package.json b/packages/kbn-text-based-editor/package.json new file mode 100644 index 0000000000000..e9862bd02a336 --- /dev/null +++ b/packages/kbn-text-based-editor/package.json @@ -0,0 +1,6 @@ +{ + "name": "@kbn/text-based-editor", + "private": true, + "version": "1.0.0", + "license": "SSPL-1.0 OR Elastic License 2.0" +} \ No newline at end of file diff --git a/packages/kbn-text-based-editor/src/__stories__/text_based_editor.stories.mdx b/packages/kbn-text-based-editor/src/__stories__/text_based_editor.stories.mdx new file mode 100644 index 0000000000000..0874305b1975b --- /dev/null +++ b/packages/kbn-text-based-editor/src/__stories__/text_based_editor.stories.mdx @@ -0,0 +1,117 @@ +import { Canvas, Meta, Story, ArgsTable } from '@storybook/addon-docs/blocks'; +import { I18nProvider } from '@kbn/i18n-react'; +import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; +import { TextBasedLanguagesEditor } from '../text_based_languages_editor'; + + +export const Template = (args) => + + {} } }, + uiSettings: { get: () => {} }, + }} + > + + +; + + + + +# Overview + +The TextBasedLanguagesEditor component is a reusable component and can be used to support text based languages in your application (SQL, ESQL): + + + + {Template.bind({})} + + + +When there are errors to the query the UI displays the errors to the editor: + + + Unexpected error from Elasticsearch: verification_exception - Found 1 problem line 1:16: Unknown column [field10]' + ), + ] + } + } + argTypes={ + { onTextLangQueryChange: { action: 'changed' }, onTextLangQuerySubmit: { action: 'submitted' }, expandCodeEditor: { action: 'expanded' }} + } + > + {Template.bind({})} + + + +When there the query is long and the editor is on the compact view: + + + + {Template.bind({})} + + + + +The editor also works on the expanded mode: + + + + {Template.bind({})} + + + +## Component props + +The component exposes the following properties: + + \ No newline at end of file diff --git a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/editor_footer.tsx b/packages/kbn-text-based-editor/src/editor_footer.tsx similarity index 90% rename from src/plugins/unified_search/public/query_string_input/text_based_languages_editor/editor_footer.tsx rename to packages/kbn-text-based-editor/src/editor_footer.tsx index 90e30b6c019e6..9516979e9b55f 100644 --- a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/editor_footer.tsx +++ b/packages/kbn-text-based-editor/src/editor_footer.tsx @@ -48,16 +48,16 @@ export const EditorFooter = memo(function EditorFooter({ - +

    - {i18n.translate('unifiedSearch.query.textBasedLanguagesEditor.lineCount', { + {i18n.translate('textBasedEditor.query.textBasedLanguagesEditor.lineCount', { defaultMessage: '{count} {count, plural, one {line} other {lines}}', values: { count: lines }, })} @@ -89,7 +89,7 @@ export const EditorFooter = memo(function EditorFooter({ >

    {i18n.translate( - 'unifiedSearch.query.textBasedLanguagesEditor.errorCount', + 'textBasedEditor.query.textBasedLanguagesEditor.errorCount', { defaultMessage: '{count} {count, plural, one {error} other {errors}}', values: { count: errors.length }, @@ -105,7 +105,7 @@ export const EditorFooter = memo(function EditorFooter({

    {i18n.translate( - 'unifiedSearch.query.textBasedLanguagesEditor.errorsTitle', + 'textBasedEditor.query.textBasedLanguagesEditor.errorsTitle', { defaultMessage: 'Errors', } @@ -131,7 +131,7 @@ export const EditorFooter = memo(function EditorFooter({ {i18n.translate( - 'unifiedSearch.query.textBasedLanguagesEditor.lineNumber', + 'textBasedEditor.query.textBasedLanguagesEditor.lineNumber', { defaultMessage: 'Line {lineNumber}', values: { lineNumber: error.startLineNumber }, @@ -142,7 +142,7 @@ export const EditorFooter = memo(function EditorFooter({ {error.message} @@ -164,7 +164,7 @@ export const EditorFooter = memo(function EditorFooter({

    - {i18n.translate('unifiedSearch.query.textBasedLanguagesEditor.runQuery', { + {i18n.translate('textBasedEditor.query.textBasedLanguagesEditor.runQuery', { defaultMessage: 'Run query', })}

    diff --git a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/helpers.test.ts b/packages/kbn-text-based-editor/src/helpers.test.ts similarity index 100% rename from src/plugins/unified_search/public/query_string_input/text_based_languages_editor/helpers.test.ts rename to packages/kbn-text-based-editor/src/helpers.test.ts diff --git a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/helpers.ts b/packages/kbn-text-based-editor/src/helpers.ts similarity index 97% rename from src/plugins/unified_search/public/query_string_input/text_based_languages_editor/helpers.ts rename to packages/kbn-text-based-editor/src/helpers.ts index 58e603fa62d4f..d1deae5bf0d80 100644 --- a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/helpers.ts +++ b/packages/kbn-text-based-editor/src/helpers.ts @@ -90,7 +90,7 @@ export const getDocumentationSections = async (language: string) => { aggregateFunctions, } = await import('./sql_documentation_sections'); groups.push({ - label: i18n.translate('unifiedSearch.query.textBasedLanguagesEditor.howItWorks', { + label: i18n.translate('textBasedEditor.query.textBasedLanguagesEditor.howItWorks', { defaultMessage: 'How it works', }), items: [], diff --git a/packages/kbn-text-based-editor/src/overwrite.scss b/packages/kbn-text-based-editor/src/overwrite.scss new file mode 100644 index 0000000000000..dc46eeebc17a9 --- /dev/null +++ b/packages/kbn-text-based-editor/src/overwrite.scss @@ -0,0 +1,45 @@ +.TextBasedLangEditor .monaco-editor { + border-top-left-radius: 6px; + border-bottom-left-radius: 6px; +} + +.TextBasedLangEditor .monaco-editor .monaco-hover { + display: none !important; +} + +.TextBasedLangEditor--expanded .monaco-editor .monaco-hover { + display: block !important; +} + +.TextBasedLangEditor .monaco-editor .margin { + border-top-left-radius: 6px; + border-bottom-left-radius: 6px; +} + +.TextBasedLangEditor--compact .monaco-editor { + border-top-left-radius: 0; + border-bottom-left-radius: 0; +} + +.TextBasedLangEditor--compact .monaco-editor .margin { + border-top-left-radius: 0; + border-bottom-left-radius: 0; + background-color: $euiColorLightestShade; + color: $euiColorDisabledText; +} + +.TextBasedLangEditor .monaco-editor .margin-view-overlays .line-numbers { + color: $euiColorDisabledText; +} + +.TextBasedLangEditor .monaco-editor .current-line ~ .line-numbers { + color: $euiTextSubduedColor; +} + +.TextBasedLangEditor--compact .monaco-editor .monaco-scrollable-element { + margin-left: 4px; +} + +.TextBasedLangEditor_errorMessage { + @include euiTextBreakWord; +} \ No newline at end of file diff --git a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/resizable_button.scss b/packages/kbn-text-based-editor/src/resizable_button.scss similarity index 95% rename from src/plugins/unified_search/public/query_string_input/text_based_languages_editor/resizable_button.scss rename to packages/kbn-text-based-editor/src/resizable_button.scss index dd5267c9a657e..cd0342df39a77 100644 --- a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/resizable_button.scss +++ b/packages/kbn-text-based-editor/src/resizable_button.scss @@ -1,4 +1,4 @@ -.unifiedTextLangEditor--resizableButtonContainer { +.TextBasedLangEditor--resizableButtonContainer { position: absolute; bottom: 0; left: 0; @@ -7,7 +7,7 @@ flex-direction: column; } -.unifiedTextLangEditor--resizableButton { +.TextBasedLangEditor--resizableButton { position: relative; flex-shrink: 0; z-index: 1; diff --git a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/resizable_button.tsx b/packages/kbn-text-based-editor/src/resizable_button.tsx similarity index 83% rename from src/plugins/unified_search/public/query_string_input/text_based_languages_editor/resizable_button.tsx rename to packages/kbn-text-based-editor/src/resizable_button.tsx index 70d2cea176b55..7ae69b4e33d73 100644 --- a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/resizable_button.tsx +++ b/packages/kbn-text-based-editor/src/resizable_button.tsx @@ -22,10 +22,10 @@ export function ResizableButton({ const setFocus = (e: React.MouseEvent) => e.currentTarget.focus(); return ( -
    +