diff --git a/.buildkite/ftr_configs.yml b/.buildkite/ftr_configs.yml index 955fe7a72414a..c9a97dd80e4aa 100644 --- a/.buildkite/ftr_configs.yml +++ b/.buildkite/ftr_configs.yml @@ -23,6 +23,7 @@ disabled: - x-pack/test/upgrade/config.ts - test/functional/config.edge.js - x-pack/test/functional/config.edge.js + - x-pack/test/cloud_security_posture_functional/config.cloud.ts # Cypress configs, for now these are still run manually - x-pack/test/fleet_cypress/cli_config.ts diff --git a/.buildkite/pipelines/on_merge_unsupported_ftrs.yml b/.buildkite/pipelines/on_merge_unsupported_ftrs.yml index 24fc59fdbe26a..c7ac27e032bd8 100644 --- a/.buildkite/pipelines/on_merge_unsupported_ftrs.yml +++ b/.buildkite/pipelines/on_merge_unsupported_ftrs.yml @@ -80,39 +80,3 @@ steps: limit: 3 - exit_status: '*' limit: 1 - - - command: .buildkite/scripts/steps/functional/defend_workflows.sh - label: 'Defend Workflows Cypress Tests' - agents: - image: family/kibana-ubuntu-2004 - imageProject: elastic-images-prod - provider: gcp - enableNestedVirtualization: true - localSsdInterface: nvme - localSsds: 1 - machineType: n2-standard-4 - depends_on: build - timeout_in_minutes: 60 - parallelism: 20 - retry: - automatic: - - exit_status: '-1' - limit: 1 - - - command: .buildkite/scripts/steps/functional/defend_workflows_serverless.sh - label: 'Defend Workflows Cypress Tests on Serverless' - agents: - image: family/kibana-ubuntu-2004 - imageProject: elastic-images-prod - provider: gcp - enableNestedVirtualization: true - localSsdInterface: nvme - localSsds: 1 - machineType: n2-standard-4 - depends_on: build - timeout_in_minutes: 60 - parallelism: 14 - retry: - automatic: - - exit_status: '-1' - limit: 1 diff --git a/.buildkite/scripts/steps/artifacts/docker_image.sh b/.buildkite/scripts/steps/artifacts/docker_image.sh index 308b391118b77..551910432c413 100755 --- a/.buildkite/scripts/steps/artifacts/docker_image.sh +++ b/.buildkite/scripts/steps/artifacts/docker_image.sh @@ -27,15 +27,10 @@ echo "--- Build Kibana" node scripts/build \ --debug \ --release \ + --serverless \ --docker-cross-compile \ - --docker-images \ --docker-namespace="kibana-ci" \ - --docker-tag="$KIBANA_IMAGE_TAG" \ - --skip-docker-ubuntu \ - --skip-docker-chainguard \ - --skip-docker-ubi \ - --skip-docker-fips \ - --skip-docker-cloud + --docker-tag="$KIBANA_IMAGE_TAG" echo "--- Tag images" docker rmi "$KIBANA_IMAGE" @@ -99,8 +94,8 @@ ts-node "$(git rev-parse --show-toplevel)/.buildkite/scripts/steps/artifacts/val "$CDN_ASSETS_FOLDER" echo "--- Upload archives" -buildkite-agent artifact upload "kibana-$BASE_VERSION-linux-x86_64.tar.gz" -buildkite-agent artifact upload "kibana-$BASE_VERSION-linux-aarch64.tar.gz" +buildkite-agent artifact upload "kibana-serverless-$BASE_VERSION-linux-x86_64.tar.gz" +buildkite-agent artifact upload "kibana-serverless-$BASE_VERSION-linux-aarch64.tar.gz" buildkite-agent artifact upload "kibana-serverless-$BASE_VERSION-docker-image.tar.gz" buildkite-agent artifact upload "kibana-serverless-$BASE_VERSION-docker-image-aarch64.tar.gz" buildkite-agent artifact upload "kibana-serverless-$BASE_VERSION-docker-build-context.tar.gz" diff --git a/.eslintrc.js b/.eslintrc.js index d7956c1590688..4e6c367970c02 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -908,10 +908,6 @@ module.exports = { }, ], 'react-hooks/rules-of-hooks': 'error', // Checks rules of Hooks - 'react-hooks/exhaustive-deps': [ - 'error', - { additionalHooks: '^(useFetcher|useProgressiveFetcher|useBreadcrumb)$' }, - ], }, }, { @@ -931,6 +927,18 @@ module.exports = { ], }, }, + { + files: ['x-pack/plugins/observability_solution/**/*.{ts,tsx}'], + rules: { + 'react-hooks/exhaustive-deps': [ + 'error', + { + additionalHooks: + '^(useAbortableAsync|useMemoWithAbortSignal|useFetcher|useProgressiveFetcher|useBreadcrumb|useAsync|useTimeRangeAsync|useAutoAbortedHttpClient)$', + }, + ], + }, + }, { files: [ 'x-pack/plugins/aiops/**/*.tsx', @@ -964,17 +972,6 @@ module.exports = { ], }, }, - // Profiling - { - files: ['x-pack/plugins/observability_solution/profiling/**/*.{js,mjs,ts,tsx}'], - rules: { - 'react-hooks/rules-of-hooks': 'error', // Checks rules of Hooks - 'react-hooks/exhaustive-deps': [ - 'error', - { additionalHooks: '^(useAsync|useTimeRangeAsync|useAutoAbortedHttpClient)$' }, - ], - }, - }, { // disable imports from legacy uptime plugin files: [ diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 5f0a5a3f4bc3d..dc4a36124cad2 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -506,6 +506,7 @@ src/plugins/inspector @elastic/kibana-presentation src/plugins/interactive_setup @elastic/kibana-security test/interactive_setup_api_integration/plugins/test_endpoints @elastic/kibana-security packages/kbn-interpreter @elastic/kibana-visualizations +x-pack/plugins/observability_solution/investigate @elastic/obs-ai-assistant packages/kbn-io-ts-utils @elastic/obs-knowledge-team packages/kbn-ipynb @elastic/search-kibana packages/kbn-jest-serializers @elastic/kibana-operations @@ -892,6 +893,7 @@ examples/unified_field_list_examples @elastic/kibana-data-discovery src/plugins/unified_histogram @elastic/kibana-data-discovery src/plugins/unified_search @elastic/kibana-visualizations packages/kbn-unsaved-changes-badge @elastic/kibana-data-discovery +packages/kbn-unsaved-changes-prompt @elastic/kibana-management x-pack/plugins/upgrade_assistant @elastic/kibana-management x-pack/plugins/observability_solution/uptime @elastic/obs-ux-infra_services-team x-pack/plugins/drilldowns/url_drilldown @elastic/appex-sharedux diff --git a/.i18nrc.json b/.i18nrc.json index 4d71e47159e1b..0053dc5d2ad51 100644 --- a/.i18nrc.json +++ b/.i18nrc.json @@ -148,6 +148,7 @@ "unifiedHistogram": "src/plugins/unified_histogram", "unifiedDataTable": "packages/kbn-unified-data-table", "unsavedChangesBadge": "packages/kbn-unsaved-changes-badge", + "unsavedChangesPrompt": "packages/kbn-unsaved-changes-prompt", "managedContentBadge": "packages/kbn-managed-content-badge" }, "translations": [] diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index 831353b6d3494..9943a5ac90919 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: 2024-06-06 +date: 2024-06-09 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 d137092af9487..d55ae963162c4 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] --- import advancedSettingsObj from './advanced_settings.devdocs.json'; diff --git a/api_docs/ai_assistant_management_selection.mdx b/api_docs/ai_assistant_management_selection.mdx index a852618dd6af9..de10ba4af625e 100644 --- a/api_docs/ai_assistant_management_selection.mdx +++ b/api_docs/ai_assistant_management_selection.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiAssistantManagementSelection title: "aiAssistantManagementSelection" image: https://source.unsplash.com/400x175/?github description: API docs for the aiAssistantManagementSelection plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection'] --- import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json'; diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx index 6036c1650e040..9075df5e8ce8a 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] --- import aiopsObj from './aiops.devdocs.json'; diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index 9516eb5e76c61..f6b4e99f2b5ec 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] --- import alertingObj from './alerting.devdocs.json'; diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index 66c8eefc0e896..d098501122ab0 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] --- import apmObj from './apm.devdocs.json'; diff --git a/api_docs/apm_data_access.mdx b/api_docs/apm_data_access.mdx index 6686687b9b209..dc57cb53eebed 100644 --- a/api_docs/apm_data_access.mdx +++ b/api_docs/apm_data_access.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apmDataAccess title: "apmDataAccess" image: https://source.unsplash.com/400x175/?github description: API docs for the apmDataAccess plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess'] --- import apmDataAccessObj from './apm_data_access.devdocs.json'; diff --git a/api_docs/asset_manager.mdx b/api_docs/asset_manager.mdx index eadedadcca608..345243d484bc2 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager'] --- import assetManagerObj from './asset_manager.devdocs.json'; diff --git a/api_docs/assets_data_access.mdx b/api_docs/assets_data_access.mdx index d4c1b9f7cff5b..1cedb1e4aab92 100644 --- a/api_docs/assets_data_access.mdx +++ b/api_docs/assets_data_access.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/assetsDataAccess title: "assetsDataAccess" image: https://source.unsplash.com/400x175/?github description: API docs for the assetsDataAccess plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetsDataAccess'] --- import assetsDataAccessObj from './assets_data_access.devdocs.json'; diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index 288d4854e2b96..6616530eb0076 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: 2024-06-06 +date: 2024-06-09 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 2aa52c937c75e..10ce7f737c4d6 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: 2024-06-06 +date: 2024-06-09 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 c7b4a492469ed..97db81ee2bbcb 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] --- import canvasObj from './canvas.devdocs.json'; diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index 29f8ee91d77ba..6416662de3480 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] --- import casesObj from './cases.devdocs.json'; diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index 2dc3bc3b1e3a5..eab6f8b27f18a 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] --- import chartsObj from './charts.devdocs.json'; diff --git a/api_docs/cloud.devdocs.json b/api_docs/cloud.devdocs.json index 716a92b728c29..04c3ac0d00123 100644 --- a/api_docs/cloud.devdocs.json +++ b/api_docs/cloud.devdocs.json @@ -197,6 +197,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudConfigType.onboarding", + "type": "Object", + "tags": [], + "label": "onboarding", + "description": [], + "signature": [ + "{ default_solution?: string | undefined; } | undefined" + ], + "path": "x-pack/plugins/cloud/public/plugin.tsx", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "cloud", "id": "def-public.CloudConfigType.serverless", @@ -797,6 +811,30 @@ ], "returnComment": [] }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudSetup.onboarding", + "type": "Object", + "tags": [], + "label": "onboarding", + "description": [ + "\nOnboarding configuration" + ], + "signature": [ + "{ defaultSolution?: ", + { + "pluginId": "cloud", + "scope": "common", + "docId": "kibCloudPluginApi", + "section": "def-common.OnBoardingDefaultSolution", + "text": "OnBoardingDefaultSolution" + }, + " | undefined; }" + ], + "path": "x-pack/plugins/cloud/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "cloud", "id": "def-public.CloudSetup.isServerlessEnabled", @@ -1058,6 +1096,30 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "cloud", + "id": "def-server.CloudSetup.onboarding", + "type": "Object", + "tags": [], + "label": "onboarding", + "description": [ + "\nOnboarding configuration." + ], + "signature": [ + "{ defaultSolution?: ", + { + "pluginId": "cloud", + "scope": "common", + "docId": "kibCloudPluginApi", + "section": "def-common.OnBoardingDefaultSolution", + "text": "OnBoardingDefaultSolution" + }, + " | undefined; }" + ], + "path": "x-pack/plugins/cloud/server/plugin.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "cloud", "id": "def-server.CloudSetup.isServerlessEnabled", @@ -1161,7 +1223,23 @@ "functions": [], "interfaces": [], "enums": [], - "misc": [], + "misc": [ + { + "parentPluginId": "cloud", + "id": "def-common.OnBoardingDefaultSolution", + "type": "Type", + "tags": [], + "label": "OnBoardingDefaultSolution", + "description": [], + "signature": [ + "\"security\" | \"es\" | \"oblt\"" + ], + "path": "x-pack/plugins/cloud/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], "objects": [] } } \ No newline at end of file diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index 9c6d74d6f3d72..d0f6e9b5ddb1b 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] --- import cloudObj from './cloud.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 | |-------------------|-----------|------------------------|-----------------| -| 74 | 0 | 17 | 0 | +| 78 | 0 | 19 | 0 | ## Client @@ -39,3 +39,8 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core ### Start +## Common + +### Consts, variables and types + + diff --git a/api_docs/cloud_data_migration.mdx b/api_docs/cloud_data_migration.mdx index 903c3cfb52635..269dd82ce00bb 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration'] --- import cloudDataMigrationObj from './cloud_data_migration.devdocs.json'; diff --git a/api_docs/cloud_defend.mdx b/api_docs/cloud_defend.mdx index e56f2446d7539..5000568c30f74 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend'] --- import cloudDefendObj from './cloud_defend.devdocs.json'; diff --git a/api_docs/cloud_experiments.mdx b/api_docs/cloud_experiments.mdx index f8a4841588a83..20e6537e3388a 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: 2024-06-06 +date: 2024-06-09 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 5194834b05454..decdaf04be750 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: 2024-06-06 +date: 2024-06-09 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 221aed330d108..df65584132e0f 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: 2024-06-06 +date: 2024-06-09 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 fc7619e1f3d57..d44bb65328d33 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement'] --- import contentManagementObj from './content_management.devdocs.json'; diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index c8c3ad0661eaa..383f0b2fcc8c2 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] --- import controlsObj from './controls.devdocs.json'; diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index a25fd1f0fcb0b..889805453eb70 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] --- import customIntegrationsObj from './custom_integrations.devdocs.json'; diff --git a/api_docs/dashboard.devdocs.json b/api_docs/dashboard.devdocs.json index 5a58dd9a28026..d22dda4cd015b 100644 --- a/api_docs/dashboard.devdocs.json +++ b/api_docs/dashboard.devdocs.json @@ -944,7 +944,13 @@ "text": "DashboardContainerInput" }, ", \"executionContext\" | \"panels\" | \"controlGroupInput\" | \"isEmbeddedExternally\">> & { dashboardId?: string | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; searchSessionId?: string | undefined; panels?: (", - "SavedDashboardPanel", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel", + "text": "SavedDashboardPanel" + }, " & ", { "pluginId": "@kbn/utility-types", @@ -1202,7 +1208,13 @@ "text": "DashboardPanelMap" }, ", removeLegacyVersion?: boolean | undefined) => ", - "SavedDashboardPanel", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel", + "text": "SavedDashboardPanel" + }, "[]" ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", @@ -1274,7 +1286,13 @@ "text": "SavedObjectEmbeddableInput" }, ">, removeLegacyVersion: boolean | undefined) => ", - "SavedDashboardPanel" + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel", + "text": "SavedDashboardPanel" + } ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "deprecated": false, @@ -1338,7 +1356,13 @@ "description": [], "signature": [ "(savedDashboardPanel: ", - "SavedDashboardPanel", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel", + "text": "SavedDashboardPanel" + }, ") => ", { "pluginId": "dashboard", @@ -1361,7 +1385,13 @@ "label": "savedDashboardPanel", "description": [], "signature": [ - "SavedDashboardPanel" + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel", + "text": "SavedDashboardPanel" + } ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", "deprecated": false, @@ -1381,7 +1411,13 @@ "description": [], "signature": [ "(panels?: ", - "SavedDashboardPanel", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel", + "text": "SavedDashboardPanel" + }, "[] | undefined) => ", { "pluginId": "dashboard", @@ -1403,7 +1439,13 @@ "label": "panels", "description": [], "signature": [ - "SavedDashboardPanel", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel", + "text": "SavedDashboardPanel" + }, "[] | undefined" ], "path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts", @@ -2327,6 +2369,138 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "dashboard", + "id": "def-common.SavedDashboardPanel", + "type": "Interface", + "tags": [], + "label": "SavedDashboardPanel", + "description": [ + "\nA saved dashboard panel parsed directly from the Dashboard Attributes panels JSON" + ], + "path": "src/plugins/dashboard/common/content_management/v1/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dashboard", + "id": "def-common.SavedDashboardPanel.embeddableConfig", + "type": "Object", + "tags": [], + "label": "embeddableConfig", + "description": [], + "signature": [ + "{ [key: string]: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.Serializable", + "text": "Serializable" + }, + "; }" + ], + "path": "src/plugins/dashboard/common/content_management/v1/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dashboard", + "id": "def-common.SavedDashboardPanel.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/dashboard/common/content_management/v1/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dashboard", + "id": "def-common.SavedDashboardPanel.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "src/plugins/dashboard/common/content_management/v1/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dashboard", + "id": "def-common.SavedDashboardPanel.panelRefName", + "type": "string", + "tags": [], + "label": "panelRefName", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/dashboard/common/content_management/v1/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dashboard", + "id": "def-common.SavedDashboardPanel.gridData", + "type": "Object", + "tags": [], + "label": "gridData", + "description": [], + "signature": [ + "GridData" + ], + "path": "src/plugins/dashboard/common/content_management/v1/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dashboard", + "id": "def-common.SavedDashboardPanel.panelIndex", + "type": "string", + "tags": [], + "label": "panelIndex", + "description": [], + "path": "src/plugins/dashboard/common/content_management/v1/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dashboard", + "id": "def-common.SavedDashboardPanel.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/dashboard/common/content_management/v1/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dashboard", + "id": "def-common.SavedDashboardPanel.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nThis version key was used to store Kibana version information from versions 7.3.0 -> 8.11.0.\nAs of version 8.11.0, the versioning information is now per-embeddable-type and is stored on the\nembeddable's input. (embeddableConfig in this type)." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/dashboard/common/content_management/v1/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false } ], "enums": [], @@ -2442,7 +2616,13 @@ "text": "TimeRange" }, " | undefined; timeslice?: [number, number] | undefined; isEmbeddedExternally?: boolean | undefined; timeRestore?: boolean | undefined; useMargins?: boolean | undefined; panels?: ", - "SavedDashboardPanel", + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel", + "text": "SavedDashboardPanel" + }, "[] | undefined; }" ], "path": "src/plugins/dashboard/common/types.ts", diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index 47579feee7a5c..a7f24cb3d8507 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] --- import dashboardObj from './dashboard.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 | |-------------------|-----------|------------------------|-----------------| -| 120 | 0 | 116 | 13 | +| 129 | 0 | 123 | 12 | ## Client diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index 4961ce4d394af..1c1cb32c7416c 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] --- import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json'; diff --git a/api_docs/data.mdx b/api_docs/data.mdx index fd3ce12357125..b2a57487254e6 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] --- import dataObj from './data.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 | |-------------------|-----------|------------------------|-----------------| -| 3194 | 31 | 2585 | 24 | +| 3199 | 31 | 2590 | 24 | ## Client diff --git a/api_docs/data_quality.mdx b/api_docs/data_quality.mdx index 7e33b9e915b50..868d9821ef377 100644 --- a/api_docs/data_quality.mdx +++ b/api_docs/data_quality.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataQuality title: "dataQuality" image: https://source.unsplash.com/400x175/?github description: API docs for the dataQuality plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataQuality'] --- import dataQualityObj from './data_quality.devdocs.json'; diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index fb0078694dd4d..36363475ce294 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] --- import dataQueryObj from './data_query.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 | |-------------------|-----------|------------------------|-----------------| -| 3194 | 31 | 2585 | 24 | +| 3199 | 31 | 2590 | 24 | ## Client diff --git a/api_docs/data_search.devdocs.json b/api_docs/data_search.devdocs.json index a9e4a675758c1..3e3047831b93f 100644 --- a/api_docs/data_search.devdocs.json +++ b/api_docs/data_search.devdocs.json @@ -16864,6 +16864,134 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.queryToFields", + "type": "Function", + "tags": [], + "label": "queryToFields", + "description": [], + "signature": [ + "({\n dataView,\n sort,\n request,\n}: { dataView: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewLazy", + "text": "DataViewLazy" + }, + "; sort?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySortValue", + "text": "EsQuerySortValue" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySortValue", + "text": "EsQuerySortValue" + }, + "[] | undefined; request: ", + "SearchRequest", + "; }) => Promise>" + ], + "path": "src/plugins/data/common/search/search_source/query_to_fields.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.queryToFields.$1", + "type": "Object", + "tags": [], + "label": "{\n dataView,\n sort,\n request,\n}", + "description": [], + "path": "src/plugins/data/common/search/search_source/query_to_fields.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.queryToFields.$1.dataView", + "type": "Object", + "tags": [], + "label": "dataView", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewLazy", + "text": "DataViewLazy" + } + ], + "path": "src/plugins/data/common/search/search_source/query_to_fields.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "data", + "id": "def-common.queryToFields.$1.sort", + "type": "CompoundType", + "tags": [], + "label": "sort", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySortValue", + "text": "EsQuerySortValue" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySortValue", + "text": "EsQuerySortValue" + }, + "[] | undefined" + ], + "path": "src/plugins/data/common/search/search_source/query_to_fields.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "data", + "id": "def-common.queryToFields.$1.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "src/plugins/data/common/search/search_source/query_to_fields.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.splitStringInterval", diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index 660143527ee4b..cff3b15809f3d 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] --- import dataSearchObj from './data_search.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 | |-------------------|-----------|------------------------|-----------------| -| 3194 | 31 | 2585 | 24 | +| 3199 | 31 | 2590 | 24 | ## Client diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 5715bf59b4f42..e23184e4a4319 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: 2024-06-06 +date: 2024-06-09 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 86f30dc8db931..3717f7b039d1d 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: 2024-06-06 +date: 2024-06-09 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 d60627a240454..f0fcbfb118e04 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] --- import dataViewManagementObj from './data_view_management.devdocs.json'; diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index eff9071cd9783..99de68695fade 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: 2024-06-06 +date: 2024-06-09 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 506587ae36934..dff783792e3c1 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] --- import dataVisualizerObj from './data_visualizer.devdocs.json'; diff --git a/api_docs/dataset_quality.mdx b/api_docs/dataset_quality.mdx index 0454dbdc976da..a9b109ec03c8a 100644 --- a/api_docs/dataset_quality.mdx +++ b/api_docs/dataset_quality.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/datasetQuality title: "datasetQuality" image: https://source.unsplash.com/400x175/?github description: API docs for the datasetQuality plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality'] --- import datasetQualityObj from './dataset_quality.devdocs.json'; diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index 012d5ec04b548..842d96f673ae9 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -31,11 +31,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | triggersActionsUi | - | | | @kbn/core, visualizations, triggersActionsUi | - | | | ruleRegistry, securitySolution, synthetics, slo | - | +| | security, actions, alerting, files, ruleRegistry, cases, fleet, securitySolution | - | | | alerting, discover, securitySolution | - | | | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-api-server-internal, @kbn/core-saved-objects-import-export-server-internal, @kbn/core-saved-objects-server-internal, fleet, graph, lists, osquery, securitySolution, alerting | - | | | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-api-server-internal, @kbn/core-saved-objects-import-export-server-internal, @kbn/core-saved-objects-server-internal, fleet, graph, lists, osquery, securitySolution, alerting | - | | | alerting, discover, securitySolution | - | | | securitySolution | - | +| | actions, alerting, files, cases, observabilityAIAssistant, fleet, cloudDefend, cloudSecurityPosture, elasticAssistant, enterpriseSearch, lists, osquery, securitySolution, reporting, serverlessSearch, transform, upgradeAssistant, apm, synthetics, security | - | +| | cases, securitySolution, security | - | | | @kbn/securitysolution-data-table, securitySolution | - | | | @kbn/securitysolution-data-table, securitySolution | - | | | securitySolution | - | @@ -45,6 +48,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | securitySolution | - | | | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, home, savedObjectsTagging, canvas, 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 | - | | | @kbn/core-saved-objects-migration-server-internal, actions, dataViews, data, alerting, lens, cases, savedSearch, canvas, savedObjectsTagging, graph, lists, maps, visualizations, securitySolution, dashboard, @kbn/core-test-helpers-so-type-serializer | - | +| | dataViews, security, maps, imageEmbeddable, enterpriseSearch, securitySolution, serverlessSearch, cloudLinks, observabilityAIAssistantApp, cases, apm | - | +| | security, cases, searchPlayground, securitySolution | - | | | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - | | | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - | | | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - | @@ -60,7 +65,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | @kbn/monaco, securitySolution | - | | | fleet, cloudSecurityPosture, exploratoryView, osquery, synthetics | - | | | actions, alerting | - | -| | visualizations, lens, controls, dashboard, maps, discover, infra, profiling, links | - | +| | visualizations, lens, controls, dashboard, maps, discover, profiling, links | - | | | discover, @kbn/reporting-public | - | | | data, discover, imageEmbeddable, embeddable | - | | | @kbn/core-plugins-browser-internal, @kbn/core-root-browser-internal, home, savedObjects, unifiedSearch, visualizations, fileUpload, dashboardEnhanced, transform, dashboard, discover, dataVisualizer | - | @@ -110,6 +115,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | dashboard, canvas | - | | | dashboard | - | | | embeddable, dashboard | - | +| | dataVisualizer, security | - | | | dataViews, maps | - | | | dataViews, dataViewManagement | - | | | dataViews, dataViewManagement | - | @@ -145,18 +151,18 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | @kbn/core-logging-server-internal, security | - | | | @kbn/react-kibana-context-styled, kibanaReact | - | | | encryptedSavedObjects | - | -| | @kbn/content-management-table-list-view, filesManagement | - | -| | @kbn/core | - | -| | @kbn/core | - | -| | @kbn/core-lifecycle-browser-mocks, @kbn/core, @kbn/core-plugins-browser-internal | - | -| | @kbn/core | - | -| | @kbn/core-plugins-server-internal | - | | | reporting | - | | | @kbn/reporting-export-types-csv, reporting | - | | | @kbn/reporting-export-types-csv, reporting | - | | | reporting | - | | | reporting | - | | | @kbn/reporting-export-types-pdf, reporting | - | +| | @kbn/content-management-table-list-view, filesManagement | - | +| | @kbn/core | - | +| | @kbn/core | - | +| | @kbn/core-lifecycle-browser-mocks, @kbn/core, @kbn/core-plugins-browser-internal | - | +| | @kbn/core | - | +| | @kbn/core-plugins-server-internal | - | | | @kbn/reporting-csv-share-panel | - | | | security, aiops, licenseManagement, ml, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher, profiling, apm, slo | 8.8.0 | | | spaces, security, actions, alerting, aiops, remoteClusters, ml, graph, indexLifecycleManagement, mapsEms, osquery, securitySolution, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | 8.8.0 | diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index 17738be06f5b8..665dbca27df13 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -449,10 +449,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/lib/license_state.test.ts#:~:text=license%24) | 8.8.0 | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=authc) | - | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=authz) | - | +| | [action_executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/lib/action_executor.ts#:~:text=authc), [action_executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/lib/action_executor.ts#:~:text=authc) | - | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=index) | - | | | [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client/actions_client.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes)+ 10 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/saved_objects/index.ts#:~:text=migrations), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/saved_objects/index.ts#:~:text=migrations) | - | | | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/saved_objects/index.ts#:~:text=convertToMultiNamespaceTypeVersion), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/saved_objects/index.ts#:~:text=convertToMultiNamespaceTypeVersion) | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=audit), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=audit) | - | @@ -478,10 +480,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch) | - | | | [plugin.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/plugin.test.ts#:~:text=getKibanaFeatures) | 8.8.0 | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24) | 8.8.0 | +| | [rules_client_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/rules_client_factory.ts#:~:text=authc), [rules_client_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/rules_client_factory.ts#:~:text=authc), [rules_client_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/rules_client_factory.ts#:~:text=authc), [rules_settings_client_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/rules_settings_client_factory.ts#:~:text=authc), [maintenance_window_client_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/maintenance_window_client_factory.ts#:~:text=authc), [task.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/invalidate_pending_api_keys/task.ts#:~:text=authc), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/plugin.ts#:~:text=authc), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/plugin.ts#:~:text=authc), [rules_client_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/rules_client_factory.ts#:~:text=authc), [rules_client_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/rules_client_factory.ts#:~:text=authc)+ 6 more | - | | | [task.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/usage/task.ts#:~:text=index) | - | | | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule_attributes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts#:~:text=SavedObjectAttributes), [rule_attributes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts#:~:text=SavedObjectAttributes), [rule_attributes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts#:~:text=SavedObjectAttributes), [rule_attributes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts#:~:text=SavedObjectAttributes), [rule_attributes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts#:~:text=SavedObjectAttributes), [inject_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/rules_client/common/inject_references.ts#:~:text=SavedObjectAttributes), [inject_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/rules_client/common/inject_references.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes)+ 36 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/index.ts#:~:text=migrations) | - | | | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/index.ts#:~:text=convertToMultiNamespaceTypeVersion) | - | +| | [rules_client_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/rules_client_factory.ts#:~:text=audit) | - | @@ -493,7 +497,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode)+ 2 more | 8.8.0 | | | [license_context.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/public/context/license/license_context.tsx#:~:text=license%24) | 8.8.0 | | | [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/common/license_check.test.ts#:~:text=mode)+ 2 more | 8.8.0 | +| | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/server/lib/helpers/get_random_sampler/index.ts#:~:text=authc), [get_agent_keys_privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/server/routes/agent_keys/get_agent_keys_privileges.ts#:~:text=authc), [is_superuser.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/server/routes/fleet/is_superuser.ts#:~:text=authc), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/server/lib/helpers/get_random_sampler/index.ts#:~:text=authc), [get_agent_keys_privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/server/routes/agent_keys/get_agent_keys_privileges.ts#:~:text=authc), [is_superuser.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/server/routes/fleet/is_superuser.ts#:~:text=authc) | - | | | [apm_service_groups.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/server/saved_objects/apm_service_groups.ts#:~:text=migrations) | - | +| | [use_current_user.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/public/hooks/use_current_user.ts#:~:text=authc), [use_current_user.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/apm/public/hooks/use_current_user.ts#:~:text=authc) | - | @@ -537,9 +543,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [factory.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/client/factory.test.ts#:~:text=getKibanaFeatures) | 8.8.0 | +| | [factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/client/factory.ts#:~:text=authc), [factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/client/factory.ts#:~:text=authc) | - | +| | [email_notification_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/notifications/email_notification_service.ts#:~:text=userProfiles), [factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/client/factory.ts#:~:text=userProfiles), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/client/cases/utils.ts#:~:text=userProfiles), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_profiles/index.ts#:~:text=userProfiles), [email_notification_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/notifications/email_notification_service.ts#:~:text=userProfiles), [factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/client/factory.ts#:~:text=userProfiles), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/client/cases/utils.ts#:~:text=userProfiles), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/services/user_profiles/index.ts#:~:text=userProfiles) | - | | | [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) | - | | | [cases.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/saved_object_types/cases/cases.ts#:~:text=migrations), [configure.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/saved_object_types/configure.ts#:~:text=migrations), [comments.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/saved_object_types/comments.ts#:~:text=migrations), [user_actions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/saved_object_types/user_actions.ts#:~:text=migrations), [connector_mappings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/saved_object_types/connector_mappings.ts#:~:text=migrations) | - | | | [cases.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/saved_object_types/cases/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) | - | +| | [hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/public/common/lib/kibana/hooks.ts#:~:text=authc) | - | +| | [api.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/public/containers/user_profiles/api.ts#:~:text=userProfiles), [api.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/public/containers/user_profiles/api.ts#:~:text=userProfiles), [api.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/public/containers/user_profiles/api.test.ts#:~:text=userProfiles), [api.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/public/containers/user_profiles/api.test.ts#:~:text=userProfiles), [api.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/public/containers/user_profiles/api.test.ts#:~:text=userProfiles), [api.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/public/containers/user_profiles/api.test.ts#:~:text=userProfiles) | - | +| | [factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cases/server/client/factory.ts#:~:text=audit) | - | @@ -551,11 +562,28 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] +## cloudDefend + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [setup_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_defend/server/routes/setup_routes.ts#:~:text=authc), [setup_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_defend/server/routes/setup_routes.ts#:~:text=authc) | - | + + + +## cloudLinks + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [maybe_add_cloud_links.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_integrations/cloud_links/public/maybe_add_cloud_links/maybe_add_cloud_links.ts#:~:text=authc) | - | + + + ## cloudSecurityPosture | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [overview_tab.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/overview_tab.tsx#:~:text=indexPatternId) | - | +| | [setup_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/server/routes/setup_routes.ts#:~:text=authc), [setup_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/server/routes/setup_routes.ts#:~:text=authc) | - | | | [csp_benchmark_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/server/saved_objects/csp_benchmark_rule.ts#:~:text=migrations) | - | | | [csp_benchmark_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/server/saved_objects/csp_benchmark_rule.ts#:~:text=schemas), [csp_settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/server/saved_objects/csp_settings.ts#:~:text=schemas) | - | @@ -668,6 +696,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [data_view.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_view.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_view.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_views.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_views.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields) | - | | | [data_views.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/server/saved_objects/data_views.ts#:~:text=migrations) | - | | | [data_views.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/server/saved_objects/data_views.ts#:~:text=convertToMultiNamespaceTypeVersion) | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/public/plugin.ts#:~:text=authc) | - | @@ -677,6 +706,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | ---------------|-----------|-----------| | | [document_stats.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/components/field_data_row/document_stats.tsx#:~:text=fieldFormats), [distinct_values.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/components/field_data_row/distinct_values.tsx#:~:text=fieldFormats), [top_values.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx#:~:text=fieldFormats), [choropleth_map.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/components/field_data_expanded_row/choropleth_map.tsx#:~:text=fieldFormats), [default_value_formatter.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/data_drift/charts/default_value_formatter.ts#:~:text=fieldFormats) | - | | | [use_data_visualizer_grid_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts#:~:text=title) | - | +| | [filebeat_config_flyout.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/common/components/filebeat_config_flyout/filebeat_config_flyout.tsx#:~:text=authc), [use_data_visualizer_grid_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts#:~:text=authc), [filebeat_config_flyout.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/common/components/filebeat_config_flyout/filebeat_config_flyout.tsx#:~:text=authc), [use_data_visualizer_grid_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts#:~:text=authc) | - | | | [index_data_visualizer.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/index_data_visualizer.tsx#:~:text=savedObjects) | - | | | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/common/types/index.ts#:~:text=SimpleSavedObject), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/common/types/index.ts#:~:text=SimpleSavedObject) | - | @@ -698,6 +728,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] +## elasticAssistant + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [request_context_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/elastic_assistant/server/routes/request_context_factory.ts#:~:text=authc), [request_context_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/elastic_assistant/server/routes/request_context_factory.ts#:~:text=authc) | - | + + + ## embeddable | Deprecated API | Reference location(s) | Remove By | @@ -735,8 +773,10 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [find_or_create_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/analytics/utils/find_or_create_data_view.ts#:~:text=title), [analytics_collection_explore_table_formulas.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/analytics/components/analytics_collection_view/analytics_collection_explore_table_formulas.ts#:~:text=title), [find_or_create_data_view.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/analytics/utils/find_or_create_data_view.test.ts#:~:text=title) | - | | | [account_settings.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/account_settings/account_settings.tsx#:~:text=uiApi), [account_settings.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/account_settings/account_settings.tsx#:~:text=uiApi), [account_settings.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/account_settings/account_settings.tsx#:~:text=uiApi), [account_settings.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/account_settings/account_settings.tsx#:~:text=uiApi) | - | | | [check_access.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz), [check_access.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz), [check_access.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz) | - | +| | [create_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/indices/create_api_key.ts#:~:text=authc), [api_keys.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/routes/enterprise_search/api_keys.ts#:~:text=authc), [api_keys.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/routes/enterprise_search/api_keys.ts#:~:text=authc), [create_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/indices/create_api_key.ts#:~:text=authc), [api_keys.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/routes/enterprise_search/api_keys.ts#:~:text=authc), [api_keys.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/routes/enterprise_search/api_keys.ts#:~:text=authc) | - | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/plugin.ts#:~:text=legacy) | - | | | [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes) | - | +| | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/index.tsx#:~:text=authc), [roles_empty_prompt.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/shared/role_mapping/roles_empty_prompt.tsx#:~:text=authc), [roles_empty_prompt.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/shared/role_mapping/roles_empty_prompt.tsx#:~:text=authc), [account_settings.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/account_settings/account_settings.tsx#:~:text=authc), [account_settings.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/account_settings/account_settings.tsx#:~:text=authc) | - | @@ -792,6 +832,15 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] +## files + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [create.ts](https://github.com/elastic/kibana/tree/main/src/plugins/files/server/routes/file_kind/create.ts#:~:text=authc), [create.ts](https://github.com/elastic/kibana/tree/main/src/plugins/files/server/routes/file_kind/create.ts#:~:text=authc) | - | +| | [file_service_factory.ts](https://github.com/elastic/kibana/tree/main/src/plugins/files/server/file_service/file_service_factory.ts#:~:text=audit), [file_service_factory.ts](https://github.com/elastic/kibana/tree/main/src/plugins/files/server/file_service/file_service_factory.ts#:~:text=audit) | - | + + + ## filesManagement | Deprecated API | Reference location(s) | Remove By | @@ -810,8 +859,10 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [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) | - | | | [agent_policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/services/agent_policy_config.test.ts#:~:text=mode), [agent_policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/services/agent_policy_config.test.ts#:~:text=mode), [agent_policy_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/agent_policy_watch.test.ts#:~:text=mode), [agent_policy_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/agent_policy_watch.test.ts#:~:text=mode) | 8.8.0 | | | [agent_policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/services/agent_policy_config.test.ts#:~:text=mode), [agent_policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/services/agent_policy_config.test.ts#:~:text=mode), [agent_policy_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/agent_policy_watch.test.ts#:~:text=mode), [agent_policy_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/agent_policy_watch.test.ts#:~:text=mode) | 8.8.0 | +| | [security.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/security/security.ts#:~:text=authc), [transform_api_keys.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/api_keys/transform_api_keys.ts#:~:text=authc), [security.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/api_keys/security.ts#:~:text=authc), [handlers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts#:~:text=authc), [handlers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts#:~:text=authc), [handlers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts#:~:text=authc), [handlers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts#:~:text=authc), [handlers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/routes/package_policy/handlers.ts#:~:text=authc), [handlers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/routes/epm/handlers.ts#:~:text=authc), [handlers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/routes/epm/handlers.ts#:~:text=authc)+ 36 more | - | | | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 | | | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/saved_objects/index.ts#:~:text=migrations), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/saved_objects/index.ts#:~:text=migrations), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/saved_objects/index.ts#:~:text=migrations), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/saved_objects/index.ts#:~:text=migrations), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/saved_objects/index.ts#:~:text=migrations) | - | +| | [audit_logging.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/audit_logging.ts#:~:text=audit), [audit_logging.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/audit_logging.ts#:~:text=audit) | - | @@ -863,6 +914,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [image_embeddable.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/image_embeddable/public/components/image_embeddable.tsx#:~:text=executeTriggerActions) | - | +| | [open_image_editor.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/image_embeddable/public/components/image_editor/open_image_editor.tsx#:~:text=authc) | - | @@ -879,7 +931,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [use_waffle_filters.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/infra/public/pages/metrics/inventory_view/hooks/use_waffle_filters.test.ts#:~:text=title) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/infra/public/plugin.ts#:~:text=registerEmbeddableFactory) | - | | | [saved_object_type.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/infra/server/lib/sources/saved_object_type.ts#:~:text=migrations) | - | @@ -971,6 +1022,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | ---------------|-----------|-----------| | | [exception_list_client.mock.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts#:~:text=migrationVersion) | - | | | [exception_list_client.mock.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts#:~:text=migrationVersion), [exception_list_client.mock.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts#:~:text=migrationVersion), [exception_list_client.mock.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts#:~:text=migrationVersion), [exception_list_client.mock.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts#:~:text=migrationVersion) | - | +| | [get_user.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/get_user.ts#:~:text=authc), [get_user.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/get_user.ts#:~:text=authc) | - | | | [exception_list_client.mock.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts#:~:text=SavedObject), [exception_list_client.mock.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts#:~:text=SavedObject), [exception_list_client.mock.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts#:~:text=SavedObject), [exception_list_client.mock.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts#:~:text=SavedObject), [exception_list_client.mock.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts#:~:text=SavedObject) | - | | | [exception_list.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/saved_objects/exception_list.ts#:~:text=migrations), [exception_list.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/saved_objects/exception_list.ts#:~:text=migrations) | - | | | [exception_list.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lists/server/saved_objects/exception_list.ts#:~:text=convertToMultiNamespaceTypeVersion) | - | @@ -1021,6 +1073,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/common/migrations/references.ts#:~:text=SavedObjectReference), [references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/common/migrations/references.ts#:~:text=SavedObjectReference), [references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/common/migrations/references.ts#:~:text=SavedObjectReference), [references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/common/migrations/references.ts#:~:text=SavedObjectReference), [references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/common/migrations/references.ts#:~:text=SavedObjectReference), [map_attribute_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/map_attribute_service.ts#:~:text=SavedObjectReference), [map_attribute_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/map_attribute_service.ts#:~:text=SavedObjectReference) | - | | | [setup_saved_objects.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/server/saved_objects/setup_saved_objects.ts#:~:text=migrations) | - | | | [setup_saved_objects.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/server/saved_objects/setup_saved_objects.ts#:~:text=convertToMultiNamespaceTypeVersion) | - | +| | [es_search_source.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=authc) | - | @@ -1057,6 +1110,22 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] +## observabilityAIAssistant + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/index.ts#:~:text=authc), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/index.ts#:~:text=authc) | - | + + + +## observabilityAIAssistantApp + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [use_current_user.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/hooks/use_current_user.ts#:~:text=authc) | - | + + + ## observabilityOnboarding | Deprecated API | Reference location(s) | Remove By | @@ -1082,6 +1151,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [read_pack_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/pack/read_pack_route.ts#:~:text=migrationVersion), [read_pack_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/pack/read_pack_route.ts#:~:text=migrationVersion), [read_pack_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/pack/read_pack_route.ts#:~:text=migrationVersion), [read_pack_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/pack/read_pack_route.ts#:~:text=migrationVersion) | - | | | [pack_queries_status_table.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/public/packs/pack_queries_status_table.tsx#:~:text=indexPatternId), [view_results_in_discover.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/public/discover/view_results_in_discover.tsx#:~:text=indexPatternId), [use_discover_link.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/public/common/hooks/use_discover_link.tsx#:~:text=indexPatternId) | - | | | [create_action_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/handlers/action/create_action_service.ts#:~:text=license%24) | 8.8.0 | +| | [create_live_query_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/live_query/create_live_query_route.ts#:~:text=authc), [create_saved_query_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/saved_query/create_saved_query_route.ts#:~:text=authc), [update_saved_query_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/saved_query/update_saved_query_route.ts#:~:text=authc), [create_pack_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/pack/create_pack_route.ts#:~:text=authc), [update_pack_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/pack/update_pack_route.ts#:~:text=authc), [update_assets_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/asset/update_assets_route.ts#:~:text=authc), [create_live_query_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/live_query/create_live_query_route.ts#:~:text=authc), [create_saved_query_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/saved_query/create_saved_query_route.ts#:~:text=authc), [update_saved_query_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/saved_query/update_saved_query_route.ts#:~:text=authc), [create_pack_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/server/routes/pack/create_pack_route.ts#:~:text=authc)+ 2 more | - | | | [add_to_timeline_button.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/osquery/public/timelines/add_to_timeline_button.tsx#:~:text=getHoverActions) | - | @@ -1125,6 +1195,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [get_user.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/server/routes/common/get_user.ts#:~:text=authc), [get_user.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/server/routes/common/get_user.ts#:~:text=authc) | - | | | [core.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/server/core.ts#:~:text=CsvSearchSourceImmediateExportType), [core.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/server/core.ts#:~:text=CsvSearchSourceImmediateExportType) | - | | | [csv_searchsource_immediate.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/server/routes/internal/generate/csv_searchsource_immediate.ts#:~:text=JobParamsDownloadCSV), [csv_searchsource_immediate.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/server/routes/internal/generate/csv_searchsource_immediate.ts#:~:text=JobParamsDownloadCSV) | - | | | [csv_searchsource_immediate.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/server/routes/internal/generate/csv_searchsource_immediate.ts#:~:text=CSV_SEARCHSOURCE_IMMEDIATE_TYPE), [csv_searchsource_immediate.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/server/routes/internal/generate/csv_searchsource_immediate.ts#:~:text=CSV_SEARCHSOURCE_IMMEDIATE_TYPE), [csv_searchsource_immediate.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/server/routes/internal/generate/csv_searchsource_immediate.ts#:~:text=CSV_SEARCHSOURCE_IMMEDIATE_TYPE) | - | @@ -1147,6 +1218,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [create_lifecycle_executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts#:~:text=alertFactory), [create_persistence_rule_type_wrapper.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_wrapper.ts#:~:text=alertFactory), [create_persistence_rule_type_wrapper.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_wrapper.ts#:~:text=alertFactory), [rule_executor.test_helpers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/rule_registry/server/utils/rule_executor.test_helpers.ts#:~:text=alertFactory) | - | +| | [alerts_client_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client_factory.ts#:~:text=audit), [search_strategy.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/rule_registry/server/search_strategy/search_strategy.ts#:~:text=audit) | - | @@ -1218,6 +1290,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] +## searchPlayground + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [use_user_profile.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/search_playground/public/hooks/use_user_profile.ts#:~:text=userProfiles) | - | + + + ## searchprofiler | Deprecated API | Reference location(s) | Remove By | @@ -1239,7 +1319,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ 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 | -| | [app_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.ts#:~:text=getKibanaFeatures), [privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.ts#:~:text=getKibanaFeatures), [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getKibanaFeatures), [app_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 15 more | 8.8.0 | +| | [app_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.ts#:~:text=getKibanaFeatures), [privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.ts#:~:text=getKibanaFeatures), [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getKibanaFeatures), [app_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 24 more | 8.8.0 | | | [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getElasticsearchFeatures) | 8.8.0 | | | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | | | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/plugin.tsx#:~:text=license%24) | 8.8.0 | @@ -1247,6 +1327,12 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/plugin.ts#:~:text=license%24) | 8.8.0 | | | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 | | | [config.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/config.ts#:~:text=max) | - | +| | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/plugin.tsx#:~:text=authc) | - | +| | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/plugin.tsx#:~:text=authc) | - | +| | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/plugin.tsx#:~:text=userProfiles) | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/plugin.ts#:~:text=audit) | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/plugin.ts#:~:text=authc) | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/plugin.ts#:~:text=userProfiles) | - | @@ -1268,6 +1354,8 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 | | | [get_is_alert_suppression_active.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_is_alert_suppression_active.ts#:~:text=license%24), [create_threat_signals.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/indicator_match/threat_mapping/create_threat_signals.ts#:~:text=license%24), [query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts#:~:text=license%24), [threshold.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/threshold.ts#:~:text=license%24), [get_is_alert_suppression_active.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_is_alert_suppression_active.test.ts#:~:text=license%24), [get_is_alert_suppression_active.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_is_alert_suppression_active.test.ts#:~:text=license%24), [get_is_alert_suppression_active.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_is_alert_suppression_active.test.ts#:~:text=license%24) | 8.8.0 | | | [request_context_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts#:~:text=authc), [create_signals_migration_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts#:~:text=authc), [delete_signals_migration_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts#:~:text=authc), [finalize_signals_migration_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts#:~:text=authc), [common.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts#:~:text=authc) | - | +| | [endpoint_app_context_services.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/endpoint_app_context_services.ts#:~:text=authc), [open_close_signals_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts#:~:text=authc), [open_close_signals_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts#:~:text=authc), [file_info_handler.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/routes/actions/file_info_handler.ts#:~:text=authc), [file_download_handler.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/routes/actions/file_download_handler.ts#:~:text=authc), [response_actions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts#:~:text=authc), [list.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts#:~:text=authc), [response_actions.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts#:~:text=authc), [state.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/routes/actions/state.test.ts#:~:text=authc), [index.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/routes/suggestions/index.test.ts#:~:text=authc)+ 14 more | - | +| | [suggest_user_profiles_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/users/suggest_user_profiles_route.ts#:~:text=userProfiles), [suggest_user_profiles_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/users/suggest_user_profiles_route.ts#:~:text=userProfiles) | - | | | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx#:~:text=DeprecatedCellValueElementProps), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx#:~:text=DeprecatedCellValueElementProps) | - | | | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx#:~:text=DeprecatedRowRenderer), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx#:~:text=DeprecatedRowRenderer) | - | | | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#:~:text=BeatFields), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/search_strategy/endpoint_fields/index.ts#:~:text=BeatFields), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/search_strategy/endpoint_fields/index.ts#:~:text=BeatFields), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/search_strategy/endpoint_fields/index.ts#:~:text=BeatFields) | - | @@ -1280,6 +1368,9 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | | [host_risk_score_dashboards.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/host_risk_score_dashboards.ts#:~:text=SavedObject), [host_risk_score_dashboards.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/host_risk_score_dashboards.ts#:~:text=SavedObject), [user_risk_score_dashboards.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/user_risk_score_dashboards.ts#:~:text=SavedObject), [user_risk_score_dashboards.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/user_risk_score_dashboards.ts#:~:text=SavedObject) | - | | | [timelines.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/timeline/saved_object_mappings/timelines.ts#:~:text=migrations), [notes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/timeline/saved_object_mappings/notes.ts#:~:text=migrations), [pinned_events.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/timeline/saved_object_mappings/pinned_events.ts#:~:text=migrations), [legacy_saved_object_mappings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_saved_object_mappings.ts#:~:text=migrations), [saved_object_mappings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/saved_object_mappings.ts#:~:text=migrations) | - | | | [timelines.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/timeline/saved_object_mappings/timelines.ts#:~:text=convertToMultiNamespaceTypeVersion), [notes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/timeline/saved_object_mappings/notes.ts#:~:text=convertToMultiNamespaceTypeVersion), [pinned_events.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/timeline/saved_object_mappings/pinned_events.ts#:~:text=convertToMultiNamespaceTypeVersion), [legacy_saved_object_mappings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_saved_object_mappings.ts#:~:text=convertToMultiNamespaceTypeVersion) | - | +| | [links.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/links.ts#:~:text=authc), [hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/lib/kibana/hooks.ts#:~:text=authc) | - | +| | [use_bulk_get_user_profiles.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/user_profiles/use_bulk_get_user_profiles.tsx#:~:text=userProfiles), [use_get_current_user_profile.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/user_profiles/use_get_current_user_profile.tsx#:~:text=userProfiles), [overlay.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/assistant/overlay.tsx#:~:text=userProfiles) | - | +| | [request_context_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=audit), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/plugin.ts#:~:text=audit) | - | | | [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [lists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [trusted_app_validator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lists_integration/endpoint/validators/trusted_app_validator.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [trusted_app_validator.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lists_integration/endpoint/validators/trusted_app_validator.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [policy_hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_hooks.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [policy_hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/policy/view/policy_hooks.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [api_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/api_client.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID), [api_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/api_client.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_ID)+ 25 more | - | | | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_NAME), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_NAME), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/trusted_apps/index.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_NAME), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/trusted_apps/index.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_NAME) | - | | | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/trusted_apps/index.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/scripts/endpoint/trusted_apps/index.ts#:~:text=ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION) | - | @@ -1296,6 +1387,15 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ +## serverlessSearch + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [api_key_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/serverless_search/server/routes/api_key_routes.ts#:~:text=authc), [api_key_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/serverless_search/server/routes/api_key_routes.ts#:~:text=authc), [indices_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/serverless_search/server/routes/indices_routes.ts#:~:text=authc), [api_key_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/serverless_search/server/routes/api_key_routes.ts#:~:text=authc), [api_key_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/serverless_search/server/routes/api_key_routes.ts#:~:text=authc), [indices_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/serverless_search/server/routes/indices_routes.ts#:~:text=authc) | - | +| | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/serverless_search/public/plugin.ts#:~:text=authc) | - | + + + ## share | Deprecated API | Reference location(s) | Remove By | @@ -1354,6 +1454,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | ---------------|-----------|-----------| | | [common.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/alert_rules/common.ts#:~:text=alertFactory), [message_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/alert_rules/tls_rule/message_utils.ts#:~:text=alertFactory), [tls_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/alert_rules/tls_rule/tls_rule.ts#:~:text=alertFactory), [monitor_status_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/alert_rules/status_rule/monitor_status_rule.ts#:~:text=alertFactory) | - | | | [stderr_logs.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/components/stderr_logs.tsx#:~:text=indexPatternId) | - | +| | [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [enablement.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/routes/synthetics_service/enablement.ts#:~:text=authc), [enablement.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/routes/synthetics_service/enablement.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc)+ 6 more | - | | | [synthetics_monitor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/synthetics/server/saved_objects/synthetics_monitor.ts#:~:text=migrations) | - | @@ -1389,6 +1490,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | ---------------|-----------|-----------| | | [filter_term_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_term_form.tsx#:~:text=title), [use_data_view_exists.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/transform/public/app/hooks/use_data_view_exists.ts#:~:text=title), [common.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/common.test.ts#:~:text=title) | - | | | [license.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/transform/server/services/license.ts#:~:text=license%24) | 8.8.0 | +| | [route_handler_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/transform/server/routes/api/reauthorize_transforms/route_handler_factory.ts#:~:text=authc), [route_handler_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/transform/server/routes/api/reauthorize_transforms/route_handler_factory.ts#:~:text=authc) | - | | | [mount_management_section.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/transform/public/app/mount_management_section.ts#:~:text=savedObjects) | - | | | [app_dependencies.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/transform/public/app/app_dependencies.tsx#:~:text=SavedObjectsStart), [app_dependencies.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/transform/public/app/app_dependencies.tsx#:~:text=SavedObjectsStart) | - | @@ -1431,6 +1533,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | ---------------|-----------|-----------| | | [external_links.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/public/application/components/es_deprecation_logs/fix_deprecation_logs/external_links.tsx#:~:text=title) | - | | | [reindex_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.ts#:~:text=license%24), [reindex_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts#:~:text=license%24), [reindex_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts#:~:text=license%24) | 8.8.0 | +| | [credential_store.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/credential_store.ts#:~:text=authc), [credential_store.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/credential_store.ts#:~:text=authc), [credential_store.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/credential_store.ts#:~:text=authc), [credential_store.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/credential_store.ts#:~:text=authc), [credential_store.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/credential_store.ts#:~:text=authc), [credential_store.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/credential_store.ts#:~:text=authc) | - | | | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/common/types.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/common/types.ts#:~:text=SavedObject) | - | diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index 6f0507a83fcc5..55723af7a0679 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -87,7 +87,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ 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 | | [app_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.ts#:~:text=getKibanaFeatures), [privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.ts#:~:text=getKibanaFeatures), [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getKibanaFeatures), [app_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 18 more | 8.8.0 | +| security | | [app_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.ts#:~:text=getKibanaFeatures), [privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.ts#:~:text=getKibanaFeatures), [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getKibanaFeatures), [app_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 27 more | 8.8.0 | | security | | [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getElasticsearchFeatures) | 8.8.0 | | security | | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | | security | | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/plugin.tsx#:~:text=license%24) | 8.8.0 | diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index 7fcee6515d7a6..715f165736c2b 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: 2024-06-06 +date: 2024-06-09 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 5fe1ce61f7e5b..ad91704bd2c7d 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: 2024-06-06 +date: 2024-06-09 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 6b89700428deb..9d47a144d4b2a 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] --- import discoverEnhancedObj from './discover_enhanced.devdocs.json'; diff --git a/api_docs/discover_shared.mdx b/api_docs/discover_shared.mdx index f5cdb04be276a..3e23a9ec7dd21 100644 --- a/api_docs/discover_shared.mdx +++ b/api_docs/discover_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverShared title: "discoverShared" image: https://source.unsplash.com/400x175/?github description: API docs for the discoverShared plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverShared'] --- import discoverSharedObj from './discover_shared.devdocs.json'; diff --git a/api_docs/ecs_data_quality_dashboard.mdx b/api_docs/ecs_data_quality_dashboard.mdx index beff6b515b4d3..b04c83fcf5250 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard'] --- import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json'; diff --git a/api_docs/elastic_assistant.mdx b/api_docs/elastic_assistant.mdx index 4b564120c22ef..25d88edcf7963 100644 --- a/api_docs/elastic_assistant.mdx +++ b/api_docs/elastic_assistant.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/elasticAssistant title: "elasticAssistant" image: https://source.unsplash.com/400x175/?github description: API docs for the elasticAssistant plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant'] --- import elasticAssistantObj from './elastic_assistant.devdocs.json'; diff --git a/api_docs/embeddable.devdocs.json b/api_docs/embeddable.devdocs.json index 929b5fdefe5ed..01c91c22b075e 100644 --- a/api_docs/embeddable.devdocs.json +++ b/api_docs/embeddable.devdocs.json @@ -14302,10 +14302,6 @@ "plugin": "discover", "path": "src/plugins/discover/public/plugin.tsx" }, - { - "plugin": "infra", - "path": "x-pack/plugins/observability_solution/infra/public/plugin.ts" - }, { "plugin": "profiling", "path": "x-pack/plugins/observability_solution/profiling/public/embeddables/register_embeddables.ts" diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index afdb88fcd88ba..de4c5a7674082 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: 2024-06-06 +date: 2024-06-09 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 ac4f81a223cec..61a42bc57f617 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: 2024-06-06 +date: 2024-06-09 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 44e6016bcf702..3128ab3e5946d 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: 2024-06-06 +date: 2024-06-09 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 84cd075bd48f2..2a3bba48bada4 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: 2024-06-06 +date: 2024-06-09 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 35c350116888b..b3538db59ee92 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] --- import esUiSharedObj from './es_ui_shared.devdocs.json'; diff --git a/api_docs/esql_data_grid.mdx b/api_docs/esql_data_grid.mdx index 039db9f9ef1e4..e78b7621bb2f7 100644 --- a/api_docs/esql_data_grid.mdx +++ b/api_docs/esql_data_grid.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esqlDataGrid title: "esqlDataGrid" image: https://source.unsplash.com/400x175/?github description: API docs for the esqlDataGrid plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esqlDataGrid'] --- import esqlDataGridObj from './esql_data_grid.devdocs.json'; diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index 99cfc2f27f983..1ee995dba019b 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] --- import eventAnnotationObj from './event_annotation.devdocs.json'; diff --git a/api_docs/event_annotation_listing.mdx b/api_docs/event_annotation_listing.mdx index 869eb08007491..e62bb9d5ff80b 100644 --- a/api_docs/event_annotation_listing.mdx +++ b/api_docs/event_annotation_listing.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotationListing title: "eventAnnotationListing" image: https://source.unsplash.com/400x175/?github description: API docs for the eventAnnotationListing plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing'] --- import eventAnnotationListingObj from './event_annotation_listing.devdocs.json'; diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index cd377b22d8f00..820dbfa7e1ecb 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: 2024-06-06 +date: 2024-06-09 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 f6470755965ac..d84b539b44a08 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: 2024-06-06 +date: 2024-06-09 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 7e33b6bb9a025..3f35211d1cbb3 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: 2024-06-06 +date: 2024-06-09 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 d9a6dfcb91df3..5a2bf6ca62442 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: 2024-06-06 +date: 2024-06-09 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 5e69f016743aa..c73d823fd44a7 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: 2024-06-06 +date: 2024-06-09 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 804514ae674e9..93110d2ab41cf 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: 2024-06-06 +date: 2024-06-09 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 dabcdb2854a77..7e9e60f7dd05b 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: 2024-06-06 +date: 2024-06-09 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 ffb3d622d9a5d..2da47ebe19cce 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: 2024-06-06 +date: 2024-06-09 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 2876a3617c019..e86cf7f2b2ab7 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: 2024-06-06 +date: 2024-06-09 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 21c8c3655f0b7..bd5f348ccfcc4 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: 2024-06-06 +date: 2024-06-09 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 c61c88babacb4..8122cfccbfcb0 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: 2024-06-06 +date: 2024-06-09 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 a16db7043647c..c75076257eb31 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: 2024-06-06 +date: 2024-06-09 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 b3c04451c0dcd..4dbfd70f3fa6d 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: 2024-06-06 +date: 2024-06-09 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 41822e6678792..f8e17f29c0b05 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: 2024-06-06 +date: 2024-06-09 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 01f5b56b41639..b277563fccea0 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: 2024-06-06 +date: 2024-06-09 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 61403d8eed4bc..3b2a2e90f0123 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: 2024-06-06 +date: 2024-06-09 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 2fd46e8ffdbd9..9af80b8a01f04 100644 --- a/api_docs/features.devdocs.json +++ b/api_docs/features.devdocs.json @@ -56,7 +56,7 @@ "label": "config", "description": [], "signature": [ - "Readonly<{ id: string; name: string; description?: string | undefined; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; requireAllSpaces?: boolean | undefined; privilegesTooltip?: string | undefined; privilegeGroups: readonly Readonly<{ groupType: ", + "Readonly<{ id: string; name: string; description?: string | undefined; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; requireAllSpaces?: boolean | undefined; privilegesTooltip?: string | undefined; privilegeGroups: readonly Readonly<{ groupType: ", { "pluginId": "features", "scope": "common", @@ -64,7 +64,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"read\" | \"all\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; ui: readonly string[]; catalogue?: readonly string[] | undefined; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"read\" | \"all\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; ui: readonly string[]; catalogue?: readonly string[] | undefined; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; }>[]; }> | undefined; hidden?: boolean | undefined; }>" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -85,6 +85,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "features", + "id": "def-public.KibanaFeature.hidden", + "type": "CompoundType", + "tags": [], + "label": "hidden", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "features", "id": "def-public.KibanaFeature.name", @@ -202,7 +216,7 @@ "label": "privileges", "description": [], "signature": [ - "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" + "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; }> | null" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -255,7 +269,7 @@ "label": "reserved", "description": [], "signature": [ - "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" + "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; }>[]; }> | undefined" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -480,6 +494,30 @@ "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "features", + "id": "def-public.FeatureKibanaPrivileges.composedOf", + "type": "Object", + "tags": [], + "label": "composedOf", + "description": [ + "\nAn optional list of other registered feature or sub-feature privileges that this privilege is composed of. When\nprivilege is registered with Elasticsearch, it will be expanded to grant everything that referenced privileges\ngrant. This property can only be set in the feature configuration overrides." + ], + "signature": [ + "readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureKibanaPrivilegesReference", + "text": "FeatureKibanaPrivilegesReference" + }, + "[] | undefined" + ], + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -782,6 +820,22 @@ "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "features", + "id": "def-public.KibanaFeatureConfig.hidden", + "type": "CompoundType", + "tags": [], + "label": "hidden", + "description": [ + "\nIndicates whether the feature is available as a standalone feature. The feature can still be\nreferenced by other features, but it will not be displayed in any feature management UIs. By default, all features\nare visible." + ], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -912,7 +966,7 @@ "section": "def-common.FeatureKibanaPrivileges", "text": "FeatureKibanaPrivileges" }, - ", \"excludeFromBasePrivileges\">" + ", \"excludeFromBasePrivileges\" | \"composedOf\">" ], "path": "x-pack/plugins/features/common/sub_feature.ts", "deprecated": false, @@ -1264,7 +1318,7 @@ "label": "config", "description": [], "signature": [ - "Readonly<{ id: string; name: string; description?: string | undefined; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; requireAllSpaces?: boolean | undefined; privilegesTooltip?: string | undefined; privilegeGroups: readonly Readonly<{ groupType: ", + "Readonly<{ id: string; name: string; description?: string | undefined; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; requireAllSpaces?: boolean | undefined; privilegesTooltip?: string | undefined; privilegeGroups: readonly Readonly<{ groupType: ", { "pluginId": "features", "scope": "common", @@ -1272,7 +1326,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"read\" | \"all\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; ui: readonly string[]; catalogue?: readonly string[] | undefined; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"read\" | \"all\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; ui: readonly string[]; catalogue?: readonly string[] | undefined; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; }>[]; }> | undefined; hidden?: boolean | undefined; }>" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -1293,6 +1347,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "features", + "id": "def-server.KibanaFeature.hidden", + "type": "CompoundType", + "tags": [], + "label": "hidden", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "features", "id": "def-server.KibanaFeature.name", @@ -1410,7 +1478,7 @@ "label": "privileges", "description": [], "signature": [ - "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" + "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; }> | null" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -1463,7 +1531,7 @@ "label": "reserved", "description": [], "signature": [ - "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" + "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; }>[]; }> | undefined" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -1867,6 +1935,30 @@ "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "features", + "id": "def-server.FeatureKibanaPrivileges.composedOf", + "type": "Object", + "tags": [], + "label": "composedOf", + "description": [ + "\nAn optional list of other registered feature or sub-feature privileges that this privilege is composed of. When\nprivilege is registered with Elasticsearch, it will be expanded to grant everything that referenced privileges\ngrant. This property can only be set in the feature configuration overrides." + ], + "signature": [ + "readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureKibanaPrivilegesReference", + "text": "FeatureKibanaPrivilegesReference" + }, + "[] | undefined" + ], + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -2169,6 +2261,22 @@ "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "features", + "id": "def-server.KibanaFeatureConfig.hidden", + "type": "CompoundType", + "tags": [], + "label": "hidden", + "description": [ + "\nIndicates whether the feature is available as a standalone feature. The feature can still be\nreferenced by other features, but it will not be displayed in any feature management UIs. By default, all features\nare visible." + ], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -2417,6 +2525,42 @@ "plugin": "security", "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/server/authorization/privileges/privileges.test.ts" + }, { "plugin": "spaces", "path": "x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.test.ts" @@ -2965,7 +3109,7 @@ "label": "config", "description": [], "signature": [ - "Readonly<{ id: string; name: string; description?: string | undefined; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; requireAllSpaces?: boolean | undefined; privilegesTooltip?: string | undefined; privilegeGroups: readonly Readonly<{ groupType: ", + "Readonly<{ id: string; name: string; description?: string | undefined; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; requireAllSpaces?: boolean | undefined; privilegesTooltip?: string | undefined; privilegeGroups: readonly Readonly<{ groupType: ", { "pluginId": "features", "scope": "common", @@ -2973,7 +3117,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"read\" | \"all\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; ui: readonly string[]; catalogue?: readonly string[] | undefined; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"read\" | \"all\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; ui: readonly string[]; catalogue?: readonly string[] | undefined; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; }>[]; }> | undefined; hidden?: boolean | undefined; }>" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -2994,6 +3138,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "features", + "id": "def-common.KibanaFeature.hidden", + "type": "CompoundType", + "tags": [], + "label": "hidden", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "features", "id": "def-common.KibanaFeature.name", @@ -3111,7 +3269,7 @@ "label": "privileges", "description": [], "signature": [ - "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null" + "Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; }> | null" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -3164,7 +3322,7 @@ "label": "reserved", "description": [], "signature": [ - "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined" + "Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; settings?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; composedOf?: readonly Readonly<{ feature: string; privileges: readonly string[]; }>[] | undefined; }>; }>[]; }> | undefined" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -3701,6 +3859,75 @@ "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "features", + "id": "def-common.FeatureKibanaPrivileges.composedOf", + "type": "Object", + "tags": [], + "label": "composedOf", + "description": [ + "\nAn optional list of other registered feature or sub-feature privileges that this privilege is composed of. When\nprivilege is registered with Elasticsearch, it will be expanded to grant everything that referenced privileges\ngrant. This property can only be set in the feature configuration overrides." + ], + "signature": [ + "readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureKibanaPrivilegesReference", + "text": "FeatureKibanaPrivilegesReference" + }, + "[] | undefined" + ], + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "features", + "id": "def-common.FeatureKibanaPrivilegesReference", + "type": "Interface", + "tags": [], + "label": "FeatureKibanaPrivilegesReference", + "description": [ + "\nDefines a reference to a set of privileges of a specific feature." + ], + "path": "x-pack/plugins/features/common/feature_kibana_privileges_reference.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "features", + "id": "def-common.FeatureKibanaPrivilegesReference.feature", + "type": "string", + "tags": [], + "label": "feature", + "description": [ + "\nThe ID of the feature." + ], + "path": "x-pack/plugins/features/common/feature_kibana_privileges_reference.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "features", + "id": "def-common.FeatureKibanaPrivilegesReference.privileges", + "type": "Object", + "tags": [], + "label": "privileges", + "description": [ + "\nThe set of IDs of feature or sub-feature privileges provided by the feature." + ], + "signature": [ + "readonly string[]" + ], + "path": "x-pack/plugins/features/common/feature_kibana_privileges_reference.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -4003,6 +4230,22 @@ "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "features", + "id": "def-common.KibanaFeatureConfig.hidden", + "type": "CompoundType", + "tags": [], + "label": "hidden", + "description": [ + "\nIndicates whether the feature is available as a standalone feature. The feature can still be\nreferenced by other features, but it will not be displayed in any feature management UIs. By default, all features\nare visible." + ], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -4133,7 +4376,7 @@ "section": "def-common.FeatureKibanaPrivileges", "text": "FeatureKibanaPrivileges" }, - ", \"excludeFromBasePrivileges\">" + ", \"excludeFromBasePrivileges\" | \"composedOf\">" ], "path": "x-pack/plugins/features/common/sub_feature.ts", "deprecated": false, diff --git a/api_docs/features.mdx b/api_docs/features.mdx index d8573459557de..0599b1ee27a11 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] --- import featuresObj from './features.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 | |-------------------|-----------|------------------------|-----------------| -| 235 | 0 | 99 | 2 | +| 247 | 0 | 102 | 2 | ## Client diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index 376991a8e5e35..c5c4435bdf43e 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] --- import fieldFormatsObj from './field_formats.devdocs.json'; diff --git a/api_docs/fields_metadata.mdx b/api_docs/fields_metadata.mdx index e8907fca5b10c..9f679f164075c 100644 --- a/api_docs/fields_metadata.mdx +++ b/api_docs/fields_metadata.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldsMetadata title: "fieldsMetadata" image: https://source.unsplash.com/400x175/?github description: API docs for the fieldsMetadata plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldsMetadata'] --- import fieldsMetadataObj from './fields_metadata.devdocs.json'; diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index 2cb302c00a3af..54f40d0832924 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: 2024-06-06 +date: 2024-06-09 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 1e712361ce570..fcc8d1075f70d 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: 2024-06-06 +date: 2024-06-09 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 5e54d26dd3720..b1de172e07688 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement'] --- import filesManagementObj from './files_management.devdocs.json'; diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index 46ab5547e135b..a15901488f3fd 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] --- import fleetObj from './fleet.devdocs.json'; diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index db33ffce5d161..9efe2e9626b67 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: 2024-06-06 +date: 2024-06-09 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 de3163d291ce2..c6612b960c27c 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: 2024-06-06 +date: 2024-06-09 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 c474a65bab10e..e441fa46aca62 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: 2024-06-06 +date: 2024-06-09 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 cee062a239e1d..bb0087213d788 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: 2024-06-06 +date: 2024-06-09 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 be4e0f89815d2..86a7cc593b65e 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: 2024-06-06 +date: 2024-06-09 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 55f95671f92f7..79dee9bb31ba8 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] --- import indexManagementObj from './index_management.devdocs.json'; diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index 25eca7c718271..ddfac4502fa45 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] --- import infraObj from './infra.devdocs.json'; diff --git a/api_docs/ingest_pipelines.mdx b/api_docs/ingest_pipelines.mdx index 093e13defe8be..b5222004f44fa 100644 --- a/api_docs/ingest_pipelines.mdx +++ b/api_docs/ingest_pipelines.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ingestPipelines title: "ingestPipelines" image: https://source.unsplash.com/400x175/?github description: API docs for the ingestPipelines plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ingestPipelines'] --- import ingestPipelinesObj from './ingest_pipelines.devdocs.json'; diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index 49515f37cf2de..bb4260b93c639 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: 2024-06-06 +date: 2024-06-09 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 63b5d223fdf7a..17ead3c7b0e71 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup'] --- import interactiveSetupObj from './interactive_setup.devdocs.json'; diff --git a/api_docs/investigate.devdocs.json b/api_docs/investigate.devdocs.json new file mode 100644 index 0000000000000..aef706f884292 --- /dev/null +++ b/api_docs/investigate.devdocs.json @@ -0,0 +1,8904 @@ +{ + "id": "investigate", + "client": { + "classes": [], + "functions": [ + { + "parentPluginId": "investigate", + "id": "def-public.createEsqlWidget", + "type": "Function", + "tags": [], + "label": "createEsqlWidget", + "description": [], + "signature": [ + ", PredefinedKeys>>(widgetCreate: T) => Pick<", + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidgetCreate", + "text": "InvestigateWidgetCreate" + }, + "<", + { + "pluginId": "investigate", + "scope": "public", + "docId": "kibInvestigatePluginApi", + "section": "def-public.EsqlWidgetParameters", + "text": "EsqlWidgetParameters" + }, + ">, PredefinedKeys> & Omit & { parameters: T[\"parameters\"] & ", + "_DeepPartialObject", + "<", + "GlobalWidgetParameters", + ">; }" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/esql_widget/create_esql_widget.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.createEsqlWidget.$1", + "type": "Uncategorized", + "tags": [], + "label": "widgetCreate", + "description": [], + "signature": [ + "T" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/create_widget.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.createWidgetFactory", + "type": "Function", + "tags": [], + "label": "createWidgetFactory", + "description": [], + "signature": [ + "(type: string, defaults: Pick>, AllowedDefaultKeys> | undefined) => ", + "WidgetFactory", + "" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/create_widget.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.createWidgetFactory.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/create_widget.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "investigate", + "id": "def-public.createWidgetFactory.$2", + "type": "Object", + "tags": [], + "label": "defaults", + "description": [], + "signature": [ + "Pick>, AllowedDefaultKeys> | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/create_widget.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.getEsFilterFromGlobalParameters", + "type": "Function", + "tags": [], + "label": "getEsFilterFromGlobalParameters", + "description": [], + "signature": [ + "({\n query,\n filters,\n timeRange,\n}: Partial<", + "GlobalWidgetParameters", + ">) => { bool: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.BoolQuery", + "text": "BoolQuery" + }, + "; }" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/util/get_es_filters_from_global_parameters.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.getEsFilterFromGlobalParameters.$1", + "type": "Object", + "tags": [], + "label": "{\n query,\n filters,\n timeRange,\n}", + "description": [], + "signature": [ + "Partial<", + "GlobalWidgetParameters", + ">" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/util/get_es_filters_from_global_parameters.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "investigate", + "id": "def-public.EsqlWidgetParameters", + "type": "Interface", + "tags": [], + "label": "EsqlWidgetParameters", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/public/esql_widget/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.EsqlWidgetParameters.esql", + "type": "string", + "tags": [], + "label": "esql", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/public/esql_widget/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.EsqlWidgetParameters.suggestion", + "type": "Object", + "tags": [], + "label": "suggestion", + "description": [], + "signature": [ + "Suggestion | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/esql_widget/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.EsqlWidgetParameters.predefined", + "type": "Object", + "tags": [], + "label": "predefined", + "description": [], + "signature": [ + "Partial<", + "GlobalWidgetParameters", + "> | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/esql_widget/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.GlobalWidgetParameters", + "type": "Interface", + "tags": [], + "label": "GlobalWidgetParameters", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.GlobalWidgetParameters.timeRange", + "type": "Object", + "tags": [], + "label": "timeRange", + "description": [], + "signature": [ + "{ from: string; to: string; }" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.GlobalWidgetParameters.query", + "type": "Object", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "{ query: string; language: \"kuery\"; }" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.GlobalWidgetParameters.filters", + "type": "Array", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateTimeline", + "type": "Interface", + "tags": [], + "label": "InvestigateTimeline", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateTimeline.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateTimeline.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateTimeline.timestamp", + "type": "number", + "tags": [], + "label": "'@timestamp'", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateTimeline.user", + "type": "Object", + "tags": [], + "label": "user", + "description": [], + "signature": [ + "InvestigateUser" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateTimeline.items", + "type": "Array", + "tags": [], + "label": "items", + "description": [], + "signature": [ + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidget", + "text": "InvestigateWidget" + }, + "<{}, {}>[]" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateUser", + "type": "Interface", + "tags": [], + "label": "InvestigateUser", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateUser.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidget", + "type": "Interface", + "tags": [], + "label": "InvestigateWidget", + "description": [], + "signature": [ + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidget", + "text": "InvestigateWidget" + }, + "" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidget.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidget.created", + "type": "number", + "tags": [], + "label": "created", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidget.last_updated", + "type": "number", + "tags": [], + "label": "last_updated", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidget.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidget.user", + "type": "Object", + "tags": [], + "label": "user", + "description": [], + "signature": [ + "InvestigateUser" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidget.parameters", + "type": "CompoundType", + "tags": [], + "label": "parameters", + "description": [], + "signature": [ + "GlobalWidgetParameters", + " & TParameters" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidget.data", + "type": "Uncategorized", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "TData" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidget.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidget.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidget.columns", + "type": "Enum", + "tags": [], + "label": "columns", + "description": [], + "signature": [ + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidgetColumnSpan", + "text": "InvestigateWidgetColumnSpan" + } + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidget.rows", + "type": "number", + "tags": [], + "label": "rows", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidget.locked", + "type": "boolean", + "tags": [], + "label": "locked", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.WidgetRenderAPI", + "type": "Interface", + "tags": [], + "label": "WidgetRenderAPI", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.WidgetRenderAPI.onDelete", + "type": "Function", + "tags": [], + "label": "onDelete", + "description": [], + "signature": [ + "() => void" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "investigate", + "id": "def-public.WidgetRenderAPI.onWidgetAdd", + "type": "Function", + "tags": [], + "label": "onWidgetAdd", + "description": [], + "signature": [ + "(create: ", + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidgetCreate", + "text": "InvestigateWidgetCreate" + }, + "<{}>) => Promise" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.WidgetRenderAPI.onWidgetAdd.$1", + "type": "CompoundType", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "Pick<", + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidget", + "text": "InvestigateWidget" + }, + "<{}, {}>, \"type\" | \"title\" | \"description\" | \"rows\" | \"columns\" | \"locked\"> & { parameters: ", + "_DeepPartialObject", + "<", + "GlobalWidgetParameters", + ">; }" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "investigate", + "id": "def-public.WidgetRenderAPI.blocks", + "type": "Object", + "tags": [], + "label": "blocks", + "description": [], + "signature": [ + "{ publish: (blocks: ", + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.WorkflowBlock", + "text": "WorkflowBlock" + }, + "[]) => UnregisterFunction; }" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.WorkflowBlock", + "type": "Interface", + "tags": [], + "label": "WorkflowBlock", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.WorkflowBlock.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.WorkflowBlock.content", + "type": "string", + "tags": [], + "label": "content", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.WorkflowBlock.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.WorkflowBlock.loading", + "type": "boolean", + "tags": [], + "label": "loading", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.WorkflowBlock.onClick", + "type": "Function", + "tags": [], + "label": "onClick", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "investigate", + "id": "def-public.WorkflowBlock.color", + "type": "CompoundType", + "tags": [], + "label": "color", + "description": [], + "signature": [ + "\"link\" | \"text\" | \"title\" | \"warning\" | \"disabled\" | \"success\" | \"body\" | \"highlight\" | \"primary\" | \"accent\" | \"danger\" | \"primaryText\" | \"accentText\" | \"successText\" | \"warningText\" | \"dangerText\" | \"emptyShade\" | \"lightestShade\" | \"lightShade\" | \"mediumShade\" | \"darkShade\" | \"darkestShade\" | \"fullShade\" | \"disabledText\" | \"shadow\" | \"subduedText\" | \"ghost\" | \"ink\" | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.WorkflowBlock.children", + "type": "CompoundType", + "tags": [], + "label": "children", + "description": [], + "signature": [ + "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "investigate", + "id": "def-public.ChromeOption", + "type": "Enum", + "tags": [], + "label": "ChromeOption", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidgetColumnSpan", + "type": "Enum", + "tags": [], + "label": "InvestigateWidgetColumnSpan", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "investigate", + "id": "def-public.ESQL_WIDGET_NAME", + "type": "string", + "tags": [], + "label": "ESQL_WIDGET_NAME", + "description": [], + "signature": [ + "\"esql\"" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/esql_widget/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigateWidgetCreate", + "type": "Type", + "tags": [], + "label": "InvestigateWidgetCreate", + "description": [], + "signature": [ + "Pick<", + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidget", + "text": "InvestigateWidget" + }, + "<{}, {}>, \"type\" | \"title\" | \"description\" | \"rows\" | \"columns\" | \"locked\"> & { parameters: ", + "_DeepPartialObject", + "<", + "GlobalWidgetParameters", + "> & TParameters; }" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.OnWidgetAdd", + "type": "Type", + "tags": [], + "label": "OnWidgetAdd", + "description": [], + "signature": [ + "(create: ", + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidgetCreate", + "text": "InvestigateWidgetCreate" + }, + "<{}>) => Promise" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.OnWidgetAdd.$1", + "type": "CompoundType", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "Pick<", + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidget", + "text": "InvestigateWidget" + }, + "<{}, {}>, \"type\" | \"title\" | \"description\" | \"rows\" | \"columns\" | \"locked\"> & { parameters: ", + "_DeepPartialObject", + "<", + "GlobalWidgetParameters", + ">; }" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "parentPluginId": "investigate", + "id": "def-public.InvestigatePublicSetup", + "type": "Interface", + "tags": [], + "label": "InvestigatePublicSetup", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.InvestigatePublicSetup.registerWidget", + "type": "Function", + "tags": [], + "label": "registerWidget", + "description": [], + "signature": [ + ">(definition: Omit & { schema: TSchema; }, generateCallback: GenerateCallback, renderCallback: (options: WidgetRenderOptions<", + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidget", + "text": "InvestigateWidget" + }, + ", TData>>) => React.ReactNode) => void" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.InvestigatePublicSetup.registerWidget.$1", + "type": "CompoundType", + "tags": [], + "label": "definition", + "description": [], + "signature": [ + "Omit & { schema: TSchema; }" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigatePublicSetup.registerWidget.$2", + "type": "Function", + "tags": [], + "label": "generateCallback", + "description": [], + "signature": [ + "(options: { parameters: (TSchema extends ", + "CompatibleJSONSchema", + " ? ", + "node_modules/ts-algebra/lib/meta-types/resolve", + "$Resolve<", + "JSONSchema7", + " extends (TSchema extends Record ? ", + "DeepWritable", + " : TSchema) ? ", + "Any", + " : (TSchema extends Record ? ", + "DeepWritable", + " : TSchema) extends string | true ? ", + "Any", + " : (TSchema extends Record ? ", + "DeepWritable", + " : TSchema) extends false ? ", + "Never", + " : (TSchema extends Record ? ", + "DeepWritable", + " : TSchema) extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> ? ", + "Any", + " : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends string | true ? ", + "Any", + " : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends false ? ", + "Never", + " : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends string | true ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends false ? ", + "Never", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"$ref\"], \"#\">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "OneOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnOneOfSchema<(", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AnyOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnAnyOfSchema<(", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "EnumSchema", + " ? ", + "node_modules/ts-algebra/lib/meta-types/intersection/index", + "$Intersect<", + "If", + "<", + "IsNever", + "<", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>>, ", + "Never", + ", { type: \"enum\"; values: ", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>; isSerialized: false; deserialized: never; }>, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ConstSchema", + " ? ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { const: unknown; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "MultipleTypesSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnMixedSchema<(", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "SingleTypeSchema", + " ? ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { type: ", + "JSONSchema7TypeName", + "; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends string | true ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends false ? ", + "Never", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"$ref\"], \"#\">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "OneOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnOneOfSchema<(", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AnyOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnAnyOfSchema<(", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "EnumSchema", + " ? ", + "node_modules/ts-algebra/lib/meta-types/intersection/index", + "$Intersect<", + "If", + "<", + "IsNever", + "<", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>>, ", + "Never", + ", { type: \"enum\"; values: ", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>; isSerialized: false; deserialized: never; }>, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ConstSchema", + " ? ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { const: unknown; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "MultipleTypesSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnMixedSchema<(", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "SingleTypeSchema", + " ? ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { type: ", + "JSONSchema7TypeName", + "; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends string | true ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends false ? ", + "Never", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"$ref\"], \"#\">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "OneOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnOneOfSchema<(", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AnyOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnAnyOfSchema<(", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "EnumSchema", + " ? ", + "node_modules/ts-algebra/lib/meta-types/intersection/index", + "$Intersect<", + "If", + "<", + "IsNever", + "<", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>>, ", + "Never", + ", { type: \"enum\"; values: ", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>; isSerialized: false; deserialized: never; }>, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ConstSchema", + " ? ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { const: unknown; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "MultipleTypesSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnMixedSchema<(", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "SingleTypeSchema", + " ? ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { type: ", + "JSONSchema7TypeName", + "; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : ", + "Any", + "> : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">)[\"$ref\"], \"#\">> : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> ? ", + "Any", + " : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends string | true ? ", + "Any", + " : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends false ? ", + "Never", + " : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"$ref\"], \"#\">> : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "OneOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnOneOfSchema<(", + "OneOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "AnyOfSchema", + " ? any : any> : any> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> ? ", + "Any", + " : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends string | true ? ", + "Any", + " : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends false ? ", + "Never", + " : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends string | true ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends false ? ", + "Never", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"$ref\"], \"#\">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "OneOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnOneOfSchema<(", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AnyOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnAnyOfSchema<(", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "EnumSchema", + " ? ", + "node_modules/ts-algebra/lib/meta-types/intersection/index", + "$Intersect<", + "If", + "<", + "IsNever", + "<", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>>, ", + "Never", + ", { type: \"enum\"; values: ", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>; isSerialized: false; deserialized: never; }>, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ConstSchema", + " ? ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { const: unknown; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "MultipleTypesSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnMixedSchema<(", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "SingleTypeSchema", + " ? ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { type: ", + "JSONSchema7TypeName", + "; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends string | true ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends false ? ", + "Never", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"$ref\"], \"#\">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "OneOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnOneOfSchema<(", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AnyOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnAnyOfSchema<(", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "EnumSchema", + " ? ", + "node_modules/ts-algebra/lib/meta-types/intersection/index", + "$Intersect<", + "If", + "<", + "IsNever", + "<", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>>, ", + "Never", + ", { type: \"enum\"; values: ", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>; isSerialized: false; deserialized: never; }>, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ConstSchema", + " ? ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { const: unknown; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "MultipleTypesSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnMixedSchema<(", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "SingleTypeSchema", + " ? ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { type: ", + "JSONSchema7TypeName", + "; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends string | true ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends false ? ", + "Never", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"$ref\"], \"#\">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "OneOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnOneOfSchema<(", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AnyOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnAnyOfSchema<(", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "EnumSchema", + " ? ", + "node_modules/ts-algebra/lib/meta-types/intersection/index", + "$Intersect<", + "If", + "<", + "IsNever", + "<", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>>, ", + "Never", + ", { type: \"enum\"; values: ", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>; isSerialized: false; deserialized: never; }>, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ConstSchema", + " ? ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { const: unknown; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "MultipleTypesSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnMixedSchema<(", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "SingleTypeSchema", + " ? ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { type: ", + "JSONSchema7TypeName", + "; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : ", + "Any", + "> : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">)[\"$ref\"], \"#\">> : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> ? ", + "Any", + " : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends string | true ? ", + "Any", + " : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends false ? ", + "Never", + " : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"$ref\"], \"#\">> : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "OneOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnOneOfSchema<(", + "OneOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "AnyOfSchema", + " ? any : any> : any> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> ? ", + "Any", + " : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends string | true ? ", + "Any", + " : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends false ? ", + "Never", + " : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends string | true ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends false ? ", + "Never", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"$ref\"], \"#\">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "OneOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnOneOfSchema<(", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AnyOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnAnyOfSchema<(", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "EnumSchema", + " ? ", + "node_modules/ts-algebra/lib/meta-types/intersection/index", + "$Intersect<", + "If", + "<", + "IsNever", + "<", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>>, ", + "Never", + ", { type: \"enum\"; values: ", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>; isSerialized: false; deserialized: never; }>, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ConstSchema", + " ? ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { const: unknown; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "MultipleTypesSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnMixedSchema<(", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "SingleTypeSchema", + " ? ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { type: ", + "JSONSchema7TypeName", + "; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends string | true ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends false ? ", + "Never", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"$ref\"], \"#\">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "OneOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnOneOfSchema<(", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AnyOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnAnyOfSchema<(", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "EnumSchema", + " ? ", + "node_modules/ts-algebra/lib/meta-types/intersection/index", + "$Intersect<", + "If", + "<", + "IsNever", + "<", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>>, ", + "Never", + ", { type: \"enum\"; values: ", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>; isSerialized: false; deserialized: never; }>, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ConstSchema", + " ? ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { const: unknown; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "MultipleTypesSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnMixedSchema<(", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "SingleTypeSchema", + " ? ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { type: ", + "JSONSchema7TypeName", + "; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends string | true ? ", + "Any", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends false ? ", + "Never", + " : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"$ref\"], \"#\">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "OneOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnOneOfSchema<(", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "AnyOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnAnyOfSchema<(", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"anyOf\"], ", + "AnyOfSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "EnumSchema", + " ? ", + "node_modules/ts-algebra/lib/meta-types/intersection/index", + "$Intersect<", + "If", + "<", + "IsNever", + "<", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>>, ", + "Never", + ", { type: \"enum\"; values: ", + "Compute", + "<(", + "EnumSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"enum\"][number], never>; isSerialized: false; deserialized: never; }>, ", + "Any", + "> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "ConstSchema", + " ? ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseConstSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { const: unknown; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "MultipleTypesSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnMixedSchema<(", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">)[\"type\"], ", + "MultipleTypesSchema", + " & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\"> extends ", + "SingleTypeSchema", + " ? ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> | ", + "ParseSingleTypeSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { type: ", + "JSONSchema7TypeName", + "; } & Omit<", + "NullableSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">> : ", + "Any", + "> : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">)[\"$ref\"], \"#\">> : Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "JSONSchema7", + " extends Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> ? ", + "Any", + " : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends string | true ? ", + "Any", + " : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends false ? ", + "Never", + " : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "NullableSchema", + " ? ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> | ", + "ParseNullableSchema", + " & { const?: unknown; enum?: unknown; items?: ", + "JSONSchema7", + " | ", + "JSONSchema7", + "[] | undefined; additionalItems?: ", + "JSONSchema7", + " | undefined; contains?: ", + "JSONSchema7", + " | undefined; properties?: Record | undefined; patternProperties?: Record | undefined; additionalProperties?: ", + "JSONSchema7", + " | undefined; dependencies?: { [key: string]: string[] | ", + "JSONSchema7", + "; } | undefined; propertyNames?: ", + "JSONSchema7", + " | undefined; if?: ", + "JSONSchema7", + " | undefined; then?: ", + "JSONSchema7", + " | undefined; else?: ", + "JSONSchema7", + " | undefined; allOf?: ", + "JSONSchema7", + "[] | undefined; anyOf?: ", + "JSONSchema7", + "[] | undefined; oneOf?: ", + "JSONSchema7", + "[] | undefined; not?: ", + "JSONSchema7", + " | undefined; nullable?: boolean | undefined; definitions?: { [key: string]: ", + "JSONSchema7", + "; } | undefined; examples?: unknown[] | undefined; default?: unknown; [$JSONSchema7]?: typeof ", + "node_modules/json-schema-to-ts/lib/types/definitions/jsonSchema7", + "$JSONSchema7 | undefined; } & { nullable: boolean; } & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "ReferenceSchema", + " ? ", + "ParseReferenceSchema", + "<", + "ReferenceSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, RecSplit<(", + "ReferenceSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"$ref\"], \"#\">> : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "AllOfSchema", + " ? RecurseOnAllOfSchema<(", + "AllOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"allOf\"], ", + "AllOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, ", + "Any", + "> : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "OneOfSchema", + " ? ", + "If", + "<", + "IsNever", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>>, ", + "Never", + ", ", + "DoesExtend", + " ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>, ", + "Never", + "> extends true ? ", + "Never", + " : { type: \"union\"; values: RecurseOnOneOfSchema<(", + "OneOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">)[\"oneOf\"], ", + "OneOfSchema", + " & Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\">, ", + "ParseOptions", + " ? ", + "DeepWritable", + " : TSchema, ", + "FromSchemaDefaultOptions", + ">, never>; }> : Omit<", + "AllOfSchema", + " & Omit<", + "NullableSchema", + " & (TSchema extends Record ? ", + "DeepWritable", + " : TSchema), \"nullable\">, \"allOf\"> extends ", + "AnyOfSchema", + " ? any : any> : any> : any, ", + "ResolveDefaultOptions", + "> : {}) & ", + "GlobalWidgetParameters", + "; signal: AbortSignal; }) => any" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.InvestigatePublicSetup.registerWidget.$2.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "{ parameters: (TSchema extends ", + "CompatibleJSONSchema", + " ? any : {}) & ", + "GlobalWidgetParameters", + "; signal: AbortSignal; }" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "investigate", + "id": "def-public.InvestigatePublicSetup.registerWidget.$3", + "type": "Function", + "tags": [], + "label": "renderCallback", + "description": [], + "signature": [ + "(options: WidgetRenderOptions<", + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidget", + "text": "InvestigateWidget" + }, + ", TData>>) => React.ReactNode" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.InvestigatePublicSetup.registerWidget.$3.$1", + "type": "CompoundType", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "{ widget: any; } & ", + { + "pluginId": "investigate", + "scope": "public", + "docId": "kibInvestigatePluginApi", + "section": "def-public.WidgetRenderAPI", + "text": "WidgetRenderAPI" + } + ], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ] + } + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "investigate", + "id": "def-public.InvestigatePublicStart", + "type": "Interface", + "tags": [], + "label": "InvestigatePublicStart", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-public.InvestigatePublicStart.getWidgetDefinitions", + "type": "Function", + "tags": [], + "label": "getWidgetDefinitions", + "description": [], + "signature": [ + "() => ", + "WidgetDefinition", + "[]" + ], + "path": "x-pack/plugins/observability_solution/investigate/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + } + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "parentPluginId": "investigate", + "id": "def-server.InvestigateServerSetup", + "type": "Interface", + "tags": [], + "label": "InvestigateServerSetup", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "investigate", + "id": "def-server.InvestigateServerStart", + "type": "Interface", + "tags": [], + "label": "InvestigateServerStart", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateTimeline", + "type": "Interface", + "tags": [], + "label": "InvestigateTimeline", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateTimeline.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateTimeline.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateTimeline.timestamp", + "type": "number", + "tags": [], + "label": "'@timestamp'", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateTimeline.user", + "type": "Object", + "tags": [], + "label": "user", + "description": [], + "signature": [ + "InvestigateUser" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateTimeline.items", + "type": "Array", + "tags": [], + "label": "items", + "description": [], + "signature": [ + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidget", + "text": "InvestigateWidget" + }, + "<{}, {}>[]" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidget", + "type": "Interface", + "tags": [], + "label": "InvestigateWidget", + "description": [], + "signature": [ + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidget", + "text": "InvestigateWidget" + }, + "" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidget.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidget.created", + "type": "number", + "tags": [], + "label": "created", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidget.last_updated", + "type": "number", + "tags": [], + "label": "last_updated", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidget.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidget.user", + "type": "Object", + "tags": [], + "label": "user", + "description": [], + "signature": [ + "InvestigateUser" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidget.parameters", + "type": "CompoundType", + "tags": [], + "label": "parameters", + "description": [], + "signature": [ + "GlobalWidgetParameters", + " & TParameters" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidget.data", + "type": "Uncategorized", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "TData" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidget.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidget.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidget.columns", + "type": "Enum", + "tags": [], + "label": "columns", + "description": [], + "signature": [ + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidgetColumnSpan", + "text": "InvestigateWidgetColumnSpan" + } + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidget.rows", + "type": "number", + "tags": [], + "label": "rows", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidget.locked", + "type": "boolean", + "tags": [], + "label": "locked", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.WorkflowBlock", + "type": "Interface", + "tags": [], + "label": "WorkflowBlock", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "investigate", + "id": "def-common.WorkflowBlock.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.WorkflowBlock.content", + "type": "string", + "tags": [], + "label": "content", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.WorkflowBlock.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.WorkflowBlock.loading", + "type": "boolean", + "tags": [], + "label": "loading", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.WorkflowBlock.onClick", + "type": "Function", + "tags": [], + "label": "onClick", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "investigate", + "id": "def-common.WorkflowBlock.color", + "type": "CompoundType", + "tags": [], + "label": "color", + "description": [], + "signature": [ + "\"link\" | \"text\" | \"title\" | \"warning\" | \"disabled\" | \"success\" | \"body\" | \"highlight\" | \"primary\" | \"accent\" | \"danger\" | \"primaryText\" | \"accentText\" | \"successText\" | \"warningText\" | \"dangerText\" | \"emptyShade\" | \"lightestShade\" | \"lightShade\" | \"mediumShade\" | \"darkShade\" | \"darkestShade\" | \"fullShade\" | \"disabledText\" | \"shadow\" | \"subduedText\" | \"ghost\" | \"ink\" | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "investigate", + "id": "def-common.WorkflowBlock.children", + "type": "CompoundType", + "tags": [], + "label": "children", + "description": [], + "signature": [ + "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidgetColumnSpan", + "type": "Enum", + "tags": [], + "label": "InvestigateWidgetColumnSpan", + "description": [], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "investigate", + "id": "def-common.InvestigateWidgetCreate", + "type": "Type", + "tags": [], + "label": "InvestigateWidgetCreate", + "description": [], + "signature": [ + "Pick<", + { + "pluginId": "investigate", + "scope": "common", + "docId": "kibInvestigatePluginApi", + "section": "def-common.InvestigateWidget", + "text": "InvestigateWidget" + }, + "<{}, {}>, \"type\" | \"title\" | \"description\" | \"rows\" | \"columns\" | \"locked\"> & { parameters: ", + "_DeepPartialObject", + "<", + "GlobalWidgetParameters", + "> & TParameters; }" + ], + "path": "x-pack/plugins/observability_solution/investigate/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/investigate.mdx b/api_docs/investigate.mdx new file mode 100644 index 0000000000000..4cd71308143d3 --- /dev/null +++ b/api_docs/investigate.mdx @@ -0,0 +1,64 @@ +--- +#### +#### 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: kibInvestigatePluginApi +slug: /kibana-dev-docs/api/investigate +title: "investigate" +image: https://source.unsplash.com/400x175/?github +description: API docs for the investigate plugin +date: 2024-06-09 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'investigate'] +--- +import investigateObj from './investigate.devdocs.json'; + + + +Contact [@elastic/obs-ai-assistant](https://github.com/orgs/elastic/teams/obs-ai-assistant) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 95 | 0 | 95 | 4 | + +## Client + +### Setup + + +### Start + + +### Functions + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + +## Server + +### Setup + + +### Start + + +## Common + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/kbn_ace.mdx b/api_docs/kbn_ace.mdx index 85e950d6e6424..26b57c2df0d42 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace'] --- import kbnAceObj from './kbn_ace.devdocs.json'; diff --git a/api_docs/kbn_actions_types.mdx b/api_docs/kbn_actions_types.mdx index cce95321c94ed..d81f21f0ed8b7 100644 --- a/api_docs/kbn_actions_types.mdx +++ b/api_docs/kbn_actions_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-actions-types title: "@kbn/actions-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/actions-types plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/actions-types'] --- import kbnActionsTypesObj from './kbn_actions_types.devdocs.json'; diff --git a/api_docs/kbn_aiops_components.mdx b/api_docs/kbn_aiops_components.mdx index 49bf0e2f749e6..c857c6e7398aa 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components'] --- import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json'; diff --git a/api_docs/kbn_aiops_log_pattern_analysis.mdx b/api_docs/kbn_aiops_log_pattern_analysis.mdx index 438ace7befe4c..26ad41fea1566 100644 --- a/api_docs/kbn_aiops_log_pattern_analysis.mdx +++ b/api_docs/kbn_aiops_log_pattern_analysis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-log-pattern-analysis title: "@kbn/aiops-log-pattern-analysis" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/aiops-log-pattern-analysis plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-log-pattern-analysis'] --- import kbnAiopsLogPatternAnalysisObj from './kbn_aiops_log_pattern_analysis.devdocs.json'; diff --git a/api_docs/kbn_aiops_log_rate_analysis.mdx b/api_docs/kbn_aiops_log_rate_analysis.mdx index 59a1c372ef75b..753ad8646c9d1 100644 --- a/api_docs/kbn_aiops_log_rate_analysis.mdx +++ b/api_docs/kbn_aiops_log_rate_analysis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-log-rate-analysis title: "@kbn/aiops-log-rate-analysis" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/aiops-log-rate-analysis plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-log-rate-analysis'] --- import kbnAiopsLogRateAnalysisObj from './kbn_aiops_log_rate_analysis.devdocs.json'; diff --git a/api_docs/kbn_alerting_api_integration_helpers.mdx b/api_docs/kbn_alerting_api_integration_helpers.mdx index 0cdfe8935f838..b37ddcb04a4dc 100644 --- a/api_docs/kbn_alerting_api_integration_helpers.mdx +++ b/api_docs/kbn_alerting_api_integration_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-api-integration-helpers title: "@kbn/alerting-api-integration-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerting-api-integration-helpers plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-api-integration-helpers'] --- import kbnAlertingApiIntegrationHelpersObj from './kbn_alerting_api_integration_helpers.devdocs.json'; diff --git a/api_docs/kbn_alerting_comparators.mdx b/api_docs/kbn_alerting_comparators.mdx index b3d39c3d6ec46..84b71a8a31659 100644 --- a/api_docs/kbn_alerting_comparators.mdx +++ b/api_docs/kbn_alerting_comparators.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-comparators title: "@kbn/alerting-comparators" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerting-comparators plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-comparators'] --- import kbnAlertingComparatorsObj from './kbn_alerting_comparators.devdocs.json'; diff --git a/api_docs/kbn_alerting_state_types.mdx b/api_docs/kbn_alerting_state_types.mdx index cbd30df625f75..24373697fc20a 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types'] --- import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json'; diff --git a/api_docs/kbn_alerting_types.mdx b/api_docs/kbn_alerting_types.mdx index ff5a6d8c22dcb..b2f96c76f12f3 100644 --- a/api_docs/kbn_alerting_types.mdx +++ b/api_docs/kbn_alerting_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-types title: "@kbn/alerting-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerting-types plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-types'] --- import kbnAlertingTypesObj from './kbn_alerting_types.devdocs.json'; diff --git a/api_docs/kbn_alerts_as_data_utils.mdx b/api_docs/kbn_alerts_as_data_utils.mdx index 500c6236e95fc..eb6b40f3108f3 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: 2024-06-06 +date: 2024-06-09 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 9c667b3522904..a0f155958ab57 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: 2024-06-06 +date: 2024-06-09 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 70e1b0b2dbc2f..0a4fb858fbcf6 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: 2024-06-06 +date: 2024-06-09 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 df44979f314f7..9b007d0873dc5 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client'] --- import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json'; diff --git a/api_docs/kbn_analytics_collection_utils.mdx b/api_docs/kbn_analytics_collection_utils.mdx index 8482f52521779..ac764dea37351 100644 --- a/api_docs/kbn_analytics_collection_utils.mdx +++ b/api_docs/kbn_analytics_collection_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-collection-utils title: "@kbn/analytics-collection-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-collection-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-collection-utils'] --- import kbnAnalyticsCollectionUtilsObj from './kbn_analytics_collection_utils.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 9ce8481c30da5..5a402386de8a3 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: 2024-06-06 +date: 2024-06-09 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 8eb5fda7b929d..e8f43f67b3128 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: 2024-06-06 +date: 2024-06-09 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 e984adf2bebf2..5104355c40bb2 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: 2024-06-06 +date: 2024-06-09 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 74c2781ab4482..77a9ed66be73e 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory'] --- import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json'; diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index dda3f94651ab5..12d449ff288ae 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: 2024-06-06 +date: 2024-06-09 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_data_view.mdx b/api_docs/kbn_apm_data_view.mdx index 58ce0150f0329..94638ab7ea62d 100644 --- a/api_docs/kbn_apm_data_view.mdx +++ b/api_docs/kbn_apm_data_view.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-data-view title: "@kbn/apm-data-view" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-data-view plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-data-view'] --- import kbnApmDataViewObj from './kbn_apm_data_view.devdocs.json'; diff --git a/api_docs/kbn_apm_synthtrace.mdx b/api_docs/kbn_apm_synthtrace.mdx index 205b8fcc594f2..e4b8fb8913e4b 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: 2024-06-06 +date: 2024-06-09 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.devdocs.json b/api_docs/kbn_apm_synthtrace_client.devdocs.json index 935496013d4fc..f8b1769ca6d2e 100644 --- a/api_docs/kbn_apm_synthtrace_client.devdocs.json +++ b/api_docs/kbn_apm_synthtrace_client.devdocs.json @@ -1845,28 +1845,12 @@ "label": "generateLongId", "description": [], "signature": [ - "(seed: string | undefined) => string" + "() => string" ], "path": "packages/kbn-apm-synthtrace-client/src/lib/utils/generate_id.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/apm-synthtrace-client", - "id": "def-common.generateLongId.$1", - "type": "string", - "tags": [], - "label": "seed", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-apm-synthtrace-client/src/lib/utils/generate_id.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], + "children": [], "returnComment": [], "initialIsOpen": false }, @@ -1878,28 +1862,12 @@ "label": "generateShortId", "description": [], "signature": [ - "(seed: string | undefined) => string" + "() => string" ], "path": "packages/kbn-apm-synthtrace-client/src/lib/utils/generate_id.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/apm-synthtrace-client", - "id": "def-common.generateShortId.$1", - "type": "string", - "tags": [], - "label": "seed", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-apm-synthtrace-client/src/lib/utils/generate_id.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], + "children": [], "returnComment": [], "initialIsOpen": false }, diff --git a/api_docs/kbn_apm_synthtrace_client.mdx b/api_docs/kbn_apm_synthtrace_client.mdx index 74c7107084985..172b37d7277c7 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace-client'] --- import kbnApmSynthtraceClientObj from './kbn_apm_synthtrace_client.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/te | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 193 | 0 | 193 | 30 | +| 191 | 0 | 191 | 30 | ## Common diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index 3a20094c648cb..6fb607201e7f6 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: 2024-06-06 +date: 2024-06-09 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 064ff2a12ae48..d500af0273cb2 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] --- import kbnAxeConfigObj from './kbn_axe_config.devdocs.json'; diff --git a/api_docs/kbn_bfetch_error.mdx b/api_docs/kbn_bfetch_error.mdx index 2970d9800d9be..8990a13323915 100644 --- a/api_docs/kbn_bfetch_error.mdx +++ b/api_docs/kbn_bfetch_error.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-bfetch-error title: "@kbn/bfetch-error" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/bfetch-error plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bfetch-error'] --- import kbnBfetchErrorObj from './kbn_bfetch_error.devdocs.json'; diff --git a/api_docs/kbn_calculate_auto.mdx b/api_docs/kbn_calculate_auto.mdx index 6654928a90454..bd04ae38def6d 100644 --- a/api_docs/kbn_calculate_auto.mdx +++ b/api_docs/kbn_calculate_auto.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-calculate-auto title: "@kbn/calculate-auto" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/calculate-auto plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/calculate-auto'] --- import kbnCalculateAutoObj from './kbn_calculate_auto.devdocs.json'; diff --git a/api_docs/kbn_calculate_width_from_char_count.mdx b/api_docs/kbn_calculate_width_from_char_count.mdx index df124fbdfe9bb..b15ca97c86403 100644 --- a/api_docs/kbn_calculate_width_from_char_count.mdx +++ b/api_docs/kbn_calculate_width_from_char_count.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-calculate-width-from-char-count title: "@kbn/calculate-width-from-char-count" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/calculate-width-from-char-count plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/calculate-width-from-char-count'] --- import kbnCalculateWidthFromCharCountObj from './kbn_calculate_width_from_char_count.devdocs.json'; diff --git a/api_docs/kbn_cases_components.mdx b/api_docs/kbn_cases_components.mdx index 7326dce204cbd..22b5fb0a2f391 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: 2024-06-06 +date: 2024-06-09 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 7697bacb81a9b..09f43c4edb80a 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: 2024-06-06 +date: 2024-06-09 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 3c27536c713e7..d0d888afb7636 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: 2024-06-06 +date: 2024-06-09 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 bc58103b4dd8c..de470981053e2 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: 2024-06-06 +date: 2024-06-09 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 e4ba2f711cc18..36fbf5d847ef0 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: 2024-06-06 +date: 2024-06-09 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 4231923343a18..50a7fb7e04e8d 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: 2024-06-06 +date: 2024-06-09 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 8850c07f6481e..6a8f9641a07ed 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: 2024-06-06 +date: 2024-06-09 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 1927e2bed10fb..71dc4b8b979fd 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: 2024-06-06 +date: 2024-06-09 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 feb6795e1a4da..1d939edd3f8b3 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-editor'] --- import kbnCodeEditorObj from './kbn_code_editor.devdocs.json'; diff --git a/api_docs/kbn_code_editor_mock.mdx b/api_docs/kbn_code_editor_mock.mdx index 028912c58cc79..cff650df128ca 100644 --- a/api_docs/kbn_code_editor_mock.mdx +++ b/api_docs/kbn_code_editor_mock.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-code-editor-mock title: "@kbn/code-editor-mock" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/code-editor-mock plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-editor-mock'] --- import kbnCodeEditorMockObj from './kbn_code_editor_mock.devdocs.json'; diff --git a/api_docs/kbn_code_owners.mdx b/api_docs/kbn_code_owners.mdx index 10218de434d8b..809ceba957ea2 100644 --- a/api_docs/kbn_code_owners.mdx +++ b/api_docs/kbn_code_owners.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-code-owners title: "@kbn/code-owners" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/code-owners plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-owners'] --- import kbnCodeOwnersObj from './kbn_code_owners.devdocs.json'; diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx index 709559355773b..07d4d3e84abe8 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: 2024-06-06 +date: 2024-06-09 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 376468689feb4..50a47366134b8 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: 2024-06-06 +date: 2024-06-09 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 6b2a88816993d..78d24546ca3be 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: 2024-06-06 +date: 2024-06-09 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 8ee3161ebfc2e..a2aa84dd67896 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: 2024-06-06 +date: 2024-06-09 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 19c23a2b6c561..7a4be7d228adc 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: 2024-06-06 +date: 2024-06-09 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_tabbed_table_list_view.mdx b/api_docs/kbn_content_management_tabbed_table_list_view.mdx index 252c492b32446..5543e21d0debf 100644 --- a/api_docs/kbn_content_management_tabbed_table_list_view.mdx +++ b/api_docs/kbn_content_management_tabbed_table_list_view.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-tabbed-table-list-view title: "@kbn/content-management-tabbed-table-list-view" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-tabbed-table-list-view plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-tabbed-table-list-view'] --- import kbnContentManagementTabbedTableListViewObj from './kbn_content_management_tabbed_table_list_view.devdocs.json'; diff --git a/api_docs/kbn_content_management_table_list_view.mdx b/api_docs/kbn_content_management_table_list_view.mdx index f078cd4dd1170..8a8adc470d455 100644 --- a/api_docs/kbn_content_management_table_list_view.mdx +++ b/api_docs/kbn_content_management_table_list_view.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-table-list-view title: "@kbn/content-management-table-list-view" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-table-list-view plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-table-list-view'] --- import kbnContentManagementTableListViewObj from './kbn_content_management_table_list_view.devdocs.json'; diff --git a/api_docs/kbn_content_management_table_list_view_common.mdx b/api_docs/kbn_content_management_table_list_view_common.mdx index b1762ebc509d2..97ffe1f1a9f58 100644 --- a/api_docs/kbn_content_management_table_list_view_common.mdx +++ b/api_docs/kbn_content_management_table_list_view_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-table-list-view-common title: "@kbn/content-management-table-list-view-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-table-list-view-common plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-table-list-view-common'] --- import kbnContentManagementTableListViewCommonObj from './kbn_content_management_table_list_view_common.devdocs.json'; diff --git a/api_docs/kbn_content_management_table_list_view_table.mdx b/api_docs/kbn_content_management_table_list_view_table.mdx index 4cad839e77967..f5f445704ee70 100644 --- a/api_docs/kbn_content_management_table_list_view_table.mdx +++ b/api_docs/kbn_content_management_table_list_view_table.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-table-list-view-table title: "@kbn/content-management-table-list-view-table" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-table-list-view-table plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-table-list-view-table'] --- import kbnContentManagementTableListViewTableObj from './kbn_content_management_table_list_view_table.devdocs.json'; diff --git a/api_docs/kbn_content_management_utils.mdx b/api_docs/kbn_content_management_utils.mdx index dde15fe10284a..c3c8e5f6a9911 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-utils'] --- import kbnContentManagementUtilsObj from './kbn_content_management_utils.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_browser.mdx b/api_docs/kbn_core_analytics_browser.mdx index d4e27553bac9d..b6429c08f3641 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: 2024-06-06 +date: 2024-06-09 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 7c6e56b192fc8..9e947560bef3b 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: 2024-06-06 +date: 2024-06-09 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 fc75be5859b02..c53017c3488df 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: 2024-06-06 +date: 2024-06-09 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 178955a658cfb..ab2eb636fddca 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: 2024-06-06 +date: 2024-06-09 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 a59b562eb3e4a..72e072ff2fa92 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: 2024-06-06 +date: 2024-06-09 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 1dd2f9e32fda2..b150236e6e9bf 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: 2024-06-06 +date: 2024-06-09 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 01f3431ac68c9..2ccbfff332d2a 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: 2024-06-06 +date: 2024-06-09 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 c78440551baff..7723a7eb99ff1 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: 2024-06-06 +date: 2024-06-09 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 51201c1965b7a..4131e5507306d 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: 2024-06-06 +date: 2024-06-09 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 bded4148954a3..c23d75d936ed2 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: 2024-06-06 +date: 2024-06-09 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 35991368aa9d2..8bdf12e7ebf9f 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: 2024-06-06 +date: 2024-06-09 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 f05501b894930..8136f719ae067 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: 2024-06-06 +date: 2024-06-09 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 6e1c945f25efd..0fe7bbb7140c8 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: 2024-06-06 +date: 2024-06-09 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 00ee2c16f0913..244f21f79060a 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: 2024-06-06 +date: 2024-06-09 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 605bf086eeafc..4ac443443b6e1 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: 2024-06-06 +date: 2024-06-09 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 0e4ffa01786fe..f1b4bf718c971 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: 2024-06-06 +date: 2024-06-09 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 9bb4110c0f9a0..cbfc5764727ad 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: 2024-06-06 +date: 2024-06-09 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 14d150341fdc4..7d79680b2f0b4 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: 2024-06-06 +date: 2024-06-09 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 4ee71981d57d3..3711f989ebdba 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: 2024-06-06 +date: 2024-06-09 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 86c8d55e89ff7..dc7fb8539f8d5 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: 2024-06-06 +date: 2024-06-09 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 51b1e4c192d1f..703422c6b18c4 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: 2024-06-06 +date: 2024-06-09 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.devdocs.json b/api_docs/kbn_core_chrome_browser.devdocs.json index e4c0daecf50a6..0cc31110a2fb6 100644 --- a/api_docs/kbn_core_chrome_browser.devdocs.json +++ b/api_docs/kbn_core_chrome_browser.devdocs.json @@ -4042,6 +4042,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/core-chrome-browser", + "id": "def-common.RenderAs", + "type": "Type", + "tags": [], + "label": "RenderAs", + "description": [], + "signature": [ + "\"block\" | \"item\" | \"accordion\" | \"panelOpener\"" + ], + "path": "packages/core/chrome/core-chrome-browser/src/project_navigation.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-chrome-browser", "id": "def-common.RootNavigationItemDefinition", diff --git a/api_docs/kbn_core_chrome_browser.mdx b/api_docs/kbn_core_chrome_browser.mdx index 1edf9458265b5..5bdacf2798d75 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-chrome-browser'] --- import kbnCoreChromeBrowserObj from './kbn_core_chrome_browser.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 | |-------------------|-----------|------------------------|-----------------| -| 206 | 0 | 99 | 0 | +| 207 | 0 | 100 | 0 | ## Common diff --git a/api_docs/kbn_core_chrome_browser_mocks.mdx b/api_docs/kbn_core_chrome_browser_mocks.mdx index 99ae5060f915f..21cbf708f2640 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: 2024-06-06 +date: 2024-06-09 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 2154a771e31cf..3142e20b5a3fa 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: 2024-06-06 +date: 2024-06-09 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 279f48304661b..f4252d31dddde 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: 2024-06-06 +date: 2024-06-09 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 f8bd5f8ed9aeb..c4f26e44bf596 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: 2024-06-06 +date: 2024-06-09 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 c69b47542ac39..12b49bc6b7ad7 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: 2024-06-06 +date: 2024-06-09 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 1eb0822fd1241..c7b039318d9ed 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: 2024-06-06 +date: 2024-06-09 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 5355271133437..166976b013d7b 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: 2024-06-06 +date: 2024-06-09 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 90817c07bd280..2849a76ea0f77 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: 2024-06-06 +date: 2024-06-09 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 3b719ec23fe5e..64644df107531 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: 2024-06-06 +date: 2024-06-09 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 70358fcbf98c0..605907edbd126 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: 2024-06-06 +date: 2024-06-09 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 63504c0cf73c1..8a1e37340a15c 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: 2024-06-06 +date: 2024-06-09 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 82ab1368ec4eb..88bdda76b395e 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: 2024-06-06 +date: 2024-06-09 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 3dea741c7c6e6..649b6181c55f5 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: 2024-06-06 +date: 2024-06-09 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 5beb921a71ddf..84a70ba42a8c2 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: 2024-06-06 +date: 2024-06-09 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 79e130e95ece9..74c67105f0a25 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: 2024-06-06 +date: 2024-06-09 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 ab4daeefb4eea..2b2f9308652ed 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: 2024-06-06 +date: 2024-06-09 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 eb8f9dab8154a..b3f06a4d4b5ec 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: 2024-06-06 +date: 2024-06-09 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 e4e2056b71388..5f4a2b8639262 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: 2024-06-06 +date: 2024-06-09 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 00830ee60b2d2..790b2befeff9c 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: 2024-06-06 +date: 2024-06-09 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 c9cb0975aacb1..bfa3d5dad9deb 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: 2024-06-06 +date: 2024-06-09 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 1a077837893e8..1164f5be15166 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: 2024-06-06 +date: 2024-06-09 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 07ee5bc870dd4..9f2592160de36 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: 2024-06-06 +date: 2024-06-09 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 0f9d38cf67764..79c07b24425bf 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: 2024-06-06 +date: 2024-06-09 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 17f8d2f7aa802..44d7653ef262d 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: 2024-06-06 +date: 2024-06-09 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 7343d4c1eaf95..bd438e59fe1bc 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: 2024-06-06 +date: 2024-06-09 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 037fe6b97844d..8acc90bad6123 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: 2024-06-06 +date: 2024-06-09 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 d6f663dcec122..f212b8d82eb15 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: 2024-06-06 +date: 2024-06-09 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 9f79cdc3bac1a..7eb9e811fa1f3 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: 2024-06-06 +date: 2024-06-09 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 0f8bbbf74e2f5..5ef791da264db 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: 2024-06-06 +date: 2024-06-09 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 10660c180bd37..53ae0516c0ee5 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: 2024-06-06 +date: 2024-06-09 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 09d0bf2872258..0d20869b509a4 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: 2024-06-06 +date: 2024-06-09 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 34293a467d3b4..6f48d22f92edd 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: 2024-06-06 +date: 2024-06-09 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 a4766db8d8663..5b11f8abd8c8e 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: 2024-06-06 +date: 2024-06-09 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 0d91cb66fbff2..41a56932e653c 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: 2024-06-06 +date: 2024-06-09 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 19e79559c277b..528f238276c3b 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: 2024-06-06 +date: 2024-06-09 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 8e5ee17c10bb4..557277bb797df 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: 2024-06-06 +date: 2024-06-09 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 1a8eb0d274c17..e8c07b6cba4b0 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: 2024-06-06 +date: 2024-06-09 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 2f4d538d3edba..b38f69d10b504 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: 2024-06-06 +date: 2024-06-09 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 2b926c62b7197..b6cb529f2d3bd 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: 2024-06-06 +date: 2024-06-09 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 35b7592118496..af51a51e22142 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: 2024-06-06 +date: 2024-06-09 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 6b1e8f7cc8709..f495c0218b1b3 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: 2024-06-06 +date: 2024-06-09 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 37fb139f01c15..8c3891d30bd65 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: 2024-06-06 +date: 2024-06-09 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 e16bd5187f033..8cac495dba565 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: 2024-06-06 +date: 2024-06-09 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 40cccc4a8db02..8c6c964e434bf 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: 2024-06-06 +date: 2024-06-09 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 0d7fcb6c7efee..8b4ffbd76091c 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: 2024-06-06 +date: 2024-06-09 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.devdocs.json b/api_docs/kbn_core_http_router_server_internal.devdocs.json index 8d9d2e4892dd9..bd6d96ce1e1d2 100644 --- a/api_docs/kbn_core_http_router_server_internal.devdocs.json +++ b/api_docs/kbn_core_http_router_server_internal.devdocs.json @@ -187,7 +187,7 @@ }, "<", "Method", - ">, \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; description?: string | undefined; }" + ">, \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; summary?: string | undefined; description?: string | undefined; }" ], "path": "packages/core/http/core-http-router-server-internal/src/versioned_router/core_versioned_router.ts", "deprecated": false, @@ -258,7 +258,7 @@ }, "<", "Method", - ">, \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; description?: string | undefined; }" + ">, \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; summary?: string | undefined; description?: string | undefined; }" ], "path": "packages/core/http/core-http-router-server-internal/src/versioned_router/core_versioned_router.ts", "deprecated": false, @@ -329,7 +329,7 @@ }, "<", "Method", - ">, \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; description?: string | undefined; }" + ">, \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; summary?: string | undefined; description?: string | undefined; }" ], "path": "packages/core/http/core-http-router-server-internal/src/versioned_router/core_versioned_router.ts", "deprecated": false, @@ -400,7 +400,7 @@ }, "<", "Method", - ">, \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; description?: string | undefined; }" + ">, \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; summary?: string | undefined; description?: string | undefined; }" ], "path": "packages/core/http/core-http-router-server-internal/src/versioned_router/core_versioned_router.ts", "deprecated": false, @@ -471,7 +471,7 @@ }, "<", "Method", - ">, \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; description?: string | undefined; }" + ">, \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; summary?: string | undefined; description?: string | undefined; }" ], "path": "packages/core/http/core-http-router-server-internal/src/versioned_router/core_versioned_router.ts", "deprecated": false, diff --git a/api_docs/kbn_core_http_router_server_internal.mdx b/api_docs/kbn_core_http_router_server_internal.mdx index 12dcd7effb801..bb76f454ae2cf 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: 2024-06-06 +date: 2024-06-09 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.devdocs.json b/api_docs/kbn_core_http_router_server_mocks.devdocs.json index 271920acee8d6..068d2f989e0d7 100644 --- a/api_docs/kbn_core_http_router_server_mocks.devdocs.json +++ b/api_docs/kbn_core_http_router_server_mocks.devdocs.json @@ -80,7 +80,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; description?: string | undefined; }" + ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; summary?: string | undefined; description?: string | undefined; }" ], "path": "packages/core/http/core-http-router-server-mocks/src/versioned_router.mock.ts", "deprecated": false, diff --git a/api_docs/kbn_core_http_router_server_mocks.mdx b/api_docs/kbn_core_http_router_server_mocks.mdx index 0045c6b631c7b..bc2929bdd7865 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: 2024-06-06 +date: 2024-06-09 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 f3eff9964da8a..7fbe9f21461e0 100644 --- a/api_docs/kbn_core_http_server.devdocs.json +++ b/api_docs/kbn_core_http_server.devdocs.json @@ -12568,6 +12568,22 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-common.RouteConfigOptions.summary", + "type": "string", + "tags": [], + "label": "summary", + "description": [ + "\nShort summary of this route. Required for all routes used in OAS documentation.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/core-http-server", "id": "def-common.RouteConfigOptions.description", @@ -12575,7 +12591,7 @@ "tags": [], "label": "description", "description": [ - "A short, human-friendly description of this endpoint" + "\nOptional API description, which supports [CommonMark](https://spec.commonmark.org) markdown formatting\n" ], "signature": [ "string | undefined" @@ -14875,7 +14891,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; description?: string | undefined; }" + ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; summary?: string | undefined; description?: string | undefined; }" ], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, @@ -15158,7 +15174,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; description?: string | undefined; }" + ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; summary?: string | undefined; description?: string | undefined; }" ], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, @@ -16169,7 +16185,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; description?: string | undefined; }" + ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; summary?: string | undefined; description?: string | undefined; }" ], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, @@ -16296,7 +16312,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; description?: string | undefined; }" + ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; summary?: string | undefined; description?: string | undefined; }" ], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, @@ -16555,7 +16571,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; description?: string | undefined; }" + ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; summary?: string | undefined; description?: string | undefined; }" ], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, @@ -19233,7 +19249,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; description?: string | undefined; }" + ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; summary?: string | undefined; description?: string | undefined; }" ], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, @@ -19301,7 +19317,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; description?: string | undefined; }" + ", \"description\" | \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; summary?: string | undefined; description?: string | undefined; }" ], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, diff --git a/api_docs/kbn_core_http_server.mdx b/api_docs/kbn_core_http_server.mdx index 50f9fe6d0824a..94f67456096ee 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: 2024-06-06 +date: 2024-06-09 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 | |-------------------|-----------|------------------------|-----------------| -| 486 | 2 | 193 | 0 | +| 487 | 2 | 193 | 0 | ## Common diff --git a/api_docs/kbn_core_http_server_internal.mdx b/api_docs/kbn_core_http_server_internal.mdx index bbac5900dd663..1a5e720fec44a 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server-internal'] --- import kbnCoreHttpServerInternalObj from './kbn_core_http_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_server_mocks.mdx b/api_docs/kbn_core_http_server_mocks.mdx index ab056dc9de223..4cadec29bea1c 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: 2024-06-06 +date: 2024-06-09 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 63676705354c4..577ea9f176dcc 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: 2024-06-06 +date: 2024-06-09 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 b9069438abe0e..84a3c0ac4cc9d 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: 2024-06-06 +date: 2024-06-09 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 2b77d83e2823b..d60576dd383ba 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: 2024-06-06 +date: 2024-06-09 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 53bac42144476..e9ff8f4d9af1a 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: 2024-06-06 +date: 2024-06-09 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 286c38c1df469..a9564f238e252 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: 2024-06-06 +date: 2024-06-09 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 4ec88a0041dc3..306d9edf96038 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: 2024-06-06 +date: 2024-06-09 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 769c1c31a97ea..3a2c4eba16689 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: 2024-06-06 +date: 2024-06-09 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 de4727659517a..50ebc27a80715 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: 2024-06-06 +date: 2024-06-09 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.mdx b/api_docs/kbn_core_lifecycle_browser.mdx index 2d284b67cae7c..86d09af803a9f 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: 2024-06-06 +date: 2024-06-09 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 0cfc7ac404cc3..31cd08857b48f 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: 2024-06-06 +date: 2024-06-09 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 a56a9a52f39cd..5de80fc8b0691 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: 2024-06-06 +date: 2024-06-09 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 f5fc717c37233..3c60b6f3aa954 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: 2024-06-06 +date: 2024-06-09 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 9889b8642595f..bea9d9ff4b66e 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: 2024-06-06 +date: 2024-06-09 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 6910793d98892..95c08356812d1 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: 2024-06-06 +date: 2024-06-09 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 360d448b01d50..43c9c0149b463 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: 2024-06-06 +date: 2024-06-09 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 a81561b4c9287..17aa32952b2b6 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: 2024-06-06 +date: 2024-06-09 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 bf066b8029e61..22459a2b4a8b3 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: 2024-06-06 +date: 2024-06-09 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 df9c61b7318dc..766d9ed1c610f 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: 2024-06-06 +date: 2024-06-09 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 69c2b784713ba..44ef82ed91d74 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: 2024-06-06 +date: 2024-06-09 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 dc439705586a2..6938ab96a3d2b 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: 2024-06-06 +date: 2024-06-09 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 ec9034e044faa..c919b6a3cced1 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: 2024-06-06 +date: 2024-06-09 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 27ad67647ffee..0b099591b74f1 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: 2024-06-06 +date: 2024-06-09 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 f6f83d1211586..af909d75f14e3 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: 2024-06-06 +date: 2024-06-09 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 e8fe1ff5b21fa..744fe135a9eaa 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: 2024-06-06 +date: 2024-06-09 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 e7b9db77a355f..52e9b1fde6370 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: 2024-06-06 +date: 2024-06-09 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 4503e277f2666..19d2b58bdda1b 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: 2024-06-06 +date: 2024-06-09 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 22b669f3a2678..6fcc4f658ed54 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: 2024-06-06 +date: 2024-06-09 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 b954bb10affea..f2e4029bd3dd5 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: 2024-06-06 +date: 2024-06-09 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 33ed0e3531c57..db806776c6422 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: 2024-06-06 +date: 2024-06-09 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 fbbcbdcb461b6..ba0fd3a5c7a82 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: 2024-06-06 +date: 2024-06-09 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 8337ac3385699..437f1c56523eb 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: 2024-06-06 +date: 2024-06-09 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 cb7a2e1a84280..a585a19e82764 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: 2024-06-06 +date: 2024-06-09 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 f6f9a9bdb2d5f..17e9b4daad27b 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: 2024-06-06 +date: 2024-06-09 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 305584026b0a5..8fd9e99c6ae0a 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: 2024-06-06 +date: 2024-06-09 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_contracts_browser.mdx b/api_docs/kbn_core_plugins_contracts_browser.mdx index dbbc16ef7eda2..b601a5345dbf1 100644 --- a/api_docs/kbn_core_plugins_contracts_browser.mdx +++ b/api_docs/kbn_core_plugins_contracts_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-contracts-browser title: "@kbn/core-plugins-contracts-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-contracts-browser plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-contracts-browser'] --- import kbnCorePluginsContractsBrowserObj from './kbn_core_plugins_contracts_browser.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_contracts_server.mdx b/api_docs/kbn_core_plugins_contracts_server.mdx index dd98e8d7aeb7f..efd6e643c57a2 100644 --- a/api_docs/kbn_core_plugins_contracts_server.mdx +++ b/api_docs/kbn_core_plugins_contracts_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-contracts-server title: "@kbn/core-plugins-contracts-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-contracts-server plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-contracts-server'] --- import kbnCorePluginsContractsServerObj from './kbn_core_plugins_contracts_server.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_server.mdx b/api_docs/kbn_core_plugins_server.mdx index a66dba7c552a2..79a8d06a67241 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: 2024-06-06 +date: 2024-06-09 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 caec03a291c13..c40183f9a4bf7 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: 2024-06-06 +date: 2024-06-09 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 6c5638bab7cb7..d05f93f0c2e8a 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: 2024-06-06 +date: 2024-06-09 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 ca06a738fe79c..02f9651a41036 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: 2024-06-06 +date: 2024-06-09 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 fdc9e94e6f694..4c9dbb9328b76 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: 2024-06-06 +date: 2024-06-09 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 76d80febd7280..5b7ff9002e53f 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: 2024-06-06 +date: 2024-06-09 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 3bd8c24fcf985..a2de8c7cc9e12 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: 2024-06-06 +date: 2024-06-09 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 085793e469ca0..cd473b98dcda7 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: 2024-06-06 +date: 2024-06-09 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.mdx b/api_docs/kbn_core_saved_objects_api_browser.mdx index 0ca6c5366c0e1..a1176c64a3ed9 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: 2024-06-06 +date: 2024-06-09 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 2dbdc9f4e068e..a29b8d2a9f17d 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: 2024-06-06 +date: 2024-06-09 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 84ede3fa1b7d5..b1368b4ced444 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: 2024-06-06 +date: 2024-06-09 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.mdx b/api_docs/kbn_core_saved_objects_base_server_internal.mdx index b2e5f541a4108..410d0d57fab05 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-base-server-internal'] --- import kbnCoreSavedObjectsBaseServerInternalObj from './kbn_core_saved_objects_base_server_internal.devdocs.json'; 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 dc3a5005c4430..0fd931b1e44de 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: 2024-06-06 +date: 2024-06-09 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 647d20de24018..ea0f20b0a5ac6 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: 2024-06-06 +date: 2024-06-09 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 f826658ed4e45..b939ba6a90442 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: 2024-06-06 +date: 2024-06-09 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 5e826de2a9353..1f8374aa6b060 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: 2024-06-06 +date: 2024-06-09 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.mdx b/api_docs/kbn_core_saved_objects_common.mdx index 005697e5808ec..4fb3831b5300b 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: 2024-06-06 +date: 2024-06-09 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 20de326e3ae0b..db87a077fab37 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: 2024-06-06 +date: 2024-06-09 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 b226dd828b662..0b37ed7b93e7a 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: 2024-06-06 +date: 2024-06-09 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.mdx b/api_docs/kbn_core_saved_objects_migration_server_internal.mdx index 8e1ce7cd36664..3fedcee0acd26 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-migration-server-internal'] --- import kbnCoreSavedObjectsMigrationServerInternalObj from './kbn_core_saved_objects_migration_server_internal.devdocs.json'; 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 ce9d721488141..72cbfddbab317 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: 2024-06-06 +date: 2024-06-09 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.mdx b/api_docs/kbn_core_saved_objects_server.mdx index a74765e8dfd2d..3017b2cd8c5aa 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server'] --- import kbnCoreSavedObjectsServerObj from './kbn_core_saved_objects_server.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_server_internal.mdx b/api_docs/kbn_core_saved_objects_server_internal.mdx index 61cac73b73599..bfa0e3937f31a 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: 2024-06-06 +date: 2024-06-09 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 c51a3d559d27e..a32c0fca5f41b 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: 2024-06-06 +date: 2024-06-09 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.mdx b/api_docs/kbn_core_saved_objects_utils_server.mdx index 13b937485b797..d401fdf3cd40f 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-utils-server'] --- import kbnCoreSavedObjectsUtilsServerObj from './kbn_core_saved_objects_utils_server.devdocs.json'; diff --git a/api_docs/kbn_core_security_browser.mdx b/api_docs/kbn_core_security_browser.mdx index 60f5af1d984bc..6517dd714733a 100644 --- a/api_docs/kbn_core_security_browser.mdx +++ b/api_docs/kbn_core_security_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-browser title: "@kbn/core-security-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-security-browser plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-browser'] --- import kbnCoreSecurityBrowserObj from './kbn_core_security_browser.devdocs.json'; diff --git a/api_docs/kbn_core_security_browser_internal.mdx b/api_docs/kbn_core_security_browser_internal.mdx index 57eb45503d600..ef64aa6d2c6f4 100644 --- a/api_docs/kbn_core_security_browser_internal.mdx +++ b/api_docs/kbn_core_security_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-browser-internal title: "@kbn/core-security-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-security-browser-internal plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-browser-internal'] --- import kbnCoreSecurityBrowserInternalObj from './kbn_core_security_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_security_browser_mocks.mdx b/api_docs/kbn_core_security_browser_mocks.mdx index 94cf22a9d552d..36590a7840c71 100644 --- a/api_docs/kbn_core_security_browser_mocks.mdx +++ b/api_docs/kbn_core_security_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-browser-mocks title: "@kbn/core-security-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-security-browser-mocks plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-browser-mocks'] --- import kbnCoreSecurityBrowserMocksObj from './kbn_core_security_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_security_common.mdx b/api_docs/kbn_core_security_common.mdx index 57ac41274be53..fa65d64b21227 100644 --- a/api_docs/kbn_core_security_common.mdx +++ b/api_docs/kbn_core_security_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-common title: "@kbn/core-security-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-security-common plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-common'] --- import kbnCoreSecurityCommonObj from './kbn_core_security_common.devdocs.json'; diff --git a/api_docs/kbn_core_security_server.mdx b/api_docs/kbn_core_security_server.mdx index 18325bf1651ac..ae5e5e8487f9f 100644 --- a/api_docs/kbn_core_security_server.mdx +++ b/api_docs/kbn_core_security_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-server title: "@kbn/core-security-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-security-server plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-server'] --- import kbnCoreSecurityServerObj from './kbn_core_security_server.devdocs.json'; diff --git a/api_docs/kbn_core_security_server_internal.mdx b/api_docs/kbn_core_security_server_internal.mdx index 87bb44d41d03c..0774786b940c1 100644 --- a/api_docs/kbn_core_security_server_internal.mdx +++ b/api_docs/kbn_core_security_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-server-internal title: "@kbn/core-security-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-security-server-internal plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-server-internal'] --- import kbnCoreSecurityServerInternalObj from './kbn_core_security_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_security_server_mocks.mdx b/api_docs/kbn_core_security_server_mocks.mdx index b2ddb893b89a6..6585f2b50f737 100644 --- a/api_docs/kbn_core_security_server_mocks.mdx +++ b/api_docs/kbn_core_security_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-security-server-mocks title: "@kbn/core-security-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-security-server-mocks plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-security-server-mocks'] --- import kbnCoreSecurityServerMocksObj from './kbn_core_security_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_status_common.mdx b/api_docs/kbn_core_status_common.mdx index 3c839bb8e0902..11c0513b04b75 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: 2024-06-06 +date: 2024-06-09 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 15bc5bd8309f4..f47c5df9c3f3a 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: 2024-06-06 +date: 2024-06-09 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 f4a7643c4acfd..2966ac6daf510 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: 2024-06-06 +date: 2024-06-09 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 901fe64810128..25568e6e1d229 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: 2024-06-06 +date: 2024-06-09 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 998d17664276f..b3064d9466969 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: 2024-06-06 +date: 2024-06-09 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 2682ca4c5a9c4..1eb9287dc028f 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: 2024-06-06 +date: 2024-06-09 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 ae341e9c3e050..d8a3659e4c2d8 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: 2024-06-06 +date: 2024-06-09 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 60aa630e9d912..30b0982971b8c 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: 2024-06-06 +date: 2024-06-09 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_model_versions.mdx b/api_docs/kbn_core_test_helpers_model_versions.mdx index aafca4a09f770..2787e01e453d3 100644 --- a/api_docs/kbn_core_test_helpers_model_versions.mdx +++ b/api_docs/kbn_core_test_helpers_model_versions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-model-versions title: "@kbn/core-test-helpers-model-versions" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-model-versions plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-model-versions'] --- import kbnCoreTestHelpersModelVersionsObj from './kbn_core_test_helpers_model_versions.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 dee1fc002cffc..701ee4608145e 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: 2024-06-06 +date: 2024-06-09 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 dbebc77fa5fe7..384dbdbf609aa 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: 2024-06-06 +date: 2024-06-09 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 dd7c5a5719c84..b6bebc46f42b4 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: 2024-06-06 +date: 2024-06-09 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_mocks.mdx b/api_docs/kbn_core_theme_browser_mocks.mdx index f130231ef8e10..3eec1c9b397ef 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: 2024-06-06 +date: 2024-06-09 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 c4d4694122e2a..f5bf52f777cc8 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: 2024-06-06 +date: 2024-06-09 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 fffdeff228570..b3b5a37206bf3 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: 2024-06-06 +date: 2024-06-09 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 65ef01a286ec0..9bfe708ba0001 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: 2024-06-06 +date: 2024-06-09 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 1f28ee212a18e..470cc77a883f0 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: 2024-06-06 +date: 2024-06-09 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 e9fccc01ab61d..5079f5646edd4 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: 2024-06-06 +date: 2024-06-09 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 8b20cd8e50aa9..dacc960e7f97b 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: 2024-06-06 +date: 2024-06-09 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 a101c255f3244..643875902056c 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: 2024-06-06 +date: 2024-06-09 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 47b27c6e58503..fbb67a227e74c 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: 2024-06-06 +date: 2024-06-09 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 2a0bf0e7794b6..e95922c8d2a63 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: 2024-06-06 +date: 2024-06-09 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 529466e00862b..e8b74cc77d58c 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: 2024-06-06 +date: 2024-06-09 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_profile_browser.mdx b/api_docs/kbn_core_user_profile_browser.mdx index 171c7cf1a29ea..b39c3c9c8b283 100644 --- a/api_docs/kbn_core_user_profile_browser.mdx +++ b/api_docs/kbn_core_user_profile_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-browser title: "@kbn/core-user-profile-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-profile-browser plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-browser'] --- import kbnCoreUserProfileBrowserObj from './kbn_core_user_profile_browser.devdocs.json'; diff --git a/api_docs/kbn_core_user_profile_browser_internal.mdx b/api_docs/kbn_core_user_profile_browser_internal.mdx index 450484366f626..82d158a51dc7d 100644 --- a/api_docs/kbn_core_user_profile_browser_internal.mdx +++ b/api_docs/kbn_core_user_profile_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-browser-internal title: "@kbn/core-user-profile-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-profile-browser-internal plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-browser-internal'] --- import kbnCoreUserProfileBrowserInternalObj from './kbn_core_user_profile_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_user_profile_browser_mocks.mdx b/api_docs/kbn_core_user_profile_browser_mocks.mdx index 2d2cab336aa7b..3acdb571d52ba 100644 --- a/api_docs/kbn_core_user_profile_browser_mocks.mdx +++ b/api_docs/kbn_core_user_profile_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-browser-mocks title: "@kbn/core-user-profile-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-profile-browser-mocks plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-browser-mocks'] --- import kbnCoreUserProfileBrowserMocksObj from './kbn_core_user_profile_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_user_profile_common.mdx b/api_docs/kbn_core_user_profile_common.mdx index 2989952f0b26c..e36972f369e2d 100644 --- a/api_docs/kbn_core_user_profile_common.mdx +++ b/api_docs/kbn_core_user_profile_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-common title: "@kbn/core-user-profile-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-profile-common plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-common'] --- import kbnCoreUserProfileCommonObj from './kbn_core_user_profile_common.devdocs.json'; diff --git a/api_docs/kbn_core_user_profile_server.mdx b/api_docs/kbn_core_user_profile_server.mdx index fa29cb692b158..b84f0c0ea04f8 100644 --- a/api_docs/kbn_core_user_profile_server.mdx +++ b/api_docs/kbn_core_user_profile_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-server title: "@kbn/core-user-profile-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-profile-server plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-server'] --- import kbnCoreUserProfileServerObj from './kbn_core_user_profile_server.devdocs.json'; diff --git a/api_docs/kbn_core_user_profile_server_internal.mdx b/api_docs/kbn_core_user_profile_server_internal.mdx index fb2ec358dc59b..8fb70499c6bb2 100644 --- a/api_docs/kbn_core_user_profile_server_internal.mdx +++ b/api_docs/kbn_core_user_profile_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-server-internal title: "@kbn/core-user-profile-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-profile-server-internal plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-server-internal'] --- import kbnCoreUserProfileServerInternalObj from './kbn_core_user_profile_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_user_profile_server_mocks.mdx b/api_docs/kbn_core_user_profile_server_mocks.mdx index 4264b73dd9619..8c7f7adaca70c 100644 --- a/api_docs/kbn_core_user_profile_server_mocks.mdx +++ b/api_docs/kbn_core_user_profile_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-profile-server-mocks title: "@kbn/core-user-profile-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-profile-server-mocks plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-profile-server-mocks'] --- import kbnCoreUserProfileServerMocksObj from './kbn_core_user_profile_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 17f3b2818faea..6c074c00ff383 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: 2024-06-06 +date: 2024-06-09 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_mocks.mdx b/api_docs/kbn_core_user_settings_server_mocks.mdx index a3b120109e3c7..88695c6285245 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: 2024-06-06 +date: 2024-06-09 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 a8f074a147163..5f54e5892115b 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: 2024-06-06 +date: 2024-06-09 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 3059edfae6e92..29d53491a4f83 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto-browser'] --- import kbnCryptoBrowserObj from './kbn_crypto_browser.devdocs.json'; diff --git a/api_docs/kbn_custom_icons.mdx b/api_docs/kbn_custom_icons.mdx index b55196acb98a7..0624a998722ba 100644 --- a/api_docs/kbn_custom_icons.mdx +++ b/api_docs/kbn_custom_icons.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-custom-icons title: "@kbn/custom-icons" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/custom-icons plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/custom-icons'] --- import kbnCustomIconsObj from './kbn_custom_icons.devdocs.json'; diff --git a/api_docs/kbn_custom_integrations.mdx b/api_docs/kbn_custom_integrations.mdx index 815fb6d9d13cf..aa0b84726889b 100644 --- a/api_docs/kbn_custom_integrations.mdx +++ b/api_docs/kbn_custom_integrations.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-custom-integrations title: "@kbn/custom-integrations" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/custom-integrations plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/custom-integrations'] --- import kbnCustomIntegrationsObj from './kbn_custom_integrations.devdocs.json'; diff --git a/api_docs/kbn_cypress_config.mdx b/api_docs/kbn_cypress_config.mdx index bbd309d1c720c..f6bdee64fac63 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cypress-config'] --- import kbnCypressConfigObj from './kbn_cypress_config.devdocs.json'; diff --git a/api_docs/kbn_data_forge.mdx b/api_docs/kbn_data_forge.mdx index bc794f0cf19ce..f00effd1be147 100644 --- a/api_docs/kbn_data_forge.mdx +++ b/api_docs/kbn_data_forge.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-data-forge title: "@kbn/data-forge" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/data-forge plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/data-forge'] --- import kbnDataForgeObj from './kbn_data_forge.devdocs.json'; diff --git a/api_docs/kbn_data_service.mdx b/api_docs/kbn_data_service.mdx index f85865e50f2c7..06af892ec80ee 100644 --- a/api_docs/kbn_data_service.mdx +++ b/api_docs/kbn_data_service.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-data-service title: "@kbn/data-service" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/data-service plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/data-service'] --- import kbnDataServiceObj from './kbn_data_service.devdocs.json'; diff --git a/api_docs/kbn_data_stream_adapter.mdx b/api_docs/kbn_data_stream_adapter.mdx index 3819e315a2960..77bafc9249c92 100644 --- a/api_docs/kbn_data_stream_adapter.mdx +++ b/api_docs/kbn_data_stream_adapter.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-data-stream-adapter title: "@kbn/data-stream-adapter" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/data-stream-adapter plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/data-stream-adapter'] --- import kbnDataStreamAdapterObj from './kbn_data_stream_adapter.devdocs.json'; diff --git a/api_docs/kbn_data_view_utils.mdx b/api_docs/kbn_data_view_utils.mdx index 0e42ac9f36ab2..c1d9fa9983c81 100644 --- a/api_docs/kbn_data_view_utils.mdx +++ b/api_docs/kbn_data_view_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-data-view-utils title: "@kbn/data-view-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/data-view-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/data-view-utils'] --- import kbnDataViewUtilsObj from './kbn_data_view_utils.devdocs.json'; diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index ce4f2e42843d9..513ae0ce1d8f8 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] --- import kbnDatemathObj from './kbn_datemath.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_analytics.mdx b/api_docs/kbn_deeplinks_analytics.mdx index 095d545eac671..b14d7088f8701 100644 --- a/api_docs/kbn_deeplinks_analytics.mdx +++ b/api_docs/kbn_deeplinks_analytics.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-analytics title: "@kbn/deeplinks-analytics" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-analytics plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-analytics'] --- import kbnDeeplinksAnalyticsObj from './kbn_deeplinks_analytics.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_devtools.mdx b/api_docs/kbn_deeplinks_devtools.mdx index 20920d355c178..3685255e9868a 100644 --- a/api_docs/kbn_deeplinks_devtools.mdx +++ b/api_docs/kbn_deeplinks_devtools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-devtools title: "@kbn/deeplinks-devtools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-devtools plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-devtools'] --- import kbnDeeplinksDevtoolsObj from './kbn_deeplinks_devtools.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_fleet.mdx b/api_docs/kbn_deeplinks_fleet.mdx index 76ffebe96c030..db5243f2e3f99 100644 --- a/api_docs/kbn_deeplinks_fleet.mdx +++ b/api_docs/kbn_deeplinks_fleet.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-fleet title: "@kbn/deeplinks-fleet" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-fleet plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-fleet'] --- import kbnDeeplinksFleetObj from './kbn_deeplinks_fleet.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_management.mdx b/api_docs/kbn_deeplinks_management.mdx index 6aec967f6af10..273f766590437 100644 --- a/api_docs/kbn_deeplinks_management.mdx +++ b/api_docs/kbn_deeplinks_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-management title: "@kbn/deeplinks-management" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-management plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-management'] --- import kbnDeeplinksManagementObj from './kbn_deeplinks_management.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_ml.mdx b/api_docs/kbn_deeplinks_ml.mdx index 16cef106f87b3..df66618ac220b 100644 --- a/api_docs/kbn_deeplinks_ml.mdx +++ b/api_docs/kbn_deeplinks_ml.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-ml title: "@kbn/deeplinks-ml" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-ml plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-ml'] --- import kbnDeeplinksMlObj from './kbn_deeplinks_ml.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_observability.mdx b/api_docs/kbn_deeplinks_observability.mdx index 366ac8d1b5e9a..b7c3b09b2d678 100644 --- a/api_docs/kbn_deeplinks_observability.mdx +++ b/api_docs/kbn_deeplinks_observability.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-observability title: "@kbn/deeplinks-observability" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-observability plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-observability'] --- import kbnDeeplinksObservabilityObj from './kbn_deeplinks_observability.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_search.mdx b/api_docs/kbn_deeplinks_search.mdx index 89acf665dca51..d2308418ebeb6 100644 --- a/api_docs/kbn_deeplinks_search.mdx +++ b/api_docs/kbn_deeplinks_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-search title: "@kbn/deeplinks-search" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-search plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-search'] --- import kbnDeeplinksSearchObj from './kbn_deeplinks_search.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_security.mdx b/api_docs/kbn_deeplinks_security.mdx index df164eee52761..3a5a5a450b982 100644 --- a/api_docs/kbn_deeplinks_security.mdx +++ b/api_docs/kbn_deeplinks_security.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-security title: "@kbn/deeplinks-security" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-security plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-security'] --- import kbnDeeplinksSecurityObj from './kbn_deeplinks_security.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_shared.mdx b/api_docs/kbn_deeplinks_shared.mdx index 4bbefb30db1f9..7e41ac4468dc5 100644 --- a/api_docs/kbn_deeplinks_shared.mdx +++ b/api_docs/kbn_deeplinks_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-shared title: "@kbn/deeplinks-shared" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-shared plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-shared'] --- import kbnDeeplinksSharedObj from './kbn_deeplinks_shared.devdocs.json'; diff --git a/api_docs/kbn_default_nav_analytics.mdx b/api_docs/kbn_default_nav_analytics.mdx index 6950d5dd296c6..0d3523a67dbf5 100644 --- a/api_docs/kbn_default_nav_analytics.mdx +++ b/api_docs/kbn_default_nav_analytics.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-default-nav-analytics title: "@kbn/default-nav-analytics" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/default-nav-analytics plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/default-nav-analytics'] --- import kbnDefaultNavAnalyticsObj from './kbn_default_nav_analytics.devdocs.json'; diff --git a/api_docs/kbn_default_nav_devtools.mdx b/api_docs/kbn_default_nav_devtools.mdx index c64cea23f0a77..083a237749b84 100644 --- a/api_docs/kbn_default_nav_devtools.mdx +++ b/api_docs/kbn_default_nav_devtools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-default-nav-devtools title: "@kbn/default-nav-devtools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/default-nav-devtools plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/default-nav-devtools'] --- import kbnDefaultNavDevtoolsObj from './kbn_default_nav_devtools.devdocs.json'; diff --git a/api_docs/kbn_default_nav_management.mdx b/api_docs/kbn_default_nav_management.mdx index 7ae11628e535e..3e3ef26c3115e 100644 --- a/api_docs/kbn_default_nav_management.mdx +++ b/api_docs/kbn_default_nav_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-default-nav-management title: "@kbn/default-nav-management" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/default-nav-management plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/default-nav-management'] --- import kbnDefaultNavManagementObj from './kbn_default_nav_management.devdocs.json'; diff --git a/api_docs/kbn_default_nav_ml.mdx b/api_docs/kbn_default_nav_ml.mdx index 09a9e230a65d7..edce360158a6e 100644 --- a/api_docs/kbn_default_nav_ml.mdx +++ b/api_docs/kbn_default_nav_ml.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-default-nav-ml title: "@kbn/default-nav-ml" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/default-nav-ml plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/default-nav-ml'] --- import kbnDefaultNavMlObj from './kbn_default_nav_ml.devdocs.json'; diff --git a/api_docs/kbn_dev_cli_errors.mdx b/api_docs/kbn_dev_cli_errors.mdx index be995597425cd..8072d3d020505 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: 2024-06-06 +date: 2024-06-09 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 0a7ed8faec87a..ef02db734bc92 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: 2024-06-06 +date: 2024-06-09 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 4737c9a9d1250..6a3133e6bd5a9 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: 2024-06-06 +date: 2024-06-09 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 dc72d61fecf8f..2320e68350dc3 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] --- import kbnDevUtilsObj from './kbn_dev_utils.devdocs.json'; diff --git a/api_docs/kbn_discover_utils.mdx b/api_docs/kbn_discover_utils.mdx index 794af4d7a92cf..47875158ee62f 100644 --- a/api_docs/kbn_discover_utils.mdx +++ b/api_docs/kbn_discover_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-discover-utils title: "@kbn/discover-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/discover-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/discover-utils'] --- import kbnDiscoverUtilsObj from './kbn_discover_utils.devdocs.json'; diff --git a/api_docs/kbn_doc_links.devdocs.json b/api_docs/kbn_doc_links.devdocs.json index 56152abc3712d..84badfab59a72 100644 --- a/api_docs/kbn_doc_links.devdocs.json +++ b/api_docs/kbn_doc_links.devdocs.json @@ -840,7 +840,7 @@ "label": "fleet", "description": [], "signature": [ - "{ readonly beatsAgentComparison: string; readonly guide: string; readonly fleetServer: string; readonly fleetServerAddFleetServer: string; readonly esSettings: string; readonly settings: string; readonly logstashSettings: string; readonly kafkaSettings: string; readonly settingsFleetServerHostSettings: string; readonly settingsFleetServerProxySettings: string; readonly troubleshooting: string; readonly elasticAgent: string; readonly datastreams: string; readonly datastreamsILM: string; readonly datastreamsNamingScheme: string; readonly datastreamsManualRollover: string; readonly datastreamsTSDS: string; readonly datastreamsTSDSMetrics: string; readonly installElasticAgent: string; readonly installElasticAgentStandalone: string; readonly packageSignatures: string; readonly upgradeElasticAgent: string; readonly learnMoreBlog: string; readonly apiKeysLearnMore: string; readonly onPremRegistry: string; readonly secureLogstash: string; readonly agentPolicy: string; readonly api: string; readonly uninstallAgent: string; readonly installAndUninstallIntegrationAssets: string; readonly elasticAgentInputConfiguration: string; readonly policySecrets: string; readonly remoteESOoutput: string; readonly performancePresets: string; readonly scalingKubernetesResourcesAndLimits: string; readonly roleAndPrivileges: string; }" + "{ readonly beatsAgentComparison: string; readonly guide: string; readonly fleetServer: string; readonly fleetServerAddFleetServer: string; readonly esSettings: string; readonly settings: string; readonly logstashSettings: string; readonly kafkaSettings: string; readonly settingsFleetServerHostSettings: string; readonly settingsFleetServerProxySettings: string; readonly troubleshooting: string; readonly elasticAgent: string; readonly datastreams: string; readonly datastreamsILM: string; readonly datastreamsNamingScheme: string; readonly datastreamsManualRollover: string; readonly datastreamsTSDS: string; readonly datastreamsTSDSMetrics: string; readonly installElasticAgent: string; readonly installElasticAgentStandalone: string; readonly packageSignatures: string; readonly upgradeElasticAgent: string; readonly learnMoreBlog: string; readonly apiKeysLearnMore: string; readonly onPremRegistry: string; readonly secureLogstash: string; readonly agentPolicy: string; readonly api: string; readonly uninstallAgent: string; readonly installAndUninstallIntegrationAssets: string; readonly elasticAgentInputConfiguration: string; readonly policySecrets: string; readonly remoteESOoutput: string; readonly performancePresets: string; readonly scalingKubernetesResourcesAndLimits: string; readonly roleAndPrivileges: string; readonly proxiesSettings: 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 590233a86c512..e7764624c2307 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: 2024-06-06 +date: 2024-06-09 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 8e8ce8925bca9..7d20dd01d7744 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: 2024-06-06 +date: 2024-06-09 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 170b27d29236b..c635fe607cc53 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: 2024-06-06 +date: 2024-06-09 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 23f286773aa22..834db1f446a42 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ebt-tools'] --- import kbnEbtToolsObj from './kbn_ebt_tools.devdocs.json'; diff --git a/api_docs/kbn_ecs_data_quality_dashboard.mdx b/api_docs/kbn_ecs_data_quality_dashboard.mdx index e64b22fbe24d8..6d2c8056e08d6 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: 2024-06-06 +date: 2024-06-09 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_elastic_agent_utils.mdx b/api_docs/kbn_elastic_agent_utils.mdx index 76de8d3d838b8..e9a84129e0d47 100644 --- a/api_docs/kbn_elastic_agent_utils.mdx +++ b/api_docs/kbn_elastic_agent_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-elastic-agent-utils title: "@kbn/elastic-agent-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/elastic-agent-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/elastic-agent-utils'] --- import kbnElasticAgentUtilsObj from './kbn_elastic_agent_utils.devdocs.json'; diff --git a/api_docs/kbn_elastic_assistant.mdx b/api_docs/kbn_elastic_assistant.mdx index 12ede6e557145..b5da5cf95b37a 100644 --- a/api_docs/kbn_elastic_assistant.mdx +++ b/api_docs/kbn_elastic_assistant.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-elastic-assistant title: "@kbn/elastic-assistant" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/elastic-assistant plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/elastic-assistant'] --- import kbnElasticAssistantObj from './kbn_elastic_assistant.devdocs.json'; diff --git a/api_docs/kbn_elastic_assistant_common.mdx b/api_docs/kbn_elastic_assistant_common.mdx index 2d5aa7b027db2..59cb76d8b3fde 100644 --- a/api_docs/kbn_elastic_assistant_common.mdx +++ b/api_docs/kbn_elastic_assistant_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-elastic-assistant-common title: "@kbn/elastic-assistant-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/elastic-assistant-common plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/elastic-assistant-common'] --- import kbnElasticAssistantCommonObj from './kbn_elastic_assistant_common.devdocs.json'; diff --git a/api_docs/kbn_entities_schema.mdx b/api_docs/kbn_entities_schema.mdx index 2be750b43856e..65849ce02d96a 100644 --- a/api_docs/kbn_entities_schema.mdx +++ b/api_docs/kbn_entities_schema.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-entities-schema title: "@kbn/entities-schema" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/entities-schema plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/entities-schema'] --- import kbnEntitiesSchemaObj from './kbn_entities_schema.devdocs.json'; diff --git a/api_docs/kbn_es.mdx b/api_docs/kbn_es.mdx index 67ac80fb34ad1..6cf2d42d7f9dd 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: 2024-06-06 +date: 2024-06-09 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 8c3e21ee0e584..d3f932b88e683 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: 2024-06-06 +date: 2024-06-09 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 48e5a3e4595d9..48db028ed0f7c 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: 2024-06-06 +date: 2024-06-09 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 016e9d5f32f6c..49d09d97a36f8 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: 2024-06-06 +date: 2024-06-09 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 2a6a44bfb42af..d5e0c449a7613 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: 2024-06-06 +date: 2024-06-09 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 620e7e7172cf6..a672881632dfc 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] --- import kbnEslintPluginImportsObj from './kbn_eslint_plugin_imports.devdocs.json'; diff --git a/api_docs/kbn_esql_ast.mdx b/api_docs/kbn_esql_ast.mdx index 7861436737a69..55cf7501bc816 100644 --- a/api_docs/kbn_esql_ast.mdx +++ b/api_docs/kbn_esql_ast.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-esql-ast title: "@kbn/esql-ast" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/esql-ast plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/esql-ast'] --- import kbnEsqlAstObj from './kbn_esql_ast.devdocs.json'; diff --git a/api_docs/kbn_esql_utils.mdx b/api_docs/kbn_esql_utils.mdx index a42b5fc12763a..3657a91e67b8d 100644 --- a/api_docs/kbn_esql_utils.mdx +++ b/api_docs/kbn_esql_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-esql-utils title: "@kbn/esql-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/esql-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/esql-utils'] --- import kbnEsqlUtilsObj from './kbn_esql_utils.devdocs.json'; diff --git a/api_docs/kbn_esql_validation_autocomplete.mdx b/api_docs/kbn_esql_validation_autocomplete.mdx index d441755a4f5aa..cf01d0d2e1fad 100644 --- a/api_docs/kbn_esql_validation_autocomplete.mdx +++ b/api_docs/kbn_esql_validation_autocomplete.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-esql-validation-autocomplete title: "@kbn/esql-validation-autocomplete" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/esql-validation-autocomplete plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/esql-validation-autocomplete'] --- import kbnEsqlValidationAutocompleteObj from './kbn_esql_validation_autocomplete.devdocs.json'; diff --git a/api_docs/kbn_event_annotation_common.mdx b/api_docs/kbn_event_annotation_common.mdx index 3a5414e7bb7cd..14e56cd6646eb 100644 --- a/api_docs/kbn_event_annotation_common.mdx +++ b/api_docs/kbn_event_annotation_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-event-annotation-common title: "@kbn/event-annotation-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/event-annotation-common plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/event-annotation-common'] --- import kbnEventAnnotationCommonObj from './kbn_event_annotation_common.devdocs.json'; diff --git a/api_docs/kbn_event_annotation_components.mdx b/api_docs/kbn_event_annotation_components.mdx index 9a8ee90e9dbb5..807ab55048e17 100644 --- a/api_docs/kbn_event_annotation_components.mdx +++ b/api_docs/kbn_event_annotation_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-event-annotation-components title: "@kbn/event-annotation-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/event-annotation-components plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/event-annotation-components'] --- import kbnEventAnnotationComponentsObj from './kbn_event_annotation_components.devdocs.json'; diff --git a/api_docs/kbn_expandable_flyout.devdocs.json b/api_docs/kbn_expandable_flyout.devdocs.json index 8fbc1787e2d68..88d40c2acec00 100644 --- a/api_docs/kbn_expandable_flyout.devdocs.json +++ b/api_docs/kbn_expandable_flyout.devdocs.json @@ -574,6 +574,22 @@ "path": "packages/kbn-expandable-flyout/src/index.tsx", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "@kbn/expandable-flyout", + "id": "def-public.ExpandableFlyoutProps.onClose", + "type": "Function", + "tags": [], + "label": "onClose", + "description": [ + "\nCallback function to let application's code the flyout is closed" + ], + "signature": [ + "((event: MouseEvent | KeyboardEvent | TouchEvent) => void) | undefined" + ], + "path": "packages/kbn-expandable-flyout/src/index.tsx", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false diff --git a/api_docs/kbn_expandable_flyout.mdx b/api_docs/kbn_expandable_flyout.mdx index b72f246865334..1bbea58c49861 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/expandable-flyout'] --- import kbnExpandableFlyoutObj from './kbn_expandable_flyout.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/security-threat-hunting-investigations](https://github.com/org | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 38 | 0 | 14 | 1 | +| 39 | 0 | 14 | 1 | ## Client diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index 4fc8ca88e523b..cecc71ce5ab01 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types'] --- import kbnFieldTypesObj from './kbn_field_types.devdocs.json'; diff --git a/api_docs/kbn_field_utils.mdx b/api_docs/kbn_field_utils.mdx index 481e252119175..890b780e67784 100644 --- a/api_docs/kbn_field_utils.mdx +++ b/api_docs/kbn_field_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-field-utils title: "@kbn/field-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/field-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-utils'] --- import kbnFieldUtilsObj from './kbn_field_utils.devdocs.json'; diff --git a/api_docs/kbn_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx index 9a5294e0ae564..547653aab56a0 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: 2024-06-06 +date: 2024-06-09 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_formatters.mdx b/api_docs/kbn_formatters.mdx index 00ce8c0a26e34..1cb73aae05b5d 100644 --- a/api_docs/kbn_formatters.mdx +++ b/api_docs/kbn_formatters.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-formatters title: "@kbn/formatters" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/formatters plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/formatters'] --- import kbnFormattersObj from './kbn_formatters.devdocs.json'; diff --git a/api_docs/kbn_ftr_common_functional_services.mdx b/api_docs/kbn_ftr_common_functional_services.mdx index 7e2ebf6f66cc6..a2f19f37e480c 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: 2024-06-06 +date: 2024-06-09 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_ftr_common_functional_ui_services.mdx b/api_docs/kbn_ftr_common_functional_ui_services.mdx index ad45d713382cf..ec6d2ecd04e1d 100644 --- a/api_docs/kbn_ftr_common_functional_ui_services.mdx +++ b/api_docs/kbn_ftr_common_functional_ui_services.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ftr-common-functional-ui-services title: "@kbn/ftr-common-functional-ui-services" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ftr-common-functional-ui-services plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ftr-common-functional-ui-services'] --- import kbnFtrCommonFunctionalUiServicesObj from './kbn_ftr_common_functional_ui_services.devdocs.json'; diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx index 825c817d3ff19..cdd51cdcd2deb 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] --- import kbnGenerateObj from './kbn_generate.devdocs.json'; diff --git a/api_docs/kbn_generate_console_definitions.mdx b/api_docs/kbn_generate_console_definitions.mdx index 2234488f9130b..f22214e3a63d5 100644 --- a/api_docs/kbn_generate_console_definitions.mdx +++ b/api_docs/kbn_generate_console_definitions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate-console-definitions title: "@kbn/generate-console-definitions" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/generate-console-definitions plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate-console-definitions'] --- import kbnGenerateConsoleDefinitionsObj from './kbn_generate_console_definitions.devdocs.json'; diff --git a/api_docs/kbn_generate_csv.mdx b/api_docs/kbn_generate_csv.mdx index 6e217bd9a3a75..8ae017b0fa397 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate-csv'] --- import kbnGenerateCsvObj from './kbn_generate_csv.devdocs.json'; diff --git a/api_docs/kbn_grouping.mdx b/api_docs/kbn_grouping.mdx index 5bc41f33b9696..f68982ecef66b 100644 --- a/api_docs/kbn_grouping.mdx +++ b/api_docs/kbn_grouping.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-grouping title: "@kbn/grouping" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/grouping plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/grouping'] --- import kbnGroupingObj from './kbn_grouping.devdocs.json'; diff --git a/api_docs/kbn_guided_onboarding.mdx b/api_docs/kbn_guided_onboarding.mdx index 20e31413166a3..51287160808ed 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: 2024-06-06 +date: 2024-06-09 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 95c8ee7d0ff69..154da1ed5bb01 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: 2024-06-06 +date: 2024-06-09 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 9806fc9d53d71..5ac2802ca8295 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: 2024-06-06 +date: 2024-06-09 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 7990b9dd93490..79b01a04ca297 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: 2024-06-06 +date: 2024-06-09 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 7683d54967a24..2e2591ff73759 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: 2024-06-06 +date: 2024-06-09 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 a3a884da6175e..7e8b47c3c8eda 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: 2024-06-06 +date: 2024-06-09 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 6fdcc827304de..cd1f569088be3 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: 2024-06-06 +date: 2024-06-09 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 4505e348a8359..8335309a6afec 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: 2024-06-06 +date: 2024-06-09 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 d3886d4088931..3d3cca7b58e93 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] --- import kbnImportResolverObj from './kbn_import_resolver.devdocs.json'; diff --git a/api_docs/kbn_index_management.mdx b/api_docs/kbn_index_management.mdx index f41501dc5a272..daac4dacd1585 100644 --- a/api_docs/kbn_index_management.mdx +++ b/api_docs/kbn_index_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-index-management title: "@kbn/index-management" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/index-management plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/index-management'] --- import kbnIndexManagementObj from './kbn_index_management.devdocs.json'; diff --git a/api_docs/kbn_inference_integration_flyout.mdx b/api_docs/kbn_inference_integration_flyout.mdx index b603c76dc4778..805f0b0f61d3b 100644 --- a/api_docs/kbn_inference_integration_flyout.mdx +++ b/api_docs/kbn_inference_integration_flyout.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-inference_integration_flyout title: "@kbn/inference_integration_flyout" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/inference_integration_flyout plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/inference_integration_flyout'] --- import kbnInferenceIntegrationFlyoutObj from './kbn_inference_integration_flyout.devdocs.json'; diff --git a/api_docs/kbn_infra_forge.mdx b/api_docs/kbn_infra_forge.mdx index 8481053e60c6c..eea83c947c9cf 100644 --- a/api_docs/kbn_infra_forge.mdx +++ b/api_docs/kbn_infra_forge.mdx @@ -8,7 +8,7 @@ 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/infra-forge'] --- import kbnInfraForgeObj from './kbn_infra_forge.devdocs.json'; diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index 80e6b8777fb8c..ec0890de4660b 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: 2024-06-06 +date: 2024-06-09 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 31b7793c8bfe1..6ac80c6bd9040 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-utils'] --- import kbnIoTsUtilsObj from './kbn_io_ts_utils.devdocs.json'; diff --git a/api_docs/kbn_ipynb.mdx b/api_docs/kbn_ipynb.mdx index d54d4eaf8c788..78e6e819c0e02 100644 --- a/api_docs/kbn_ipynb.mdx +++ b/api_docs/kbn_ipynb.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ipynb title: "@kbn/ipynb" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ipynb plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ipynb'] --- import kbnIpynbObj from './kbn_ipynb.devdocs.json'; diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx index f0820e7db9f22..4c633fe1a72d8 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: 2024-06-06 +date: 2024-06-09 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 47b6bbf013f98..c8b64ab477efe 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: 2024-06-06 +date: 2024-06-09 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 21e5d7ad62bdd..28d80c0e5b38c 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: 2024-06-06 +date: 2024-06-09 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 03eadb6054f51..8c192dbfc8e56 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: 2024-06-06 +date: 2024-06-09 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 77e8d495c4318..9561b20caae48 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/language-documentation-popover'] --- import kbnLanguageDocumentationPopoverObj from './kbn_language_documentation_popover.devdocs.json'; diff --git a/api_docs/kbn_lens_embeddable_utils.mdx b/api_docs/kbn_lens_embeddable_utils.mdx index e2d1a7abfd3d8..5f70ba7dc0e8a 100644 --- a/api_docs/kbn_lens_embeddable_utils.mdx +++ b/api_docs/kbn_lens_embeddable_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-lens-embeddable-utils title: "@kbn/lens-embeddable-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/lens-embeddable-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/lens-embeddable-utils'] --- import kbnLensEmbeddableUtilsObj from './kbn_lens_embeddable_utils.devdocs.json'; diff --git a/api_docs/kbn_lens_formula_docs.mdx b/api_docs/kbn_lens_formula_docs.mdx index e33ed9495722c..69fa5235b4227 100644 --- a/api_docs/kbn_lens_formula_docs.mdx +++ b/api_docs/kbn_lens_formula_docs.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-lens-formula-docs title: "@kbn/lens-formula-docs" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/lens-formula-docs plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/lens-formula-docs'] --- import kbnLensFormulaDocsObj from './kbn_lens_formula_docs.devdocs.json'; diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx index 464b66fea3882..51fda0b46b40f 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: 2024-06-06 +date: 2024-06-09 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 6439e9fe9242d..9c7c70d4d26f7 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks'] --- import kbnLoggingMocksObj from './kbn_logging_mocks.devdocs.json'; diff --git a/api_docs/kbn_managed_content_badge.mdx b/api_docs/kbn_managed_content_badge.mdx index 34f338575dc3c..8f3a20185c2d9 100644 --- a/api_docs/kbn_managed_content_badge.mdx +++ b/api_docs/kbn_managed_content_badge.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-managed-content-badge title: "@kbn/managed-content-badge" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/managed-content-badge plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/managed-content-badge'] --- import kbnManagedContentBadgeObj from './kbn_managed_content_badge.devdocs.json'; diff --git a/api_docs/kbn_managed_vscode_config.mdx b/api_docs/kbn_managed_vscode_config.mdx index 821c75a6a01e1..30aaf877e419f 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/managed-vscode-config'] --- import kbnManagedVscodeConfigObj from './kbn_managed_vscode_config.devdocs.json'; diff --git a/api_docs/kbn_management_cards_navigation.mdx b/api_docs/kbn_management_cards_navigation.mdx index e96bfc000c752..b1140aa266ebf 100644 --- a/api_docs/kbn_management_cards_navigation.mdx +++ b/api_docs/kbn_management_cards_navigation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-cards-navigation title: "@kbn/management-cards-navigation" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-cards-navigation plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-cards-navigation'] --- import kbnManagementCardsNavigationObj from './kbn_management_cards_navigation.devdocs.json'; diff --git a/api_docs/kbn_management_settings_application.mdx b/api_docs/kbn_management_settings_application.mdx index 02e2741887fc6..ff62deda2e57b 100644 --- a/api_docs/kbn_management_settings_application.mdx +++ b/api_docs/kbn_management_settings_application.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-application title: "@kbn/management-settings-application" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-settings-application plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-application'] --- import kbnManagementSettingsApplicationObj from './kbn_management_settings_application.devdocs.json'; diff --git a/api_docs/kbn_management_settings_components_field_category.mdx b/api_docs/kbn_management_settings_components_field_category.mdx index fa6a998d20dac..f850d37d63d5f 100644 --- a/api_docs/kbn_management_settings_components_field_category.mdx +++ b/api_docs/kbn_management_settings_components_field_category.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-components-field-category title: "@kbn/management-settings-components-field-category" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-settings-components-field-category plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-components-field-category'] --- import kbnManagementSettingsComponentsFieldCategoryObj from './kbn_management_settings_components_field_category.devdocs.json'; diff --git a/api_docs/kbn_management_settings_components_field_input.mdx b/api_docs/kbn_management_settings_components_field_input.mdx index 64af43b129ed5..eebb0d72011e6 100644 --- a/api_docs/kbn_management_settings_components_field_input.mdx +++ b/api_docs/kbn_management_settings_components_field_input.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-components-field-input title: "@kbn/management-settings-components-field-input" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-settings-components-field-input plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-components-field-input'] --- import kbnManagementSettingsComponentsFieldInputObj from './kbn_management_settings_components_field_input.devdocs.json'; diff --git a/api_docs/kbn_management_settings_components_field_row.mdx b/api_docs/kbn_management_settings_components_field_row.mdx index 3b623ec76df3c..f1199708450a9 100644 --- a/api_docs/kbn_management_settings_components_field_row.mdx +++ b/api_docs/kbn_management_settings_components_field_row.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-components-field-row title: "@kbn/management-settings-components-field-row" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-settings-components-field-row plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-components-field-row'] --- import kbnManagementSettingsComponentsFieldRowObj from './kbn_management_settings_components_field_row.devdocs.json'; diff --git a/api_docs/kbn_management_settings_components_form.mdx b/api_docs/kbn_management_settings_components_form.mdx index dbc02d3412473..9f8cd607a9bbb 100644 --- a/api_docs/kbn_management_settings_components_form.mdx +++ b/api_docs/kbn_management_settings_components_form.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-components-form title: "@kbn/management-settings-components-form" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-settings-components-form plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-components-form'] --- import kbnManagementSettingsComponentsFormObj from './kbn_management_settings_components_form.devdocs.json'; diff --git a/api_docs/kbn_management_settings_field_definition.mdx b/api_docs/kbn_management_settings_field_definition.mdx index 8e2f613f72e22..0b51e35fe0354 100644 --- a/api_docs/kbn_management_settings_field_definition.mdx +++ b/api_docs/kbn_management_settings_field_definition.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-field-definition title: "@kbn/management-settings-field-definition" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-settings-field-definition plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-field-definition'] --- import kbnManagementSettingsFieldDefinitionObj from './kbn_management_settings_field_definition.devdocs.json'; diff --git a/api_docs/kbn_management_settings_ids.mdx b/api_docs/kbn_management_settings_ids.mdx index c78540b4ab5b6..2b9f2112606dd 100644 --- a/api_docs/kbn_management_settings_ids.mdx +++ b/api_docs/kbn_management_settings_ids.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-ids title: "@kbn/management-settings-ids" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-settings-ids plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-ids'] --- import kbnManagementSettingsIdsObj from './kbn_management_settings_ids.devdocs.json'; diff --git a/api_docs/kbn_management_settings_section_registry.mdx b/api_docs/kbn_management_settings_section_registry.mdx index 13fb7ebbd709f..c086e01a8202d 100644 --- a/api_docs/kbn_management_settings_section_registry.mdx +++ b/api_docs/kbn_management_settings_section_registry.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-section-registry title: "@kbn/management-settings-section-registry" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-settings-section-registry plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-section-registry'] --- import kbnManagementSettingsSectionRegistryObj from './kbn_management_settings_section_registry.devdocs.json'; diff --git a/api_docs/kbn_management_settings_types.mdx b/api_docs/kbn_management_settings_types.mdx index 92491b21b93d5..fc9336ec7e739 100644 --- a/api_docs/kbn_management_settings_types.mdx +++ b/api_docs/kbn_management_settings_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-types title: "@kbn/management-settings-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-settings-types plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-types'] --- import kbnManagementSettingsTypesObj from './kbn_management_settings_types.devdocs.json'; diff --git a/api_docs/kbn_management_settings_utilities.mdx b/api_docs/kbn_management_settings_utilities.mdx index 70b43cc9f063d..dfeeaedff9b7b 100644 --- a/api_docs/kbn_management_settings_utilities.mdx +++ b/api_docs/kbn_management_settings_utilities.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-settings-utilities title: "@kbn/management-settings-utilities" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-settings-utilities plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-settings-utilities'] --- import kbnManagementSettingsUtilitiesObj from './kbn_management_settings_utilities.devdocs.json'; diff --git a/api_docs/kbn_management_storybook_config.mdx b/api_docs/kbn_management_storybook_config.mdx index d25a5e79337f3..1a39f1d58bd57 100644 --- a/api_docs/kbn_management_storybook_config.mdx +++ b/api_docs/kbn_management_storybook_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-storybook-config title: "@kbn/management-storybook-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-storybook-config plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-storybook-config'] --- import kbnManagementStorybookConfigObj from './kbn_management_storybook_config.devdocs.json'; diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index 7dc7ca53553fe..6b3df13353842 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: 2024-06-06 +date: 2024-06-09 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.mdx b/api_docs/kbn_maps_vector_tile_utils.mdx index 9add5bd501270..a27d1545eebcb 100644 --- a/api_docs/kbn_maps_vector_tile_utils.mdx +++ b/api_docs/kbn_maps_vector_tile_utils.mdx @@ -8,7 +8,7 @@ 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/maps-vector-tile-utils'] --- import kbnMapsVectorTileUtilsObj from './kbn_maps_vector_tile_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_agg_utils.mdx b/api_docs/kbn_ml_agg_utils.mdx index 0a91925f96637..9d54ed5457a78 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: 2024-06-06 +date: 2024-06-09 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 a251ff4d1abf7..1dbcd22143093 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: 2024-06-06 +date: 2024-06-09 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_cancellable_search.mdx b/api_docs/kbn_ml_cancellable_search.mdx index b5cc32726971f..c50639f2c9bce 100644 --- a/api_docs/kbn_ml_cancellable_search.mdx +++ b/api_docs/kbn_ml_cancellable_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-cancellable-search title: "@kbn/ml-cancellable-search" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-cancellable-search plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-cancellable-search'] --- import kbnMlCancellableSearchObj from './kbn_ml_cancellable_search.devdocs.json'; diff --git a/api_docs/kbn_ml_category_validator.mdx b/api_docs/kbn_ml_category_validator.mdx index e1dca2bbd818f..de4f2adbcb863 100644 --- a/api_docs/kbn_ml_category_validator.mdx +++ b/api_docs/kbn_ml_category_validator.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-category-validator title: "@kbn/ml-category-validator" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-category-validator plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-category-validator'] --- import kbnMlCategoryValidatorObj from './kbn_ml_category_validator.devdocs.json'; diff --git a/api_docs/kbn_ml_chi2test.mdx b/api_docs/kbn_ml_chi2test.mdx index c226a71f670e7..c30e62fafc1d4 100644 --- a/api_docs/kbn_ml_chi2test.mdx +++ b/api_docs/kbn_ml_chi2test.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-chi2test title: "@kbn/ml-chi2test" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-chi2test plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-chi2test'] --- import kbnMlChi2testObj from './kbn_ml_chi2test.devdocs.json'; diff --git a/api_docs/kbn_ml_data_frame_analytics_utils.mdx b/api_docs/kbn_ml_data_frame_analytics_utils.mdx index fcbf2c1e3e853..b6d63a0256b49 100644 --- a/api_docs/kbn_ml_data_frame_analytics_utils.mdx +++ b/api_docs/kbn_ml_data_frame_analytics_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-data-frame-analytics-utils title: "@kbn/ml-data-frame-analytics-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-data-frame-analytics-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-data-frame-analytics-utils'] --- import kbnMlDataFrameAnalyticsUtilsObj from './kbn_ml_data_frame_analytics_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_data_grid.mdx b/api_docs/kbn_ml_data_grid.mdx index 0d8245c86450f..84836597d1f81 100644 --- a/api_docs/kbn_ml_data_grid.mdx +++ b/api_docs/kbn_ml_data_grid.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-data-grid title: "@kbn/ml-data-grid" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-data-grid plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-data-grid'] --- import kbnMlDataGridObj from './kbn_ml_data_grid.devdocs.json'; diff --git a/api_docs/kbn_ml_date_picker.mdx b/api_docs/kbn_ml_date_picker.mdx index 7d6ec8a79a78d..b5db47fdc2a52 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: 2024-06-06 +date: 2024-06-09 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_date_utils.mdx b/api_docs/kbn_ml_date_utils.mdx index 920d1ef9de54e..7664aef6055c1 100644 --- a/api_docs/kbn_ml_date_utils.mdx +++ b/api_docs/kbn_ml_date_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-date-utils title: "@kbn/ml-date-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-date-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-date-utils'] --- import kbnMlDateUtilsObj from './kbn_ml_date_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_error_utils.mdx b/api_docs/kbn_ml_error_utils.mdx index fc4ef21de2b06..f4f989eeb7e23 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: 2024-06-06 +date: 2024-06-09 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_in_memory_table.mdx b/api_docs/kbn_ml_in_memory_table.mdx index 745361f6b250f..3734c37678a0b 100644 --- a/api_docs/kbn_ml_in_memory_table.mdx +++ b/api_docs/kbn_ml_in_memory_table.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-in-memory-table title: "@kbn/ml-in-memory-table" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-in-memory-table plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-in-memory-table'] --- import kbnMlInMemoryTableObj from './kbn_ml_in_memory_table.devdocs.json'; diff --git a/api_docs/kbn_ml_is_defined.mdx b/api_docs/kbn_ml_is_defined.mdx index 12066116ccb89..bb0c4952f3851 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: 2024-06-06 +date: 2024-06-09 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 5a276a443e8f5..d9d6112152f30 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: 2024-06-06 +date: 2024-06-09 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_kibana_theme.mdx b/api_docs/kbn_ml_kibana_theme.mdx index a3040a6f5dd68..639e505a2e2c1 100644 --- a/api_docs/kbn_ml_kibana_theme.mdx +++ b/api_docs/kbn_ml_kibana_theme.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-kibana-theme title: "@kbn/ml-kibana-theme" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-kibana-theme plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-kibana-theme'] --- import kbnMlKibanaThemeObj from './kbn_ml_kibana_theme.devdocs.json'; diff --git a/api_docs/kbn_ml_local_storage.mdx b/api_docs/kbn_ml_local_storage.mdx index 90d519aed8550..23df077beca87 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: 2024-06-06 +date: 2024-06-09 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 6ec3763865604..898af863d5ec3 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: 2024-06-06 +date: 2024-06-09 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 208967c0e3dbb..4dd48e4b54d8f 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: 2024-06-06 +date: 2024-06-09 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 949d725718b18..d88bf88006d84 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: 2024-06-06 +date: 2024-06-09 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 29acb9c13249f..be6cff7cd5013 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: 2024-06-06 +date: 2024-06-09 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 5a3c739b74767..672da742c32b1 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: 2024-06-06 +date: 2024-06-09 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_runtime_field_utils.mdx b/api_docs/kbn_ml_runtime_field_utils.mdx index e6b08aa4f47a4..18f24190f8087 100644 --- a/api_docs/kbn_ml_runtime_field_utils.mdx +++ b/api_docs/kbn_ml_runtime_field_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-runtime-field-utils title: "@kbn/ml-runtime-field-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-runtime-field-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-runtime-field-utils'] --- import kbnMlRuntimeFieldUtilsObj from './kbn_ml_runtime_field_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_string_hash.mdx b/api_docs/kbn_ml_string_hash.mdx index 70c63a5c6ce04..58f4e2867c471 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: 2024-06-06 +date: 2024-06-09 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_time_buckets.mdx b/api_docs/kbn_ml_time_buckets.mdx index 8582ab57e387b..ecf49714e744b 100644 --- a/api_docs/kbn_ml_time_buckets.mdx +++ b/api_docs/kbn_ml_time_buckets.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-time-buckets title: "@kbn/ml-time-buckets" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-time-buckets plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-time-buckets'] --- import kbnMlTimeBucketsObj from './kbn_ml_time_buckets.devdocs.json'; diff --git a/api_docs/kbn_ml_trained_models_utils.mdx b/api_docs/kbn_ml_trained_models_utils.mdx index 7bdefa1e1c3c4..5a8765164742a 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: 2024-06-06 +date: 2024-06-09 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_ui_actions.mdx b/api_docs/kbn_ml_ui_actions.mdx index 71ded5d676ba7..d231507c8cb4f 100644 --- a/api_docs/kbn_ml_ui_actions.mdx +++ b/api_docs/kbn_ml_ui_actions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-ui-actions title: "@kbn/ml-ui-actions" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-ui-actions plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-ui-actions'] --- import kbnMlUiActionsObj from './kbn_ml_ui_actions.devdocs.json'; diff --git a/api_docs/kbn_ml_url_state.mdx b/api_docs/kbn_ml_url_state.mdx index f4341114e0b10..b784d97933b2f 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-url-state'] --- import kbnMlUrlStateObj from './kbn_ml_url_state.devdocs.json'; diff --git a/api_docs/kbn_mock_idp_utils.mdx b/api_docs/kbn_mock_idp_utils.mdx index 95c1c0abf1a8e..8e8c16fba8fdb 100644 --- a/api_docs/kbn_mock_idp_utils.mdx +++ b/api_docs/kbn_mock_idp_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-mock-idp-utils title: "@kbn/mock-idp-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/mock-idp-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mock-idp-utils'] --- import kbnMockIdpUtilsObj from './kbn_mock_idp_utils.devdocs.json'; diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index 7c206bb2623e5..96bad058199ae 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: 2024-06-06 +date: 2024-06-09 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 8854f3c112282..dc77e04e55d5c 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: 2024-06-06 +date: 2024-06-09 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.mdx b/api_docs/kbn_observability_alert_details.mdx index 0cfb4790f2727..f03280a83dffa 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/observability-alert-details'] --- import kbnObservabilityAlertDetailsObj from './kbn_observability_alert_details.devdocs.json'; diff --git a/api_docs/kbn_observability_alerting_test_data.mdx b/api_docs/kbn_observability_alerting_test_data.mdx index b560823bb00b5..d0178017a98bf 100644 --- a/api_docs/kbn_observability_alerting_test_data.mdx +++ b/api_docs/kbn_observability_alerting_test_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-observability-alerting-test-data title: "@kbn/observability-alerting-test-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/observability-alerting-test-data plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/observability-alerting-test-data'] --- import kbnObservabilityAlertingTestDataObj from './kbn_observability_alerting_test_data.devdocs.json'; diff --git a/api_docs/kbn_observability_get_padded_alert_time_range_util.mdx b/api_docs/kbn_observability_get_padded_alert_time_range_util.mdx index 52146763f43b4..675c5d065e03e 100644 --- a/api_docs/kbn_observability_get_padded_alert_time_range_util.mdx +++ b/api_docs/kbn_observability_get_padded_alert_time_range_util.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-observability-get-padded-alert-time-range-util title: "@kbn/observability-get-padded-alert-time-range-util" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/observability-get-padded-alert-time-range-util plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/observability-get-padded-alert-time-range-util'] --- import kbnObservabilityGetPaddedAlertTimeRangeUtilObj from './kbn_observability_get_padded_alert_time_range_util.devdocs.json'; diff --git a/api_docs/kbn_openapi_bundler.devdocs.json b/api_docs/kbn_openapi_bundler.devdocs.json index 08edc2847eb06..1c2e10dea8bdf 100644 --- a/api_docs/kbn_openapi_bundler.devdocs.json +++ b/api_docs/kbn_openapi_bundler.devdocs.json @@ -27,7 +27,7 @@ "label": "bundle", "description": [], "signature": [ - "({ sourceGlob, outputFilePath, specInfo, }: ", + "({ sourceGlob, outputFilePath, options, }: ", { "pluginId": "@kbn/openapi-bundler", "scope": "common", @@ -46,7 +46,7 @@ "id": "def-common.bundle.$1", "type": "Object", "tags": [], - "label": "{\n sourceGlob,\n outputFilePath = 'bundled-{version}.schema.yaml',\n specInfo,\n}", + "label": "{\n sourceGlob,\n outputFilePath = 'bundled-{version}.schema.yaml',\n options,\n}", "description": [], "signature": [ { @@ -103,15 +103,13 @@ }, { "parentPluginId": "@kbn/openapi-bundler", - "id": "def-common.BundlerConfig.specInfo", + "id": "def-common.BundlerConfig.options", "type": "Object", "tags": [], - "label": "specInfo", + "label": "options", "description": [], "signature": [ - "Omit, \"version\"> | undefined" + "BundleOptions | undefined" ], "path": "packages/kbn-openapi-bundler/src/openapi_bundler.ts", "deprecated": false, diff --git a/api_docs/kbn_openapi_bundler.mdx b/api_docs/kbn_openapi_bundler.mdx index a214f84263bda..171a9cea8ee5e 100644 --- a/api_docs/kbn_openapi_bundler.mdx +++ b/api_docs/kbn_openapi_bundler.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-openapi-bundler title: "@kbn/openapi-bundler" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/openapi-bundler plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/openapi-bundler'] --- import kbnOpenapiBundlerObj from './kbn_openapi_bundler.devdocs.json'; diff --git a/api_docs/kbn_openapi_generator.mdx b/api_docs/kbn_openapi_generator.mdx index 8c05dabd7aeb1..7da63a4fb6e1f 100644 --- a/api_docs/kbn_openapi_generator.mdx +++ b/api_docs/kbn_openapi_generator.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-openapi-generator title: "@kbn/openapi-generator" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/openapi-generator plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/openapi-generator'] --- import kbnOpenapiGeneratorObj from './kbn_openapi_generator.devdocs.json'; diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index b267b100ef71c..f02f5a2d138cf 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: 2024-06-06 +date: 2024-06-09 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 677e39f6b4bc4..222bdeee326c1 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: 2024-06-06 +date: 2024-06-09 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 713d5d444ce71..e32ee53e4c08d 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: 2024-06-06 +date: 2024-06-09 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_panel_loader.mdx b/api_docs/kbn_panel_loader.mdx index c5d41b114aa22..858e4dadad2fc 100644 --- a/api_docs/kbn_panel_loader.mdx +++ b/api_docs/kbn_panel_loader.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-panel-loader title: "@kbn/panel-loader" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/panel-loader plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/panel-loader'] --- import kbnPanelLoaderObj from './kbn_panel_loader.devdocs.json'; diff --git a/api_docs/kbn_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx index a9f9c4d06c5dd..abb0ea671632f 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: 2024-06-06 +date: 2024-06-09 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_check.mdx b/api_docs/kbn_plugin_check.mdx index b657207cea809..18ff818c9f7cd 100644 --- a/api_docs/kbn_plugin_check.mdx +++ b/api_docs/kbn_plugin_check.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-check title: "@kbn/plugin-check" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/plugin-check plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-check'] --- import kbnPluginCheckObj from './kbn_plugin_check.devdocs.json'; diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index 4247bf0a9158b..393a663f79adb 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: 2024-06-06 +date: 2024-06-09 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 77ca04087f5a6..c0f821c0db410 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] --- import kbnPluginHelpersObj from './kbn_plugin_helpers.devdocs.json'; diff --git a/api_docs/kbn_presentation_containers.mdx b/api_docs/kbn_presentation_containers.mdx index 3e4b21def6cba..cc00369519039 100644 --- a/api_docs/kbn_presentation_containers.mdx +++ b/api_docs/kbn_presentation_containers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-presentation-containers title: "@kbn/presentation-containers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/presentation-containers plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/presentation-containers'] --- import kbnPresentationContainersObj from './kbn_presentation_containers.devdocs.json'; diff --git a/api_docs/kbn_presentation_publishing.mdx b/api_docs/kbn_presentation_publishing.mdx index b45ce4abea611..16987f97b8388 100644 --- a/api_docs/kbn_presentation_publishing.mdx +++ b/api_docs/kbn_presentation_publishing.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-presentation-publishing title: "@kbn/presentation-publishing" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/presentation-publishing plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/presentation-publishing'] --- import kbnPresentationPublishingObj from './kbn_presentation_publishing.devdocs.json'; diff --git a/api_docs/kbn_profiling_utils.mdx b/api_docs/kbn_profiling_utils.mdx index d67ed422e181c..160063bc4ae91 100644 --- a/api_docs/kbn_profiling_utils.mdx +++ b/api_docs/kbn_profiling_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-profiling-utils title: "@kbn/profiling-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/profiling-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/profiling-utils'] --- import kbnProfilingUtilsObj from './kbn_profiling_utils.devdocs.json'; diff --git a/api_docs/kbn_random_sampling.mdx b/api_docs/kbn_random_sampling.mdx index 9fbde7e1ce37a..33278b2d6bb09 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: 2024-06-06 +date: 2024-06-09 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 bedb6e8102b19..767eb6103df92 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] --- import kbnReactFieldObj from './kbn_react_field.devdocs.json'; diff --git a/api_docs/kbn_react_hooks.mdx b/api_docs/kbn_react_hooks.mdx index fd8de6c291fd9..0bfa9101027c1 100644 --- a/api_docs/kbn_react_hooks.mdx +++ b/api_docs/kbn_react_hooks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-hooks title: "@kbn/react-hooks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/react-hooks plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-hooks'] --- import kbnReactHooksObj from './kbn_react_hooks.devdocs.json'; diff --git a/api_docs/kbn_react_kibana_context_common.mdx b/api_docs/kbn_react_kibana_context_common.mdx index 8283419df32e3..4dd6986146738 100644 --- a/api_docs/kbn_react_kibana_context_common.mdx +++ b/api_docs/kbn_react_kibana_context_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-kibana-context-common title: "@kbn/react-kibana-context-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/react-kibana-context-common plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-kibana-context-common'] --- import kbnReactKibanaContextCommonObj from './kbn_react_kibana_context_common.devdocs.json'; diff --git a/api_docs/kbn_react_kibana_context_render.mdx b/api_docs/kbn_react_kibana_context_render.mdx index fab057a8bd5b8..242b9ad3d79d4 100644 --- a/api_docs/kbn_react_kibana_context_render.mdx +++ b/api_docs/kbn_react_kibana_context_render.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-kibana-context-render title: "@kbn/react-kibana-context-render" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/react-kibana-context-render plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-kibana-context-render'] --- import kbnReactKibanaContextRenderObj from './kbn_react_kibana_context_render.devdocs.json'; diff --git a/api_docs/kbn_react_kibana_context_root.mdx b/api_docs/kbn_react_kibana_context_root.mdx index e2b7293d7ccd6..fe51c4231652b 100644 --- a/api_docs/kbn_react_kibana_context_root.mdx +++ b/api_docs/kbn_react_kibana_context_root.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-kibana-context-root title: "@kbn/react-kibana-context-root" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/react-kibana-context-root plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-kibana-context-root'] --- import kbnReactKibanaContextRootObj from './kbn_react_kibana_context_root.devdocs.json'; diff --git a/api_docs/kbn_react_kibana_context_styled.mdx b/api_docs/kbn_react_kibana_context_styled.mdx index 5cc97bb13ae71..5308e8ce42f12 100644 --- a/api_docs/kbn_react_kibana_context_styled.mdx +++ b/api_docs/kbn_react_kibana_context_styled.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-kibana-context-styled title: "@kbn/react-kibana-context-styled" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/react-kibana-context-styled plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-kibana-context-styled'] --- import kbnReactKibanaContextStyledObj from './kbn_react_kibana_context_styled.devdocs.json'; diff --git a/api_docs/kbn_react_kibana_context_theme.mdx b/api_docs/kbn_react_kibana_context_theme.mdx index d6432a839da39..1a035643158db 100644 --- a/api_docs/kbn_react_kibana_context_theme.mdx +++ b/api_docs/kbn_react_kibana_context_theme.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-kibana-context-theme title: "@kbn/react-kibana-context-theme" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/react-kibana-context-theme plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-kibana-context-theme'] --- import kbnReactKibanaContextThemeObj from './kbn_react_kibana_context_theme.devdocs.json'; diff --git a/api_docs/kbn_react_kibana_mount.mdx b/api_docs/kbn_react_kibana_mount.mdx index f9ade2fbd3caa..c76d807ee7a4b 100644 --- a/api_docs/kbn_react_kibana_mount.mdx +++ b/api_docs/kbn_react_kibana_mount.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-kibana-mount title: "@kbn/react-kibana-mount" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/react-kibana-mount plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-kibana-mount'] --- import kbnReactKibanaMountObj from './kbn_react_kibana_mount.devdocs.json'; diff --git a/api_docs/kbn_repo_file_maps.mdx b/api_docs/kbn_repo_file_maps.mdx index 6865e689fa9f8..b0295aacad836 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: 2024-06-06 +date: 2024-06-09 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 cdc2da85f6b61..5901396803f28 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: 2024-06-06 +date: 2024-06-09 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 29e64b17c6c78..85afee07d7761 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: 2024-06-06 +date: 2024-06-09 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 a07a3b72baab1..f01d85b151b12 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: 2024-06-06 +date: 2024-06-09 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 68e79c1085608..cecc970d21957 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-common'] --- import kbnReportingCommonObj from './kbn_reporting_common.devdocs.json'; diff --git a/api_docs/kbn_reporting_csv_share_panel.mdx b/api_docs/kbn_reporting_csv_share_panel.mdx index 53411116aa19c..75ea91ac3b25c 100644 --- a/api_docs/kbn_reporting_csv_share_panel.mdx +++ b/api_docs/kbn_reporting_csv_share_panel.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-csv-share-panel title: "@kbn/reporting-csv-share-panel" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/reporting-csv-share-panel plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-csv-share-panel'] --- import kbnReportingCsvSharePanelObj from './kbn_reporting_csv_share_panel.devdocs.json'; diff --git a/api_docs/kbn_reporting_export_types_csv.mdx b/api_docs/kbn_reporting_export_types_csv.mdx index 99514a50057a2..2898c5c610c11 100644 --- a/api_docs/kbn_reporting_export_types_csv.mdx +++ b/api_docs/kbn_reporting_export_types_csv.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-export-types-csv title: "@kbn/reporting-export-types-csv" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/reporting-export-types-csv plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-export-types-csv'] --- import kbnReportingExportTypesCsvObj from './kbn_reporting_export_types_csv.devdocs.json'; diff --git a/api_docs/kbn_reporting_export_types_csv_common.mdx b/api_docs/kbn_reporting_export_types_csv_common.mdx index f20e7d94cfb31..033822c35ddfb 100644 --- a/api_docs/kbn_reporting_export_types_csv_common.mdx +++ b/api_docs/kbn_reporting_export_types_csv_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-export-types-csv-common title: "@kbn/reporting-export-types-csv-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/reporting-export-types-csv-common plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-export-types-csv-common'] --- import kbnReportingExportTypesCsvCommonObj from './kbn_reporting_export_types_csv_common.devdocs.json'; diff --git a/api_docs/kbn_reporting_export_types_pdf.mdx b/api_docs/kbn_reporting_export_types_pdf.mdx index 7a9debe751eca..6c268ffd9cc38 100644 --- a/api_docs/kbn_reporting_export_types_pdf.mdx +++ b/api_docs/kbn_reporting_export_types_pdf.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-export-types-pdf title: "@kbn/reporting-export-types-pdf" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/reporting-export-types-pdf plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-export-types-pdf'] --- import kbnReportingExportTypesPdfObj from './kbn_reporting_export_types_pdf.devdocs.json'; diff --git a/api_docs/kbn_reporting_export_types_pdf_common.mdx b/api_docs/kbn_reporting_export_types_pdf_common.mdx index cbb3da2ea6858..698d0afc0c2c0 100644 --- a/api_docs/kbn_reporting_export_types_pdf_common.mdx +++ b/api_docs/kbn_reporting_export_types_pdf_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-export-types-pdf-common title: "@kbn/reporting-export-types-pdf-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/reporting-export-types-pdf-common plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-export-types-pdf-common'] --- import kbnReportingExportTypesPdfCommonObj from './kbn_reporting_export_types_pdf_common.devdocs.json'; diff --git a/api_docs/kbn_reporting_export_types_png.mdx b/api_docs/kbn_reporting_export_types_png.mdx index 8127661ff8263..4163dd5045e60 100644 --- a/api_docs/kbn_reporting_export_types_png.mdx +++ b/api_docs/kbn_reporting_export_types_png.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-export-types-png title: "@kbn/reporting-export-types-png" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/reporting-export-types-png plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-export-types-png'] --- import kbnReportingExportTypesPngObj from './kbn_reporting_export_types_png.devdocs.json'; diff --git a/api_docs/kbn_reporting_export_types_png_common.mdx b/api_docs/kbn_reporting_export_types_png_common.mdx index adcd5fe4b476a..7ffb7be86294e 100644 --- a/api_docs/kbn_reporting_export_types_png_common.mdx +++ b/api_docs/kbn_reporting_export_types_png_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-export-types-png-common title: "@kbn/reporting-export-types-png-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/reporting-export-types-png-common plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-export-types-png-common'] --- import kbnReportingExportTypesPngCommonObj from './kbn_reporting_export_types_png_common.devdocs.json'; diff --git a/api_docs/kbn_reporting_mocks_server.mdx b/api_docs/kbn_reporting_mocks_server.mdx index 9ab030fcc36c5..e4b115270c0f6 100644 --- a/api_docs/kbn_reporting_mocks_server.mdx +++ b/api_docs/kbn_reporting_mocks_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-mocks-server title: "@kbn/reporting-mocks-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/reporting-mocks-server plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-mocks-server'] --- import kbnReportingMocksServerObj from './kbn_reporting_mocks_server.devdocs.json'; diff --git a/api_docs/kbn_reporting_public.mdx b/api_docs/kbn_reporting_public.mdx index c416e7d7b46bf..d0db21f1076a7 100644 --- a/api_docs/kbn_reporting_public.mdx +++ b/api_docs/kbn_reporting_public.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-public title: "@kbn/reporting-public" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/reporting-public plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-public'] --- import kbnReportingPublicObj from './kbn_reporting_public.devdocs.json'; diff --git a/api_docs/kbn_reporting_server.mdx b/api_docs/kbn_reporting_server.mdx index 3fc0ceba6c245..741b0b683355b 100644 --- a/api_docs/kbn_reporting_server.mdx +++ b/api_docs/kbn_reporting_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-server title: "@kbn/reporting-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/reporting-server plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-server'] --- import kbnReportingServerObj from './kbn_reporting_server.devdocs.json'; diff --git a/api_docs/kbn_resizable_layout.mdx b/api_docs/kbn_resizable_layout.mdx index 36eb6e26eabd0..efc192aece784 100644 --- a/api_docs/kbn_resizable_layout.mdx +++ b/api_docs/kbn_resizable_layout.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-resizable-layout title: "@kbn/resizable-layout" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/resizable-layout plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/resizable-layout'] --- import kbnResizableLayoutObj from './kbn_resizable_layout.devdocs.json'; diff --git a/api_docs/kbn_rison.mdx b/api_docs/kbn_rison.mdx index 4219aac9a0a22..1c3f04b33c44a 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rison'] --- import kbnRisonObj from './kbn_rison.devdocs.json'; diff --git a/api_docs/kbn_router_to_openapispec.mdx b/api_docs/kbn_router_to_openapispec.mdx index c8b565819609f..076942c3963dc 100644 --- a/api_docs/kbn_router_to_openapispec.mdx +++ b/api_docs/kbn_router_to_openapispec.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-router-to-openapispec title: "@kbn/router-to-openapispec" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/router-to-openapispec plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/router-to-openapispec'] --- import kbnRouterToOpenapispecObj from './kbn_router_to_openapispec.devdocs.json'; diff --git a/api_docs/kbn_router_utils.mdx b/api_docs/kbn_router_utils.mdx index 0bb7c449fae02..b60f12ef93c83 100644 --- a/api_docs/kbn_router_utils.mdx +++ b/api_docs/kbn_router_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-router-utils title: "@kbn/router-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/router-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/router-utils'] --- import kbnRouterUtilsObj from './kbn_router_utils.devdocs.json'; diff --git a/api_docs/kbn_rrule.mdx b/api_docs/kbn_rrule.mdx index 13e27bea70d93..e33963887e6ab 100644 --- a/api_docs/kbn_rrule.mdx +++ b/api_docs/kbn_rrule.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rrule title: "@kbn/rrule" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/rrule plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rrule'] --- import kbnRruleObj from './kbn_rrule.devdocs.json'; diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index 22cf7855949bc..d6914939fce42 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: 2024-06-06 +date: 2024-06-09 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 557c59a894bcf..46bfb49123a40 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/saved-objects-settings'] --- import kbnSavedObjectsSettingsObj from './kbn_saved_objects_settings.devdocs.json'; diff --git a/api_docs/kbn_search_api_panels.mdx b/api_docs/kbn_search_api_panels.mdx index dc3172f92c51a..2ba0656357cc7 100644 --- a/api_docs/kbn_search_api_panels.mdx +++ b/api_docs/kbn_search_api_panels.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-api-panels title: "@kbn/search-api-panels" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/search-api-panels plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-api-panels'] --- import kbnSearchApiPanelsObj from './kbn_search_api_panels.devdocs.json'; diff --git a/api_docs/kbn_search_connectors.devdocs.json b/api_docs/kbn_search_connectors.devdocs.json index 1e94d2d2d2d87..6e88d1a9bde29 100644 --- a/api_docs/kbn_search_connectors.devdocs.json +++ b/api_docs/kbn_search_connectors.devdocs.json @@ -279,7 +279,7 @@ "section": "def-common.IngestPipelineParams", "text": "IngestPipelineParams" }, - " | undefined; serviceType?: string | null | undefined; instant_response?: boolean | undefined; }) => Promise<", + " | undefined; serviceType?: string | null | undefined; }) => Promise<", { "pluginId": "@kbn/search-connectors", "scope": "common", @@ -454,20 +454,6 @@ "path": "packages/kbn-search-connectors/lib/create_connector.ts", "deprecated": false, "trackAdoption": false - }, - { - "parentPluginId": "@kbn/search-connectors", - "id": "def-common.createConnector.$2.instant_response", - "type": "CompoundType", - "tags": [], - "label": "instant_response", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "packages/kbn-search-connectors/lib/create_connector.ts", - "deprecated": false, - "trackAdoption": false } ] } diff --git a/api_docs/kbn_search_connectors.mdx b/api_docs/kbn_search_connectors.mdx index 2582599b32fc1..36618bad5d8ec 100644 --- a/api_docs/kbn_search_connectors.mdx +++ b/api_docs/kbn_search_connectors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-connectors title: "@kbn/search-connectors" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/search-connectors plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-connectors'] --- import kbnSearchConnectorsObj from './kbn_search_connectors.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/search-kibana](https://github.com/orgs/elastic/teams/search-ki | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3688 | 0 | 3688 | 0 | +| 3687 | 0 | 3687 | 0 | ## Common diff --git a/api_docs/kbn_search_errors.mdx b/api_docs/kbn_search_errors.mdx index 4d8412b32ad75..62d77f0abbadf 100644 --- a/api_docs/kbn_search_errors.mdx +++ b/api_docs/kbn_search_errors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-errors title: "@kbn/search-errors" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/search-errors plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-errors'] --- import kbnSearchErrorsObj from './kbn_search_errors.devdocs.json'; diff --git a/api_docs/kbn_search_index_documents.mdx b/api_docs/kbn_search_index_documents.mdx index 306b32146ebaa..8d5d51a6b6fa3 100644 --- a/api_docs/kbn_search_index_documents.mdx +++ b/api_docs/kbn_search_index_documents.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-index-documents title: "@kbn/search-index-documents" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/search-index-documents plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-index-documents'] --- import kbnSearchIndexDocumentsObj from './kbn_search_index_documents.devdocs.json'; diff --git a/api_docs/kbn_search_response_warnings.mdx b/api_docs/kbn_search_response_warnings.mdx index 4a01674c86fe1..18d91c75d278a 100644 --- a/api_docs/kbn_search_response_warnings.mdx +++ b/api_docs/kbn_search_response_warnings.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-response-warnings title: "@kbn/search-response-warnings" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/search-response-warnings plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-response-warnings'] --- import kbnSearchResponseWarningsObj from './kbn_search_response_warnings.devdocs.json'; diff --git a/api_docs/kbn_search_types.mdx b/api_docs/kbn_search_types.mdx index 5e0479a5de430..b327d7861ad78 100644 --- a/api_docs/kbn_search_types.mdx +++ b/api_docs/kbn_search_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-search-types title: "@kbn/search-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/search-types plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/search-types'] --- import kbnSearchTypesObj from './kbn_search_types.devdocs.json'; diff --git a/api_docs/kbn_security_hardening.mdx b/api_docs/kbn_security_hardening.mdx index 0fd698f9f83bd..32b639ea0130c 100644 --- a/api_docs/kbn_security_hardening.mdx +++ b/api_docs/kbn_security_hardening.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-hardening title: "@kbn/security-hardening" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-hardening plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-hardening'] --- import kbnSecurityHardeningObj from './kbn_security_hardening.devdocs.json'; diff --git a/api_docs/kbn_security_plugin_types_common.mdx b/api_docs/kbn_security_plugin_types_common.mdx index 1e7ed4ab97197..74889e3c89cd7 100644 --- a/api_docs/kbn_security_plugin_types_common.mdx +++ b/api_docs/kbn_security_plugin_types_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-plugin-types-common title: "@kbn/security-plugin-types-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-plugin-types-common plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-plugin-types-common'] --- import kbnSecurityPluginTypesCommonObj from './kbn_security_plugin_types_common.devdocs.json'; diff --git a/api_docs/kbn_security_plugin_types_public.devdocs.json b/api_docs/kbn_security_plugin_types_public.devdocs.json index 7f87070f3ade3..6c39e67266318 100644 --- a/api_docs/kbn_security_plugin_types_public.devdocs.json +++ b/api_docs/kbn_security_plugin_types_public.devdocs.json @@ -497,10 +497,12 @@ "parentPluginId": "@kbn/security-plugin-types-public", "id": "def-public.SecurityPluginSetup.authc", "type": "Object", - "tags": [], + "tags": [ + "deprecated" + ], "label": "authc", "description": [ - "\nExposes authentication information about the currently logged in user." + "\nExposes authentication information about the currently logged in user.\n" ], "signature": [ { @@ -512,8 +514,22 @@ } ], "path": "x-pack/packages/security/plugin_types_public/src/plugin.ts", - "deprecated": false, - "trackAdoption": false + "deprecated": true, + "trackAdoption": false, + "references": [ + { + "plugin": "security", + "path": "x-pack/plugins/security/public/plugin.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/filebeat_config_flyout/filebeat_config_flyout.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts" + } + ] }, { "parentPluginId": "@kbn/security-plugin-types-public", @@ -599,10 +615,12 @@ "parentPluginId": "@kbn/security-plugin-types-public", "id": "def-public.SecurityPluginStart.authc", "type": "Object", - "tags": [], + "tags": [ + "deprecated" + ], "label": "authc", "description": [ - "\nExposes authentication information about the currently logged in user." + "\nExposes authentication information about the currently logged in user.\n" ], "signature": [ { @@ -614,8 +632,78 @@ } ], "path": "x-pack/packages/security/plugin_types_public/src/plugin.ts", - "deprecated": false, - "trackAdoption": false + "deprecated": true, + "trackAdoption": false, + "references": [ + { + "plugin": "dataViews", + "path": "src/plugins/data_views/public/plugin.ts" + }, + { + "plugin": "security", + "path": "x-pack/plugins/security/public/plugin.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx" + }, + { + "plugin": "imageEmbeddable", + "path": "src/plugins/image_embeddable/public/components/image_editor/open_image_editor.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/index.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/shared/role_mapping/roles_empty_prompt.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/shared/role_mapping/roles_empty_prompt.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/workplace_search/views/account_settings/account_settings.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/workplace_search/views/account_settings/account_settings.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/management/links.ts" + }, + { + "plugin": "serverlessSearch", + "path": "x-pack/plugins/serverless_search/public/plugin.ts" + }, + { + "plugin": "cloudLinks", + "path": "x-pack/plugins/cloud_integrations/cloud_links/public/maybe_add_cloud_links/maybe_add_cloud_links.ts" + }, + { + "plugin": "observabilityAIAssistantApp", + "path": "x-pack/plugins/observability_solution/observability_ai_assistant_app/public/hooks/use_current_user.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/public/common/lib/kibana/hooks.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/lib/kibana/hooks.ts" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/observability_solution/apm/public/hooks/use_current_user.ts" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/observability_solution/apm/public/hooks/use_current_user.ts" + } + ] }, { "parentPluginId": "@kbn/security-plugin-types-public", @@ -643,10 +731,12 @@ "parentPluginId": "@kbn/security-plugin-types-public", "id": "def-public.SecurityPluginStart.userProfiles", "type": "CompoundType", - "tags": [], + "tags": [ + "deprecated" + ], "label": "userProfiles", "description": [ - "\nA set of methods to work with Kibana user profiles." + "\nA set of methods to work with Kibana user profiles.\n" ], "signature": [ "Omit<", @@ -684,8 +774,54 @@ "; }" ], "path": "x-pack/packages/security/plugin_types_public/src/plugin.ts", - "deprecated": false, - "trackAdoption": false + "deprecated": true, + "trackAdoption": false, + "references": [ + { + "plugin": "security", + "path": "x-pack/plugins/security/public/plugin.tsx" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/public/containers/user_profiles/api.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/public/containers/user_profiles/api.ts" + }, + { + "plugin": "searchPlayground", + "path": "x-pack/plugins/search_playground/public/hooks/use_user_profile.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/user_profiles/use_bulk_get_user_profiles.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/user_profiles/use_get_current_user_profile.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/assistant/overlay.tsx" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/public/containers/user_profiles/api.test.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/public/containers/user_profiles/api.test.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/public/containers/user_profiles/api.test.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/public/containers/user_profiles/api.test.ts" + } + ] } ], "initialIsOpen": false diff --git a/api_docs/kbn_security_plugin_types_public.mdx b/api_docs/kbn_security_plugin_types_public.mdx index 35642e22e727d..d1ec7a804248c 100644 --- a/api_docs/kbn_security_plugin_types_public.mdx +++ b/api_docs/kbn_security_plugin_types_public.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-plugin-types-public title: "@kbn/security-plugin-types-public" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-plugin-types-public plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-plugin-types-public'] --- import kbnSecurityPluginTypesPublicObj from './kbn_security_plugin_types_public.devdocs.json'; diff --git a/api_docs/kbn_security_plugin_types_server.devdocs.json b/api_docs/kbn_security_plugin_types_server.devdocs.json index 834476b9400b5..3702b94894196 100644 --- a/api_docs/kbn_security_plugin_types_server.devdocs.json +++ b/api_docs/kbn_security_plugin_types_server.devdocs.json @@ -3003,10 +3003,12 @@ "parentPluginId": "@kbn/security-plugin-types-server", "id": "def-server.SecurityPluginSetup.audit", "type": "Object", - "tags": [], + "tags": [ + "deprecated" + ], "label": "audit", "description": [ - "\nExposes services for audit logging." + "\nExposes services for audit logging.\n" ], "signature": [ { @@ -3018,8 +3020,62 @@ } ], "path": "x-pack/packages/security/plugin_types_server/src/plugin.ts", - "deprecated": false, - "trackAdoption": false + "deprecated": true, + "trackAdoption": false, + "references": [ + { + "plugin": "security", + "path": "x-pack/plugins/security/server/plugin.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/plugin.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/plugin.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/rules_client_factory.ts" + }, + { + "plugin": "files", + "path": "src/plugins/files/server/file_service/file_service_factory.ts" + }, + { + "plugin": "files", + "path": "src/plugins/files/server/file_service/file_service_factory.ts" + }, + { + "plugin": "ruleRegistry", + "path": "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client_factory.ts" + }, + { + "plugin": "ruleRegistry", + "path": "x-pack/plugins/rule_registry/server/search_strategy/search_strategy.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/client/factory.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/audit_logging.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/audit_logging.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/request_context_factory.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/plugin.ts" + } + ] }, { "parentPluginId": "@kbn/security-plugin-types-server", @@ -3063,10 +3119,12 @@ "parentPluginId": "@kbn/security-plugin-types-server", "id": "def-server.SecurityPluginStart.authc", "type": "Object", - "tags": [], + "tags": [ + "deprecated" + ], "label": "authc", "description": [ - "\nAuthentication services to confirm the user is who they say they are." + "\nAuthentication services to confirm the user is who they say they are.\n" ], "signature": [ { @@ -3078,8 +3136,330 @@ } ], "path": "x-pack/packages/security/plugin_types_server/src/plugin.ts", - "deprecated": false, - "trackAdoption": false + "deprecated": true, + "trackAdoption": false, + "references": [ + { + "plugin": "security", + "path": "x-pack/plugins/security/server/plugin.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/lib/action_executor.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/rules_client_factory.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/rules_client_factory.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/rules_client_factory.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/rules_settings_client_factory.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/maintenance_window_client_factory.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/invalidate_pending_api_keys/task.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/plugin.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/plugin.ts" + }, + { + "plugin": "files", + "path": "src/plugins/files/server/routes/file_kind/create.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/client/factory.ts" + }, + { + "plugin": "observabilityAIAssistant", + "path": "x-pack/plugins/observability_solution/observability_ai_assistant/server/service/index.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/security/security.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/api_keys/transform_api_keys.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/api_keys/security.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/package_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/package_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/package_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/package_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/package_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/epm/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/epm/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/epm/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/epm/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/epm/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/setup/fleet_server_policies_enrollment_keys.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/setup/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/settings/index.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/agent_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/agent_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/agent_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/agent_policy/handlers.ts" + }, + { + "plugin": "cloudDefend", + "path": "x-pack/plugins/cloud_defend/server/routes/setup_routes.ts" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/server/routes/setup_routes.ts" + }, + { + "plugin": "elasticAssistant", + "path": "x-pack/plugins/elastic_assistant/server/routes/request_context_factory.ts" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/server/lib/indices/create_api_key.ts" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/server/routes/enterprise_search/api_keys.ts" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/server/routes/enterprise_search/api_keys.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/server/get_user.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/live_query/create_live_query_route.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/saved_query/create_saved_query_route.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/saved_query/update_saved_query_route.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/pack/create_pack_route.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/pack/update_pack_route.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/asset/update_assets_route.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/endpoint_app_context_services.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/file_info_handler.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/file_download_handler.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts" + }, + { + "plugin": "reporting", + "path": "x-pack/plugins/reporting/server/routes/common/get_user.ts" + }, + { + "plugin": "serverlessSearch", + "path": "x-pack/plugins/serverless_search/server/routes/api_key_routes.ts" + }, + { + "plugin": "serverlessSearch", + "path": "x-pack/plugins/serverless_search/server/routes/api_key_routes.ts" + }, + { + "plugin": "serverlessSearch", + "path": "x-pack/plugins/serverless_search/server/routes/indices_routes.ts" + }, + { + "plugin": "transform", + "path": "x-pack/plugins/transform/server/routes/api/reauthorize_transforms/route_handler_factory.ts" + }, + { + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/server/lib/reindexing/credential_store.ts" + }, + { + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/server/lib/reindexing/credential_store.ts" + }, + { + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/server/lib/reindexing/credential_store.ts" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/observability_solution/apm/server/lib/helpers/get_random_sampler/index.ts" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/observability_solution/apm/server/routes/agent_keys/get_agent_keys_privileges.ts" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/observability_solution/apm/server/routes/fleet/is_superuser.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/routes/synthetics_service/enablement.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/routes/synthetics_service/enablement.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/setup/handlers.test.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/setup/handlers.test.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/setup/handlers.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/state.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/suggestions/index.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lists_integration/endpoint/validators/base_validator.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts" + } + ] }, { "parentPluginId": "@kbn/security-plugin-types-server", @@ -3107,10 +3487,12 @@ "parentPluginId": "@kbn/security-plugin-types-server", "id": "def-server.SecurityPluginStart.userProfiles", "type": "Object", - "tags": [], + "tags": [ + "deprecated" + ], "label": "userProfiles", "description": [ - "\nUser profiles services to retrieve user profiles." + "\nUser profiles services to retrieve user profiles.\n" ], "signature": [ { @@ -3122,8 +3504,34 @@ } ], "path": "x-pack/packages/security/plugin_types_server/src/plugin.ts", - "deprecated": false, - "trackAdoption": false + "deprecated": true, + "trackAdoption": false, + "references": [ + { + "plugin": "security", + "path": "x-pack/plugins/security/server/plugin.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/services/notifications/email_notification_service.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/client/factory.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/client/cases/utils.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/services/user_profiles/index.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/users/suggest_user_profiles_route.ts" + } + ] } ], "initialIsOpen": false diff --git a/api_docs/kbn_security_plugin_types_server.mdx b/api_docs/kbn_security_plugin_types_server.mdx index 35cdc321d4dbd..8a777d80e9522 100644 --- a/api_docs/kbn_security_plugin_types_server.mdx +++ b/api_docs/kbn_security_plugin_types_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-plugin-types-server title: "@kbn/security-plugin-types-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-plugin-types-server plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-plugin-types-server'] --- import kbnSecurityPluginTypesServerObj from './kbn_security_plugin_types_server.devdocs.json'; diff --git a/api_docs/kbn_security_solution_features.devdocs.json b/api_docs/kbn_security_solution_features.devdocs.json index a90a3ec230623..83b547011e113 100644 --- a/api_docs/kbn_security_solution_features.devdocs.json +++ b/api_docs/kbn_security_solution_features.devdocs.json @@ -49,7 +49,7 @@ "label": "baseKibanaFeature", "description": [], "signature": [ - "{ id: string; order?: number | undefined; name: string; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; category: ", + "{ id: string; order?: number | undefined; name: string; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; hidden?: boolean | undefined; category: ", { "pluginId": "@kbn/core-application-common", "scope": "common", @@ -154,7 +154,7 @@ "label": "BaseKibanaFeatureConfig", "description": [], "signature": [ - "{ id: string; order?: number | undefined; name: string; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; category: ", + "{ id: string; order?: number | undefined; name: string; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; hidden?: boolean | undefined; category: ", { "pluginId": "@kbn/core-application-common", "scope": "common", diff --git a/api_docs/kbn_security_solution_features.mdx b/api_docs/kbn_security_solution_features.mdx index 9b974e6cfbc7e..48e162e847a98 100644 --- a/api_docs/kbn_security_solution_features.mdx +++ b/api_docs/kbn_security_solution_features.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-features title: "@kbn/security-solution-features" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-solution-features plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-features'] --- import kbnSecuritySolutionFeaturesObj from './kbn_security_solution_features.devdocs.json'; diff --git a/api_docs/kbn_security_solution_navigation.mdx b/api_docs/kbn_security_solution_navigation.mdx index 83f2ca2124e77..4e9473e4e1a8b 100644 --- a/api_docs/kbn_security_solution_navigation.mdx +++ b/api_docs/kbn_security_solution_navigation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-navigation title: "@kbn/security-solution-navigation" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-solution-navigation plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-navigation'] --- import kbnSecuritySolutionNavigationObj from './kbn_security_solution_navigation.devdocs.json'; diff --git a/api_docs/kbn_security_solution_side_nav.mdx b/api_docs/kbn_security_solution_side_nav.mdx index 2d7b13a243859..c532ddbb91cb5 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: 2024-06-06 +date: 2024-06-09 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 021b65a8e408c..413137dccfe82 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: 2024-06-06 +date: 2024-06-09 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 f0cc2e44363d6..54310d8a417cf 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: 2024-06-06 +date: 2024-06-09 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 bea87f3ff838b..94f5b5d54cffb 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: 2024-06-06 +date: 2024-06-09 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 fe7b74dcdb4b6..5ccfa35e6392a 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: 2024-06-06 +date: 2024-06-09 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 497f29b3856c9..ffbf102638cf5 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: 2024-06-06 +date: 2024-06-09 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 438c1ab42e167..868d45f433ded 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: 2024-06-06 +date: 2024-06-09 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_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index 2bdd9e238697e..825f4d20d1f98 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: 2024-06-06 +date: 2024-06-09 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 eadb0a4b6999f..1527fdd603c8b 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: 2024-06-06 +date: 2024-06-09 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 9cacf4e44a94b..d51374c79d376 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: 2024-06-06 +date: 2024-06-09 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 c01e4e3ed761a..f208176cf7244 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: 2024-06-06 +date: 2024-06-09 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 7fbee25df54b7..9fd7ed6bb28c4 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: 2024-06-06 +date: 2024-06-09 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 f314edce6f547..c3e5f480371f5 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: 2024-06-06 +date: 2024-06-09 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 484a8dfb271b0..176a38b4e37ba 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: 2024-06-06 +date: 2024-06-09 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 bc72b4cb8ae56..125a4009e3bda 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: 2024-06-06 +date: 2024-06-09 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 01a1d3ea34c7e..022ce24a7b5ba 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: 2024-06-06 +date: 2024-06-09 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 df6fb7f3b1388..924ce919480e9 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: 2024-06-06 +date: 2024-06-09 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 49197c1256919..6d579446ec6e6 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: 2024-06-06 +date: 2024-06-09 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 6b144a6cc7537..1378a817542e6 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: 2024-06-06 +date: 2024-06-09 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 88f92b22d7f04..c0f50282ece8c 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: 2024-06-06 +date: 2024-06-09 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.mdx b/api_docs/kbn_server_route_repository.mdx index 69cceeb6fefc3..c44c5dd30b45f 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: 2024-06-06 +date: 2024-06-09 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_common_settings.mdx b/api_docs/kbn_serverless_common_settings.mdx index d791360f0340a..84c7017bb1b6c 100644 --- a/api_docs/kbn_serverless_common_settings.mdx +++ b/api_docs/kbn_serverless_common_settings.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-common-settings title: "@kbn/serverless-common-settings" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/serverless-common-settings plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-common-settings'] --- import kbnServerlessCommonSettingsObj from './kbn_serverless_common_settings.devdocs.json'; diff --git a/api_docs/kbn_serverless_observability_settings.mdx b/api_docs/kbn_serverless_observability_settings.mdx index a6f197fbd55bc..7d040cd4ba2cb 100644 --- a/api_docs/kbn_serverless_observability_settings.mdx +++ b/api_docs/kbn_serverless_observability_settings.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-observability-settings title: "@kbn/serverless-observability-settings" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/serverless-observability-settings plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-observability-settings'] --- import kbnServerlessObservabilitySettingsObj from './kbn_serverless_observability_settings.devdocs.json'; diff --git a/api_docs/kbn_serverless_project_switcher.mdx b/api_docs/kbn_serverless_project_switcher.mdx index cf912fb5c32a6..fe9e7660184b2 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: 2024-06-06 +date: 2024-06-09 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_search_settings.mdx b/api_docs/kbn_serverless_search_settings.mdx index 7ee6959d8caff..5bac8ceaa2fde 100644 --- a/api_docs/kbn_serverless_search_settings.mdx +++ b/api_docs/kbn_serverless_search_settings.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-search-settings title: "@kbn/serverless-search-settings" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/serverless-search-settings plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-search-settings'] --- import kbnServerlessSearchSettingsObj from './kbn_serverless_search_settings.devdocs.json'; diff --git a/api_docs/kbn_serverless_security_settings.mdx b/api_docs/kbn_serverless_security_settings.mdx index 59e2be159758b..4753a67a83802 100644 --- a/api_docs/kbn_serverless_security_settings.mdx +++ b/api_docs/kbn_serverless_security_settings.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-security-settings title: "@kbn/serverless-security-settings" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/serverless-security-settings plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-security-settings'] --- import kbnServerlessSecuritySettingsObj from './kbn_serverless_security_settings.devdocs.json'; diff --git a/api_docs/kbn_serverless_storybook_config.mdx b/api_docs/kbn_serverless_storybook_config.mdx index 7e662eba21e81..ac01642633e9a 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: 2024-06-06 +date: 2024-06-09 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 1c0680d137e7c..fcb06dde62cfc 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: 2024-06-06 +date: 2024-06-09 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 cea4803901527..9411549453686 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: 2024-06-06 +date: 2024-06-09 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_button_exit_full_screen.mdx b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx index b3898d0a68e4a..d3b654ff239c4 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: 2024-06-06 +date: 2024-06-09 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_toolbar.mdx b/api_docs/kbn_shared_ux_button_toolbar.mdx index 337568b6900fd..5bab2b0048b2e 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: 2024-06-06 +date: 2024-06-09 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 1fddb4fe12a63..d1a0ccc43b2da 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: 2024-06-06 +date: 2024-06-09 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 165c9775917fa..6b2ae1aeffb5c 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: 2024-06-06 +date: 2024-06-09 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 8ad79a93bfba6..5f7c18a526538 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: 2024-06-06 +date: 2024-06-09 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_error_boundary.mdx b/api_docs/kbn_shared_ux_error_boundary.mdx index 9473c5eabd903..4a0cdc80f76ae 100644 --- a/api_docs/kbn_shared_ux_error_boundary.mdx +++ b/api_docs/kbn_shared_ux_error_boundary.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-error-boundary title: "@kbn/shared-ux-error-boundary" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-error-boundary plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-error-boundary'] --- import kbnSharedUxErrorBoundaryObj from './kbn_shared_ux_error_boundary.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_context.mdx b/api_docs/kbn_shared_ux_file_context.mdx index e8daeb78308e8..aa4decf7d8160 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: 2024-06-06 +date: 2024-06-09 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 b33ed2a7a431c..8766510c3a75a 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: 2024-06-06 +date: 2024-06-09 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 3f8769f4e1809..fb302506901f9 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: 2024-06-06 +date: 2024-06-09 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 aa12f94a83c34..bb27c42efeec8 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: 2024-06-06 +date: 2024-06-09 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 b098e754cd50b..acb8bc91c808b 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: 2024-06-06 +date: 2024-06-09 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 0718f5c0daaa4..aee6793f9b8e6 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: 2024-06-06 +date: 2024-06-09 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 1cca08c3209f2..070b44bf18ab8 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: 2024-06-06 +date: 2024-06-09 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 d70a7750b212f..799fa49c7aa2f 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: 2024-06-06 +date: 2024-06-09 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 36446e12db4b0..846ea0ca44233 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: 2024-06-06 +date: 2024-06-09 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 d0f279a5ab2c5..a2549c08b0033 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: 2024-06-06 +date: 2024-06-09 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 3de3519a64523..ed69b7c608103 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: 2024-06-06 +date: 2024-06-09 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 1e4662977bb89..61145a8e7d7ad 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: 2024-06-06 +date: 2024-06-09 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 73f07b4c0fda5..b802acedcbc34 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: 2024-06-06 +date: 2024-06-09 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 49b774fc68d88..499f654537d9d 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: 2024-06-06 +date: 2024-06-09 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 31abe36d41dd7..355937e0c5784 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: 2024-06-06 +date: 2024-06-09 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 e6bad30c78ef2..e2d11e36595d2 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: 2024-06-06 +date: 2024-06-09 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 b603563f67656..354d1137b7e85 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: 2024-06-06 +date: 2024-06-09 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 cd39e31111d4e..94c8b13399a39 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: 2024-06-06 +date: 2024-06-09 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 e2aaf03b06464..dc05bafd2a75a 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: 2024-06-06 +date: 2024-06-09 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 2c971c4d4a9d6..46b5f7d2fbef5 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: 2024-06-06 +date: 2024-06-09 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 f7a8b4af72bd3..970eb3f8d699c 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: 2024-06-06 +date: 2024-06-09 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 098ae86079d62..e99b9859f5a5d 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: 2024-06-06 +date: 2024-06-09 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 664fb28e9653d..378c9612f8112 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: 2024-06-06 +date: 2024-06-09 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 b913313f1c415..1b45ab3affd87 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: 2024-06-06 +date: 2024-06-09 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 9d9f227a724e7..0a2cd5856a5cf 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: 2024-06-06 +date: 2024-06-09 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 6cbab09679e87..6e3cc2175bbb6 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: 2024-06-06 +date: 2024-06-09 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 540dd5b046040..bb89e85c1c97f 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: 2024-06-06 +date: 2024-06-09 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 48bb6cee15eac..a15be4cb3e515 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: 2024-06-06 +date: 2024-06-09 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 26ff3abc42739..5fecbdf9efd66 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: 2024-06-06 +date: 2024-06-09 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 9d9f9dbb65e82..aac7d24c11caf 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: 2024-06-06 +date: 2024-06-09 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_tabbed_modal.mdx b/api_docs/kbn_shared_ux_tabbed_modal.mdx index 33e5d8f308a09..5003334feed59 100644 --- a/api_docs/kbn_shared_ux_tabbed_modal.mdx +++ b/api_docs/kbn_shared_ux_tabbed_modal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-tabbed-modal title: "@kbn/shared-ux-tabbed-modal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-tabbed-modal plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-tabbed-modal'] --- import kbnSharedUxTabbedModalObj from './kbn_shared_ux_tabbed_modal.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx index d237d95986b7d..48e13583124ef 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: 2024-06-06 +date: 2024-06-09 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 b5cfbdf54a733..8acc3fb8c8aac 100644 --- a/api_docs/kbn_slo_schema.devdocs.json +++ b/api_docs/kbn_slo_schema.devdocs.json @@ -561,7 +561,7 @@ "label": "APMTransactionDurationIndicator", "description": [], "signature": [ - "{ type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }" + "{ type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -576,7 +576,7 @@ "label": "APMTransactionErrorRateIndicator", "description": [], "signature": [ - "{ type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }" + "{ type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -606,7 +606,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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; } & { id?: string | undefined; settings?: { syncDelay?: string | undefined; frequency?: string | undefined; preventInitialBackfill?: boolean | undefined; } | undefined; tags?: string[] | undefined; groupBy?: string | string[] | undefined; revision?: number | 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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; } & { id?: string | undefined; settings?: { syncDelay?: string | undefined; frequency?: string | undefined; preventInitialBackfill?: boolean | undefined; } | undefined; tags?: string[] | undefined; groupBy?: string | string[] | undefined; revision?: number | undefined; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/routes/create.ts", "deprecated": false, @@ -621,7 +621,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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }; 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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }; timeWindow: { duration: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -805,7 +805,7 @@ "label": "FiltersSchema", "description": [], "signature": [ - "{ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]" + "{ meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -835,7 +835,7 @@ "label": "FindSLODefinitionsResponse", "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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; }[]; }" + "{ 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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; }[]; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/routes/find_definition.ts", "deprecated": false, @@ -895,7 +895,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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; } & { summaryUpdatedAt?: string | null | undefined; }; groupings: { [x: string]: string | number; }; } & { instanceId?: string | undefined; meta?: { synthetics?: { monitorId: string; locationId: string; configId: string; } | undefined; } | undefined; remote?: { remoteName: string; kibanaUrl: string; } | undefined; })[]; }" + "{ 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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; } & { summaryUpdatedAt?: string | null | undefined; }; groupings: { [x: string]: string | number; }; } & { instanceId?: string | undefined; meta?: { synthetics?: { monitorId: string; locationId: string; configId: string; } | undefined; } | undefined; remote?: { remoteName: string; kibanaUrl: string; } | undefined; })[]; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/routes/find.ts", "deprecated": false, @@ -910,7 +910,7 @@ "label": "GetPreviewDataParams", "description": [], "signature": [ - "{ indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }; range: { from: Date; to: Date; }; } & { objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: ", + "{ indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }; range: { from: Date; to: Date; }; } & { objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -993,7 +993,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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; } & { summaryUpdatedAt?: string | null | undefined; }; groupings: { [x: string]: string | number; }; } & { instanceId?: string | undefined; meta?: { synthetics?: { monitorId: string; locationId: string; configId: string; } | undefined; } | undefined; remote?: { remoteName: string; kibanaUrl: string; } | undefined; }" + "{ 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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; } & { summaryUpdatedAt?: string | null | undefined; }; groupings: { [x: string]: string | number; }; } & { instanceId?: string | undefined; meta?: { synthetics?: { monitorId: string; locationId: string; configId: string; } | undefined; } | undefined; remote?: { remoteName: string; kibanaUrl: string; } | undefined; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/routes/get.ts", "deprecated": false, @@ -1068,7 +1068,7 @@ "label": "HistogramIndicator", "description": [], "signature": [ - "{ type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }" + "{ type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -1098,7 +1098,7 @@ "label": "Indicator", "description": [], "signature": [ - "{ type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }" + "{ type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -1128,7 +1128,7 @@ "label": "KQLCustomIndicator", "description": [], "signature": [ - "{ type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }" + "{ type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -1143,7 +1143,7 @@ "label": "KqlWithFiltersSchema", "description": [], "signature": [ - "{ kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }" + "{ kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -1173,7 +1173,7 @@ "label": "MetricCustomIndicator", "description": [], "signature": [ - "{ type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }" + "{ type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -1233,7 +1233,7 @@ "label": "QuerySchema", "description": [], "signature": [ - "string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }" + "string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -1263,7 +1263,7 @@ "label": "ResetSLOResponse", "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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; }" + "{ 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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/routes/reset.ts", "deprecated": false, @@ -1278,7 +1278,7 @@ "label": "SLODefinitionResponse", "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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; }" + "{ 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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -1293,7 +1293,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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; } & { summaryUpdatedAt?: string | null | undefined; }; groupings: { [x: string]: string | number; }; } & { instanceId?: string | undefined; meta?: { synthetics?: { monitorId: string; locationId: string; configId: string; } | undefined; } | undefined; remote?: { remoteName: string; kibanaUrl: string; } | undefined; }" + "{ 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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; } & { summaryUpdatedAt?: string | null | undefined; }; groupings: { [x: string]: string | number; }; } & { instanceId?: string | undefined; meta?: { synthetics?: { monitorId: string; locationId: string; configId: string; } | undefined; } | undefined; remote?: { remoteName: string; kibanaUrl: string; } | undefined; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -1308,7 +1308,7 @@ "label": "SyntheticsAvailabilityIndicator", "description": [], "signature": [ - "{ type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }" + "{ type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -1323,7 +1323,7 @@ "label": "TimesclieMetricPercentileMetric", "description": [], "signature": [ - "{ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }" + "{ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -1338,7 +1338,7 @@ "label": "TimesliceMetricBasicMetricWithField", "description": [], "signature": [ - "{ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }" + "{ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -1353,7 +1353,7 @@ "label": "TimesliceMetricDocCountMetric", "description": [], "signature": [ - "{ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }" + "{ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -1368,7 +1368,7 @@ "label": "TimesliceMetricIndicator", "description": [], "signature": [ - "{ type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }" + "{ type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/indicators.ts", "deprecated": false, @@ -1398,7 +1398,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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | undefined; timeWindow?: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; } | undefined; budgetingMethod?: \"occurrences\" | \"timeslices\" | undefined; objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }) | undefined; settings?: { syncDelay?: string | undefined; frequency?: string | undefined; preventInitialBackfill?: boolean | undefined; } | undefined; tags?: string[] | undefined; groupBy?: string | 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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | undefined; timeWindow?: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; } | undefined; budgetingMethod?: \"occurrences\" | \"timeslices\" | undefined; objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }) | undefined; settings?: { syncDelay?: string | undefined; frequency?: string | undefined; preventInitialBackfill?: boolean | undefined; } | undefined; tags?: string[] | undefined; groupBy?: string | string[] | undefined; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/routes/update.ts", "deprecated": false, @@ -1413,7 +1413,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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | 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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | undefined; timeWindow?: { duration: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -1468,7 +1468,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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; }" + "{ 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 | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; preventInitialBackfill: boolean; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; groupBy: string | string[]; version: number; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/routes/update.ts", "deprecated": false, @@ -1606,19 +1606,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>" + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>" ], "path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts", "deprecated": false, @@ -1720,19 +1722,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>" + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>" ], "path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts", "deprecated": false, @@ -1912,19 +1916,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -1996,19 +2002,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -2104,19 +2112,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -2162,12 +2172,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -2210,12 +2220,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -2262,19 +2272,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -2338,12 +2350,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -2396,12 +2408,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -2464,12 +2476,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -2522,12 +2534,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -2576,19 +2588,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -2652,12 +2666,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -2710,12 +2724,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -2772,12 +2786,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -2830,19 +2844,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -2902,12 +2918,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -2964,12 +2980,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -3024,12 +3040,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -3086,12 +3102,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -3136,19 +3152,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>]>; timeWindow: ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -3714,12 +3732,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -3860,19 +3878,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -3944,19 +3964,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -4052,19 +4074,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -4110,12 +4134,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -4158,12 +4182,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -4210,19 +4234,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -4286,12 +4312,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -4344,12 +4370,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -4412,12 +4438,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -4470,12 +4496,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -4524,19 +4550,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -4600,12 +4628,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -4658,12 +4686,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -4720,12 +4748,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -4778,19 +4806,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -4850,12 +4880,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -4912,12 +4942,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -4972,12 +5002,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -5034,12 +5064,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -5084,19 +5114,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>]>; timeWindow: ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -5470,19 +5502,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -5554,19 +5588,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -5662,19 +5698,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -5720,12 +5758,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -5768,12 +5806,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -5820,19 +5858,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -5896,12 +5936,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -5954,12 +5994,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -6022,12 +6062,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -6080,12 +6120,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -6134,19 +6174,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -6210,12 +6252,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -6268,12 +6310,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -6330,12 +6372,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -6388,19 +6430,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -6460,12 +6504,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -6522,12 +6566,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -6582,12 +6626,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -6644,12 +6688,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -6694,19 +6738,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>]>; timeWindow: ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -6980,19 +7026,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -7064,19 +7112,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -7172,19 +7222,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -7230,12 +7282,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -7278,12 +7330,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -7330,19 +7382,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -7406,12 +7460,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -7464,12 +7518,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -7532,12 +7586,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -7590,12 +7644,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -7644,19 +7698,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -7720,12 +7776,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -7778,12 +7834,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -7840,12 +7896,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -7898,19 +7954,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -7970,12 +8028,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -8032,12 +8090,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -8092,12 +8150,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -8154,12 +8212,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -8204,19 +8262,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>]>; range: ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>]>; range: ", "TypeC", "<{ from: ", "Type", @@ -8552,19 +8612,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -8636,19 +8698,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -8744,19 +8808,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -8802,12 +8868,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -8850,12 +8916,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -8902,19 +8968,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -8978,12 +9046,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -9036,12 +9104,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -9104,12 +9172,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -9162,12 +9230,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -9216,19 +9284,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -9292,12 +9362,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -9350,12 +9420,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -9412,12 +9482,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -9470,19 +9540,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -9542,12 +9614,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -9604,12 +9676,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -9664,12 +9736,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -9726,12 +9798,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -9776,19 +9848,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>]>; timeWindow: ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -10178,12 +10252,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -10240,12 +10314,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -10300,12 +10374,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -10362,12 +10436,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -10412,19 +10486,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>" + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>" ], "path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts", "deprecated": false, @@ -10584,19 +10660,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -10668,19 +10746,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -10776,19 +10856,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -10834,12 +10916,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -10882,12 +10964,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -10934,19 +11016,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -11010,12 +11094,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -11068,12 +11152,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -11136,12 +11220,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -11194,12 +11278,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -11248,19 +11332,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -11324,12 +11410,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -11382,12 +11468,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -11444,12 +11530,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -11502,19 +11588,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -11574,12 +11662,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -11636,12 +11724,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -11696,12 +11784,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -11758,12 +11846,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -11808,19 +11896,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>]>" + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>]>" ], "path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts", "deprecated": false, @@ -11926,12 +12016,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -11974,12 +12064,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -12026,19 +12116,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>" + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>" ], "path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts", "deprecated": false, @@ -12115,12 +12207,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -12233,12 +12325,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -12305,12 +12397,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -12395,12 +12487,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -12453,12 +12545,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -12521,12 +12613,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -12579,12 +12671,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -12633,19 +12725,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>" + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>" ], "path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts", "deprecated": false, @@ -12869,12 +12963,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -13019,19 +13113,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -13103,19 +13199,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -13211,19 +13309,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -13269,12 +13369,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -13317,12 +13417,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -13369,19 +13469,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -13445,12 +13547,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -13503,12 +13605,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -13571,12 +13673,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -13629,12 +13731,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -13683,19 +13785,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -13759,12 +13863,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -13817,12 +13921,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -13879,12 +13983,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -13937,19 +14041,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -14009,12 +14115,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -14071,12 +14177,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -14131,12 +14237,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -14193,12 +14299,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -14243,19 +14349,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>]>; timeWindow: ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -14543,19 +14651,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -14627,19 +14737,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -14735,19 +14847,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -14793,12 +14907,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -14841,12 +14955,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -14893,19 +15007,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -14969,12 +15085,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -15027,12 +15143,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -15095,12 +15211,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -15153,12 +15269,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -15207,19 +15323,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -15283,12 +15401,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -15341,12 +15459,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -15403,12 +15521,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -15461,19 +15579,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -15533,12 +15653,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -15595,12 +15715,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -15655,12 +15775,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -15717,12 +15837,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -15767,19 +15887,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>]>; timeWindow: ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -16100,19 +16222,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -16184,19 +16308,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -16292,19 +16418,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -16350,12 +16478,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -16398,12 +16526,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -16450,19 +16578,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -16526,12 +16656,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -16584,12 +16714,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -16652,12 +16782,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -16710,12 +16840,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -16764,19 +16894,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -16840,12 +16972,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -16898,12 +17030,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -16960,12 +17092,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -17018,19 +17150,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -17090,12 +17224,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -17152,12 +17286,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -17212,12 +17346,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -17274,12 +17408,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -17324,19 +17458,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>]>; timeWindow: ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -17720,19 +17856,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>" + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>" ], "path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts", "deprecated": false, @@ -17846,12 +17984,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -17976,12 +18114,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -18066,12 +18204,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -18124,12 +18262,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -18186,12 +18324,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -18244,19 +18382,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>" + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>" ], "path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts", "deprecated": false, @@ -18336,12 +18476,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -18394,12 +18534,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -18456,12 +18596,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -18532,12 +18672,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -18726,19 +18866,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -18810,19 +18952,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -18918,19 +19062,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -18976,12 +19122,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -19024,12 +19170,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -19076,19 +19222,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -19152,12 +19300,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -19210,12 +19358,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -19278,12 +19426,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -19336,12 +19484,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -19390,19 +19538,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -19466,12 +19616,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -19524,12 +19674,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -19586,12 +19736,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -19644,19 +19794,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -19716,12 +19868,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -19778,12 +19930,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -19838,12 +19990,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -19900,12 +20052,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -19950,19 +20102,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>]>; timeWindow: ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -20158,19 +20312,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -20242,19 +20398,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -20350,19 +20508,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -20408,12 +20568,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -20456,12 +20616,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -20508,19 +20668,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -20584,12 +20746,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -20642,12 +20804,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -20710,12 +20872,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -20768,12 +20930,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -20822,19 +20984,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -20898,12 +21062,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -20956,12 +21120,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -21018,12 +21182,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -21076,19 +21240,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>, ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>, ", "TypeC", "<{ type: ", "LiteralC", @@ -21148,12 +21314,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -21210,12 +21376,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -21270,12 +21436,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -21332,12 +21498,12 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", @@ -21382,19 +21548,21 @@ "StringC", "; key: ", "StringC", + "; field: ", + "StringC", "; params: ", "AnyC", "; value: ", "StringC", - "; field: ", - "StringC", "; }>; query: ", "RecordC", "<", "StringC", ", ", "AnyC", - ">; }>>; }>]>; }>]>; }>]>; timeWindow: ", + ">; }>>; }>]>; dataViewId: ", + "StringC", + "; }>]>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", diff --git a/api_docs/kbn_slo_schema.mdx b/api_docs/kbn_slo_schema.mdx index e30a50ef8ff3f..4989c90f47b5c 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/slo-schema'] --- import kbnSloSchemaObj from './kbn_slo_schema.devdocs.json'; diff --git a/api_docs/kbn_some_dev_log.mdx b/api_docs/kbn_some_dev_log.mdx index 38f88f777ddeb..5d868f58cb36a 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/some-dev-log'] --- import kbnSomeDevLogObj from './kbn_some_dev_log.devdocs.json'; diff --git a/api_docs/kbn_sort_predicates.mdx b/api_docs/kbn_sort_predicates.mdx index 223a14c3c57fc..d73ac608b8b3c 100644 --- a/api_docs/kbn_sort_predicates.mdx +++ b/api_docs/kbn_sort_predicates.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-sort-predicates title: "@kbn/sort-predicates" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/sort-predicates plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sort-predicates'] --- import kbnSortPredicatesObj from './kbn_sort_predicates.devdocs.json'; diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index 5a6b2d62ec9fb..d4cf02feca81d 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: 2024-06-06 +date: 2024-06-09 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 d4713a81c8f3e..ce51ec03b59fc 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: 2024-06-06 +date: 2024-06-09 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 81e260e524986..0faa44953f344 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: 2024-06-06 +date: 2024-06-09 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 9a035566e85ef..ab85ae91f61d2 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: 2024-06-06 +date: 2024-06-09 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 6dc418ddd22dd..62208aad8cf53 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] --- import kbnTestObj from './kbn_test.devdocs.json'; diff --git a/api_docs/kbn_test_eui_helpers.mdx b/api_docs/kbn_test_eui_helpers.mdx index a4e26e3403fe1..6ee82dd2fed2d 100644 --- a/api_docs/kbn_test_eui_helpers.mdx +++ b/api_docs/kbn_test_eui_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test-eui-helpers title: "@kbn/test-eui-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/test-eui-helpers plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-eui-helpers'] --- import kbnTestEuiHelpersObj from './kbn_test_eui_helpers.devdocs.json'; diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index 56a953dee0195..da0c88bc1d8e3 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: 2024-06-06 +date: 2024-06-09 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 45d9039876b66..12836097a0e03 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: 2024-06-06 +date: 2024-06-09 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 index 4e17b35d2cfb8..c0e207109fedb 100644 --- a/api_docs/kbn_text_based_editor.devdocs.json +++ b/api_docs/kbn_text_based_editor.devdocs.json @@ -627,6 +627,22 @@ "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.hideHeaderWhenExpanded", + "type": "CompoundType", + "tags": [], + "label": "hideHeaderWhenExpanded", + "description": [ + "hide header buttons when editor is expanded" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false diff --git a/api_docs/kbn_text_based_editor.mdx b/api_docs/kbn_text_based_editor.mdx index c9223159101d5..66a2b5a767cfe 100644 --- a/api_docs/kbn_text_based_editor.mdx +++ b/api_docs/kbn_text_based_editor.mdx @@ -8,7 +8,7 @@ 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/text-based-editor'] --- import kbnTextBasedEditorObj from './kbn_text_based_editor.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 32 | 0 | 13 | 0 | +| 33 | 0 | 13 | 0 | ## Client diff --git a/api_docs/kbn_timerange.mdx b/api_docs/kbn_timerange.mdx index 1eb1b7ed8bf32..94e69e29c81df 100644 --- a/api_docs/kbn_timerange.mdx +++ b/api_docs/kbn_timerange.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-timerange title: "@kbn/timerange" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/timerange plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/timerange'] --- import kbnTimerangeObj from './kbn_timerange.devdocs.json'; diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index 4605f179941df..12b853a389c72 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] --- import kbnToolingLogObj from './kbn_tooling_log.devdocs.json'; diff --git a/api_docs/kbn_triggers_actions_ui_types.mdx b/api_docs/kbn_triggers_actions_ui_types.mdx index a988274710ce7..293d7f5bac09d 100644 --- a/api_docs/kbn_triggers_actions_ui_types.mdx +++ b/api_docs/kbn_triggers_actions_ui_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-triggers-actions-ui-types title: "@kbn/triggers-actions-ui-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/triggers-actions-ui-types plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/triggers-actions-ui-types'] --- import kbnTriggersActionsUiTypesObj from './kbn_triggers_actions_ui_types.devdocs.json'; diff --git a/api_docs/kbn_try_in_console.mdx b/api_docs/kbn_try_in_console.mdx index 1d22531325f6b..617ea9fc422dd 100644 --- a/api_docs/kbn_try_in_console.mdx +++ b/api_docs/kbn_try_in_console.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-try-in-console title: "@kbn/try-in-console" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/try-in-console plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/try-in-console'] --- import kbnTryInConsoleObj from './kbn_try_in_console.devdocs.json'; diff --git a/api_docs/kbn_ts_projects.mdx b/api_docs/kbn_ts_projects.mdx index 064d5ef942ab1..5898463e82383 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: 2024-06-06 +date: 2024-06-09 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 ed6bbc7782218..497dc74eb13d3 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: 2024-06-06 +date: 2024-06-09 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 2bbd9dfd047c8..896233cbf8af7 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: 2024-06-06 +date: 2024-06-09 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 ebf8c157c6747..cca9774e29df3 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: 2024-06-06 +date: 2024-06-09 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 68a37421a1deb..82e45151f5694 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] --- import kbnUiThemeObj from './kbn_ui_theme.devdocs.json'; diff --git a/api_docs/kbn_unified_data_table.mdx b/api_docs/kbn_unified_data_table.mdx index 693a9f4f79409..08da68a3f421f 100644 --- a/api_docs/kbn_unified_data_table.mdx +++ b/api_docs/kbn_unified_data_table.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-unified-data-table title: "@kbn/unified-data-table" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/unified-data-table plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/unified-data-table'] --- import kbnUnifiedDataTableObj from './kbn_unified_data_table.devdocs.json'; diff --git a/api_docs/kbn_unified_doc_viewer.mdx b/api_docs/kbn_unified_doc_viewer.mdx index d29e1814be9b2..b6ce194ec179f 100644 --- a/api_docs/kbn_unified_doc_viewer.mdx +++ b/api_docs/kbn_unified_doc_viewer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-unified-doc-viewer title: "@kbn/unified-doc-viewer" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/unified-doc-viewer plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/unified-doc-viewer'] --- import kbnUnifiedDocViewerObj from './kbn_unified_doc_viewer.devdocs.json'; diff --git a/api_docs/kbn_unified_field_list.mdx b/api_docs/kbn_unified_field_list.mdx index c1df059bc930e..bac9df3aaa727 100644 --- a/api_docs/kbn_unified_field_list.mdx +++ b/api_docs/kbn_unified_field_list.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-unified-field-list title: "@kbn/unified-field-list" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/unified-field-list plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/unified-field-list'] --- import kbnUnifiedFieldListObj from './kbn_unified_field_list.devdocs.json'; diff --git a/api_docs/kbn_unsaved_changes_badge.mdx b/api_docs/kbn_unsaved_changes_badge.mdx index 9abd22c489603..b7dfa2421aa97 100644 --- a/api_docs/kbn_unsaved_changes_badge.mdx +++ b/api_docs/kbn_unsaved_changes_badge.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-unsaved-changes-badge title: "@kbn/unsaved-changes-badge" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/unsaved-changes-badge plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/unsaved-changes-badge'] --- import kbnUnsavedChangesBadgeObj from './kbn_unsaved_changes_badge.devdocs.json'; diff --git a/api_docs/kbn_unsaved_changes_prompt.devdocs.json b/api_docs/kbn_unsaved_changes_prompt.devdocs.json new file mode 100644 index 0000000000000..97e3715543f87 --- /dev/null +++ b/api_docs/kbn_unsaved_changes_prompt.devdocs.json @@ -0,0 +1,61 @@ +{ + "id": "@kbn/unsaved-changes-prompt", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/unsaved-changes-prompt", + "id": "def-common.useUnsavedChangesPrompt", + "type": "Function", + "tags": [], + "label": "useUnsavedChangesPrompt", + "description": [], + "signature": [ + "({ hasUnsavedChanges, openConfirm, history, http, navigateToUrl, messageText, titleText, confirmButtonText, cancelButtonText, }: Props) => void" + ], + "path": "packages/kbn-unsaved-changes-prompt/src/unsaved_changes_prompt/unsaved_changes_prompt.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/unsaved-changes-prompt", + "id": "def-common.useUnsavedChangesPrompt.$1", + "type": "Object", + "tags": [], + "label": "{\n hasUnsavedChanges,\n openConfirm,\n history,\n http,\n navigateToUrl,\n // Provide overrides for confirm dialog\n messageText = DEFAULT_BODY_TEXT,\n titleText = DEFAULT_TITLE_TEXT,\n confirmButtonText = DEFAULT_CONFIRM_BUTTON,\n cancelButtonText = DEFAULT_CANCEL_BUTTON,\n}", + "description": [], + "signature": [ + "Props" + ], + "path": "packages/kbn-unsaved-changes-prompt/src/unsaved_changes_prompt/unsaved_changes_prompt.tsx", + "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_unsaved_changes_prompt.mdx b/api_docs/kbn_unsaved_changes_prompt.mdx new file mode 100644 index 0000000000000..a1eb4dc9f3561 --- /dev/null +++ b/api_docs/kbn_unsaved_changes_prompt.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: kibKbnUnsavedChangesPromptPluginApi +slug: /kibana-dev-docs/api/kbn-unsaved-changes-prompt +title: "@kbn/unsaved-changes-prompt" +image: https://source.unsplash.com/400x175/?github +description: API docs for the @kbn/unsaved-changes-prompt plugin +date: 2024-06-09 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/unsaved-changes-prompt'] +--- +import kbnUnsavedChangesPromptObj from './kbn_unsaved_changes_prompt.devdocs.json'; + + + +Contact [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) 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_use_tracked_promise.mdx b/api_docs/kbn_use_tracked_promise.mdx index 13a839a283902..a126387fd8749 100644 --- a/api_docs/kbn_use_tracked_promise.mdx +++ b/api_docs/kbn_use_tracked_promise.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-use-tracked-promise title: "@kbn/use-tracked-promise" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/use-tracked-promise plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/use-tracked-promise'] --- import kbnUseTrackedPromiseObj from './kbn_use_tracked_promise.devdocs.json'; diff --git a/api_docs/kbn_user_profile_components.mdx b/api_docs/kbn_user_profile_components.mdx index 8897c95a656c0..1843da313855f 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: 2024-06-06 +date: 2024-06-09 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 86045edf15fb8..f5dee4dc2fa7a 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: 2024-06-06 +date: 2024-06-09 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 009129821d28d..bb9bc173c84fa 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: 2024-06-06 +date: 2024-06-09 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.mdx b/api_docs/kbn_utils.mdx index 53d474b0c710f..5ec756f823f9d 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utils'] --- import kbnUtilsObj from './kbn_utils.devdocs.json'; diff --git a/api_docs/kbn_visualization_ui_components.mdx b/api_docs/kbn_visualization_ui_components.mdx index 7c09a3ddb7981..dda0945c022aa 100644 --- a/api_docs/kbn_visualization_ui_components.mdx +++ b/api_docs/kbn_visualization_ui_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-visualization-ui-components title: "@kbn/visualization-ui-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/visualization-ui-components plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/visualization-ui-components'] --- import kbnVisualizationUiComponentsObj from './kbn_visualization_ui_components.devdocs.json'; diff --git a/api_docs/kbn_visualization_utils.mdx b/api_docs/kbn_visualization_utils.mdx index 47263f57d6df6..445b4633b1f98 100644 --- a/api_docs/kbn_visualization_utils.mdx +++ b/api_docs/kbn_visualization_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-visualization-utils title: "@kbn/visualization-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/visualization-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/visualization-utils'] --- import kbnVisualizationUtilsObj from './kbn_visualization_utils.devdocs.json'; diff --git a/api_docs/kbn_xstate_utils.mdx b/api_docs/kbn_xstate_utils.mdx index cd8d4c10bec0f..8d11b145c7f5e 100644 --- a/api_docs/kbn_xstate_utils.mdx +++ b/api_docs/kbn_xstate_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-xstate-utils title: "@kbn/xstate-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/xstate-utils plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/xstate-utils'] --- import kbnXstateUtilsObj from './kbn_xstate_utils.devdocs.json'; diff --git a/api_docs/kbn_yarn_lock_validator.mdx b/api_docs/kbn_yarn_lock_validator.mdx index 80dc603c0b1b1..1c474ac3ecb87 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/yarn-lock-validator'] --- import kbnYarnLockValidatorObj from './kbn_yarn_lock_validator.devdocs.json'; diff --git a/api_docs/kbn_zod_helpers.mdx b/api_docs/kbn_zod_helpers.mdx index e5e548d33795d..0e020c95e3be1 100644 --- a/api_docs/kbn_zod_helpers.mdx +++ b/api_docs/kbn_zod_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-zod-helpers title: "@kbn/zod-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/zod-helpers plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/zod-helpers'] --- import kbnZodHelpersObj from './kbn_zod_helpers.devdocs.json'; diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx index c7f3c9e8dfd4d..7339a90e6467e 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: 2024-06-06 +date: 2024-06-09 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 61475a2115986..adcc27a3298e2 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: 2024-06-06 +date: 2024-06-09 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 b02aabeeb41ae..b53f4e2c10f46 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaUtils'] --- import kibanaUtilsObj from './kibana_utils.devdocs.json'; diff --git a/api_docs/kubernetes_security.mdx b/api_docs/kubernetes_security.mdx index 044b18ddface8..20b7f41596111 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kubernetesSecurity'] --- import kubernetesSecurityObj from './kubernetes_security.devdocs.json'; diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index 0a0012271aa51..5da18d0146c79 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] --- import lensObj from './lens.devdocs.json'; diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index be0d88c87ca71..6eec40d0d2391 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: 2024-06-06 +date: 2024-06-09 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 00fabca4e4953..6cd2c5bacc2c8 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: 2024-06-06 +date: 2024-06-09 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 427cf57221434..171c7110cd14b 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] --- import licensingObj from './licensing.devdocs.json'; diff --git a/api_docs/links.mdx b/api_docs/links.mdx index 98c4bf0b63540..cf47dfef1953a 100644 --- a/api_docs/links.mdx +++ b/api_docs/links.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/links title: "links" image: https://source.unsplash.com/400x175/?github description: API docs for the links plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'links'] --- import linksObj from './links.devdocs.json'; diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index 0857a1e3c0dcd..6cd4d8d0cebb5 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] --- import listsObj from './lists.devdocs.json'; diff --git a/api_docs/logs_data_access.mdx b/api_docs/logs_data_access.mdx index 93b1b05f17ca9..35a52c995fd7b 100644 --- a/api_docs/logs_data_access.mdx +++ b/api_docs/logs_data_access.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/logsDataAccess title: "logsDataAccess" image: https://source.unsplash.com/400x175/?github description: API docs for the logsDataAccess plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'logsDataAccess'] --- import logsDataAccessObj from './logs_data_access.devdocs.json'; diff --git a/api_docs/logs_explorer.mdx b/api_docs/logs_explorer.mdx index b4813aba4c435..dd9f02bdcc1c4 100644 --- a/api_docs/logs_explorer.mdx +++ b/api_docs/logs_explorer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/logsExplorer title: "logsExplorer" image: https://source.unsplash.com/400x175/?github description: API docs for the logsExplorer plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'logsExplorer'] --- import logsExplorerObj from './logs_explorer.devdocs.json'; diff --git a/api_docs/logs_shared.devdocs.json b/api_docs/logs_shared.devdocs.json index a2cd970283979..c5092240bfaea 100644 --- a/api_docs/logs_shared.devdocs.json +++ b/api_docs/logs_shared.devdocs.json @@ -508,31 +508,30 @@ "label": "LogEntryFlyout", "description": [], "signature": [ - "({ logEntryId, onCloseFlyout, onSetFieldFilter, logViewReference, }: ", + "React.ForwardRefExoticComponent<", "LogEntryFlyoutProps", - ") => JSX.Element" + " & React.RefAttributes<{}>>" ], - "path": "x-pack/plugins/observability_solution/logs_shared/public/components/logging/log_entry_flyout/log_entry_flyout.tsx", + "path": "x-pack/plugins/observability_solution/logs_shared/public/index.ts", "deprecated": false, "trackAdoption": false, + "returnComment": [], "children": [ { "parentPluginId": "logsShared", "id": "def-public.LogEntryFlyout.$1", - "type": "Object", + "type": "Uncategorized", "tags": [], - "label": "{\n logEntryId,\n onCloseFlyout,\n onSetFieldFilter,\n logViewReference,\n}", + "label": "props", "description": [], "signature": [ - "LogEntryFlyoutProps" + "P" ], - "path": "x-pack/plugins/observability_solution/logs_shared/public/components/logging/log_entry_flyout/log_entry_flyout.tsx", + "path": "node_modules/@types/react/index.d.ts", "deprecated": false, - "trackAdoption": false, - "isRequired": true + "trackAdoption": false } ], - "returnComment": [], "initialIsOpen": false }, { @@ -1281,39 +1280,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "logsShared", - "id": "def-public.useLogEntryFlyout", - "type": "Function", - "tags": [], - "label": "useLogEntryFlyout", - "description": [], - "signature": [ - "(logViewReference: { logViewId: string; type: \"log-view-reference\"; } | { type: \"log-view-inline\"; id: string; attributes: { name: string; description: string; logIndices: { type: \"data_view\"; dataViewId: string; } | { type: \"index_name\"; indexName: string; }; logColumns: ({ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; })[]; }; }) => { openLogEntryFlyout: (logEntryId: any) => void; closeLogEntryFlyout: () => void; }" - ], - "path": "x-pack/plugins/observability_solution/logs_shared/public/components/logging/log_entry_flyout/log_entry_flyout.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "logsShared", - "id": "def-public.useLogEntryFlyout.$1", - "type": "CompoundType", - "tags": [], - "label": "logViewReference", - "description": [], - "signature": [ - "{ logViewId: string; type: \"log-view-reference\"; } | { type: \"log-view-inline\"; id: string; attributes: { name: string; description: string; logIndices: { type: \"data_view\"; dataViewId: string; } | { type: \"index_name\"; indexName: string; }; logColumns: ({ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; })[]; }; }" - ], - "path": "x-pack/plugins/observability_solution/logs_shared/public/components/logging/log_entry_flyout/log_entry_flyout.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "logsShared", "id": "def-public.useLogHighlightsStateContext", @@ -1474,84 +1440,6 @@ "children": [], "initialIsOpen": false }, - { - "parentPluginId": "logsShared", - "id": "def-public.useLogSummary", - "type": "Function", - "tags": [], - "label": "useLogSummary", - "description": [], - "signature": [ - "(logViewReference: { logViewId: string; type: \"log-view-reference\"; } | { type: \"log-view-inline\"; id: string; attributes: { name: string; description: string; logIndices: { type: \"data_view\"; dataViewId: string; } | { type: \"index_name\"; indexName: string; }; logColumns: ({ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; })[]; }; }, startTimestamp: number | null, endTimestamp: number | null, filterQuery: string | null) => { buckets: { start: number; end: number; entriesCount: number; }[]; start: number | null; end: number | null; }" - ], - "path": "x-pack/plugins/observability_solution/logs_shared/public/containers/logs/log_summary/log_summary.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "logsShared", - "id": "def-public.useLogSummary.$1", - "type": "CompoundType", - "tags": [], - "label": "logViewReference", - "description": [], - "signature": [ - "{ logViewId: string; type: \"log-view-reference\"; } | { type: \"log-view-inline\"; id: string; attributes: { name: string; description: string; logIndices: { type: \"data_view\"; dataViewId: string; } | { type: \"index_name\"; indexName: string; }; logColumns: ({ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; })[]; }; }" - ], - "path": "x-pack/plugins/observability_solution/logs_shared/public/containers/logs/log_summary/log_summary.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "logsShared", - "id": "def-public.useLogSummary.$2", - "type": "CompoundType", - "tags": [], - "label": "startTimestamp", - "description": [], - "signature": [ - "number | null" - ], - "path": "x-pack/plugins/observability_solution/logs_shared/public/containers/logs/log_summary/log_summary.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - }, - { - "parentPluginId": "logsShared", - "id": "def-public.useLogSummary.$3", - "type": "CompoundType", - "tags": [], - "label": "endTimestamp", - "description": [], - "signature": [ - "number | null" - ], - "path": "x-pack/plugins/observability_solution/logs_shared/public/containers/logs/log_summary/log_summary.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - }, - { - "parentPluginId": "logsShared", - "id": "def-public.useLogSummary.$4", - "type": "CompoundType", - "tags": [], - "label": "filterQuery", - "description": [], - "signature": [ - "string | null" - ], - "path": "x-pack/plugins/observability_solution/logs_shared/public/containers/logs/log_summary/log_summary.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "logsShared", "id": "def-public.useLogView", @@ -2628,7 +2516,7 @@ "label": "WithSummary", "description": [], "signature": [ - "({ serializedParsedQuery, children }: ", + "React.ForwardRefExoticComponent<", { "pluginId": "logsShared", "scope": "public", @@ -2636,36 +2524,28 @@ "section": "def-public.WithSummaryProps", "text": "WithSummaryProps" }, - ") => ", - "RendererResult" + " & React.RefAttributes<{}>>" ], - "path": "x-pack/plugins/observability_solution/logs_shared/public/containers/logs/log_summary/with_summary.ts", + "path": "x-pack/plugins/observability_solution/logs_shared/public/index.ts", "deprecated": false, "trackAdoption": false, + "returnComment": [], "children": [ { "parentPluginId": "logsShared", "id": "def-public.WithSummary.$1", - "type": "Object", + "type": "Uncategorized", "tags": [], - "label": "{ serializedParsedQuery, children }", + "label": "props", "description": [], "signature": [ - { - "pluginId": "logsShared", - "scope": "public", - "docId": "kibLogsSharedPluginApi", - "section": "def-public.WithSummaryProps", - "text": "WithSummaryProps" - } + "P" ], - "path": "x-pack/plugins/observability_solution/logs_shared/public/containers/logs/log_summary/with_summary.ts", + "path": "node_modules/@types/react/index.d.ts", "deprecated": false, - "trackAdoption": false, - "isRequired": true + "trackAdoption": false } ], - "returnComment": [], "initialIsOpen": false } ], diff --git a/api_docs/logs_shared.mdx b/api_docs/logs_shared.mdx index 7e2dc9ca04cf1..8693ff1716fdd 100644 --- a/api_docs/logs_shared.mdx +++ b/api_docs/logs_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/logsShared title: "logsShared" image: https://source.unsplash.com/400x175/?github description: API docs for the logsShared plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'logsShared'] --- import logsSharedObj from './logs_shared.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 303 | 0 | 277 | 32 | +| 296 | 0 | 268 | 32 | ## Client diff --git a/api_docs/management.mdx b/api_docs/management.mdx index 13296a74dd9b9..da3bfaf833853 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] --- import managementObj from './management.devdocs.json'; diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index 4c791d464e912..22dac662e1b49 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] --- import mapsObj from './maps.devdocs.json'; diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index 05542e5dbdbf5..2013003e5325b 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] --- import mapsEmsObj from './maps_ems.devdocs.json'; diff --git a/api_docs/metrics_data_access.devdocs.json b/api_docs/metrics_data_access.devdocs.json index a744b95998f51..13625c031de7f 100644 --- a/api_docs/metrics_data_access.devdocs.json +++ b/api_docs/metrics_data_access.devdocs.json @@ -1309,6 +1309,14 @@ "LensBaseLayer", "; readonly dockerContainerMemoryUsage: ", "LensBaseLayer", + "; readonly dockerContainerNetworkRx: ", + "LensBaseLayer", + "; readonly dockerContainerNetworkTx: ", + "LensBaseLayer", + "; readonly dockerContainerDiskIORead: ", + "LensBaseLayer", + "; readonly dockerContainerDiskIOWrite: ", + "LensBaseLayer", "; readonly k8sContainerCpuUsage: ", "LensBaseLayer", "; readonly k8sContainerMemoryUsage: ", @@ -1401,7 +1409,43 @@ "LensDataset", " | undefined; label?: string | undefined; filter?: string | undefined; format?: \"string\" | \"number\" | \"duration\" | \"percent\" | \"currency\" | \"bytes\" | \"bits\" | undefined; decimals?: number | undefined; normalizeByUnit?: \"m\" | \"d\" | \"h\" | \"s\" | undefined; compactValues?: boolean | undefined; randomSampling?: number | undefined; useGlobalFilter?: boolean | undefined; seriesColor?: string | undefined; value: string; chartType: \"metric\"; querySecondaryMetric?: string | undefined; queryMaxValue?: string | undefined; breakdown?: ", "LensBreakdownConfig", - " | undefined; trendLine?: boolean | undefined; subtitle?: string | undefined; } & { id: string; }; }; }; }>>)[]" + " | undefined; trendLine?: boolean | undefined; subtitle?: string | undefined; } & { id: string; }; }; }; readonly network: { xy: { dockerContainerRxTx: { title: string; dataset?: ", + "LensDataset", + " | undefined; chartType: \"xy\"; layers: ({ dataset?: ", + "LensDataset", + " | undefined; yAxis: ", + "LensBaseLayer", + "[]; type: \"series\"; breakdown?: ", + "LensBreakdownConfig", + " | undefined; xAxis: ", + "LensBreakdownConfig", + "; seriesType: \"area\" | \"line\" | \"bar\"; } | { dataset?: ", + "LensDataset", + " | undefined; yAxis: ", + "LensBaseLayer", + "[]; type: \"annotation\"; events: ({ name: string; color?: string | undefined; icon?: string | undefined; datetime: string; } | { name: string; color?: string | undefined; icon?: string | undefined; field: string; filter: string; })[]; } | ", + "LensReferenceLineLayer", + ")[]; legend?: { show?: boolean | undefined; position?: \"right\" | \"left\" | \"top\" | \"bottom\" | undefined; } | undefined; axisTitleVisibility?: { showXAxisTitle?: boolean | undefined; showYAxisTitle?: boolean | undefined; } | undefined; emphasizeFitting?: boolean | undefined; fittingFunction?: \"None\" | \"Average\" | \"Zero\" | \"Nearest\" | \"Linear\" | \"Carry\" | \"Lookahead\" | undefined; yBounds?: ", + "LensYBoundsConfig", + " | undefined; } & { id: string; }; }; }; readonly diskIO: { xy: { dockerContainerDiskIOReadWrite: { title: string; dataset?: ", + "LensDataset", + " | undefined; chartType: \"xy\"; layers: ({ dataset?: ", + "LensDataset", + " | undefined; yAxis: ", + "LensBaseLayer", + "[]; type: \"series\"; breakdown?: ", + "LensBreakdownConfig", + " | undefined; xAxis: ", + "LensBreakdownConfig", + "; seriesType: \"area\" | \"line\" | \"bar\"; } | { dataset?: ", + "LensDataset", + " | undefined; yAxis: ", + "LensBaseLayer", + "[]; type: \"annotation\"; events: ({ name: string; color?: string | undefined; icon?: string | undefined; datetime: string; } | { name: string; color?: string | undefined; icon?: string | undefined; field: string; filter: string; })[]; } | ", + "LensReferenceLineLayer", + ")[]; legend?: { show?: boolean | undefined; position?: \"right\" | \"left\" | \"top\" | \"bottom\" | undefined; } | undefined; axisTitleVisibility?: { showXAxisTitle?: boolean | undefined; showYAxisTitle?: boolean | undefined; } | undefined; emphasizeFitting?: boolean | undefined; fittingFunction?: \"None\" | \"Average\" | \"Zero\" | \"Nearest\" | \"Linear\" | \"Carry\" | \"Lookahead\" | undefined; yBounds?: ", + "LensYBoundsConfig", + " | undefined; } & { id: string; }; }; }; }>>)[]" ], "path": "x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/index.ts", "deprecated": false, diff --git a/api_docs/metrics_data_access.mdx b/api_docs/metrics_data_access.mdx index 7eb00acb9d3d1..a8f0e112a0091 100644 --- a/api_docs/metrics_data_access.mdx +++ b/api_docs/metrics_data_access.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/metricsDataAccess title: "metricsDataAccess" image: https://source.unsplash.com/400x175/?github description: API docs for the metricsDataAccess plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'metricsDataAccess'] --- import metricsDataAccessObj from './metrics_data_access.devdocs.json'; diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index 9c8f548f24c29..043f89e4beb7c 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] --- import mlObj from './ml.devdocs.json'; diff --git a/api_docs/mock_idp_plugin.mdx b/api_docs/mock_idp_plugin.mdx index bec9280bff73c..5e83cbfcecece 100644 --- a/api_docs/mock_idp_plugin.mdx +++ b/api_docs/mock_idp_plugin.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/mockIdpPlugin title: "mockIdpPlugin" image: https://source.unsplash.com/400x175/?github description: API docs for the mockIdpPlugin plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mockIdpPlugin'] --- import mockIdpPluginObj from './mock_idp_plugin.devdocs.json'; diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index 355f4ee51351f..3741ca934fe6a 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: 2024-06-06 +date: 2024-06-09 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 a710de9c852b9..c565cc07d66d2 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: 2024-06-06 +date: 2024-06-09 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 e0512f0e731f7..edaa2c0df3435 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: 2024-06-06 +date: 2024-06-09 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 924dc6bae7160..b66343d0e76d2 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed'] --- import newsfeedObj from './newsfeed.devdocs.json'; diff --git a/api_docs/no_data_page.mdx b/api_docs/no_data_page.mdx index 437cc2c455c36..fe7ceb9ef827e 100644 --- a/api_docs/no_data_page.mdx +++ b/api_docs/no_data_page.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/noDataPage title: "noDataPage" image: https://source.unsplash.com/400x175/?github description: API docs for the noDataPage plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'noDataPage'] --- import noDataPageObj from './no_data_page.devdocs.json'; diff --git a/api_docs/notifications.mdx b/api_docs/notifications.mdx index d15d55c62b5c0..3ebdee2b850c4 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: 2024-06-06 +date: 2024-06-09 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 39edffbdcd7e0..e6b73cbac5031 100644 --- a/api_docs/observability.devdocs.json +++ b/api_docs/observability.devdocs.json @@ -799,7 +799,7 @@ "label": "getElasticsearchQueryOrThrow", "description": [], "signature": [ - "(kuery: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }) => never[] | ", + "(kuery: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }) => never[] | ", "QueryDslQueryContainer", " | { bool: ", { @@ -823,7 +823,7 @@ "label": "kuery", "description": [], "signature": [ - "string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }" + "string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }" ], "path": "x-pack/plugins/observability_solution/observability/common/utils/parse_kuery.ts", "deprecated": false, diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index 10055f2373a28..d2d0dcca8888e 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability'] --- import observabilityObj from './observability.devdocs.json'; diff --git a/api_docs/observability_a_i_assistant.devdocs.json b/api_docs/observability_a_i_assistant.devdocs.json index 40be1e4b5dbb6..6dba439cb25b2 100644 --- a/api_docs/observability_a_i_assistant.devdocs.json +++ b/api_docs/observability_a_i_assistant.devdocs.json @@ -1928,18 +1928,16 @@ "<{ queries: ", "ArrayC", "<", - "BrandC", - "<", + "IntersectionC", + "<[", + "TypeC", + "<{ text: ", "StringC", - ", ", - { - "pluginId": "@kbn/io-ts-utils", - "scope": "common", - "docId": "kibKbnIoTsUtilsPluginApi", - "section": "def-common.NonEmptyStringBrand", - "text": "NonEmptyStringBrand" - }, - ">>; }>, ", + "; }>, ", + "PartialC", + "<{ boost: ", + "NumberC", + "; }>]>>; }>, ", "PartialC", "<{ categories: ", "ArrayC", @@ -1947,17 +1945,7 @@ "StringC", ">; }>]>; }> | undefined; handler: ({}: ", "ObservabilityAIAssistantRouteHandlerResources", - " & { params: { body: { queries: ", - "Branded", - "[]; } & { categories?: string[] | undefined; }; }; }) => Promise<{ entries: ", + " & { params: { body: { queries: ({ text: string; } & { boost?: number | undefined; })[]; } & { categories?: string[] | undefined; }; }; }) => Promise<{ entries: ", "RecalledEntry", "[]; }>; } & ", "ObservabilityAIAssistantRouteCreateOptions", @@ -2556,18 +2544,16 @@ "<{ queries: ", "ArrayC", "<", - "BrandC", - "<", + "IntersectionC", + "<[", + "TypeC", + "<{ text: ", "StringC", - ", ", - { - "pluginId": "@kbn/io-ts-utils", - "scope": "common", - "docId": "kibKbnIoTsUtilsPluginApi", - "section": "def-common.NonEmptyStringBrand", - "text": "NonEmptyStringBrand" - }, - ">>; }>, ", + "; }>, ", + "PartialC", + "<{ boost: ", + "NumberC", + "; }>]>>; }>, ", "PartialC", "<{ categories: ", "ArrayC", @@ -2575,17 +2561,7 @@ "StringC", ">; }>]>; }> | undefined; handler: ({}: ", "ObservabilityAIAssistantRouteHandlerResources", - " & { params: { body: { queries: ", - "Branded", - "[]; } & { categories?: string[] | undefined; }; }; }) => Promise<{ entries: ", + " & { params: { body: { queries: ({ text: string; } & { boost?: number | undefined; })[]; } & { categories?: string[] | undefined; }; }; }) => Promise<{ entries: ", "RecalledEntry", "[]; }>; } & ", "ObservabilityAIAssistantRouteCreateOptions", @@ -3787,18 +3763,16 @@ "<{ queries: ", "ArrayC", "<", - "BrandC", - "<", + "IntersectionC", + "<[", + "TypeC", + "<{ text: ", "StringC", - ", ", - { - "pluginId": "@kbn/io-ts-utils", - "scope": "common", - "docId": "kibKbnIoTsUtilsPluginApi", - "section": "def-common.NonEmptyStringBrand", - "text": "NonEmptyStringBrand" - }, - ">>; }>, ", + "; }>, ", + "PartialC", + "<{ boost: ", + "NumberC", + "; }>]>>; }>, ", "PartialC", "<{ categories: ", "ArrayC", @@ -3806,17 +3780,7 @@ "StringC", ">; }>]>; }> | undefined; handler: ({}: ", "ObservabilityAIAssistantRouteHandlerResources", - " & { params: { body: { queries: ", - "Branded", - "[]; } & { categories?: string[] | undefined; }; }; }) => Promise<{ entries: ", + " & { params: { body: { queries: ({ text: string; } & { boost?: number | undefined; })[]; } & { categories?: string[] | undefined; }; }; }) => Promise<{ entries: ", "RecalledEntry", "[]; }>; } & ", "ObservabilityAIAssistantRouteCreateOptions", @@ -4292,6 +4256,41 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "observabilityAIAssistant", + "id": "def-public.CompatibleJSONSchema", + "type": "Type", + "tags": [], + "label": "CompatibleJSONSchema", + "description": [], + "signature": [ + "{ type?: ", + "JSONSchema7TypeName", + " | undefined; enum?: JSONSchemaOrPrimitive[] | readonly JSONSchemaOrPrimitive[] | undefined; const?: JSONSchemaOrPrimitive | undefined; minLength?: number | undefined; maxLength?: number | undefined; items?: ", + "CompatibleJSONSchema", + " | ", + "CompatibleJSONSchema", + "[] | undefined; required?: string[] | readonly string[] | undefined; properties?: Record | undefined; allOf?: ", + "CompatibleJSONSchema", + "[] | readonly ", + "CompatibleJSONSchema", + "[] | undefined; anyOf?: ", + "CompatibleJSONSchema", + "[] | readonly ", + "CompatibleJSONSchema", + "[] | undefined; oneOf?: ", + "CompatibleJSONSchema", + "[] | readonly ", + "CompatibleJSONSchema", + "[] | undefined; description?: string | undefined; }" + ], + "path": "x-pack/plugins/observability_solution/observability_ai_assistant/common/functions/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "observabilityAIAssistant", "id": "def-public.Feedback", @@ -4535,18 +4534,16 @@ "<{ queries: ", "ArrayC", "<", - "BrandC", - "<", + "IntersectionC", + "<[", + "TypeC", + "<{ text: ", "StringC", - ", ", - { - "pluginId": "@kbn/io-ts-utils", - "scope": "common", - "docId": "kibKbnIoTsUtilsPluginApi", - "section": "def-common.NonEmptyStringBrand", - "text": "NonEmptyStringBrand" - }, - ">>; }>, ", + "; }>, ", + "PartialC", + "<{ boost: ", + "NumberC", + "; }>]>>; }>, ", "PartialC", "<{ categories: ", "ArrayC", @@ -4554,17 +4551,7 @@ "StringC", ">; }>]>; }> | undefined; handler: ({}: ", "ObservabilityAIAssistantRouteHandlerResources", - " & { params: { body: { queries: ", - "Branded", - "[]; } & { categories?: string[] | undefined; }; }; }) => Promise<{ entries: ", + " & { params: { body: { queries: ({ text: string; } & { boost?: number | undefined; })[]; } & { categories?: string[] | undefined; }; }; }) => Promise<{ entries: ", "RecalledEntry", "[]; }>; } & ", "ObservabilityAIAssistantRouteCreateOptions", @@ -5965,18 +5952,16 @@ "<{ queries: ", "ArrayC", "<", - "BrandC", - "<", + "IntersectionC", + "<[", + "TypeC", + "<{ text: ", "StringC", - ", ", - { - "pluginId": "@kbn/io-ts-utils", - "scope": "common", - "docId": "kibKbnIoTsUtilsPluginApi", - "section": "def-common.NonEmptyStringBrand", - "text": "NonEmptyStringBrand" - }, - ">>; }>, ", + "; }>, ", + "PartialC", + "<{ boost: ", + "NumberC", + "; }>]>>; }>, ", "PartialC", "<{ categories: ", "ArrayC", @@ -5984,17 +5969,7 @@ "StringC", ">; }>]>; }> | undefined; handler: ({}: ", "ObservabilityAIAssistantRouteHandlerResources", - " & { params: { body: { queries: ", - "Branded", - "[]; } & { categories?: string[] | undefined; }; }; }) => Promise<{ entries: ", + " & { params: { body: { queries: ({ text: string; } & { boost?: number | undefined; })[]; } & { categories?: string[] | undefined; }; }; }) => Promise<{ entries: ", "RecalledEntry", "[]; }>; } & ", "ObservabilityAIAssistantRouteCreateOptions", diff --git a/api_docs/observability_a_i_assistant.mdx b/api_docs/observability_a_i_assistant.mdx index f4afcf8be4f4b..840401afb8f63 100644 --- a/api_docs/observability_a_i_assistant.mdx +++ b/api_docs/observability_a_i_assistant.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityAIAssistant title: "observabilityAIAssistant" image: https://source.unsplash.com/400x175/?github description: API docs for the observabilityAIAssistant plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityAIAssistant'] --- import observabilityAIAssistantObj from './observability_a_i_assistant.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/obs-ai-assistant](https://github.com/orgs/elastic/teams/obs-ai | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 260 | 1 | 258 | 26 | +| 261 | 1 | 259 | 27 | ## Client diff --git a/api_docs/observability_a_i_assistant_app.devdocs.json b/api_docs/observability_a_i_assistant_app.devdocs.json index b03a7f23f96d6..b20b594df3987 100644 --- a/api_docs/observability_a_i_assistant_app.devdocs.json +++ b/api_docs/observability_a_i_assistant_app.devdocs.json @@ -13,7 +13,38 @@ "functions": [], "interfaces": [], "enums": [], - "misc": [], + "misc": [ + { + "parentPluginId": "observabilityAIAssistantApp", + "id": "def-server.CHANGES_FUNCTION_NAME", + "type": "string", + "tags": [], + "label": "CHANGES_FUNCTION_NAME", + "description": [], + "signature": [ + "\"changes\"" + ], + "path": "x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/changes/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityAIAssistantApp", + "id": "def-server.QUERY_FUNCTION_NAME", + "type": "string", + "tags": [], + "label": "QUERY_FUNCTION_NAME", + "description": [], + "signature": [ + "\"query\"" + ], + "path": "x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], "objects": [], "start": { "parentPluginId": "observabilityAIAssistantApp", diff --git a/api_docs/observability_a_i_assistant_app.mdx b/api_docs/observability_a_i_assistant_app.mdx index cf608471c50ee..b718830336d1e 100644 --- a/api_docs/observability_a_i_assistant_app.mdx +++ b/api_docs/observability_a_i_assistant_app.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityAIAssistantApp title: "observabilityAIAssistantApp" image: https://source.unsplash.com/400x175/?github description: API docs for the observabilityAIAssistantApp plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityAIAssistantApp'] --- import observabilityAIAssistantAppObj from './observability_a_i_assistant_app.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/obs-ai-assistant](https://github.com/orgs/elastic/teams/obs-ai | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2 | 0 | 2 | 0 | +| 4 | 0 | 4 | 0 | ## Server @@ -31,3 +31,6 @@ Contact [@elastic/obs-ai-assistant](https://github.com/orgs/elastic/teams/obs-ai ### Start +### Consts, variables and types + + diff --git a/api_docs/observability_ai_assistant_management.mdx b/api_docs/observability_ai_assistant_management.mdx index a8f39350c6025..54b9abf54d300 100644 --- a/api_docs/observability_ai_assistant_management.mdx +++ b/api_docs/observability_ai_assistant_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityAiAssistantManagement title: "observabilityAiAssistantManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the observabilityAiAssistantManagement plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityAiAssistantManagement'] --- import observabilityAiAssistantManagementObj from './observability_ai_assistant_management.devdocs.json'; diff --git a/api_docs/observability_logs_explorer.mdx b/api_docs/observability_logs_explorer.mdx index 5e540ea2d2830..959b153ae8a97 100644 --- a/api_docs/observability_logs_explorer.mdx +++ b/api_docs/observability_logs_explorer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityLogsExplorer title: "observabilityLogsExplorer" image: https://source.unsplash.com/400x175/?github description: API docs for the observabilityLogsExplorer plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityLogsExplorer'] --- import observabilityLogsExplorerObj from './observability_logs_explorer.devdocs.json'; diff --git a/api_docs/observability_onboarding.mdx b/api_docs/observability_onboarding.mdx index db1a0a2e36cf1..82452eb0f2429 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityOnboarding'] --- import observabilityOnboardingObj from './observability_onboarding.devdocs.json'; diff --git a/api_docs/observability_shared.mdx b/api_docs/observability_shared.mdx index d01ce86c1eae4..69b4e2367c0f3 100644 --- a/api_docs/observability_shared.mdx +++ b/api_docs/observability_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityShared title: "observabilityShared" image: https://source.unsplash.com/400x175/?github description: API docs for the observabilityShared plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityShared'] --- import observabilitySharedObj from './observability_shared.devdocs.json'; diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index 21f037b1cf508..1a60902a54b73 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery'] --- import osqueryObj from './osquery.devdocs.json'; diff --git a/api_docs/painless_lab.mdx b/api_docs/painless_lab.mdx index b9f13f481253d..a7b4154fe60bb 100644 --- a/api_docs/painless_lab.mdx +++ b/api_docs/painless_lab.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/painlessLab title: "painlessLab" image: https://source.unsplash.com/400x175/?github description: API docs for the painlessLab plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'painlessLab'] --- import painlessLabObj from './painless_lab.devdocs.json'; diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index 56091945c3ad1..38a1053f7a9d8 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: 2024-06-06 +date: 2024-06-09 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 | |--------------|----------|------------------------| -| 801 | 687 | 42 | +| 803 | 689 | 42 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 48784 | 239 | 37272 | 1877 | +| 48911 | 239 | 37380 | 1881 | ## Plugin Directory @@ -41,7 +41,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Canvas application to Kibana | 9 | 0 | 8 | 3 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | The Case management system in Kibana | 115 | 0 | 95 | 28 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 268 | 2 | 253 | 10 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 74 | 0 | 17 | 0 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 78 | 0 | 19 | 0 | | cloudChat | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | Chat available on Elastic Cloud deployments for quicker assistance. | 0 | 0 | 0 | 0 | | | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | Static migration page where self-managed users can see text/copy about migrating to Elastic Cloud | 8 | 0 | 8 | 1 | | | [@elastic/kibana-cloud-security-posture](https://github.com/orgs/elastic/teams/kibana-cloud-security-posture) | Defend for containers (D4C) | 52 | 0 | 43 | 2 | @@ -55,9 +55,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | crossClusterReplication | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-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 | 271 | 0 | 252 | 1 | -| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 120 | 0 | 116 | 13 | +| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 129 | 0 | 123 | 12 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | - | 54 | 0 | 51 | 0 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3194 | 31 | 2585 | 24 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3199 | 31 | 2590 | 24 | | | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | - | 8 | 0 | 8 | 0 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin provides the ability to create data views via a modal flyout inside Kibana apps | 35 | 0 | 25 | 5 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | Reusable data view field editor across Kibana | 72 | 0 | 33 | 0 | @@ -95,7 +95,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Expression Tagcloud plugin adds a `tagcloud` renderer and function to the expression plugin. The renderer will display the `Wordcloud` chart. | 6 | 0 | 6 | 2 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Expression XY plugin adds a `xy` renderer and function to the expression plugin. The renderer will display the `xy` chart. | 177 | 0 | 166 | 13 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Adds expression runtime to Kibana | 2233 | 17 | 1763 | 6 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 235 | 0 | 99 | 2 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 247 | 0 | 102 | 2 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | Index pattern fields and ambiguous values formatters | 292 | 5 | 253 | 3 | | | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | Exposes services for async usage and search of fields metadata. | 39 | 0 | 39 | 7 | | | [@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. | 84 | 0 | 84 | 8 | @@ -118,6 +118,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | 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) | - | 127 | 2 | 100 | 4 | | | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides UI and APIs for the interactive setup mode. | 28 | 0 | 18 | 0 | +| | [@elastic/obs-ai-assistant](https://github.com/orgs/elastic/teams/obs-ai-assistant) | - | 95 | 0 | 95 | 4 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 6 | 0 | 6 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 153 | 0 | 121 | 3 | | kibanaUsageCollection | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | @@ -131,7 +132,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/security-detection-engine](https://github.com/orgs/elastic/teams/security-detection-engine) | - | 226 | 0 | 97 | 52 | | | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | - | 7 | 0 | 7 | 1 | | | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | This plugin provides a LogsExplorer component using the Discover customization framework, offering several affordances specifically designed for log consumption. | 117 | 4 | 117 | 22 | -| | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | Exposes the shared components and APIs to access and visualize logs. | 303 | 0 | 277 | 32 | +| | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | Exposes the shared components and APIs to access and visualize logs. | 296 | 0 | 268 | 32 | | logstash | [@elastic/logstash](https://github.com/orgs/elastic/teams/logstash) | - | 0 | 0 | 0 | 0 | | | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 44 | 0 | 44 | 7 | | | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 286 | 0 | 281 | 31 | @@ -146,8 +147,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 3 | 0 | 3 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 2 | 0 | 2 | 1 | | | [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/obs-ux-management-team) | - | 698 | 2 | 689 | 15 | -| | [@elastic/obs-ai-assistant](https://github.com/orgs/elastic/teams/obs-ai-assistant) | - | 260 | 1 | 258 | 26 | -| | [@elastic/obs-ai-assistant](https://github.com/orgs/elastic/teams/obs-ai-assistant) | - | 2 | 0 | 2 | 0 | +| | [@elastic/obs-ai-assistant](https://github.com/orgs/elastic/teams/obs-ai-assistant) | - | 261 | 1 | 259 | 27 | +| | [@elastic/obs-ai-assistant](https://github.com/orgs/elastic/teams/obs-ai-assistant) | - | 4 | 0 | 4 | 0 | | | [@elastic/obs-ai-assistant](https://github.com/orgs/elastic/teams/obs-ai-assistant) | - | 2 | 0 | 2 | 0 | | | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | This plugin exposes and registers observability log consumption features. | 19 | 0 | 19 | 1 | | | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | - | 16 | 0 | 16 | 0 | @@ -183,8 +184,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/obs-ux-management-team) | Serverless customizations for observability. | 6 | 0 | 6 | 0 | | | [@elastic/search-kibana](https://github.com/orgs/elastic/teams/search-kibana) | Serverless customizations for search. | 6 | 0 | 6 | 0 | | | [@elastic/kibana-cloud-security-posture](https://github.com/orgs/elastic/teams/kibana-cloud-security-posture) | - | 134 | 0 | 134 | 8 | -| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Adds URL Service and sharing capabilities to Kibana | 120 | 0 | 59 | 12 | -| | [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/obs-ux-management-team) | - | 64 | 0 | 64 | 1 | +| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Adds URL Service and sharing capabilities to Kibana | 121 | 0 | 60 | 12 | +| | [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/obs-ux-management-team) | - | 65 | 0 | 65 | 1 | | | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-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. | 260 | 0 | 66 | 0 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 25 | 0 | 25 | 3 | @@ -195,7 +196,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) | - | 6 | 0 | 0 | 0 | -| | [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql) | - | 28 | 0 | 10 | 0 | +| | [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql) | - | 29 | 0 | 10 | 0 | | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | Elastic threat intelligence helps you see if you are open to or have been subject to current or historical known threats | 30 | 0 | 14 | 4 | | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 242 | 1 | 198 | 17 | | | [@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 | @@ -253,7 +254,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 18 | 0 | 18 | 0 | | | [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/teams/obs-ux-infra_services-team) | - | 4 | 0 | 4 | 0 | | | [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/teams/obs-ux-infra_services-team) | - | 49 | 0 | 49 | 8 | -| | [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/teams/obs-ux-infra_services-team) | - | 193 | 0 | 193 | 30 | +| | [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/teams/obs-ux-infra_services-team) | - | 191 | 0 | 191 | 30 | | | [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/teams/obs-ux-infra_services-team) | - | 11 | 0 | 11 | 0 | | | [@elastic/kibana-qa](https://github.com/orgs/elastic/teams/kibana-qa) | - | 12 | 0 | 12 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 4 | 0 | 1 | 0 | @@ -301,7 +302,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 5 | 0 | 0 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 20 | 0 | 7 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 6 | 0 | 6 | 0 | -| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 206 | 0 | 99 | 0 | +| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 207 | 0 | 100 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 3 | 0 | 3 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 4 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 8 | 0 | 8 | 0 | @@ -349,7 +350,7 @@ 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) | - | 54 | 7 | 54 | 6 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 13 | 0 | 13 | 1 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 486 | 2 | 193 | 0 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 487 | 2 | 193 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 92 | 0 | 79 | 10 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 44 | 0 | 43 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 2 | 0 | @@ -500,7 +501,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql) | - | 194 | 0 | 184 | 10 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 39 | 0 | 39 | 0 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 52 | 0 | 52 | 1 | -| | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 38 | 0 | 14 | 1 | +| | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 39 | 0 | 14 | 1 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 22 | 0 | 18 | 0 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 54 | 0 | 45 | 1 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 2 | 0 | 0 | 0 | @@ -628,7 +629,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/security-detections-response](https://github.com/orgs/elastic/teams/security-detections-response) | - | 125 | 0 | 122 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 2 | 0 | 2 | 0 | | | [@elastic/search-kibana](https://github.com/orgs/elastic/teams/search-kibana) | - | 76 | 0 | 76 | 0 | -| | [@elastic/search-kibana](https://github.com/orgs/elastic/teams/search-kibana) | - | 3688 | 0 | 3688 | 0 | +| | [@elastic/search-kibana](https://github.com/orgs/elastic/teams/search-kibana) | - | 3687 | 0 | 3687 | 0 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 18 | 1 | 17 | 1 | | | [@elastic/search-kibana](https://github.com/orgs/elastic/teams/search-kibana) | - | 25 | 0 | 25 | 0 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 20 | 0 | 18 | 1 | @@ -717,7 +718,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 25 | 0 | 13 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 131 | 3 | 98 | 2 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 2 | 0 | 1 | 0 | -| | [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql) | - | 32 | 0 | 13 | 0 | +| | [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql) | - | 33 | 0 | 13 | 0 | | | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | - | 8 | 0 | 8 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 72 | 0 | 55 | 0 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 11 | 0 | 11 | 0 | @@ -731,6 +732,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 18 | 0 | 17 | 5 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | Contains functionality for the field list and field stats which can be integrated into apps | 313 | 0 | 284 | 8 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 13 | 0 | 9 | 0 | +| | [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kibana-management) | - | 2 | 0 | 2 | 0 | | | [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) | - | 3 | 0 | 2 | 1 | | | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | - | 81 | 1 | 21 | 2 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 37 | 0 | 16 | 1 | diff --git a/api_docs/presentation_panel.mdx b/api_docs/presentation_panel.mdx index db707a4ec3471..0a9da0e29fce2 100644 --- a/api_docs/presentation_panel.mdx +++ b/api_docs/presentation_panel.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/presentationPanel title: "presentationPanel" image: https://source.unsplash.com/400x175/?github description: API docs for the presentationPanel plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationPanel'] --- import presentationPanelObj from './presentation_panel.devdocs.json'; diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index d013bb58ab26e..008e2a95c7479 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] --- import presentationUtilObj from './presentation_util.devdocs.json'; diff --git a/api_docs/profiling.mdx b/api_docs/profiling.mdx index 826f6e45a1d74..6b9b9c5de04ec 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'profiling'] --- import profilingObj from './profiling.devdocs.json'; diff --git a/api_docs/profiling_data_access.mdx b/api_docs/profiling_data_access.mdx index 204b381b1383b..33b67254bf2d8 100644 --- a/api_docs/profiling_data_access.mdx +++ b/api_docs/profiling_data_access.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/profilingDataAccess title: "profilingDataAccess" image: https://source.unsplash.com/400x175/?github description: API docs for the profilingDataAccess plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'profilingDataAccess'] --- import profilingDataAccessObj from './profiling_data_access.devdocs.json'; diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index 1ee800df85f26..4c5f2773f9463 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: 2024-06-06 +date: 2024-06-09 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 c38f92541b09a..a47819a05a914 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: 2024-06-06 +date: 2024-06-09 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 0569c2c01e3e2..b7e4bd038d4e5 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: 2024-06-06 +date: 2024-06-09 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 f969ce1574c60..193ca74904596 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: 2024-06-06 +date: 2024-06-09 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 74a8d8a7a1ba8..6ce3d8241b685 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: 2024-06-06 +date: 2024-06-09 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 1791c0beae57b..7bcd7c3897197 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: 2024-06-06 +date: 2024-06-09 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 076ff3f35e2dc..a7b8ef5f9c827 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: 2024-06-06 +date: 2024-06-09 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 e8a1026f13f94..984ad05b39985 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: 2024-06-06 +date: 2024-06-09 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 ccbce95fbc9d4..f9e4094b569b6 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: 2024-06-06 +date: 2024-06-09 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 84188cc926cad..c068a9c6c346e 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: 2024-06-06 +date: 2024-06-09 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 0e257da552da6..22b78f2ba90ce 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: 2024-06-06 +date: 2024-06-09 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 26eed5b8b3fcd..c969d8d82ba4c 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: 2024-06-06 +date: 2024-06-09 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 cc151e111de88..faae08ed3454a 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting'] --- import screenshottingObj from './screenshotting.devdocs.json'; diff --git a/api_docs/search_connectors.mdx b/api_docs/search_connectors.mdx index 2a986d7a569ac..01a3dc55800d5 100644 --- a/api_docs/search_connectors.mdx +++ b/api_docs/search_connectors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/searchConnectors title: "searchConnectors" image: https://source.unsplash.com/400x175/?github description: API docs for the searchConnectors plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'searchConnectors'] --- import searchConnectorsObj from './search_connectors.devdocs.json'; diff --git a/api_docs/search_notebooks.mdx b/api_docs/search_notebooks.mdx index df57e01953c6d..33bcc83b93b5c 100644 --- a/api_docs/search_notebooks.mdx +++ b/api_docs/search_notebooks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/searchNotebooks title: "searchNotebooks" image: https://source.unsplash.com/400x175/?github description: API docs for the searchNotebooks plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'searchNotebooks'] --- import searchNotebooksObj from './search_notebooks.devdocs.json'; diff --git a/api_docs/search_playground.mdx b/api_docs/search_playground.mdx index 7193bb57cce73..02e263877a79b 100644 --- a/api_docs/search_playground.mdx +++ b/api_docs/search_playground.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/searchPlayground title: "searchPlayground" image: https://source.unsplash.com/400x175/?github description: API docs for the searchPlayground plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'searchPlayground'] --- import searchPlaygroundObj from './search_playground.devdocs.json'; diff --git a/api_docs/security.devdocs.json b/api_docs/security.devdocs.json index de0e3c09debb7..99dea9ea6157f 100644 --- a/api_docs/security.devdocs.json +++ b/api_docs/security.devdocs.json @@ -1236,10 +1236,12 @@ "parentPluginId": "security", "id": "def-public.SecurityPluginSetup.authc", "type": "Object", - "tags": [], + "tags": [ + "deprecated" + ], "label": "authc", "description": [ - "\nExposes authentication information about the currently logged in user." + "\nExposes authentication information about the currently logged in user.\n" ], "signature": [ { @@ -1251,8 +1253,18 @@ } ], "path": "x-pack/packages/security/plugin_types_public/src/plugin.ts", - "deprecated": false, - "trackAdoption": false + "deprecated": true, + "trackAdoption": false, + "references": [ + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/filebeat_config_flyout/filebeat_config_flyout.tsx" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts" + } + ] }, { "parentPluginId": "security", @@ -5415,10 +5427,12 @@ "parentPluginId": "security", "id": "def-server.SecurityPluginStart.authc", "type": "Object", - "tags": [], + "tags": [ + "deprecated" + ], "label": "authc", "description": [ - "\nAuthentication services to confirm the user is who they say they are." + "\nAuthentication services to confirm the user is who they say they are.\n" ], "signature": [ { @@ -5430,8 +5444,326 @@ } ], "path": "x-pack/packages/security/plugin_types_server/src/plugin.ts", - "deprecated": false, - "trackAdoption": false + "deprecated": true, + "trackAdoption": false, + "references": [ + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/lib/action_executor.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/rules_client_factory.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/rules_client_factory.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/rules_client_factory.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/rules_settings_client_factory.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/maintenance_window_client_factory.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/invalidate_pending_api_keys/task.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/plugin.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/plugin.ts" + }, + { + "plugin": "files", + "path": "src/plugins/files/server/routes/file_kind/create.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/client/factory.ts" + }, + { + "plugin": "observabilityAIAssistant", + "path": "x-pack/plugins/observability_solution/observability_ai_assistant/server/service/index.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/security/security.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/api_keys/transform_api_keys.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/api_keys/security.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/package_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/package_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/package_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/package_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/package_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/epm/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/epm/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/epm/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/epm/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/epm/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/setup/fleet_server_policies_enrollment_keys.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/setup/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/settings/index.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/agent_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/agent_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/agent_policy/handlers.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/agent_policy/handlers.ts" + }, + { + "plugin": "cloudDefend", + "path": "x-pack/plugins/cloud_defend/server/routes/setup_routes.ts" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/server/routes/setup_routes.ts" + }, + { + "plugin": "elasticAssistant", + "path": "x-pack/plugins/elastic_assistant/server/routes/request_context_factory.ts" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/server/lib/indices/create_api_key.ts" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/server/routes/enterprise_search/api_keys.ts" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/server/routes/enterprise_search/api_keys.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/server/get_user.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/live_query/create_live_query_route.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/saved_query/create_saved_query_route.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/saved_query/update_saved_query_route.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/pack/create_pack_route.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/pack/update_pack_route.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/asset/update_assets_route.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/endpoint_app_context_services.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/file_info_handler.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/file_download_handler.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.ts" + }, + { + "plugin": "reporting", + "path": "x-pack/plugins/reporting/server/routes/common/get_user.ts" + }, + { + "plugin": "serverlessSearch", + "path": "x-pack/plugins/serverless_search/server/routes/api_key_routes.ts" + }, + { + "plugin": "serverlessSearch", + "path": "x-pack/plugins/serverless_search/server/routes/api_key_routes.ts" + }, + { + "plugin": "serverlessSearch", + "path": "x-pack/plugins/serverless_search/server/routes/indices_routes.ts" + }, + { + "plugin": "transform", + "path": "x-pack/plugins/transform/server/routes/api/reauthorize_transforms/route_handler_factory.ts" + }, + { + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/server/lib/reindexing/credential_store.ts" + }, + { + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/server/lib/reindexing/credential_store.ts" + }, + { + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/server/lib/reindexing/credential_store.ts" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/observability_solution/apm/server/lib/helpers/get_random_sampler/index.ts" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/observability_solution/apm/server/routes/agent_keys/get_agent_keys_privileges.ts" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/observability_solution/apm/server/routes/fleet/is_superuser.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/synthetics_service/get_api_key.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/routes/synthetics_service/enablement.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/observability_solution/synthetics/server/routes/synthetics_service/enablement.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/setup/handlers.test.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/setup/handlers.test.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/setup/handlers.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/state.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/endpoint/routes/suggestions/index.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lists_integration/endpoint/validators/base_validator.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts" + } + ] }, { "parentPluginId": "security", @@ -5459,10 +5791,12 @@ "parentPluginId": "security", "id": "def-server.SecurityPluginStart.userProfiles", "type": "Object", - "tags": [], + "tags": [ + "deprecated" + ], "label": "userProfiles", "description": [ - "\nUser profiles services to retrieve user profiles." + "\nUser profiles services to retrieve user profiles.\n" ], "signature": [ { @@ -5474,8 +5808,30 @@ } ], "path": "x-pack/packages/security/plugin_types_server/src/plugin.ts", - "deprecated": false, - "trackAdoption": false + "deprecated": true, + "trackAdoption": false, + "references": [ + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/services/notifications/email_notification_service.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/client/factory.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/client/cases/utils.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/services/user_profiles/index.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/users/suggest_user_profiles_route.ts" + } + ] } ], "lifecycle": "start", diff --git a/api_docs/security.mdx b/api_docs/security.mdx index 2911962fdc47d..d3fd2b74d03e9 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: 2024-06-06 +date: 2024-06-09 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 fab3dc4fe730f..5a245e3e9a6a7 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution'] --- import securitySolutionObj from './security_solution.devdocs.json'; diff --git a/api_docs/security_solution_ess.mdx b/api_docs/security_solution_ess.mdx index a38a8cdc20c2f..41afe2cdb0b90 100644 --- a/api_docs/security_solution_ess.mdx +++ b/api_docs/security_solution_ess.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/securitySolutionEss title: "securitySolutionEss" image: https://source.unsplash.com/400x175/?github description: API docs for the securitySolutionEss plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolutionEss'] --- import securitySolutionEssObj from './security_solution_ess.devdocs.json'; diff --git a/api_docs/security_solution_serverless.mdx b/api_docs/security_solution_serverless.mdx index 23cf506af5a54..b3a05192f2021 100644 --- a/api_docs/security_solution_serverless.mdx +++ b/api_docs/security_solution_serverless.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/securitySolutionServerless title: "securitySolutionServerless" image: https://source.unsplash.com/400x175/?github description: API docs for the securitySolutionServerless plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolutionServerless'] --- import securitySolutionServerlessObj from './security_solution_serverless.devdocs.json'; diff --git a/api_docs/serverless.mdx b/api_docs/serverless.mdx index e7efab4689612..fe9adee2be44e 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: 2024-06-06 +date: 2024-06-09 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 923ac382e645a..b72994040a5b0 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: 2024-06-06 +date: 2024-06-09 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 e68810fcd7113..a8bfd71e31802 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'serverlessSearch'] --- import serverlessSearchObj from './serverless_search.devdocs.json'; diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index 2516bf08dc03e..c81a3ac6aa8fc 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: 2024-06-06 +date: 2024-06-09 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 90e97c034bb12..5c1a049a9553b 100644 --- a/api_docs/share.devdocs.json +++ b/api_docs/share.devdocs.json @@ -1310,6 +1310,20 @@ "trackAdoption": false, "children": [], "returnComment": [] + }, + { + "parentPluginId": "share", + "id": "def-public.ShowShareMenuOptions.publicAPIEnabled", + "type": "CompoundType", + "tags": [], + "label": "publicAPIEnabled", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/share/public/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false diff --git a/api_docs/share.mdx b/api_docs/share.mdx index b9095535c3df7..30b38f1e212f8 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: 2024-06-06 +date: 2024-06-09 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 | |-------------------|-----------|------------------------|-----------------| -| 120 | 0 | 59 | 12 | +| 121 | 0 | 60 | 12 | ## Client diff --git a/api_docs/slo.devdocs.json b/api_docs/slo.devdocs.json index 24f688d1fc486..af855a896ee0d 100644 --- a/api_docs/slo.devdocs.json +++ b/api_docs/slo.devdocs.json @@ -1262,7 +1262,7 @@ }, "<", "CreateSLOForm", - "<{ type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; field?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }; }>> | undefined; }) => JSX.Element; }" + "<{ type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.synthetics.availability\"; params: { monitorIds: { value: string; label: string; }[]; index: string; } & { tags?: { value: string; label: string; }[] | undefined; projects?: { value: string; label: string; }[] | undefined; filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; good: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; total: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.custom\"; params: { index: string; good: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; total: { metrics: (({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.metric.timeslice\"; params: { index: string; metric: { metrics: (({ name: string; aggregation: \"min\" | \"max\" | \"sum\" | \"avg\" | \"last_value\" | \"cardinality\" | \"std_deviation\"; field: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"doc_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ name: string; aggregation: \"percentile\"; field: string; percentile: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }))[]; equation: string; threshold: number; comparator: \"GT\" | \"GTE\" | \"LT\" | \"LTE\"; }; timestampField: string; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; }); } & { filter?: string | { kqlQuery: string; filters: { meta: { alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; field?: string | undefined; params?: any; value?: string | undefined; }; query: { [x: string]: any; }; }[]; } | undefined; dataViewId?: string | undefined; }; }>> | undefined; }) => JSX.Element; }" ], "path": "x-pack/plugins/observability_solution/slo/public/types.ts", "deprecated": false, @@ -1541,6 +1541,26 @@ "path": "x-pack/plugins/observability_solution/slo/server/plugin.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "slo", + "id": "def-server.PluginStart.dataViews", + "type": "Object", + "tags": [], + "label": "dataViews", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.DataViewsServerPluginStart", + "text": "DataViewsServerPluginStart" + } + ], + "path": "x-pack/plugins/observability_solution/slo/server/plugin.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false diff --git a/api_docs/slo.mdx b/api_docs/slo.mdx index ca6a87beb8b74..5ea952f9031f0 100644 --- a/api_docs/slo.mdx +++ b/api_docs/slo.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/slo title: "slo" image: https://source.unsplash.com/400x175/?github description: API docs for the slo plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'slo'] --- import sloObj from './slo.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/ | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 64 | 0 | 64 | 1 | +| 65 | 0 | 65 | 1 | ## Client diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index 66b3b093277c2..f3164b454e7f8 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: 2024-06-06 +date: 2024-06-09 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 1f2a374948e46..ceb3861f5d559 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: 2024-06-06 +date: 2024-06-09 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 5d00650229d2e..1397892a81282 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: 2024-06-06 +date: 2024-06-09 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 75871df63616f..4d3b89e38792b 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: 2024-06-06 +date: 2024-06-09 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 b71c872b63228..5ebf761e41b05 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] --- import taskManagerObj from './task_manager.devdocs.json'; diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index 22a07f83ae2b9..7d071ffa0630a 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: 2024-06-06 +date: 2024-06-09 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 b80602206f17b..3a53e7f4d43b9 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: 2024-06-06 +date: 2024-06-09 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 04a7eb993f57a..a678c86073d70 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: 2024-06-06 +date: 2024-06-09 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 eb553c6cb8473..596a50a44a22b 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: 2024-06-06 +date: 2024-06-09 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 index 1be2693fa3a2d..3718cadcdf195 100644 --- a/api_docs/text_based_languages.devdocs.json +++ b/api_docs/text_based_languages.devdocs.json @@ -459,6 +459,22 @@ "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "textBasedLanguages", + "id": "def-public.TextBasedLanguagesEditorProps.hideHeaderWhenExpanded", + "type": "CompoundType", + "tags": [], + "label": "hideHeaderWhenExpanded", + "description": [ + "hide header buttons when editor is expanded" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-text-based-editor/src/text_based_languages_editor.tsx", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false diff --git a/api_docs/text_based_languages.mdx b/api_docs/text_based_languages.mdx index 9cc1ef21f829b..78e1ae0448be5 100644 --- a/api_docs/text_based_languages.mdx +++ b/api_docs/text_based_languages.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/textBasedLanguages title: "textBasedLanguages" image: https://source.unsplash.com/400x175/?github description: API docs for the textBasedLanguages plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'textBasedLanguages'] --- import textBasedLanguagesObj from './text_based_languages.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 28 | 0 | 10 | 0 | +| 29 | 0 | 10 | 0 | ## Client diff --git a/api_docs/threat_intelligence.mdx b/api_docs/threat_intelligence.mdx index a7faf873a2626..7112110df1e36 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: 2024-06-06 +date: 2024-06-09 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 facd2c78b184a..d55c20d2c1383 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: 2024-06-06 +date: 2024-06-09 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 47df9fe1655e1..d26fe085260c8 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform'] --- import transformObj from './transform.devdocs.json'; diff --git a/api_docs/triggers_actions_ui.devdocs.json b/api_docs/triggers_actions_ui.devdocs.json index 5d620f4757d8a..d546fabae08c8 100644 --- a/api_docs/triggers_actions_ui.devdocs.json +++ b/api_docs/triggers_actions_ui.devdocs.json @@ -8056,7 +8056,7 @@ "EuiDataGridCellPopoverElementProps", " & { alert: ", "EcsFieldsResponse", - "; }) => React.ReactNode | JSX.Element) | undefined; } & Omit React.ReactNode | JSX.Element) | undefined; emptyStateHeight?: \"short\" | \"tall\" | undefined; } & Omit, \"renderCellPopover\"> & ", "LazyLoadProps", @@ -8114,7 +8114,7 @@ "EuiDataGridCellPopoverElementProps", " & { alert: ", "EcsFieldsResponse", - "; }) => React.ReactNode | JSX.Element) | undefined; } & Omit React.ReactNode | JSX.Element) | undefined; emptyStateHeight?: \"short\" | \"tall\" | undefined; } & Omit, \"renderCellPopover\"> & ", "LazyLoadProps" diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index 4992388476b3a..14fe30ece8a3f 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: 2024-06-06 +date: 2024-06-09 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 cbe4bd15cc1ad..deccdca033191 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: 2024-06-06 +date: 2024-06-09 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 1c47d7d114bd9..24c24ce2ab5ad 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] --- import uiActionsEnhancedObj from './ui_actions_enhanced.devdocs.json'; diff --git a/api_docs/unified_doc_viewer.mdx b/api_docs/unified_doc_viewer.mdx index bdfcc152f2d0a..217c697cfb4cd 100644 --- a/api_docs/unified_doc_viewer.mdx +++ b/api_docs/unified_doc_viewer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedDocViewer title: "unifiedDocViewer" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedDocViewer plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedDocViewer'] --- import unifiedDocViewerObj from './unified_doc_viewer.devdocs.json'; diff --git a/api_docs/unified_histogram.mdx b/api_docs/unified_histogram.mdx index b4e7b989c91f4..dc763173c3eaf 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: 2024-06-06 +date: 2024-06-09 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 5fddd517e309f..4f6795d5b5607 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: 2024-06-06 +date: 2024-06-09 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 d5ead98c51877..11c412489d621 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] --- import unifiedSearchAutocompleteObj from './unified_search_autocomplete.devdocs.json'; diff --git a/api_docs/uptime.mdx b/api_docs/uptime.mdx index c76eef63d9490..6351049b9f3b2 100644 --- a/api_docs/uptime.mdx +++ b/api_docs/uptime.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/uptime title: "uptime" image: https://source.unsplash.com/400x175/?github description: API docs for the uptime plugin -date: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uptime'] --- import uptimeObj from './uptime.devdocs.json'; diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index 4b30bd73f2032..e3434a5610e9f 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: 2024-06-06 +date: 2024-06-09 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 4ec70c04ca0a6..51bc8a3b72cb5 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: 2024-06-06 +date: 2024-06-09 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 411a483ea78d9..0c2be268b971b 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: 2024-06-06 +date: 2024-06-09 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 1f525a5f6e9ab..bf6c3b83ce223 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: 2024-06-06 +date: 2024-06-09 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 cfb9a3a94056f..59bd2962640ad 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: 2024-06-06 +date: 2024-06-09 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 ada490d897b58..38ae14f3fe1d9 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: 2024-06-06 +date: 2024-06-09 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 4233b06e61626..566a5cb230f19 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: 2024-06-06 +date: 2024-06-09 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 91402ff70afad..e686c164cc2c8 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: 2024-06-06 +date: 2024-06-09 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 9aa66ffcc42ab..b1112c91d1ced 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: 2024-06-06 +date: 2024-06-09 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 9951a7a6d1aa9..8abb00e34e12b 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: 2024-06-06 +date: 2024-06-09 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 f06c4a914da4c..007810b94ade1 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: 2024-06-06 +date: 2024-06-09 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 47b5154e27935..6616351c9793a 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: 2024-06-06 +date: 2024-06-09 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 e12e613c44b4f..7c21777a2c818 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] --- import visTypeXyObj from './vis_type_xy.devdocs.json'; diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index d8ed2b189500f..50191da233b39 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: 2024-06-06 +date: 2024-06-09 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] --- import visualizationsObj from './visualizations.devdocs.json'; diff --git a/config/serverless.yml b/config/serverless.yml index 6631441e3b5dd..cb4bbac7c92fa 100644 --- a/config/serverless.yml +++ b/config/serverless.yml @@ -157,9 +157,6 @@ elasticsearch.ignoreVersionMismatch: true # Limit maxSockets to 800 as we do in ESS, which improves reliability under high loads. elasticsearch.maxSockets: 800 -# Enable dynamic config to be updated via the internal HTTP requests -coreApp.allowDynamicConfigOverrides: true - # Visualizations editors readonly settings vis_type_gauge.readOnly: true vis_type_heatmap.readOnly: true diff --git a/dev_docs/key_concepts/encrypted_saved_objects.mdx b/dev_docs/key_concepts/encrypted_saved_objects.mdx new file mode 100644 index 0000000000000..9e737306a63af --- /dev/null +++ b/dev_docs/key_concepts/encrypted_saved_objects.mdx @@ -0,0 +1,405 @@ +--- +id: kibDevDocsEncryptedSavedObjectsIntro +slug: /kibana-dev-docs/key-concepts/encrypted-saved-objects-intro +title: Encrypted Saved Objects +description: Configure your saved object types to secure sensitive data. +date: 2024-05-21 +tags: ['kibana', 'dev', 'contributor', 'api docs'] +--- + +## Overview + +"Encrypted Saved Objects" (ESO) are that have been registered with the Encrypted Saved Objects +Service (ESO Service) to specify which attributes should be protected (encrypted attributes) and which attributes, if any, should be present and unchanged +in order to decrypt the protected attributes ("Additional Authenticated Data", or AAD). + +The ESO Service encrypts ESOs with the Encrypted Saved Object encryption key, a Kibana configuration setting. This setting must have a valid value for the ESO Service +to function. For more details see [Secure saved objects](https://www.elastic.co/guide/en/kibana/current/xpack-security-secure-saved-objects.html). When running in a +development environment, Kibana is always automatically configured with a static ESO encryption key of "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa". +As the ESO encryption key is an optional setting, developers should rely on the `canEncrypt` function exposed by the ESO Plugin to decide whether they should +gracefully degrade any functionality dependent on ESOs, or reject functioning entirely. + +Developers create and manage their Encrypted Saved Object types programmatically. This document will cover the basics. + +## Registering an Encrypted Saved Object Type + +### Should your Saved Object be an Encrypted Saved Object? + +Most Saved Object types do not need to be registered as an encrypted type. Only register a Saved Object type with the ESO service if it contains sensitive +information. What sort of information is considered sensitive? Here is a non-inclusive list to help you make a determination: + +- Credentials: usernames, passwords, API keys, access keys +- Personally identifiable information (PII): social security numbers or equivalent, back routing numbers, credit card numbers +- Other sensitive information: private endpoints, secrets, etc. + +When in doubt, consult with the Kibana Security team (Application Experience/Platform Services/Security). + +### Registration + +To register a Saved Object type, the type must first be registered with the Saved Objects Repository. This can be achieved by calling the Saved Object Service's +`registerType` function. More information can be found in the tutorial. Once the +Saved Object type is registered, use the ESO Plugin's `registerType` function, and provide an `EncryptedSavedObjectTypeRegistration` object that defines how the +object should be encrypted. + +```ts + export interface EncryptedSavedObjectTypeRegistration { + readonly type: string; // The name of the Saved Object type. This must match the name used to register the type with Core's Saved Object Service. + readonly attributesToEncrypt: ReadonlySet; // The attributes to protect (anything considered sensitive data) + readonly attributesToIncludeInAAD?: ReadonlySet; // The attributes to include in AAD (more on this below) + } +``` + +`attributesToEncrypt` can be defined by either a string matching the name of the attribute, or an `AttributeToEncrypt` object, which enables you to specify when +an attribute's value should be allowed to be "dangerously exposed". There are generally three use cases to consider regarding the accessing of encrypted values: + +1. By default, when ESOs are retrieved with any "standard" Saved Object Client APIs (e.g. get, find), decryption does not occur, and instead all encrypted +attributes are removed from the returned Saved Objects. +2. As a plugin developer, if you want to access decrypted attributes of ESOs, you should use the dedicated APIs exposed via the Encrypted Saved Objects Client (e.g. +`getDecryptedAsInternalUser`, `createPointInTimeFinderDecryptedAsInternalUser`). When using these functions, it is assumed that you will only consume decrypted +attributes internally and will not expose them to end users unless it is absolutely necessary. In this case, these APIs can serve as a way to conditionally expose +certain decrypted secrets in a controlled manner. +3. If decrypted attributes should be exposed to anyone who has access to the Saved Object itself, these ESO attributes should be registered with +`dangerouslyExposeValue: true`. This way, all "standard" Saved Object Client APIs will decrypt these corresponding encrypted attributes and return them to the +consumer. As the `dangerouslyExposeValue` name implies, the decision to expose decrypted attributes should be thoroughly evaluated and documented. + +### AAD + +AAD, or Additional Authenticated Data, is part of an "Authenticated Encryption" schema. AAD is an unencrypted string that is used during encryption and decryption +operations in addition to the supplied encryption key, to protect access to encrypted values. If AAD is used during encryption, it must be provided during decryption, +and must be an exact match to the AAD value used during encryption, otherwise decryption will fail. In this way, AAD is bound to any encrypted data. Typically, AAD +comprises data that could only be accessed by an authenticated user and either never changes, or only potentially changes when encrypted data changes. + +For ESOs, AAD is constructed of key-value pairs composed of the Saved Object Descriptor and any attributes included in `attributesToIncludeInAAD` when the ESO is +registered. The Saved Object Descriptor consists of the object type, ID, and, if applicable, namespace (or space ID). The descriptor for space-agnostic types +(`namespaceType: 'agnostic'`), and multi-namespace types (`namespaceType: 'multiple-isolated'` and `namespaceType: 'multiple'`), will not include a namespace. Thus, +the Saved Object Descriptor for a Saved Object never changes. + +```ts + export interface SavedObjectDescriptor { + readonly id: string; + readonly type: string; + readonly namespace?: string; + } +``` + +Any time an ESO's AAD changes (when any attribute that is included in AAD changes), all encrypted attributes of that ESO must be re-encrypted to account for the new AAD. +This is one reason why it is important to carefully consider whether an attribute should be included in AAD. More on this below in + + +#### Nested attributes + +When an attribute is included in AAD, all of its properties, or subfields, are inherently included in AAD. When AAD is constructed as key-value pairs, the nested properties +of an attribute are all included in its value. In this way, AAD inclusion is hierarchical. If restructuring the attributes of an object to account for AAD hierarchical +inclusion is not possible or desireable, you can make use of more granular keys, e.g. `firstLevelAttribute.nestedFieldToInclude`. + +#### What attributes should be included in AAD + +Determining which attributes to include in AAD is not an exact science, however there are some basic guidelines. + +Good candidates for attributes to INCLUDE in AAD are attributes that... +- have some association or relationship with an encrypted attribute (e.g. a configuration element of an ESO that reflects the shape of the encrypted data, the token type of a connector, the URL or TLS certificate for a monitor) +- have a value that will never change once an object is created (e.g the created date or created by user, the type of action or connector) + +Good candidates for attributes to EXCLUDE from AAD are attributes that... + +- the value can be changed by an end user, and is meant to be updated separately from encrypted data, and has no association to any of the encrypted or AAD attributes (e.g. the name or UI properties of an object, the email title for an action or alert) +- may not be present or populated, or populated algorithmically (e.g. any optional attributes, or calculated attributes like statistics or last updated time) +- may be removed from the object or refactored in the future (e.g. deprecated or soon-to-be deprecated attributes, experimental attributes) +- contain a large amount of data that can significantly slow down encryption and decryption, especially during bulk operations (e.g. large geo shape, arbitrary HTML document or image data) + +There are additional considerations to make due to how version upgrades work in Serverless. These are covered in more detail in the + section, but the basics are: + +- An attribute cannot be removed from AAD once it is included, unless it can be altogether removed from the object type, or refactored with a new name. +- An existing attribute cannot be added to AAD if it was not included in AAD when it was first defined and has already been populated. + +When making the decision of which attributes to include in AAD, it is best to be conservative and only include attributes that the owning team is 100% confident +should be included. + +## Caveats + +### Partial Updates + +Partial updates on ESOs are only possible if the changes are limited to unencrypted and non-AAD attributes. Any changes to an ESO's encrypted values or AAD- +included values requires re-encryption, which means the entire object must be provided when updating to avoid corrupting the object. If an ESO is corrupted by +a partial update, it will be effectively undecryptable. Currently, there is nothing preventing or limiting partial updates of ESOs (see open GitHub issue +[50256](https://github.com/elastic/kibana/issues/50256)), so this requires consistent diligence from developers utilizing ESOs. + +### Migrations, Backward compatibility, and Serverless + +With time you may need to change your ESO types. Model Versions allow developers to make versioned changes to Saved Object types, but an ESO type requires special +handling if there are changes to its encrypted attributes or attributes that are included in AAD - in both cases an object must be re-encrypted. For this case the +ESO Service exposes a Model Version wrapper function API `createModelVersion`. Similar in utility to its predecessor (`createMigration` - used with non-Model Version +Saved Object legacy migrations), `createModelVersion` provides a way to wrap a Model Version definition such that decryption and encryption occur automatically +during migration of any applicable ESOs. + +In addition to a Model Version definition, `createModelVersion` also requires both an "input type" and "output type" `EncryptedSavedObjectTypeRegistration` +input parameters. + +```ts +export interface CreateEsoModelVersionFnOpts { + modelVersion: SavedObjectsModelVersion; + shouldTransformIfDecryptionFails?: boolean; + inputType: EncryptedSavedObjectTypeRegistration; + outputType: EncryptedSavedObjectTypeRegistration; +} +``` + +The `inputType` parameter provides the necessary ESO registration definition for decrypting an ESO of the preceding Model Version prior to performing any transforms +defined by the Model Version. The `outputType` parameter provides the necessary ESO registration definition for encrypting an ESO once the transforms defined in the +Model Version have been completed. All of the Model Version transform functions ('unsafe_transform', 'data_backfill', 'data_removal'), are merged into a single +transform function for efficiency. This way, each ESO only needs to be decrypted and re-encrypted once to incorporate all of the changes defined in a Model Version. +The optional `shouldTransformIfDecryptionFails` parameter defines whether an ESO type should proceed with the Model Version changes even if decryption fails. + +Some examples of `createModelVersion` can be found in the ESO Model Version example plugin ( +[examples/eso_model_version_example/server/plugin.ts](https://github.com/elastic/kibana/blob/06fc22a0f15e692857ba689a7b0ddec91ed2dac2/examples/eso_model_version_example/server/plugin.ts)) + +For more information see our developer documentation for . + +#### Serverless Considerations + +Changes to ESOs must be carefully considered due to how upgrades occur for Serverless projects. In Serverless, there is a "Zero Downtime" (ZDT) upgrade algorithm. This +means that both the latest and previous versions of Kibana may be running simultaneously. In regard to ESOs, this means that the previous version of Kibana may attempt +to access ESOs that have been migrated by the latest version of Kibana, and in order to do so, must be able to decrypt them successfully without having any knowledge of +the new Model Version definition or changes to the ESO's `EncryptedSavedObjectTypeRegistration`. Thus, if an ESO's AAD has changed due to the migration, the previous +version will not be able to decrypt it. It is critical that when changes are made to an ESO, that they either do not affect its AAD or are staged carefully in +subsequent Model Versions. + +It is worth noting here that if a ESO's Model Version `forwardCompatibility` schema is set to drop unknown fields (when the `unknowns` option is set to `ignore`), +ESOs of this type will first be decrypted before the unknown fields are dropped. This more easily supports the hierarchical aspect of AAD-included attributes - when +subfields of an attribute are added or removed, the previous version of Kibana will still be able to successfully construct AAD and decrypt the object. + +The table below offers some general guidance on how various changes could be supported (or not). Keep in mind that any time you are adding or removing attributes from +a Saved Object type, all related business logic for that type must be capable of gracefully and appropriately handling an object with or without the attribute in both +the current and previous version of Kibana. Some of the advice here is applicable to any Saved Object type migration. + +| Change to ESO | Encrypted? | In AAD? | General Guidance | +| -------------------------------------------- | ---------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Add a new attribute | No | No | Implement a Model Version as needed. There is no need to wrap the Model Version with `createModelVersion` because AAD is unaffected. Implement a `forwardCompatibility` schema and ignore unknowns if the previous version of Kibana will not be able to tolerate the additional attribute. | +| Add a new attribute | No | Yes | This will require 2 Serverless release stages. `Release 1`: Add the attribute to the ESO's `attributesToIncludeInAAD`. Do not yet populate or use the new attribute. `Release 2`: Implement a Model Version and wrap it in a call to `createModelVersion`, providing the former `EncryptedSavedObjectTypeRegistration` as the input type, and the new `EncryptedSavedObjectTypeRegistration` as the output type. Implement a Model Version `backfill` change as needed. The attribute can safely be populated in this release. | +| Add a new attribute | Yes | N/A | Implement a Model Version and wrap it in a call to `createModelVersion`. Implement Model Version changes as needed. Implement a `forwardCompatibility` schema and ignore unknowns if the previous version of Kibana will not be able to tolerate additions to the attribute. | +| Add an existing attribute to AAD | No | No->Yes | This is not currently supported. Existing attributes that are in use and populated with data cannot be added to AAD. The previous version of Kibana will never be able to successfully perform decryption in this case. | +| Remove an existing attribute | No | No | Implement a Model Version as needed. There is no need to wrap the Model Version with `createModelVersion` because AAD is unaffected. If the previous version of Kibana will not be able to tolerate the missing attribute, this will require 2 Serverless release stages. `Release 1`: update all business logic to handle this type without the attribute that will be removed. `Release 2`: implement a Model Version as described. | +| Remove an existing attribute | No | Yes | Implement a Model Version and wrap it in a call to `createModelVersion`, providing the former `EncryptedSavedObjectTypeRegistration` as the input type, and the new `EncryptedSavedObjectTypeRegistration` as the output type. The previous version of Kibana will be able to decrypt objects without this attribute, as attributes that are not present are never included when constructing AAD. If the previous version of Kibana will not be able to tolerate the missing attribute, this will require 2 Serverless release stages. `Release 1`: update all business logic to handle this type without the attribute that will be removed. `Release 2`: implement a Model Version as described. | +| Remove an existing attribute | Yes | N/A | Implement a Model Version as needed. There is no need to wrap the Model Version with `createModelVersion` because AAD is unaffected. The previous version of Kibana will not throw an error if there is a missing encrypted attribute, but will add a debug-level log. If the previous version of Kibana will not be able to tolerate the missing attribute, this will require 2 Serverless release stages. `Release 1`: update all business logic to handle this type without the attribute that will be removed. `Release 2`: implement a Model Version as described. | +| Modify an attribute (add or remove subfield) | No | No | Implement a Model Version as needed. There is no need to wrap the Model Version with `createModelVersion` because AAD is unaffected. If the previous version of Kibana will not be able to tolerate the changes, this will require 2 Serverless release stages. `Release 1`: update all business logic to handle this type with the modified attribute. `Release 2`: implement a Model Version as described. | +| Modify an attribute (add or remove subfield) | No | Yes | Implement a Model Version and wrap it in a call to `createModelVersion`, providing the former `EncryptedSavedObjectTypeRegistration` as the input type, and the new `EncryptedSavedObjectTypeRegistration` as the output type. The previous version of Kibana will be able to decrypt objects with the changed attribute, as all subfields are inherent in the value of AAD-included attributes when constructing AAD. If the previous version of Kibana will not be able to tolerate the attribute changes, this will require 2 Serverless release stages. `Release 1`: update all business logic to handle this type with the modified attribute. `Release 2`: implement a Model Version as described. | +| Modify an attribute (add or remove subfield) | Yes | N/A | Implement a Model Version and wrap it in a call to `createModelVersion`. Implement Model Version changes as needed. Even though AAD is unaffected, the objects will require decryption and re-encryption to be modified. If the previous version of Kibana will not be able to tolerate the attribute changes, this will require 2 Serverless release stages. `Release 1`: update all business logic to handle this type with the modified attribute. `Release 2`: implement a Model Version as described. | +| Change an existing attribute to be encrypted | No->Yes | No/Yes | This is not currently supported. The previous version of Kibana will not decrypt this attribute, and any business logic that utilizes the attribute will fail. | +| Remove an attribute from the encrypted list | Yes->No | No | This is not currently supported. The previous version of Kibana will always attempt to decrypt the attribute. | +| Remove an attribute from AAD inclusion | No | Yes->No | This is not currently supported. The previous version of Kibana will always use the attribute to construct AAD. | + +## A real world example + +Let's examine one of the latest ESO types as of writing this document, the 'ad_hoc_run_params' type. We're using this type as an example, because it is one of the first +new ESO types to use a Model Version, and it is a fairly simple type (compared to other Model Version ESOs). + +### Registering the Saved Object type + +Below is the call to register the type. + +```ts + savedObjects.registerType({ + name: AD_HOC_RUN_SAVED_OBJECT_TYPE, // 'ad_hoc_run_params' + indexPattern: ALERTING_CASES_SAVED_OBJECT_INDEX, + hidden: true, + namespaceType: 'multiple-isolated', + mappings: { + dynamic: false, + properties: { + apiKeyId: { + type: 'keyword', + }, + createdAt: { + type: 'date', + }, + end: { + type: 'date', + }, + rule: { + properties: { + alertTypeId: { + type: 'keyword', + }, + consumer: { + type: 'keyword', + }, + }, + }, + start: { + type: 'date', + }, + }, + }, + management: { + importableAndExportable: false, + }, + modelVersions: adHocRunParamsModelVersions, + }); +``` +And here is what the Model Version and schemas look like: + +```ts + const adHocRunParamsModelVersions: CustomSavedObjectsModelVersionMap = { + '1': { + changes: [], + schemas: { + forwardCompatibility: rawAdHocRunParamsSchemaV1.extends({}, { unknowns: 'ignore' }), + create: rawAdHocRunParamsSchemaV1, + }, + isCompatibleWithPreviousVersion: () => true, + }, + }; + + const rawAdHocRunParamsSchema = schema.object({ + apiKeyId: schema.string(), + apiKeyToUse: schema.string(), + createdAt: schema.string(), + duration: schema.string(), + enabled: schema.boolean(), + end: schema.maybe(schema.string()), + rule: rawAdHocRunParamsRuleSchema, + spaceId: schema.string(), + start: schema.string(), + status: rawAdHocRunStatus, + schedule: schema.arrayOf(rawAdHocRunSchedule), + }); + + const rawAdHocRunParamsRuleSchema = schema.object({ + name: schema.string(), + tags: schema.arrayOf(schema.string()), + alertTypeId: schema.string(), + params: schema.recordOf(schema.string(), schema.maybe(schema.any())), + apiKeyOwner: schema.nullable(schema.string()), + apiKeyCreatedByUser: schema.maybe(schema.nullable(schema.boolean())), + consumer: schema.string(), + enabled: schema.boolean(), + schedule: schema.object({ + interval: schema.string(), + }), + createdBy: schema.nullable(schema.string()), + updatedBy: schema.nullable(schema.string()), + updatedAt: schema.string(), + createdAt: schema.string(), + revision: schema.number(), + }); + + const rawAdHocRunStatus = schema.oneOf([ + schema.literal('complete'), + schema.literal('pending'), + schema.literal('running'), + schema.literal('error'), + schema.literal('timeout'), + ]); + + const rawAdHocRunSchedule = schema.object({ + interval: schema.string(), + status: rawAdHocRunStatus, + runAt: schema.string(), + }); +``` + +### Registering the type as an Encrypted Saved Object + +```ts + encryptedSavedObjects.registerType({ + type: AD_HOC_RUN_SAVED_OBJECT_TYPE, // 'ad_hoc_run_params' - the type name must match + attributesToEncrypt: new Set(['apiKeyToUse']), + attributesToIncludeInAAD: new Set(['rule', 'spaceId']), + }); +``` + +There is only one encrypted attribute, `apiKeyToUse`, which contains the API key that needs to be protected. The attributes to include in AAD consist of the `spaceId`, +and the `rule` definition. Since the object's namespace type is `'multiple-isolated'`, the space ID (or namespace) will not automatically be part of AAD by way of the +Saved Object Descriptor (see ). In theory, the space id will never change for a +`'multiple-isolated'`, which makes it a reasonable candidate for an AAD field. + +The `rule` attribute contains values related to the encrypted attribute `apiKeyToUse`, or that will never change: + +```ts + apiKeyOwner: schema.nullable(schema.string()), + apiKeyCreatedByUser: schema.maybe(schema.nullable(schema.boolean())), + createdBy: schema.nullable(schema.string()), + createdAt: schema.string(), +``` + +The above are prime examples of the type of attributes that should comprise AAD. The `rule` attribute also contains some attributes that may change independently of the +encrypted attribute `apiKeyToUse`: + +```ts + enabled: schema.boolean(), + schedule: schema.object({ + interval: schema.string(), + }), + updatedBy: schema.nullable(schema.string()), + updatedAt: schema.string(), + revision: schema.number(), +``` + +This is not a problem, but it is important to consider that a change to any of these attributes will require re-encryption of an object. It is worth considering the nature +of AAD hierarchical inclusion when structuring attributes for your saved objects. You can also utilize more granular keys when specifying which attributes to include in AAD, +e.g. `rule.apiKeyOwner`. For more information, see the section of +this document. + +Additionally, the owning team implemented a type to help manage partial updates. This is a great addition to ensure changes to the ESOs do not render them undecryptable. + +```ts +export type AdHocRunAttributesNotPartiallyUpdatable = 'rule' | 'spaceId' | 'apiKeyToUse'; +``` + +Usage: +```ts +export type PartiallyUpdateableAdHocRunAttributes = Partial< + Omit +>; + +interface PartiallyUpdateAdHocRunSavedObjectOptions { + refresh?: SavedObjectsUpdateOptions['refresh']; + version?: string; + ignore404?: boolean; + namespace?: string; // only should be used with ISavedObjectsRepository +} + +// typed this way so we can send a SavedObjectClient or SavedObjectRepository +type SavedObjectClientForUpdate = Pick; + +export async function partiallyUpdateAdHocRun( + savedObjectsClient: SavedObjectClientForUpdate, + id: string, + attributes: PartiallyUpdateableAdHocRunAttributes, + options: PartiallyUpdateAdHocRunSavedObjectOptions = {} +): Promise { + // ensure we only have the valid attributes that are not encrypted and are excluded from AAD + const attributeUpdates = omit(attributes, [ + ...AdHocRunAttributesToEncrypt, + ...AdHocRunAttributesIncludedInAAD, + ]); + const updateOptions: SavedObjectsUpdateOptions = pick( + options, + 'namespace', + 'version', + 'refresh' + ); + + try { + await savedObjectsClient.update( + AD_HOC_RUN_SAVED_OBJECT_TYPE, + id, + attributeUpdates, + updateOptions + ); + } catch (err) { + if (options?.ignore404 && SavedObjectsErrorHelpers.isNotFoundError(err)) { + return; + } + throw err; + } +} +``` + +## Making Changes + +If you will be making changes to your ESOs, or creating new ESOs, the AppEx Platform Services Security team is available for consultation and assistance. Please reach +out to us on Slack (#kibana-security) with any questions or queries. + +We also ask that you please tag us (@elastic/kibana-security) for review on any PRs related to ESOs. \ No newline at end of file diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index e6b980a459f15..451d978c04828 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -638,6 +638,10 @@ the infrastructure monitoring use-case within Kibana. |The ingest_pipelines plugin provides Kibana support for Elasticsearch's ingest pipelines. +|{kib-repo}blob/{branch}/x-pack/plugins/observability_solution/investigate/README.md[investigate] +|undefined + + |{kib-repo}blob/{branch}/x-pack/plugins/kubernetes_security/README.md[kubernetesSecurity] |This plugin provides interactive visualizations of your Kubernetes workload and session data. diff --git a/package.json b/package.json index ca17249520735..4949f98aca52b 100644 --- a/package.json +++ b/package.json @@ -84,6 +84,7 @@ "**/@types/node": "20.10.5", "**/@typescript-eslint/utils": "5.62.0", "**/chokidar": "^3.5.3", + "**/d3-scale/**/d3-color": "npm:@elastic/d3-color@2.0.1", "**/globule/minimatch": "^3.1.2", "**/hoist-non-react-statics": "^3.3.2", "**/isomorphic-fetch/node-fetch": "^2.6.7", @@ -542,6 +543,7 @@ "@kbn/interactive-setup-plugin": "link:src/plugins/interactive_setup", "@kbn/interactive-setup-test-endpoints-plugin": "link:test/interactive_setup_api_integration/plugins/test_endpoints", "@kbn/interpreter": "link:packages/kbn-interpreter", + "@kbn/investigate-plugin": "link:x-pack/plugins/observability_solution/investigate", "@kbn/io-ts-utils": "link:packages/kbn-io-ts-utils", "@kbn/ipynb": "link:packages/kbn-ipynb", "@kbn/kbn-health-gateway-status-plugin": "link:test/health_gateway/plugins/status", @@ -887,6 +889,7 @@ "@kbn/unified-histogram-plugin": "link:src/plugins/unified_histogram", "@kbn/unified-search-plugin": "link:src/plugins/unified_search", "@kbn/unsaved-changes-badge": "link:packages/kbn-unsaved-changes-badge", + "@kbn/unsaved-changes-prompt": "link:packages/kbn-unsaved-changes-prompt", "@kbn/upgrade-assistant-plugin": "link:x-pack/plugins/upgrade_assistant", "@kbn/uptime-plugin": "link:x-pack/plugins/observability_solution/uptime", "@kbn/url-drilldown-plugin": "link:x-pack/plugins/drilldowns/url_drilldown", diff --git a/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx b/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx index a6b85e017e24a..0bb763ed9d57f 100644 --- a/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx +++ b/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx @@ -134,7 +134,7 @@ const AppLoadingPlaceholder: FC<{ showPlainSpinner: boolean }> = ({ showPlainSpi size={'xxl'} className="appContainer__loading" data-test-subj="appContainer-loadingSpinner" - aria-label={i18n.translate('core.application.appContainer.loadingAriaLabel', { + aria-label={i18n.translate('core.application.appContainer.plainSpinner.loadingAriaLabel', { defaultMessage: 'Loading application', })} /> diff --git a/packages/core/status/core-status-server-internal/src/legacy_status.ts b/packages/core/status/core-status-server-internal/src/legacy_status.ts index f154374d5470e..ac692b2b4876d 100644 --- a/packages/core/status/core-status-server-internal/src/legacy_status.ts +++ b/packages/core/status/core-status-server-internal/src/legacy_status.ts @@ -106,7 +106,7 @@ const STATUS_LEVEL_LEGACY_ATTRS = deepFreeze>({ [ServiceStatusLevels.critical.toString()]: { id: 'red', state: 'red', - title: i18n.translate('core.status.redTitle', { + title: i18n.translate('core.status.critical.redTitle', { defaultMessage: 'Red', }), icon: 'danger', @@ -116,7 +116,7 @@ const STATUS_LEVEL_LEGACY_ATTRS = deepFreeze>({ [ServiceStatusLevels.unavailable.toString()]: { id: 'red', state: 'red', - title: i18n.translate('core.status.redTitle', { + title: i18n.translate('core.status.unavailable.redTitle', { defaultMessage: 'Red', }), icon: 'danger', @@ -126,7 +126,7 @@ const STATUS_LEVEL_LEGACY_ATTRS = deepFreeze>({ [ServiceStatusLevels.degraded.toString()]: { id: 'yellow', state: 'yellow', - title: i18n.translate('core.status.yellowTitle', { + title: i18n.translate('core.status.degraded.yellowTitle', { defaultMessage: 'Yellow', }), icon: 'warning', @@ -136,7 +136,7 @@ const STATUS_LEVEL_LEGACY_ATTRS = deepFreeze>({ [ServiceStatusLevels.available.toString()]: { id: 'green', state: 'green', - title: i18n.translate('core.status.greenTitle', { + title: i18n.translate('core.status.available.greenTitle', { defaultMessage: 'Green', }), icon: 'success', diff --git a/packages/kbn-openapi-bundler/README.md b/packages/kbn-openapi-bundler/README.md index 0a096b3f28152..cfe165c49c447 100644 --- a/packages/kbn-openapi-bundler/README.md +++ b/packages/kbn-openapi-bundler/README.md @@ -3,19 +3,22 @@ `@kbn/openapi-bundler` is a tool for transforming multiple OpenAPI specification files (source specs) into a bundled specification file(s) (target spec). The number of resulting bundles depends on a number of versions used in the OpenAPI specification files. The package can be used for API documentation generation purposes. This approach allows you to: -- Abstract away the knowledge of where you keep your OpenAPI specs, how many specs are there, and how to find them. Consumer should only know where result files are located - the bundles. +- Abstract away the knowledge of where you keep your OpenAPI specs, how many specs are there, and how to find them. Consumer should only know where result files (bundles) are located. - Omit internal API endpoints from the bundle. - Omit API endpoints that are hidden behind a feature flag and haven't been released yet. - Omit parts of schemas that are hidden behind a feature flag (e.g. a new property added to an existing response schema). -- Omit custom OpenAPI attributes from the bundle, such as `x-codegen-enabled`, `x-internal`, and `x-modify` (see below). +- Omit custom OpenAPI attributes from the bundle, such as `x-codegen-enabled`, `x-internal`, `x-modify` and `x-labels`. +- Include only dedicated OpenAPI operation objects (a.k.a HTTP verbs) into the result bundle by labeling them via `x-labels` + and using `includeLabels` bundler option, e.g. produce separate ESS and Serverless bundles - Transform the target schema according to the custom OpenAPI attributes, such as `x-modify`. -- Resolve references, inline some of them and merge allOf object schemas for better readability. The bundled file contains only local references and paths. +- Resolve references, inline some of them and merge `allOf` object schemas for better readability. The bundled file contains only local references and paths. +- Group OpenAPI specs by version (OpenAPI's `info.version`) and produce a separate bundle for each group ## Getting started -To let this package help you with bundling your OpenAPI specifications you should have OpenAPI specification describing your API endpoint request and response schemas along with common types used in your API. Refer [@kbn/openapi-generator](../kbn-openapi-generator/README.md) and [OpenAPI 3.0.3](https://swagger.io/specification/v3/) (support for [OpenAPI 3.1.0](https://swagger.io/specification/) is planned to be added soon) for more details. +To let this package help you with bundling your OpenAPI specifications you should have OpenAPI specification describing your API endpoint request and response schemas along with common types used in your API. Refer [@kbn/openapi-generator](../kbn-openapi-generator/README.md) and [OpenAPI 3.0.3](https://swagger.io/specification/v3/) (support for [OpenAPI 3.1.0](https://swagger.io/specification/) is planned to be added later) for more details. -Following recommendations provided in `@kbn/openapi-generator` you should have OpenAPI specs defined under a common folder something like `my-plugin/common/api`. +Following the recommendations provided in `@kbn/openapi-generator` you should have OpenAPI specs defined under a common folder something like `my-plugin/common/api`. Currently package supports only programmatic API. As the next step you need to create a JavaScript script file like below and put it to `my-plugin/scripts/openapi` @@ -29,15 +32,28 @@ const { join, resolve } = require('path'); const ROOT = resolve(__dirname, '../..'); bundle({ - // Root path e.g. plugin root directory - rootDir: ROOT, - // Glob pattern to find OpenAPI specification files, relative to `rootDir` - sourceGlob: './**/*.schema.yaml', + // Glob pattern to find OpenAPI specification files + sourceGlob: join(ROOT, './**/*.schema.yaml'), // Output file path. Absolute or related to the node.js working directory. // It may contain `{version}` placeholder which is optional. `{version}` placeholder - // will be replaced with the bundled specs version or filename will be prepended with - // version when placeholder is omitted, e.g. `2023-10-31-my-plugin.bundled.schema.yaml`. - outputFilePath: join(ROOT, 'target/openapi/my-plugin-{version}.bundled.schema.yaml'), + // will be replaced with the bundled specs version. In case the placeholder is omitted + // resulting bundle's filename will be prepended with a version, + // e.g. `2023-10-31-my-plugin.bundled.schema.yaml`. + outputFilePath: join(ROOT, 'target/openapi/my_bundle_name_{version}.bundled.schema.yaml'), + // OpenAPI info object (excluding `version` field) for the resulting bundle + // It allows to specify custom title like "My Domain API bundle" and description + specInfo: { + title: 'My Domain API bundle', + description: 'My description', + }, + // Bundler options (optional) + options: { + // Optional `includeLabels` allow to produce Serverless dedicated bundle by including only + // OpenAPI operations objects (a.k.a HTTP verbs) labeled with specified labels, e.g. `serverless`. + // It requires labeling relevant operations objects with labels you want to be included, in the example + // below it should be a `serverless` label. + includeLabels: ['serverless'], + }, }); ``` @@ -60,8 +76,10 @@ Finally you should be able to run OpenAPI bundler via yarn openapi:bundle ``` -This command will produce a bundled file `my-plugin/target/openapi/my-plugin.bundled.schema.yaml` containing -all specs matching `./**/*.schema.yaml` glob pattern. +This command will produce one or multiple bundled files like +`my-plugin/target/openapi/my_bundle_name_2023_10_31.bundled.schema.yaml` depending on how many +different versions (OpenAPI's `info.version`) were encountered in the processed bundles. +Produces bundles will contain corresponding specs matching `./**/*.schema.yaml` glob pattern. Here's an example how your source schemas can look like and the expected result @@ -76,6 +94,7 @@ info: paths: /api/path/to/endpoint: get: + x-labels: [ess, serverless] operationId: MyGetEndpoint responses: '200': @@ -97,6 +116,7 @@ info: paths: /api/path/to/endpoint: post: + x-labels: [serverless] x-internal: true operationId: MyPostEndpoint responses: @@ -108,13 +128,16 @@ paths: type: object ``` -And the target spec will look like +And the result bundle generated in `target/openapi/my_bundle_name_2023_10_31.bundled.schema.yaml` +will look like ```yaml openapi: 3.0.3 info: - title: Bundled specs file. See individual paths.verb.tags for details - version: not applicable + title: 'My Domain API bundle' + description: 'My description' + version: '2023-10-31' +servers: ... paths: /api/path/to/endpoint: get: @@ -136,17 +159,175 @@ paths: schema: type: object components: - schemas: {} + schemas: + securitySchemes: ... +``` + +## Multiple API versions declared via OpenAPI's `info.version` + +Serverless brought necessity for versioned HTTP API endpoints. We started with a single `2023-10-31` version. In some point +in time a group of API endpoints will need to bumps its version due to incompatible changes. In this case engineers need +to declare new version OpenAPI specs. + +OpenAPI specification doesn't provide a clear way to version API endpoints besides having different path prefix like `v1/`, +`v2/` and etc. De facto standard is to use OpenAPI's `info.version` to specify API endpoints version. [@kbn/openapi-generator](../kbn-openapi-generator/README.md) follows this pattern as well. + +OpenAPI specs bundling brings a challenge related to different API versions. When there is a necessity to bundle OpenAPI specs +describing different API versions then path clashing occurs. It's the case since multiple OpenAPI spec have the same path/HTTP verbs defined. A result bundle can have only one of them. OpenAPI specification doesn't provide a way to adopt HTTP header +versioning Kibana uses. + +To address this problem the bundler produces multiple bundles depending on how many distinct API versions were encountered +in `info.version`. Each bundle's name is prefixed with its version. `outputFilePath` provides flexibility to specify a +placeholder to the version via `{version}`. For example the following bundler configuration + +```js + +bundle({ + ... + outputFilePath: join(ROOT, 'my_path/my_bundle_name_{version}.bundled.schema.yaml'), + ... +}); ``` +will produce as many result bundles in `my_path` as many distinct API version in `info.version` were encountered, e.g. +`my_bundle_name_2023_10_31.bundled.schema.yaml` and `my_bundle_name_2024_01_01.bundled.schema.yaml` if there are only +two distinct version. + ## Supported custom (`x-` prefixed) properties OpenAPI specification allows to define custom properties. They can be used to describe extra functionality that is not covered by the standard OpenAPI Specification. We currently support the following custom properties +- [x-labels](#x-labels) - labels OpenAPI operation objects (a.k.a HTTP verbs), allows to produce separate ESS and Serverless bundles - [x-internal](#x-internal) - marks source spec nodes the bundler must NOT include in the target spec - [x-modify](#x-modify) - marks nodes to be modified by the bundler - [x-inline](#x-inline) - marks reference nodes to be inlined when bundled +### `x-labels` + +`x-labels` custom property allows to label OpenAPI operation objects (a.k.a HTTP verbs) with custom string labels like `label-a` or `myLabelB`. Without specifying bundling options By itself `x-labels` don't affect the resulting bundle. It works in conjunction with bundler's `options.includeXLables`. To tell the bundler which operation objects to include `options.includeXLables` should be set to +labels you expect to be in the resulting bundle. + +The primary goal of this feature is to make possible producing separate ESS and Serverless bundles. Taking this into account all +operation objects should be labeled by using `x-labels` custom property and `ess` and `serverless` labels. + +**Important** If `options.includeXLables` bundler's option is set then bundler will include **only** operation objects having specified labels. Operation objects without `x-labels` custom property or invalid `x-labels` value (an array of strings is expected) will be excluded from the resulting bundle. For example setting `options.includeXLables: ['ess']` will include only operation objects +having `ess` label like `x-labels: [ess]` and `x-labels: [ess, serverless, something-else]`. + +An example source spec looks like the following + +```yaml +openapi: 3.0.3 +info: + title: My endpoint + version: '2023-10-31' + +paths: + /api/path/to/endpoint: + get: + x-labels: [ess, serverless] + operationId: MyGetEndpoint + responses: + '200': + description: Successful response + content: + application/json: + schema: + type: object + /api/legacy/ess-only/api/endpoint + get: + x-labels: [ess] + operationId: MyGetEndpoint + responses: + '200': + description: Successful response + content: + application/json: + schema: + type: object +``` + +And the bundler configurations to bundle ESS and Serverless separately will look like + +```js +bundle({ + sourceGlob: join(ROOT, './**/*.schema.yaml'), + outputFilePath: join( + ROOT, + 'target/openapi/serverless/my_bundle_name_{version}.bundled.schema.yaml' + ), + options: { + includeLabels: ['serverless'], + }, +}); + +bundle({ + sourceGlob: join(ROOT, './**/*.schema.yaml'), + outputFilePath: join(ROOT, 'target/openapi/ess/my_bundle_name_{version}.bundled.schema.yaml'), + options: { + includeLabels: ['ess'], + }, +}); +``` + +After running the above script the bundler will produce the following bundles + +- `target/openapi/serverless/my_bundle_name_2023_10_31.bundled.schema.yaml` + +```yaml +openapi: 3.0.3 +info: + title: Bundled OpenAPI specs + version: '2023-10-31' +servers: ... +paths: + /api/path/to/endpoint: + get: + operationId: MyGetEndpoint + responses: + '200': + description: Successful response + content: + application/json: + schema: + type: object +components: + schemas: + securitySchemes: ... +``` + +- `target/openapi/ess/my_bundle_name_2023_10_31.bundled.schema.yaml` + +```yaml +openapi: 3.0.3 +info: + title: Bundled OpenAPI specs + version: '2023-10-31' +servers: ... +paths: + /api/path/to/endpoint: + get: + operationId: MyGetEndpoint + responses: + '200': + description: Successful response + content: + application/json: + schema: + type: object + post: + operationId: MyPostEndpoint + responses: + '200': + description: Successful response + content: + application/json: + schema: + type: object +components: + schemas: + securitySchemes: ... +``` + ### `x-internal` Marks source spec nodes the bundler must NOT include in the target spec. @@ -188,13 +369,13 @@ paths: type: object ``` -The target spec will look like +The result bundle will look like ```yaml openapi: 3.0.3 info: - title: Bundled specs file. See individual paths.verb.tags for details - version: not applicable + title: Bundled OpenAPI specs + version: '2023-10-31' paths: /api/path/to/endpoint: get: @@ -244,13 +425,13 @@ components: type: object ``` -The target spec will look like +The result bundle will look like ```yaml openapi: 3.0.3 info: - title: Bundled specs file. See individual paths.verb.tags for details - version: not applicable + title: Bundled OpenAPI specs + version: '2023-10-31' paths: /api/path/to/endpoint: get: @@ -303,13 +484,13 @@ paths: - param2 ``` -The target spec will look like +The result bundle will look like ```yaml openapi: 3.0.0 info: - title: Bundled specs file. See individual paths.verb.tags for details - version: not applicable + title: Bundled OpenAPI specs + version: '2023-10-31' paths: /api/path/to/endpoint: patch: @@ -354,13 +535,13 @@ paths: type: number ``` -The target spec will look like +The result bundle will look like ```yaml openapi: 3.0.0 info: - title: Bundled specs file. See individual paths.verb.tags for details - version: not applicable + title: Bundled OpenAPI specs + version: '2023-10-31' paths: /api/path/to/endpoint: patch: @@ -416,13 +597,13 @@ components: - param2 ``` -The target spec will look like +The result bundle will look like ```yaml openapi: 3.0.0 info: - title: Bundled specs file. See individual paths.verb.tags for details - version: not applicable + title: Bundled OpenAPI specs + version: '2023-10-31' paths: /api/path/to/endpoint: patch: @@ -478,13 +659,13 @@ components: type: object ``` -The target spec will look like +The result bundle will look like ```yaml openapi: 3.0.3 info: - title: Bundled specs file. See individual paths.verb.tags for details - version: not applicable + title: Bundled OpenAPI specs + version: '2023-10-31' paths: /api/path/to/endpoint: post: @@ -497,3 +678,19 @@ paths: schema: type: object ``` + +## Contribution + +In case you decide to contribute to the `kbn-openapi-bundler` package please make sure to add and/or update existing e2e test in `kbn-openapi-bundler/tests` folder. + +To run package tests use the following command in the repo root folder + +```bash +yarn test:jest packages/kbn-openapi-bundler +``` + +Jest watch mode can be enabled by passing `--watch` flag + +```bash +yarn test:jest packages/kbn-openapi-bundler --watch +``` diff --git a/packages/kbn-openapi-bundler/src/bundler/bundle_document.ts b/packages/kbn-openapi-bundler/src/bundler/bundle_document.ts index 502ede318ca6d..ca53afffdf010 100644 --- a/packages/kbn-openapi-bundler/src/bundler/bundle_document.ts +++ b/packages/kbn-openapi-bundler/src/bundler/bundle_document.ts @@ -7,23 +7,25 @@ */ import { isAbsolute } from 'path'; -import { RefResolver } from './ref_resolver'; -import { processDocument } from './process_document'; -import { BundleRefProcessor } from './document_processors/bundle_refs'; -import { createSkipNodeWithInternalPropProcessor } from './document_processors/skip_node_with_internal_prop'; -import { createModifyPartialProcessor } from './document_processors/modify_partial'; -import { createSkipInternalPathProcessor } from './document_processors/skip_internal_path'; -import { ResolvedDocument, ResolvedRef } from './types'; -import { createRemovePropsProcessor } from './document_processors/remove_props'; -import { createModifyRequiredProcessor } from './document_processors/modify_required'; -import { X_CODEGEN_ENABLED, X_INLINE, X_INTERNAL, X_MODIFY } from './known_custom_props'; -import { RemoveUnusedComponentsProcessor } from './document_processors/remove_unused_components'; +import { RefResolver } from './ref_resolver/ref_resolver'; +import { processDocument } from './process_document/process_document'; +import { X_CODEGEN_ENABLED, X_INLINE, X_INTERNAL, X_LABELS, X_MODIFY } from './known_custom_props'; import { isPlainObjectType } from '../utils/is_plain_object_type'; +import { ResolvedDocument } from './ref_resolver/resolved_document'; +import { ResolvedRef } from './ref_resolver/resolved_ref'; +import { createSkipNodeWithInternalPropProcessor } from './process_document/document_processors/skip_node_with_internal_prop'; +import { createSkipInternalPathProcessor } from './process_document/document_processors/skip_internal_path'; +import { createModifyPartialProcessor } from './process_document/document_processors/modify_partial'; +import { createModifyRequiredProcessor } from './process_document/document_processors/modify_required'; +import { createRemovePropsProcessor } from './process_document/document_processors/remove_props'; import { createFlattenFoldedAllOfItemsProcessor, createMergeNonConflictingAllOfItemsProcessor, createUnfoldSingleAllOfItemProcessor, -} from './document_processors/reduce_all_of_items'; +} from './process_document/document_processors/reduce_all_of_items'; +import { createIncludeLabelsProcessor } from './process_document/document_processors/include_labels'; +import { BundleRefProcessor } from './process_document/document_processors/bundle_refs'; +import { RemoveUnusedComponentsProcessor } from './process_document/document_processors/remove_unused_components'; export class SkipException extends Error { constructor(public documentPath: string, message: string) { @@ -35,6 +37,10 @@ export interface BundledDocument extends ResolvedDocument { bundledRefs: ResolvedRef[]; } +interface BundleDocumentOptions { + includeLabels?: string[]; +} + /** * Bundles document into one file and performs appropriate document modifications. * @@ -49,7 +55,10 @@ export interface BundledDocument extends ResolvedDocument { * @param absoluteDocumentPath document's absolute path * @returns bundled document */ -export async function bundleDocument(absoluteDocumentPath: string): Promise { +export async function bundleDocument( + absoluteDocumentPath: string, + options?: BundleDocumentOptions +): Promise { if (!isAbsolute(absoluteDocumentPath)) { throw new Error( `bundleDocument expects an absolute document path but got "${absoluteDocumentPath}"` @@ -69,18 +78,26 @@ export async function bundleDocument(absoluteDocumentPath: string): Promise; diff --git a/packages/kbn-openapi-bundler/src/bundler/known_custom_props.ts b/packages/kbn-openapi-bundler/src/bundler/known_custom_props.ts index 4a1832a62bce0..53f105a6e6c35 100644 --- a/packages/kbn-openapi-bundler/src/bundler/known_custom_props.ts +++ b/packages/kbn-openapi-bundler/src/bundler/known_custom_props.ts @@ -8,16 +8,18 @@ /** * `x-internal: true` marks nodes the bundler must NOT include in the result bundled document. Any other values are ignored. + * See README for more details. */ export const X_INTERNAL = 'x-internal'; /** - * `x-internal: true` marks reference nodes the bundler must inline in the result bundled document. + * `x-inline: true` marks reference nodes the bundler must inline in the result bundled document. + * See README for more details. */ export const X_INLINE = 'x-inline'; /** - * `x-modify` marks nodes to be modified by the bundler. `partial` and `required` values are supported. + * `x-modify` marks nodes to be modified by the bundler. `partial` and `required` values are supported. See README for more details. * * - `partial` leads to removing `required` property making params under `properties` optional * - `required` leads to adding or extending `required` property by adding all param names under `properties` @@ -29,3 +31,9 @@ export const X_MODIFY = 'x-modify'; * in result bundled document. */ export const X_CODEGEN_ENABLED = 'x-codegen-enabled'; + +/** + * `x-labels` allows to mark operation objects with arbitrary labels. It allows to exclude or include nodes + * marked with specific labels into the resulting bundle. See README for more details. + */ +export const X_LABELS = 'x-labels'; diff --git a/packages/kbn-openapi-bundler/src/bundler/merge_documents/merge_shared_components.ts b/packages/kbn-openapi-bundler/src/bundler/merge_documents/merge_shared_components.ts index 72f55645fa717..e7379c05b5b6e 100644 --- a/packages/kbn-openapi-bundler/src/bundler/merge_documents/merge_shared_components.ts +++ b/packages/kbn-openapi-bundler/src/bundler/merge_documents/merge_shared_components.ts @@ -10,7 +10,7 @@ import { OpenAPIV3 } from 'openapi-types'; import deepEqual from 'fast-deep-equal'; import chalk from 'chalk'; import { insertRefByPointer } from '../../utils/insert_by_json_pointer'; -import { ResolvedRef } from '../types'; +import { ResolvedRef } from '../ref_resolver/resolved_ref'; import { BundledDocument } from '../bundle_document'; export function mergeSharedComponents( diff --git a/packages/kbn-openapi-bundler/src/bundler/process_document.test.ts b/packages/kbn-openapi-bundler/src/bundler/process_document.test.ts deleted file mode 100644 index fd6e73d4272c6..0000000000000 --- a/packages/kbn-openapi-bundler/src/bundler/process_document.test.ts +++ /dev/null @@ -1,230 +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 { processDocument } from './process_document'; -import { RefResolver } from './ref_resolver'; -import { Document, DocumentNodeProcessor } from './types'; - -jest.mock('./ref_resolver'); - -describe('processDocument', () => { - it('invokes processors in the provided order', async () => { - const resolvedDocument = { - absolutePath: '/path/to/document', - document: {} as Document, - }; - const calls: string[] = []; - const processor1: DocumentNodeProcessor = { - onNodeLeave() { - calls.push('processor1'); - }, - }; - const processor2: DocumentNodeProcessor = { - onNodeLeave() { - calls.push('processor2'); - }, - }; - - processDocument(resolvedDocument, new RefResolver(), [processor1, processor2]); - - expect(calls).toEqual(['processor1', 'processor2']); - }); - - it('invokes callbacks in expected order (enter -> ref -> leave)', async () => { - const document = { - id: 'root', - t1: { - id: 't1', - $ref: '#/TestRef', - }, - }; - const calls: string[] = []; - const refResolver = new RefResolver(); - const processor: DocumentNodeProcessor = { - onNodeEnter(node) { - calls.push(`enter - ${(node as NodeWithId).id}`); - }, - shouldRemove(node) { - calls.push(`shouldRemove - ${(node as NodeWithId).id}`); - return false; - }, - onRefNodeLeave(node) { - calls.push(`ref - ${(node as NodeWithId).id}`); - }, - onNodeLeave(node) { - calls.push(`leave - ${(node as NodeWithId).id}`); - }, - }; - - const refNode = { - id: 'TestRef', - bar: 'foo', - }; - - (refResolver.resolveRef as jest.Mock).mockResolvedValue({ - absolutePath: '/path/to/document', - document: { - TestRef: refNode, - }, - refNode, - pointer: '/TestRef', - }); - - await processDocument( - { - absolutePath: '/path/to/document', - document: document as unknown as Document, - }, - refResolver, - [processor] - ); - - expect(calls).toEqual([ - 'shouldRemove - root', - 'enter - root', - 'shouldRemove - t1', - 'enter - t1', - 'shouldRemove - TestRef', - 'enter - TestRef', - 'leave - TestRef', - 'ref - t1', - 'leave - t1', - 'leave - root', - ]); - }); - - it('removes a node after "shouldRemove" callback returned true', async () => { - const nodeToRemove = { - id: 't2', - foo: 'bar', - }; - const document = { - t1: { - id: 't1', - }, - t2: nodeToRemove, - }; - const removeNodeProcessor: DocumentNodeProcessor = { - shouldRemove(node) { - return node === nodeToRemove; - }, - }; - - await processDocument( - { - absolutePath: '/path/to/document', - document: document as unknown as Document, - }, - new RefResolver(), - [removeNodeProcessor] - ); - - expect(document).toEqual({ - t1: { - id: 't1', - }, - }); - }); - - it('handles recursive documents', async () => { - const nodeA: Record = { - foo: 'bar', - }; - const nodeB: Record = { - bar: ' foo', - }; - - nodeA.circular = nodeB; - nodeB.circular = nodeA; - - const document = { - nodeA, - nodeB, - }; - - await processDocument( - { - absolutePath: '/path/to/document', - document: document as unknown as Document, - }, - new RefResolver(), - [] - ); - - expect(document).toBeDefined(); - }); - - it('handles self-recursive references', async () => { - const document = { - node: { - $ref: '#/TestComponentCircular', - }, - TestComponentCircular: { - $ref: '#/TestComponentCircular', - }, - }; - const refResolver = new RefResolver(); - - (refResolver.resolveRef as jest.Mock).mockResolvedValue({ - absolutePath: '/path/to/document', - document, - refNode: { - $ref: '#/TestComponentCircular', - }, - pointer: '/TestComponentCircular', - }); - - await processDocument( - { - absolutePath: '/path/to/document', - document: document as unknown as Document, - }, - refResolver, - [] - ); - - expect(document).toBeDefined(); - }); - - it('handles recursive references', async () => { - const document: Record = { - node: { - $ref: '#/TestComponentCircular', - }, - TestComponentCircular: { - $ref: '#/AnotherTestComponentCircular', - }, - AnotherTestComponentCircular: { - $ref: '#/TestComponentCircular', - }, - }; - const refResolver = new RefResolver(); - - (refResolver.resolveRef as jest.Mock).mockImplementation((_, pointer) => ({ - absolutePath: '/path/to/document', - document, - refNode: document[pointer.slice(1)], - pointer, - })); - - await processDocument( - { - absolutePath: '/path/to/document', - document: document as unknown as Document, - }, - refResolver, - [] - ); - - expect(document).toBeDefined(); - }); -}); - -interface NodeWithId { - id?: string; -} diff --git a/packages/kbn-openapi-bundler/src/bundler/document_processors/bundle_refs.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/bundle_refs.ts similarity index 84% rename from packages/kbn-openapi-bundler/src/bundler/document_processors/bundle_refs.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/bundle_refs.ts index 976914bcbd343..76da77cc06b0e 100644 --- a/packages/kbn-openapi-bundler/src/bundler/document_processors/bundle_refs.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/bundle_refs.ts @@ -8,19 +8,16 @@ import deepEqual from 'fast-deep-equal'; import chalk from 'chalk'; -import { - Document, - ResolvedRef, - TraverseDocumentContext, - RefNode, - DocumentNode, - TraverseRootDocumentContext, - DocumentNodeProcessor, -} from '../types'; -import { hasProp } from '../../utils/has_prop'; +import { hasProp } from '../../../utils/has_prop'; import { isChildContext } from '../is_child_context'; -import { insertRefByPointer } from '../../utils/insert_by_json_pointer'; +import { insertRefByPointer } from '../../../utils/insert_by_json_pointer'; import { inlineRef } from './utils/inline_ref'; +import { ResolvedRef } from '../../ref_resolver/resolved_ref'; +import { Document } from '../../document'; +import { DocumentNode, RefNode } from '../types/node'; +import { TraverseDocumentContext, TraverseRootDocumentContext } from '../types/context'; +import { DocumentNodeProcessor } from './types/document_node_processor'; +import { TraverseDocumentNodeContext } from './types/traverse_document_node_context'; /** * Node processor to bundle and conditionally dereference document references. @@ -45,7 +42,11 @@ export class BundleRefProcessor implements DocumentNodeProcessor { } } - onRefNodeLeave(node: RefNode, resolvedRef: ResolvedRef, context: TraverseDocumentContext): void { + onRefNodeLeave( + node: RefNode, + resolvedRef: ResolvedRef, + context: TraverseDocumentNodeContext + ): void { if (!resolvedRef.pointer.startsWith('/components')) { throw new Error( `$ref pointer ${chalk.yellow( diff --git a/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/include_labels.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/include_labels.ts new file mode 100644 index 0000000000000..6ff92075a5852 --- /dev/null +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/include_labels.ts @@ -0,0 +1,106 @@ +/* + * 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 { pick } from 'lodash'; +import { logger } from '../../../logger'; +import { hasProp } from '../../../utils/has_prop'; +import { X_LABELS } from '../../known_custom_props'; +import { DocumentNode } from '../types/node'; +import { DocumentNodeProcessor } from './types/document_node_processor'; + +/** + * Creates a node processor to include only OAS operation objects labeled + * with one or more of the provided via `labelsToInclude` labels. + */ +export function createIncludeLabelsProcessor(labelsToInclude: string[]): DocumentNodeProcessor { + if (labelsToInclude.length === 0) { + throw new Error('"labelsToInclude" must have at least one label.'); + } + + const canNodeHaveLabels = (node: Readonly): boolean => { + // Currently, x-labels can be applied only to operations (path + method). + // Each operation object has a `responses` field. + // https://swagger.io/docs/specification/paths-and-operations/ + return 'responses' in node; + }; + const logUnsupportedNodeWarning = (location: string, labelsValue: unknown): void => { + const value = Array.isArray(labelsValue) ? labelsValue.join(', ') : labelsValue; + + logger.warning( + `"${X_LABELS}: ${value}" in ${location} is ignored since "${X_LABELS}" is supported only for Operation objects.` + ); + }; + const logInvalidLabelsValueWarning = (location: string, labelsValue: unknown) => { + logger.warning( + `"${X_LABELS}" in ${location} is ignored since an array of labels is expected but got "${JSON.stringify( + labelsValue + )}".` + ); + }; + const KNOWN_HTTP_METHODS = ['head', 'get', 'post', 'patch', 'put', 'options', 'delete', 'trace']; + + return { + shouldRemove(node, { parentKey }) { + const isValidNode = canNodeHaveLabels(node); + const nodeLabels = X_LABELS in node ? node[X_LABELS] : undefined; + + if (!isValidNode) { + if (nodeLabels) { + // x-labels can't be applied to this node. + // We log a warning, but the node should still be included. + logUnsupportedNodeWarning(parentKey.toString(), nodeLabels); + } + + return false; + } + + if (!nodeLabels) { + return true; + } + + if (!Array.isArray(nodeLabels)) { + // x-labels value is not valid. + // We log a warning and remove the node because it doesn't contain the needed labels. + logInvalidLabelsValueWarning(parentKey.toString(), nodeLabels); + + return true; + } + + const hasAllExpectedLabels = labelsToInclude.every((label) => nodeLabels.includes(label)); + + // if an operation object has all labels from labelsToInclude + // leave it in the resulting bundle by returning `false` + return !hasAllExpectedLabels; + }, + // Empty path objects after excluding all operation objects by `shouldRemove` have to be removed + onNodeLeave(node, { isRootNode }) { + if ( + !isRootNode || + !hasProp(node, 'paths') || + typeof node.paths !== 'object' || + node.paths === null + ) { + return; + } + + for (const [path, pathObject] of Object.entries(node.paths)) { + if (typeof pathObject !== 'object' || pathObject === null) { + continue; + } + + // We need to check HTTP verbs only + // If there are no HTTP verbs the path definition is considered empty + const httpVerbs = pick(pathObject, KNOWN_HTTP_METHODS); + + if (Object.keys(httpVerbs).length === 0) { + delete node.paths[path as keyof typeof node.paths]; + } + } + }, + }; +} diff --git a/packages/kbn-openapi-bundler/src/bundler/document_processors/modify_partial.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/modify_partial.ts similarity index 85% rename from packages/kbn-openapi-bundler/src/bundler/document_processors/modify_partial.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/modify_partial.ts index 5d667eff1bc80..bb532cb130c36 100644 --- a/packages/kbn-openapi-bundler/src/bundler/document_processors/modify_partial.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/modify_partial.ts @@ -6,10 +6,10 @@ * Side Public License, v 1. */ -import { DocumentNodeProcessor } from '../types'; -import { hasProp } from '../../utils/has_prop'; +import { DocumentNodeProcessor } from './types/document_node_processor'; +import { hasProp } from '../../../utils/has_prop'; +import { X_MODIFY } from '../../known_custom_props'; import { inlineRef } from './utils/inline_ref'; -import { X_MODIFY } from '../known_custom_props'; /** * Creates a node processor to modify a node by removing `required` property when diff --git a/packages/kbn-openapi-bundler/src/bundler/document_processors/modify_required.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/modify_required.ts similarity index 88% rename from packages/kbn-openapi-bundler/src/bundler/document_processors/modify_required.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/modify_required.ts index 769672d64a39d..fc2b275a45743 100644 --- a/packages/kbn-openapi-bundler/src/bundler/document_processors/modify_required.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/modify_required.ts @@ -7,11 +7,11 @@ */ import chalk from 'chalk'; -import { logger } from '../../logger'; -import { isPlainObjectType } from '../../utils/is_plain_object_type'; -import { DocumentNodeProcessor } from '../types'; -import { hasProp } from '../../utils/has_prop'; -import { X_MODIFY } from '../known_custom_props'; +import { logger } from '../../../logger'; +import { isPlainObjectType } from '../../../utils/is_plain_object_type'; +import { hasProp } from '../../../utils/has_prop'; +import { X_MODIFY } from '../../known_custom_props'; +import { DocumentNodeProcessor } from './types/document_node_processor'; import { inlineRef } from './utils/inline_ref'; /** diff --git a/packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/flatten_folded_all_of_items.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/reduce_all_of_items/flatten_folded_all_of_items.ts similarity index 95% rename from packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/flatten_folded_all_of_items.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/reduce_all_of_items/flatten_folded_all_of_items.ts index dcf4b82a42af5..c4ff7d68e410a 100644 --- a/packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/flatten_folded_all_of_items.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/reduce_all_of_items/flatten_folded_all_of_items.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { DocumentNodeProcessor } from '../../types'; +import { DocumentNodeProcessor } from '../types/document_node_processor'; /** * Creates a node processor to flatten folded `allOf` items. Folded means `allOf` has items diff --git a/packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/index.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/reduce_all_of_items/index.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/index.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/reduce_all_of_items/index.ts diff --git a/packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/merge_non_conflicting_all_of_items.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/reduce_all_of_items/merge_non_conflicting_all_of_items.ts similarity index 96% rename from packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/merge_non_conflicting_all_of_items.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/reduce_all_of_items/merge_non_conflicting_all_of_items.ts index 87895be952b96..3c6d57d90346e 100644 --- a/packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/merge_non_conflicting_all_of_items.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/reduce_all_of_items/merge_non_conflicting_all_of_items.ts @@ -9,8 +9,8 @@ import { omit } from 'lodash'; import deepEqual from 'fast-deep-equal'; import { OpenAPIV3 } from 'openapi-types'; -import { isPlainObjectType } from '../../../utils/is_plain_object_type'; -import { DocumentNodeProcessor } from '../../types'; +import { isPlainObjectType } from '../../../../utils/is_plain_object_type'; +import { DocumentNodeProcessor } from '../types/document_node_processor'; type MergedObjectSchema = Required> & Pick; diff --git a/packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/unfold_single_all_of_item.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/reduce_all_of_items/unfold_single_all_of_item.ts similarity index 94% rename from packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/unfold_single_all_of_item.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/reduce_all_of_items/unfold_single_all_of_item.ts index 67a056091db4c..f90fa50c71615 100644 --- a/packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/unfold_single_all_of_item.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/reduce_all_of_items/unfold_single_all_of_item.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { DocumentNodeProcessor } from '../../types'; +import { DocumentNodeProcessor } from '../types/document_node_processor'; /** * Created a node processor to remove/unfold `allOf` with only single item. diff --git a/packages/kbn-openapi-bundler/src/bundler/document_processors/remove_props.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/remove_props.ts similarity index 84% rename from packages/kbn-openapi-bundler/src/bundler/document_processors/remove_props.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/remove_props.ts index 02fb2036e2a0c..c7d890c0a4760 100644 --- a/packages/kbn-openapi-bundler/src/bundler/document_processors/remove_props.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/remove_props.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ -import { isPlainObjectType } from '../../utils/is_plain_object_type'; -import { DocumentNodeProcessor } from '../types'; +import { isPlainObjectType } from '../../../utils/is_plain_object_type'; +import { DocumentNodeProcessor } from './types/document_node_processor'; /** * Creates a node processor to remove specified by `propNames` properties. diff --git a/packages/kbn-openapi-bundler/src/bundler/document_processors/remove_unused_components.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/remove_unused_components.ts similarity index 80% rename from packages/kbn-openapi-bundler/src/bundler/document_processors/remove_unused_components.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/remove_unused_components.ts index 393f986ec5a1a..f0bb72c34644c 100644 --- a/packages/kbn-openapi-bundler/src/bundler/document_processors/remove_unused_components.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/remove_unused_components.ts @@ -6,9 +6,11 @@ * Side Public License, v 1. */ -import { hasProp } from '../../utils/has_prop'; -import { isPlainObjectType } from '../../utils/is_plain_object_type'; -import { DocumentNodeProcessor, PlainObjectNode, ResolvedRef } from '../types'; +import { hasProp } from '../../../utils/has_prop'; +import { isPlainObjectType } from '../../../utils/is_plain_object_type'; +import { ResolvedRef } from '../../ref_resolver/resolved_ref'; +import { PlainObjectNode } from '../types/node'; +import { DocumentNodeProcessor } from './types/document_node_processor'; /** * Helps to remove unused components. diff --git a/packages/kbn-openapi-bundler/src/bundler/document_processors/skip_internal_path.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/skip_internal_path.ts similarity index 91% rename from packages/kbn-openapi-bundler/src/bundler/document_processors/skip_internal_path.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/skip_internal_path.ts index 280002ce13890..983ee42e9f644 100644 --- a/packages/kbn-openapi-bundler/src/bundler/document_processors/skip_internal_path.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/skip_internal_path.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { DocumentNodeProcessor } from '../types'; +import { DocumentNodeProcessor } from './types/document_node_processor'; /** * Creates a node processor to skip paths starting with `/internal` and omit them from the result document. diff --git a/packages/kbn-openapi-bundler/src/bundler/document_processors/skip_node_with_internal_prop.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/skip_node_with_internal_prop.ts similarity index 90% rename from packages/kbn-openapi-bundler/src/bundler/document_processors/skip_node_with_internal_prop.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/skip_node_with_internal_prop.ts index b674cfb8c0b9c..e2c03829aa3d0 100644 --- a/packages/kbn-openapi-bundler/src/bundler/document_processors/skip_node_with_internal_prop.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/skip_node_with_internal_prop.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { DocumentNodeProcessor } from '../types'; +import { DocumentNodeProcessor } from './types/document_node_processor'; /** * Creates a node processor to skip nodes having provided `skipProperty` property diff --git a/packages/kbn-openapi-bundler/src/bundler/types.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/types/document_node_processor.ts similarity index 53% rename from packages/kbn-openapi-bundler/src/bundler/types.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/types/document_node_processor.ts index fa8a7f3c83120..f52c606ccb110 100644 --- a/packages/kbn-openapi-bundler/src/bundler/types.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/types/document_node_processor.ts @@ -6,120 +6,9 @@ * Side Public License, v 1. */ -/** - * A plain object node not containing `$ref` property - */ -export type PlainObjectNode = Record; - -/** - * An array node - */ -export type ArrayNode = unknown[]; - -/** - * A ref node containing `$ref` property besides the others - */ -export interface RefNode extends PlainObjectNode { - $ref: string; -} - -/** - * An abstract OpenAPI entry node. Content besides $ref isn't important. - */ -export type DocumentNode = PlainObjectNode | ArrayNode | RefNode; - -/** - * Document abstraction. We don't mind OpenAPI `3.0` and `3.1` differences. - */ -export type Document = Record; - -export interface ResolvedDocument { - /** - * Document's absolute path - */ - absolutePath: string; - /** - * Document's root - */ - document: Document; -} - -export interface ResolvedRef extends ResolvedDocument { - /** - * Parsed pointer without leading hash symbol (e.g. `/components/schemas/MySchema`) - */ - pointer: string; - - /** - * Resolved ref's node pointer points to - */ - refNode: DocumentNode; -} - -export interface TraverseRootDocumentContext { - /** - * Root document - */ - resolvedDocument: ResolvedDocument; - - parentContext?: undefined; - followedRef?: undefined; -} - -export interface TraverseChildDocumentContext { - /** - * Current document after resolving $ref property - */ - resolvedRef: ResolvedRef; - - /** - * Context of the parent document the current one in `document` field was referenced via $ref. Empty if it's the root document. - */ - parentContext: TraverseDocumentContext; - - /** - * Reference used to resolve the current document - */ - followedRef: string; -} - -/** - * Traverse context storing additional information related to the currently traversed node - */ -export type TraverseDocumentContext = TraverseRootDocumentContext | TraverseChildDocumentContext; - -export type TraverseDocumentEntryContext = TraverseDocumentContext & { - parentNode: DocumentNode; - parentKey: string | number; -}; - -/** - * Should remove processor controls whether a node and all its descendants - * should be omitted from the further processing and result document. - * - * When result is - * - * - `true` - omit the node - * - `false` - keep the node - * - */ -export type ShouldRemoveNodeProcessorFn = ( - node: Readonly, - context: TraverseDocumentEntryContext -) => boolean; - -export type OnNodeEntryProcessorFn = ( - node: Readonly, - context: TraverseDocumentEntryContext -) => void; - -export type OnNodeLeaveProcessorFn = (node: DocumentNode, context: TraverseDocumentContext) => void; - -export type OnRefNodeLeaveProcessorFn = ( - node: RefNode, - resolvedRef: ResolvedRef, - context: TraverseDocumentContext -) => void; +import { ResolvedRef } from '../../../ref_resolver/resolved_ref'; +import { DocumentNode, RefNode } from '../../types/node'; +import { TraverseDocumentNodeContext } from './traverse_document_node_context'; /** * OpenAPI tree is traversed in two phases @@ -161,3 +50,31 @@ export interface DocumentNodeProcessor { onNodeLeave?: OnNodeLeaveProcessorFn; onRefNodeLeave?: OnRefNodeLeaveProcessorFn; } + +/** + * Should remove processor controls whether a node and all its descendants + * should be omitted from the further processing and result document. + * + * When result is + * + * - `true` - omit the node + * - `false` - keep the node + * + */ +type ShouldRemoveNodeProcessorFn = ( + node: Readonly, + context: TraverseDocumentNodeContext +) => boolean; + +type OnNodeEntryProcessorFn = ( + node: Readonly, + context: TraverseDocumentNodeContext +) => void; + +type OnNodeLeaveProcessorFn = (node: DocumentNode, context: TraverseDocumentNodeContext) => void; + +type OnRefNodeLeaveProcessorFn = ( + node: RefNode, + resolvedRef: ResolvedRef, + context: TraverseDocumentNodeContext +) => void; diff --git a/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/types/traverse_document_node_context.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/types/traverse_document_node_context.ts new file mode 100644 index 0000000000000..f1db75cd8ba14 --- /dev/null +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/types/traverse_document_node_context.ts @@ -0,0 +1,16 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { TraverseDocumentContext } from '../../types/context'; +import { DocumentNode } from '../../types/node'; + +export type TraverseDocumentNodeContext = TraverseDocumentContext & { + isRootNode: boolean; + parentNode: DocumentNode; + parentKey: string | number; +}; diff --git a/packages/kbn-openapi-bundler/src/bundler/document_processors/utils/inline_ref.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/utils/inline_ref.ts similarity index 76% rename from packages/kbn-openapi-bundler/src/bundler/document_processors/utils/inline_ref.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/utils/inline_ref.ts index fac6c519980b9..cdd8a57242c87 100644 --- a/packages/kbn-openapi-bundler/src/bundler/document_processors/utils/inline_ref.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/document_processors/utils/inline_ref.ts @@ -6,8 +6,12 @@ * Side Public License, v 1. */ -import { DocumentNode, ResolvedRef } from '../../types'; -import { InlinableRefNode } from '../types'; +import { ResolvedRef } from '../../../ref_resolver/resolved_ref'; +import { DocumentNode } from '../../types/node'; + +interface InlinableRefNode { + $ref?: string; +} export function inlineRef(node: DocumentNode, resolvedRef: ResolvedRef): void { Object.assign(node, resolvedRef.refNode); diff --git a/packages/kbn-openapi-bundler/src/bundler/document_processors/types.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/index.ts similarity index 86% rename from packages/kbn-openapi-bundler/src/bundler/document_processors/types.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/index.ts index 60fd512c3cf5b..f32d50b31e21a 100644 --- a/packages/kbn-openapi-bundler/src/bundler/document_processors/types.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/index.ts @@ -6,6 +6,4 @@ * Side Public License, v 1. */ -export interface InlinableRefNode { - $ref?: string; -} +export * from './process_document'; diff --git a/packages/kbn-openapi-bundler/src/bundler/is_child_context.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/is_child_context.ts similarity index 95% rename from packages/kbn-openapi-bundler/src/bundler/is_child_context.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/is_child_context.ts index f3fe4dde915cf..a57a0106cc88a 100644 --- a/packages/kbn-openapi-bundler/src/bundler/is_child_context.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/is_child_context.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { TraverseChildDocumentContext, TraverseDocumentContext } from './types'; +import { TraverseChildDocumentContext, TraverseDocumentContext } from './types/context'; export function isChildContext( context: TraverseDocumentContext diff --git a/packages/kbn-openapi-bundler/src/bundler/process_document/process_document.test.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/process_document.test.ts new file mode 100644 index 0000000000000..385ff93b3a1c7 --- /dev/null +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/process_document.test.ts @@ -0,0 +1,513 @@ +/* + * 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 { RefResolver } from '../ref_resolver'; +import { Document } from '../document'; +import { processDocument } from './process_document'; +import { DocumentNodeProcessor } from './document_processors/types/document_node_processor'; + +jest.mock('../ref_resolver'); + +describe('processDocument', () => { + it('invokes processors in the provided order', async () => { + const resolvedDocument = { + absolutePath: '/path/to/document', + document: {} as Document, + }; + const calls: string[] = []; + const processor1: DocumentNodeProcessor = { + onNodeLeave() { + calls.push('processor1'); + }, + }; + const processor2: DocumentNodeProcessor = { + onNodeLeave() { + calls.push('processor2'); + }, + }; + + processDocument(resolvedDocument, new RefResolver(), [processor1, processor2]); + + expect(calls).toEqual(['processor1', 'processor2']); + }); + + it('invokes callbacks in expected order (shouldRemove -> enter -> ref -> leave)', async () => { + const document = { + id: 'root', + t1: { + id: 't1', + $ref: '#/TestRef', + }, + }; + const calls: string[] = []; + const refResolver = new RefResolver(); + const processor: DocumentNodeProcessor = { + onNodeEnter(node) { + calls.push(`enter - ${(node as NodeWithId).id}`); + }, + shouldRemove(node) { + calls.push(`shouldRemove - ${(node as NodeWithId).id}`); + return false; + }, + onRefNodeLeave(node) { + calls.push(`ref - ${(node as NodeWithId).id}`); + }, + onNodeLeave(node) { + calls.push(`leave - ${(node as NodeWithId).id}`); + }, + }; + + const refNode = { + id: 'TestRef', + bar: 'foo', + }; + + (refResolver.resolveRef as jest.Mock).mockResolvedValue({ + absolutePath: '/path/to/document', + document: { + TestRef: refNode, + }, + refNode, + pointer: '/TestRef', + }); + + await processDocument( + { + absolutePath: '/path/to/document', + document: document as unknown as Document, + }, + refResolver, + [processor] + ); + + expect(calls).toEqual([ + 'shouldRemove - root', + 'enter - root', + 'shouldRemove - t1', + 'enter - t1', + 'shouldRemove - TestRef', + 'enter - TestRef', + 'leave - TestRef', + 'ref - t1', + 'leave - t1', + 'leave - root', + ]); + }); + + it('removes a node after "shouldRemove" callback returned true', async () => { + const nodeToRemove = { + id: 't2', + foo: 'bar', + }; + const document = { + t1: { + id: 't1', + }, + t2: nodeToRemove, + }; + const removeNodeProcessor: DocumentNodeProcessor = { + shouldRemove(node) { + return node === nodeToRemove; + }, + }; + + await processDocument( + { + absolutePath: '/path/to/document', + document: document as unknown as Document, + }, + new RefResolver(), + [removeNodeProcessor] + ); + + expect(document).toEqual({ + t1: { + id: 't1', + }, + }); + }); + + it('handles recursive documents', async () => { + const nodeA: Record = { + foo: 'bar', + }; + const nodeB: Record = { + bar: ' foo', + }; + + nodeA.circular = nodeB; + nodeB.circular = nodeA; + + const document = { + nodeA, + nodeB, + }; + + await processDocument( + { + absolutePath: '/path/to/document', + document: document as unknown as Document, + }, + new RefResolver(), + [] + ); + + expect(document).toBeDefined(); + }); + + it('handles self-recursive references', async () => { + const document = { + node: { + $ref: '#/TestComponentCircular', + }, + TestComponentCircular: { + $ref: '#/TestComponentCircular', + }, + }; + const refResolver = new RefResolver(); + + (refResolver.resolveRef as jest.Mock).mockResolvedValue({ + absolutePath: '/path/to/document', + document, + refNode: { + $ref: '#/TestComponentCircular', + }, + pointer: '/TestComponentCircular', + }); + + await processDocument( + { + absolutePath: '/path/to/document', + document: document as unknown as Document, + }, + refResolver, + [] + ); + + expect(document).toBeDefined(); + }); + + it('handles recursive references', async () => { + const document: Record = { + node: { + $ref: '#/TestComponentCircular', + }, + TestComponentCircular: { + $ref: '#/AnotherTestComponentCircular', + }, + AnotherTestComponentCircular: { + $ref: '#/TestComponentCircular', + }, + }; + const refResolver = new RefResolver(); + + (refResolver.resolveRef as jest.Mock).mockImplementation((_, pointer) => ({ + absolutePath: '/path/to/document', + document, + refNode: document[pointer.slice(1)], + pointer, + })); + + await processDocument( + { + absolutePath: '/path/to/document', + document: document as unknown as Document, + }, + refResolver, + [] + ); + + expect(document).toBeDefined(); + }); + + describe('processor', () => { + describe('node', () => { + it('gets a root node', async () => { + const resolvedDocument = { + absolutePath: '/path/to/document', + document: {} as Document, + }; + + expect.assertions(3); + + const processor: DocumentNodeProcessor = { + shouldRemove(node) { + expect(node).toBe(resolvedDocument.document); + + return false; + }, + onNodeEnter(node) { + expect(node).toBe(resolvedDocument.document); + }, + onNodeLeave(node) { + expect(node).toBe(resolvedDocument.document); + }, + }; + + await processDocument(resolvedDocument, new RefResolver(), [processor]); + }); + + it('gets a child node', async () => { + const childNode = { + childNode: true, + }; + const resolvedDocument = { + absolutePath: '/path/to/document', + document: { + child: childNode, + } as Document, + }; + + expect.assertions(3); + + const processor: DocumentNodeProcessor = { + shouldRemove(node) { + if (!('childNode' in node)) { + return false; + } + + expect(node).toBe(childNode); + + return false; + }, + onNodeEnter(node) { + if (!('childNode' in node)) { + return; + } + + expect(node).toBe(childNode); + }, + onNodeLeave(node) { + if (!('childNode' in node)) { + return false; + } + + expect(node).toBe(childNode); + }, + }; + + await processDocument(resolvedDocument, new RefResolver(), [processor]); + }); + + it('gets a ref node', async () => { + const referencingNode = { + $ref: '#/refNode', + }; + const referencedNode = { + refNode: true, + }; + const resolvedDocument = { + absolutePath: '/path/to/document', + document: { + node: referencingNode, + refNode: referencedNode, + } as Document, + }; + + const refResolver = new RefResolver(); + + (refResolver.resolveRef as jest.Mock).mockImplementation((_, pointer) => ({ + absolutePath: '/path/to/document', + document: resolvedDocument.document, + refNode: resolvedDocument.document[pointer.slice(1)], + pointer, + })); + + expect.assertions(1); + + const processor: DocumentNodeProcessor = { + onRefNodeLeave(node, resolvedRef) { + expect(node).toBe(referencingNode); + }, + }; + + await processDocument(resolvedDocument, refResolver, [processor]); + }); + + it('gets a resolved ref', async () => { + const referencingNode = { + $ref: '#/refNode', + }; + const referencedNode = { + refNode: true, + }; + const resolvedDocument = { + absolutePath: '/path/to/document', + document: { + node: referencingNode, + refNode: referencedNode, + } as Document, + }; + + const refResolver = new RefResolver(); + + (refResolver.resolveRef as jest.Mock).mockImplementation((_, pointer) => ({ + absolutePath: '/path/to/document', + document: resolvedDocument.document, + refNode: resolvedDocument.document[pointer.slice(1)], + pointer, + })); + + expect.assertions(1); + + const processor: DocumentNodeProcessor = { + onRefNodeLeave(_, resolvedRef) { + expect(resolvedRef).toEqual({ + absolutePath: '/path/to/document', + document: resolvedDocument.document, + refNode: referencedNode, + pointer: '/refNode', + }); + }, + }; + + await processDocument(resolvedDocument, refResolver, [processor]); + }); + }); + + describe('context', () => { + it('gets a root node context', async () => { + const resolvedDocument = { + absolutePath: '/path/to/document', + document: {} as Document, + }; + + expect.assertions(3); + + const processor: DocumentNodeProcessor = { + shouldRemove(_, context) { + expect(context).toEqual({ + resolvedDocument, + isRootNode: true, + parentKey: '', + parentNode: resolvedDocument.document, + }); + + return false; + }, + onNodeEnter(_, context) { + expect(context).toEqual({ + resolvedDocument, + isRootNode: true, + parentKey: '', + parentNode: resolvedDocument.document, + }); + }, + onNodeLeave(_, context) { + expect(context).toEqual({ + resolvedDocument, + isRootNode: true, + parentKey: '', + parentNode: resolvedDocument.document, + }); + }, + }; + + await processDocument(resolvedDocument, new RefResolver(), [processor]); + }); + + it('gets a child node context', async () => { + const resolvedDocument = { + absolutePath: '/path/to/document', + document: { + childNode: {}, + } as Document, + }; + + expect.assertions(3); + + const processor: DocumentNodeProcessor = { + shouldRemove(_, context) { + if (context.isRootNode === true) { + return false; + } + + expect(context).toEqual({ + resolvedDocument, + isRootNode: false, + parentKey: 'childNode', + parentNode: resolvedDocument.document, + }); + + return false; + }, + onNodeEnter(_, context) { + if (context.isRootNode === true) { + return false; + } + + expect(context).toEqual({ + resolvedDocument, + isRootNode: false, + parentKey: 'childNode', + parentNode: resolvedDocument.document, + }); + }, + onNodeLeave(_, context) { + if (context.isRootNode === true) { + return false; + } + + expect(context).toEqual({ + resolvedDocument, + isRootNode: false, + parentKey: 'childNode', + parentNode: resolvedDocument.document, + }); + }, + }; + + await processDocument(resolvedDocument, new RefResolver(), [processor]); + }); + + it('gets a ref node context', async () => { + const referencingNode = { + $ref: '#/refNode', + }; + const referencedNode = { + refNode: true, + }; + const resolvedDocument = { + absolutePath: '/path/to/document', + document: { + node: referencingNode, + refNode: referencedNode, + } as Document, + }; + + const refResolver = new RefResolver(); + + (refResolver.resolveRef as jest.Mock).mockImplementation((_, pointer) => ({ + absolutePath: '/path/to/document', + document: resolvedDocument.document, + refNode: resolvedDocument.document[pointer.slice(1)], + pointer, + })); + + expect.assertions(1); + + const processor: DocumentNodeProcessor = { + onRefNodeLeave(_, __, context) { + expect(context).toEqual({ + resolvedDocument, + isRootNode: false, + parentKey: 'node', + parentNode: resolvedDocument.document, + }); + }, + }; + + await processDocument(resolvedDocument, refResolver, [processor]); + }); + }); + }); +}); + +interface NodeWithId { + id?: string; +} diff --git a/packages/kbn-openapi-bundler/src/bundler/process_document.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/process_document.ts similarity index 80% rename from packages/kbn-openapi-bundler/src/bundler/process_document.ts rename to packages/kbn-openapi-bundler/src/bundler/process_document/process_document.ts index 29344fa4aa7c5..907c42ebf6ea4 100644 --- a/packages/kbn-openapi-bundler/src/bundler/process_document.ts +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/process_document.ts @@ -8,32 +8,17 @@ import { dirname } from 'path'; import { isPlainObject } from 'lodash'; -import { IRefResolver } from './ref_resolver'; -import { - DocumentNode, - ResolvedDocument, - TraverseDocumentContext, - ResolvedRef, - DocumentNodeProcessor, - RefNode, - PlainObjectNode, -} from './types'; -import { parseRef } from '../utils/parse_ref'; -import { toAbsolutePath } from '../utils/to_absolute_path'; -import { isPlainObjectType } from '../utils/is_plain_object_type'; +import { IRefResolver } from '../ref_resolver/ref_resolver'; +import { ResolvedDocument } from '../ref_resolver/resolved_document'; +import { parseRef } from '../../utils/parse_ref'; +import { toAbsolutePath } from '../../utils/to_absolute_path'; +import { isPlainObjectType } from '../../utils/is_plain_object_type'; import { isChildContext } from './is_child_context'; - -interface TraverseItem { - node: DocumentNode; - context: TraverseDocumentContext; - /** - * Keeps track of visited nodes to be able to detect circular references - */ - visitedDocumentNodes: Set; - parentNode: DocumentNode; - parentKey: string | number; - resolvedRef?: ResolvedRef; -} +import { TraverseItem } from './traverse_item'; +import { createNodeContext } from './transform_traverse_item_to_node_context'; +import { DocumentNodeProcessor } from './document_processors/types/document_node_processor'; +import { DocumentNode, PlainObjectNode, RefNode } from './types/node'; +import { TraverseDocumentContext } from './types/context'; export async function processDocument( resolvedDocument: ResolvedDocument, @@ -95,7 +80,7 @@ export async function processDocument( resolvedRef, parentContext: traverseItem.context, followedRef: absoluteRef, - }; + } as const; traverseItem.resolvedRef = resolvedRef; @@ -143,17 +128,15 @@ export async function processDocument( const traverseItem = postOrderTraversalStack[i]; for (const processor of processors) { + const context = createNodeContext(traverseItem); + // If ref has been inlined by one of the processors it's not a ref node anymore // so we can skip the following processors if (isRefNode(traverseItem.node) && traverseItem.resolvedRef) { - processor.onRefNodeLeave?.( - traverseItem.node as RefNode, - traverseItem.resolvedRef, - traverseItem.context - ); + processor.onRefNodeLeave?.(traverseItem.node as RefNode, traverseItem.resolvedRef, context); } - processor.onNodeLeave?.(traverseItem.node, traverseItem.context); + processor.onNodeLeave?.(traverseItem.node, context); } } } @@ -171,12 +154,10 @@ function applyEnterProcessors( traverseItem: TraverseItem, processors: DocumentNodeProcessor[] ): void { + const context = createNodeContext(traverseItem); + for (const processor of processors) { - processor.onNodeEnter?.(traverseItem.node, { - ...traverseItem.context, - parentNode: traverseItem.parentNode, - parentKey: traverseItem.parentKey, - }); + processor.onNodeEnter?.(traverseItem.node, context); } } @@ -187,13 +168,9 @@ function shouldRemoveSubTree( traverseItem: TraverseItem, processors: DocumentNodeProcessor[] ): boolean { - return processors.some((p) => - p.shouldRemove?.(traverseItem.node, { - ...traverseItem.context, - parentNode: traverseItem.parentNode, - parentKey: traverseItem.parentKey, - }) - ); + const context = createNodeContext(traverseItem); + + return processors.some((p) => p.shouldRemove?.(traverseItem.node, context)); } function removeNode(traverseItem: TraverseItem): void { diff --git a/packages/kbn-openapi-bundler/src/bundler/process_document/transform_traverse_item_to_node_context.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/transform_traverse_item_to_node_context.ts new file mode 100644 index 0000000000000..bdc328681422e --- /dev/null +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/transform_traverse_item_to_node_context.ts @@ -0,0 +1,19 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { TraverseDocumentNodeContext } from './document_processors/types/traverse_document_node_context'; +import { TraverseItem } from './traverse_item'; + +export function createNodeContext(traverseItem: TraverseItem): TraverseDocumentNodeContext { + return { + ...traverseItem.context, + isRootNode: traverseItem.node === traverseItem.parentNode, + parentNode: traverseItem.parentNode, + parentKey: traverseItem.parentKey, + }; +} diff --git a/packages/kbn-openapi-bundler/src/bundler/process_document/traverse_item.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/traverse_item.ts new file mode 100644 index 0000000000000..199b0b5a65374 --- /dev/null +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/traverse_item.ts @@ -0,0 +1,23 @@ +/* + * 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 { ResolvedRef } from '../ref_resolver/resolved_ref'; +import { TraverseDocumentContext } from './types/context'; +import { DocumentNode } from './types/node'; + +export interface TraverseItem { + node: DocumentNode; + context: TraverseDocumentContext; + /** + * Keeps track of visited nodes to be able to detect circular references + */ + visitedDocumentNodes: Set; + parentNode: DocumentNode; + parentKey: string | number; + resolvedRef?: ResolvedRef; +} diff --git a/packages/kbn-openapi-bundler/src/bundler/process_document/types/context.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/types/context.ts new file mode 100644 index 0000000000000..a845b65e29521 --- /dev/null +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/types/context.ts @@ -0,0 +1,42 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 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 { ResolvedDocument } from '../../ref_resolver/resolved_document'; +import { ResolvedRef } from '../../ref_resolver/resolved_ref'; + +export interface TraverseRootDocumentContext { + /** + * Root document + */ + resolvedDocument: ResolvedDocument; + + parentContext?: undefined; + followedRef?: undefined; +} + +export interface TraverseChildDocumentContext { + /** + * Current document after resolving $ref property + */ + resolvedRef: ResolvedRef; + + /** + * Context of the parent document the current one in `document` field was referenced via $ref. Empty if it's the root document. + */ + parentContext: TraverseDocumentContext; + + /** + * Reference used to resolve the current document + */ + followedRef: string; +} + +/** + * Traverse context storing additional information related to the currently traversed node + */ +export type TraverseDocumentContext = TraverseRootDocumentContext | TraverseChildDocumentContext; diff --git a/packages/kbn-openapi-bundler/src/bundler/process_document/types/node.ts b/packages/kbn-openapi-bundler/src/bundler/process_document/types/node.ts new file mode 100644 index 0000000000000..aeb540a54d345 --- /dev/null +++ b/packages/kbn-openapi-bundler/src/bundler/process_document/types/node.ts @@ -0,0 +1,29 @@ +/* + * 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. + */ + +/** + * A plain object node not containing `$ref` property + */ +export type PlainObjectNode = Record; + +/** + * An array node + */ +export type ArrayNode = unknown[]; + +/** + * A ref node containing `$ref` property besides the others + */ +export interface RefNode extends PlainObjectNode { + $ref: string; +} + +/** + * An abstract OpenAPI entry node. Content besides $ref isn't important. + */ +export type DocumentNode = PlainObjectNode | ArrayNode | RefNode; diff --git a/packages/kbn-openapi-bundler/src/bundler/__mocks__/ref_resolver.ts b/packages/kbn-openapi-bundler/src/bundler/ref_resolver/__mocks__/ref_resolver.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/bundler/__mocks__/ref_resolver.ts rename to packages/kbn-openapi-bundler/src/bundler/ref_resolver/__mocks__/ref_resolver.ts diff --git a/packages/kbn-openapi-bundler/src/bundler/ref_resolver/index.ts b/packages/kbn-openapi-bundler/src/bundler/ref_resolver/index.ts new file mode 100644 index 0000000000000..cea5fccd2e3b2 --- /dev/null +++ b/packages/kbn-openapi-bundler/src/bundler/ref_resolver/index.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 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 * from './ref_resolver'; diff --git a/packages/kbn-openapi-bundler/src/bundler/ref_resolver.ts b/packages/kbn-openapi-bundler/src/bundler/ref_resolver/ref_resolver.ts similarity index 88% rename from packages/kbn-openapi-bundler/src/bundler/ref_resolver.ts rename to packages/kbn-openapi-bundler/src/bundler/ref_resolver/ref_resolver.ts index 92b17c19c1b60..38ce43cf1d593 100644 --- a/packages/kbn-openapi-bundler/src/bundler/ref_resolver.ts +++ b/packages/kbn-openapi-bundler/src/bundler/ref_resolver/ref_resolver.ts @@ -7,9 +7,10 @@ */ import path from 'path'; -import { extractByJsonPointer } from '../utils/extract_by_json_pointer'; -import { readYamlDocument } from '../utils/read_yaml_document'; -import { ResolvedDocument, ResolvedRef } from './types'; +import { extractByJsonPointer } from '../../utils/extract_by_json_pointer'; +import { readYamlDocument } from '../../utils/read_yaml_document'; +import { ResolvedRef } from './resolved_ref'; +import { ResolvedDocument } from './resolved_document'; export interface IRefResolver { resolveRef(refDocumentAbsolutePath: string, pointer: string): Promise; diff --git a/packages/kbn-openapi-bundler/src/bundler/ref_resolver/resolved_document.ts b/packages/kbn-openapi-bundler/src/bundler/ref_resolver/resolved_document.ts new file mode 100644 index 0000000000000..7e02aa6858767 --- /dev/null +++ b/packages/kbn-openapi-bundler/src/bundler/ref_resolver/resolved_document.ts @@ -0,0 +1,20 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 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 { Document } from '../document'; + +export interface ResolvedDocument { + /** + * Document's absolute path + */ + absolutePath: string; + /** + * Document's root + */ + document: Document; +} diff --git a/packages/kbn-openapi-bundler/src/bundler/ref_resolver/resolved_ref.ts b/packages/kbn-openapi-bundler/src/bundler/ref_resolver/resolved_ref.ts new file mode 100644 index 0000000000000..f7beb71f25a73 --- /dev/null +++ b/packages/kbn-openapi-bundler/src/bundler/ref_resolver/resolved_ref.ts @@ -0,0 +1,22 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 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 { DocumentNode } from '../process_document/types/node'; +import { ResolvedDocument } from './resolved_document'; + +export interface ResolvedRef extends ResolvedDocument { + /** + * Parsed pointer without leading hash symbol (e.g. `/components/schemas/MySchema`) + */ + pointer: string; + + /** + * Resolved ref's node pointer points to + */ + refNode: DocumentNode; +} diff --git a/packages/kbn-openapi-bundler/src/openapi_bundler.ts b/packages/kbn-openapi-bundler/src/openapi_bundler.ts index aa542a28b0a32..856f9aaeb9b98 100644 --- a/packages/kbn-openapi-bundler/src/openapi_bundler.ts +++ b/packages/kbn-openapi-bundler/src/openapi_bundler.ts @@ -21,13 +21,18 @@ import { createBlankOpenApiDocument } from './bundler/merge_documents/create_bla export interface BundlerConfig { sourceGlob: string; outputFilePath: string; + options?: BundleOptions; +} + +interface BundleOptions { + includeLabels?: string[]; specInfo?: Omit, 'version'>; } export const bundle = async ({ sourceGlob, outputFilePath = 'bundled-{version}.schema.yaml', - specInfo, + options, }: BundlerConfig) => { logger.debug(chalk.bold(`Bundling API route schemas`)); logger.debug(`👀 Searching for source files in ${chalk.underline(sourceGlob)}`); @@ -46,20 +51,20 @@ export const bundle = async ({ logger.debug(`Processing schemas...`); - const resolvedDocuments = await resolveDocuments(schemaFilePaths); + const resolvedDocuments = await resolveDocuments(schemaFilePaths, options); logger.success(`Processed ${resolvedDocuments.length} schemas`); const blankOasFactory = (oasVersion: string, apiVersion: string) => createBlankOpenApiDocument(oasVersion, { version: apiVersion, - title: specInfo?.title ?? 'Bundled OpenAPI specs', + title: options?.specInfo?.title ?? 'Bundled OpenAPI specs', ...omitBy( { - description: specInfo?.description, - termsOfService: specInfo?.termsOfService, - contact: specInfo?.contact, - license: specInfo?.license, + description: options?.specInfo?.description, + termsOfService: options?.specInfo?.termsOfService, + contact: options?.specInfo?.contact, + license: options?.specInfo?.license, }, isUndefined ), @@ -75,11 +80,16 @@ function logSchemas(schemaFilePaths: string[]): void { } } -async function resolveDocuments(schemaFilePaths: string[]): Promise { +async function resolveDocuments( + schemaFilePaths: string[], + options?: BundleOptions +): Promise { const resolvedDocuments = await Promise.all( schemaFilePaths.map(async (schemaFilePath) => { try { - const resolvedDocument = await bundleDocument(schemaFilePath); + const resolvedDocument = await bundleDocument(schemaFilePath, { + includeLabels: options?.includeLabels, + }); logger.debug(`Processed ${chalk.bold(basename(schemaFilePath))}`); diff --git a/packages/kbn-openapi-bundler/src/utils/has_prop.ts b/packages/kbn-openapi-bundler/src/utils/has_prop.ts index aa38041b8178d..b10e0824eed90 100644 --- a/packages/kbn-openapi-bundler/src/utils/has_prop.ts +++ b/packages/kbn-openapi-bundler/src/utils/has_prop.ts @@ -8,7 +8,7 @@ import { isPlainObjectType } from './is_plain_object_type'; -export function hasProp( +export function hasProp( node: unknown, propName: Property, propValue?: Value diff --git a/packages/kbn-openapi-bundler/src/__test__/bundle_refs.test.ts b/packages/kbn-openapi-bundler/tests/bundle_refs.test.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/bundle_refs.test.ts rename to packages/kbn-openapi-bundler/tests/bundle_refs.test.ts diff --git a/packages/kbn-openapi-bundler/src/__test__/bundle_simple_specs.test.ts b/packages/kbn-openapi-bundler/tests/bundle_simple_specs.test.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/bundle_simple_specs.test.ts rename to packages/kbn-openapi-bundler/tests/bundle_simple_specs.test.ts diff --git a/packages/kbn-openapi-bundler/src/__test__/bundle_specs.ts b/packages/kbn-openapi-bundler/tests/bundle_specs.ts similarity index 86% rename from packages/kbn-openapi-bundler/src/__test__/bundle_specs.ts rename to packages/kbn-openapi-bundler/tests/bundle_specs.ts index 599f81c0e4c85..0eaf7d3e1a974 100644 --- a/packages/kbn-openapi-bundler/src/__test__/bundle_specs.ts +++ b/packages/kbn-openapi-bundler/tests/bundle_specs.ts @@ -18,12 +18,16 @@ import { } from 'fs'; import { dump, load } from 'js-yaml'; import { OpenAPIV3 } from 'openapi-types'; -import { bundle } from '../openapi_bundler'; +import { bundle, BundlerConfig } from '../src/openapi_bundler'; -const ROOT_PATH = join(__dirname, '..', '..'); +const ROOT_PATH = join(__dirname, '..'); + +// Suppress bundler logging via mocking the logger +jest.mock('../src/logger'); export async function bundleSpecs( - oasSpecs: Record + oasSpecs: Record, + options?: BundlerConfig['options'] ): Promise> { const randomStr = (Math.random() + 1).toString(36).substring(7); const folderToBundlePath = join(ROOT_PATH, 'target', 'oas-test', randomStr); @@ -32,7 +36,7 @@ export async function bundleSpecs( dumpSpecs(folderToBundlePath, oasSpecs); - await bundleFolder(folderToBundlePath, bundledFilePathTemplate); + await bundleFolder(folderToBundlePath, bundledFilePathTemplate, options); return readBundledSpecs(resultFolderPath); } @@ -70,10 +74,12 @@ export function readBundledSpecs(folderPath: string): Record { await bundle({ sourceGlob: join(folderToBundlePath, '*.schema.yaml'), outputFilePath: bundledFilePathTemplate, + options, }); } diff --git a/packages/kbn-openapi-bundler/src/__test__/bundle_specs_with_multiple_modifications.test.ts b/packages/kbn-openapi-bundler/tests/bundle_specs_with_multiple_modifications.test.ts similarity index 96% rename from packages/kbn-openapi-bundler/src/__test__/bundle_specs_with_multiple_modifications.test.ts rename to packages/kbn-openapi-bundler/tests/bundle_specs_with_multiple_modifications.test.ts index ed57d745f2ee4..f042596c56433 100644 --- a/packages/kbn-openapi-bundler/src/__test__/bundle_specs_with_multiple_modifications.test.ts +++ b/packages/kbn-openapi-bundler/tests/bundle_specs_with_multiple_modifications.test.ts @@ -19,7 +19,9 @@ describe('OpenAPI Bundler - specs with multiple modifications', () => { const outputFolderPath = join(ROOT_PATH, 'target', 'complex_specs_test'); const bundledFilePathTemplate = join(outputFolderPath, 'oas-test-bundle-{version}.yaml'); - await bundleFolder(folderToBundlePath, bundledFilePathTemplate); + await bundleFolder(folderToBundlePath, bundledFilePathTemplate, { + includeLabels: ['include'], + }); const [bundledSpec] = Object.values(readBundledSpecs(outputFolderPath)); diff --git a/packages/kbn-openapi-bundler/src/__test__/circular.test.ts b/packages/kbn-openapi-bundler/tests/circular.test.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/circular.test.ts rename to packages/kbn-openapi-bundler/tests/circular.test.ts diff --git a/packages/kbn-openapi-bundler/src/__test__/complex_specs/common.schema.yaml b/packages/kbn-openapi-bundler/tests/complex_specs/common.schema.yaml similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/complex_specs/common.schema.yaml rename to packages/kbn-openapi-bundler/tests/complex_specs/common.schema.yaml diff --git a/packages/kbn-openapi-bundler/src/__test__/complex_specs/expected.yaml b/packages/kbn-openapi-bundler/tests/complex_specs/expected.yaml similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/complex_specs/expected.yaml rename to packages/kbn-openapi-bundler/tests/complex_specs/expected.yaml diff --git a/packages/kbn-openapi-bundler/tests/complex_specs/invalid_labels.schema.yaml b/packages/kbn-openapi-bundler/tests/complex_specs/invalid_labels.schema.yaml new file mode 100644 index 0000000000000..67cc5b616c684 --- /dev/null +++ b/packages/kbn-openapi-bundler/tests/complex_specs/invalid_labels.schema.yaml @@ -0,0 +1,17 @@ +openapi: 3.0.3 +info: + title: Test endpoint + version: '2023-10-31' +paths: + /api/another_api: + get: + x-labels: 10 + operationId: AnotherTestEndpointGet + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: './common.schema.yaml#/components/schemas/SharedSchema' + x-modify: partial diff --git a/packages/kbn-openapi-bundler/tests/complex_specs/missing_labels.schema.yaml b/packages/kbn-openapi-bundler/tests/complex_specs/missing_labels.schema.yaml new file mode 100644 index 0000000000000..0ad484323beae --- /dev/null +++ b/packages/kbn-openapi-bundler/tests/complex_specs/missing_labels.schema.yaml @@ -0,0 +1,16 @@ +openapi: 3.0.3 +info: + title: Test endpoint + version: '2023-10-31' +paths: + /api/missing_label_should_not_be_in_bundle: + post: + operationId: AnotherTestEndpointPost + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: './common.schema.yaml#/components/schemas/SharedSchema' + x-modify: partial diff --git a/packages/kbn-openapi-bundler/src/__test__/complex_specs/spec1.schema.yaml b/packages/kbn-openapi-bundler/tests/complex_specs/spec1.schema.yaml similarity index 93% rename from packages/kbn-openapi-bundler/src/__test__/complex_specs/spec1.schema.yaml rename to packages/kbn-openapi-bundler/tests/complex_specs/spec1.schema.yaml index 0d6656fde5b68..c634ba56ccee7 100644 --- a/packages/kbn-openapi-bundler/src/__test__/complex_specs/spec1.schema.yaml +++ b/packages/kbn-openapi-bundler/tests/complex_specs/spec1.schema.yaml @@ -5,6 +5,7 @@ info: paths: /api/some_api: get: + x-labels: [include] operationId: TestEndpointGet responses: '200': diff --git a/packages/kbn-openapi-bundler/src/__test__/complex_specs/spec2.schema.yaml b/packages/kbn-openapi-bundler/tests/complex_specs/spec2.schema.yaml similarity index 95% rename from packages/kbn-openapi-bundler/src/__test__/complex_specs/spec2.schema.yaml rename to packages/kbn-openapi-bundler/tests/complex_specs/spec2.schema.yaml index a79a78f94950d..eb57308956848 100644 --- a/packages/kbn-openapi-bundler/src/__test__/complex_specs/spec2.schema.yaml +++ b/packages/kbn-openapi-bundler/tests/complex_specs/spec2.schema.yaml @@ -5,6 +5,7 @@ info: paths: /api/some_api: post: + x-labels: [include, labelA] operationId: TestEndpointPost responses: '200': diff --git a/packages/kbn-openapi-bundler/src/__test__/complex_specs/spec3.schema.yaml b/packages/kbn-openapi-bundler/tests/complex_specs/spec3.schema.yaml similarity index 96% rename from packages/kbn-openapi-bundler/src/__test__/complex_specs/spec3.schema.yaml rename to packages/kbn-openapi-bundler/tests/complex_specs/spec3.schema.yaml index d249210fff2d2..20423eaa96207 100644 --- a/packages/kbn-openapi-bundler/src/__test__/complex_specs/spec3.schema.yaml +++ b/packages/kbn-openapi-bundler/tests/complex_specs/spec3.schema.yaml @@ -5,6 +5,7 @@ info: paths: /api/some_api: put: + x-labels: [include, labelA, labelB] x-codegen-enabled: true operationId: TestEndpointPut responses: diff --git a/packages/kbn-openapi-bundler/src/__test__/create_oas_document.ts b/packages/kbn-openapi-bundler/tests/create_oas_document.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/create_oas_document.ts rename to packages/kbn-openapi-bundler/tests/create_oas_document.ts diff --git a/packages/kbn-openapi-bundler/src/__test__/different_endpoint_versions.test.ts b/packages/kbn-openapi-bundler/tests/different_endpoint_versions.test.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/different_endpoint_versions.test.ts rename to packages/kbn-openapi-bundler/tests/different_endpoint_versions.test.ts diff --git a/packages/kbn-openapi-bundler/src/__test__/different_oas_versions.test.ts b/packages/kbn-openapi-bundler/tests/different_oas_versions.test.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/different_oas_versions.test.ts rename to packages/kbn-openapi-bundler/tests/different_oas_versions.test.ts diff --git a/packages/kbn-openapi-bundler/tests/include_labels.test.ts b/packages/kbn-openapi-bundler/tests/include_labels.test.ts new file mode 100644 index 0000000000000..8456afdd00c3e --- /dev/null +++ b/packages/kbn-openapi-bundler/tests/include_labels.test.ts @@ -0,0 +1,370 @@ +/* + * 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 { bundleSpecs } from './bundle_specs'; +import { createOASDocument } from './create_oas_document'; + +describe('OpenAPI Bundler - include labeled operations', () => { + it.each([ + { + label: 'labelA', + expectedPathObjects: { '/api/some_api': ['post'], '/api/another_api': ['get'] }, + }, + { label: 'labelB', expectedPathObjects: { '/api/some_api': ['get'] } }, + ])('includes operation objects with "$label" label', async ({ label, expectedPathObjects }) => { + const spec = createOASDocument({ + paths: { + '/api/some_api': { + get: { + // @ts-expect-error custom property is unexpected here + 'x-labels': ['labelB'], + responses: { + '200': { + description: 'Successful response', + content: { + 'application/json': { + schema: { + type: 'string', + }, + }, + }, + }, + }, + }, + post: { + 'x-labels': ['labelA'], + responses: { + '200': { + description: 'Successful response', + content: { + 'application/json': { + schema: { + type: 'string', + }, + }, + }, + }, + }, + }, + }, + '/api/another_api': { + get: { + // @ts-expect-error custom property is unexpected here + 'x-labels': ['labelA'], + responses: { + '200': { + description: 'Successful response', + content: { + 'application/json': { + schema: { + type: 'string', + }, + }, + }, + }, + }, + }, + }, + }, + }); + + const [bundledSpec] = Object.values( + await bundleSpecs( + { + 1: spec, + }, + { + includeLabels: [label], + } + ) + ); + + expect(Object.keys(bundledSpec.paths)).toEqual( + expect.arrayContaining(Object.keys(expectedPathObjects)) + ); + + for (const [path, verbs] of Object.entries(expectedPathObjects)) { + expect(Object.keys(bundledSpec.paths[path]!)).toEqual(expect.arrayContaining(verbs)); + } + }); + + it('includes operation objects with multiple labels', async () => { + const spec = createOASDocument({ + paths: { + '/api/some_api': { + get: { + // @ts-expect-error custom property is unexpected here + 'x-labels': ['labelA', 'labelB'], + responses: { + '200': { + description: 'Successful response', + content: { + 'application/json': { + schema: { + type: 'string', + }, + }, + }, + }, + }, + }, + }, + }, + }); + + const [bundledSpec] = Object.values( + await bundleSpecs( + { + 1: spec, + }, + { + includeLabels: ['labelA', 'labelB'], + } + ) + ); + + expect(bundledSpec.paths).toEqual({ + '/api/some_api': { + get: expect.anything(), + }, + }); + }); + + it('does NOT include operation objects with incomplete labels set', async () => { + const spec = createOASDocument({ + paths: { + '/api/some_api': { + get: { + // @ts-expect-error custom property is unexpected here + 'x-labels': ['labelA', 'labelB', 'labelC'], + responses: { + '200': { + description: 'Successful response', + content: { + 'application/json': { + schema: { + type: 'string', + }, + }, + }, + }, + }, + }, + put: { + 'x-labels': ['labelA', 'labelC'], + responses: { + '200': { + description: 'Successful response', + content: { + 'application/json': { + schema: { + type: 'string', + }, + }, + }, + }, + }, + }, + }, + }, + }); + + const [bundledSpec] = Object.values( + await bundleSpecs( + { + 1: spec, + }, + { + includeLabels: ['labelA', 'labelB'], + } + ) + ); + + expect(bundledSpec.paths).toEqual({ + '/api/some_api': { + get: expect.anything(), + }, + }); + }); + + it('does NOT include operation objects without labels', async () => { + const spec = createOASDocument({ + paths: { + '/api/some_api': { + get: { + // @ts-expect-error custom property is unexpected here + 'x-labels': ['labelA'], + responses: { + '200': { + description: 'Successful response', + content: { + 'application/json': { + schema: { + type: 'string', + }, + }, + }, + }, + }, + }, + }, + '/api/missing_label_should_not_be_in_bundle': { + put: { + responses: { + '200': { + description: 'Successful response', + content: { + 'application/json': { + schema: { + type: 'string', + }, + }, + }, + }, + }, + }, + }, + }, + }); + + const [bundledSpec] = Object.values( + await bundleSpecs( + { + 1: spec, + }, + { + includeLabels: ['labelA'], + } + ) + ); + + expect(bundledSpec.paths).toEqual({ + '/api/some_api': { + get: expect.anything(), + }, + }); + }); + + it('does NOT include operation objects when labels are not an array', async () => { + const spec = createOASDocument({ + paths: { + '/api/some_api': { + get: { + // @ts-expect-error custom property is unexpected here + 'x-labels': 10, + responses: { + '200': { + description: 'Successful response', + content: { + 'application/json': { + schema: { + type: 'string', + }, + }, + }, + }, + }, + }, + put: { + 'x-labels': ['labelA'], + responses: { + '200': { + description: 'Successful response', + content: { + 'application/json': { + schema: { + type: 'string', + }, + }, + }, + }, + }, + }, + }, + }, + }); + + const [bundledSpec] = Object.values( + await bundleSpecs( + { + 1: spec, + }, + { + includeLabels: ['labelA'], + } + ) + ); + + expect(bundledSpec.paths).toEqual({ + '/api/some_api': { + put: expect.anything(), + }, + }); + }); + + it('removes path items without HTTP verbs defined', async () => { + const spec = createOASDocument({ + paths: { + '/api/some_api': { + get: { + // @ts-expect-error custom property is unexpected here + 'x-labels': ['labelA'], + responses: { + '200': { + description: 'Successful response', + content: { + 'application/json': { + schema: { + type: 'string', + }, + }, + }, + }, + }, + }, + }, + '/api/to_be_removed': { + summary: 'Some API PUT method OAS definition', + put: { + // @ts-expect-error custom property is unexpected here + 'x-labels': ['labelB'], + responses: { + '200': { + description: 'Successful response', + content: { + 'application/json': { + schema: { + type: 'string', + }, + }, + }, + }, + }, + }, + }, + }, + }); + + const [bundledSpec] = Object.values( + await bundleSpecs( + { + 1: spec, + }, + { + includeLabels: ['labelA'], + } + ) + ); + + expect(bundledSpec.paths).toEqual({ + '/api/some_api': { + get: expect.anything(), + }, + }); + }); +}); diff --git a/packages/kbn-openapi-bundler/src/__test__/inline_ref.test.ts b/packages/kbn-openapi-bundler/tests/inline_ref.test.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/inline_ref.test.ts rename to packages/kbn-openapi-bundler/tests/inline_ref.test.ts diff --git a/packages/kbn-openapi-bundler/src/__test__/omit_unused_schemas.test.ts b/packages/kbn-openapi-bundler/tests/omit_unused_schemas.test.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/omit_unused_schemas.test.ts rename to packages/kbn-openapi-bundler/tests/omit_unused_schemas.test.ts diff --git a/packages/kbn-openapi-bundler/src/__test__/produce_stable_bundle.test.ts b/packages/kbn-openapi-bundler/tests/produce_stable_bundle.test.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/produce_stable_bundle.test.ts rename to packages/kbn-openapi-bundler/tests/produce_stable_bundle.test.ts diff --git a/packages/kbn-openapi-bundler/src/__test__/reduce_all_of.test.ts b/packages/kbn-openapi-bundler/tests/reduce_all_of.test.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/reduce_all_of.test.ts rename to packages/kbn-openapi-bundler/tests/reduce_all_of.test.ts diff --git a/packages/kbn-openapi-bundler/src/__test__/remove_props.test.ts b/packages/kbn-openapi-bundler/tests/remove_props.test.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/remove_props.test.ts rename to packages/kbn-openapi-bundler/tests/remove_props.test.ts diff --git a/packages/kbn-openapi-bundler/src/__test__/skip_nodes.test.ts b/packages/kbn-openapi-bundler/tests/skip_nodes.test.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/skip_nodes.test.ts rename to packages/kbn-openapi-bundler/tests/skip_nodes.test.ts diff --git a/packages/kbn-openapi-bundler/src/__test__/x_modify.test.ts b/packages/kbn-openapi-bundler/tests/x_modify.test.ts similarity index 100% rename from packages/kbn-openapi-bundler/src/__test__/x_modify.test.ts rename to packages/kbn-openapi-bundler/tests/x_modify.test.ts diff --git a/packages/kbn-optimizer/limits.yml b/packages/kbn-optimizer/limits.yml index 29de4a26abcc9..a7ec0e03f3dda 100644 --- a/packages/kbn-optimizer/limits.yml +++ b/packages/kbn-optimizer/limits.yml @@ -83,6 +83,7 @@ pageLoadAssetSize: inputControlVis: 172675 inspector: 148711 interactiveSetup: 80000 + investigate: 17970 kibanaOverview: 56279 kibanaReact: 74422 kibanaUsageCollection: 16463 diff --git a/packages/kbn-storybook/src/lib/decorators.tsx b/packages/kbn-storybook/src/lib/decorators.tsx index 8693d55faac61..ff10c78fe4589 100644 --- a/packages/kbn-storybook/src/lib/decorators.tsx +++ b/packages/kbn-storybook/src/lib/decorators.tsx @@ -18,10 +18,11 @@ import { CoreTheme } from '@kbn/core-theme-browser'; import { I18nStart } from '@kbn/core-i18n-browser'; import type { AnalyticsServiceStart } from '@kbn/core-analytics-browser'; import { KibanaRootContextProvider } from '@kbn/react-kibana-context-root'; +import { i18n } from '@kbn/i18n'; const theme$ = new BehaviorSubject({ darkMode: false }); -const i18n: I18nStart = { +const i18nStart: I18nStart = { Context: ({ children }) => {children}, }; @@ -36,6 +37,8 @@ const analytics: AnalyticsServiceStart = { * `globals` provided by the Storybook theme switcher to set the `colorMode`. */ const KibanaContextDecorator: DecoratorFn = (storyFn, { globals }) => { + // TODO: Add a switcher to see components in other locales or pseudo locale + i18n.init({ locale: 'en', messages: {} }); const colorMode = globals.euiTheme === 'v8.dark' ? 'dark' : 'light'; useEffect(() => { @@ -43,7 +46,7 @@ const KibanaContextDecorator: DecoratorFn = (storyFn, { globals }) => { }, [colorMode]); return ( - + {storyFn()} ); diff --git a/packages/kbn-storybook/tsconfig.json b/packages/kbn-storybook/tsconfig.json index 97d423551115d..ab513c1d02c0c 100644 --- a/packages/kbn-storybook/tsconfig.json +++ b/packages/kbn-storybook/tsconfig.json @@ -17,6 +17,7 @@ "@kbn/repo-info", "@kbn/dev-cli-runner", "@kbn/core-theme-browser", + "@kbn/i18n", "@kbn/i18n-react", "@kbn/core-i18n-browser", "@kbn/react-kibana-context-root", diff --git a/packages/kbn-text-based-editor/src/esql_documentation_sections.tsx b/packages/kbn-text-based-editor/src/esql_documentation_sections.tsx index 84dfcde890d66..24d621e0d3750 100644 --- a/packages/kbn-text-based-editor/src/esql_documentation_sections.tsx +++ b/packages/kbn-text-based-editor/src/esql_documentation_sections.tsx @@ -172,6 +172,7 @@ The \`SHOW \` source command returns information about the deployment and * Use \`SHOW INFO\` to return the deployment's version, build date and hash. * Use \`SHOW FUNCTIONS\` to return a list of all supported functions and a synopsis of each function. `, + ignoreTag: true, description: 'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)', } @@ -214,9 +215,9 @@ Refer to the [dissect processor documentation](https://www.elastic.co/guide/en/e \`\`\` ROW a = "1953-01-23T12:15:00Z - some text - 127.0.0.1" -| DISSECT a "%\\{Y\\}-%\\{M\\}-%\\{D\\}T%\\{h\\}:%\\{m\\}:%\\{s\\}Z - %\\{msg\\} - %\\{ip\\}" -\`\`\` - `, +| DISSECT a "%'\{Y\}-%\{M\}-%\{D\}T%\{h\}:%\{m\}:%\{s\}Z - %\{msg\} - %\{ip\}'" +\`\`\` `, + ignoreTag: true, description: 'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)', } @@ -308,6 +309,7 @@ By default (if no \`WITH\` is defined), \`ENRICH\` will add all the enrich field In case of name collisions, the newly created fields will override the existing fields. `, + ignoreTag: true, description: 'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)', } @@ -376,7 +378,7 @@ Refer to the [grok processor documentation](https://www.elastic.co/guide/en/elas \`\`\` ROW a = "12 15.5 15.6 true" -| GROK a "%\\{NUMBER:b:int\\} %\\{NUMBER:c:float\\} %\\{NUMBER:d:double\\} %\\{WORD:e:boolean\\}" +| GROK a "%'{NUMBER:b:int}' %'{NUMBER:c:float}' %'{NUMBER:d:double}' %'{WORD:e:boolean}'" \`\`\` `, description: @@ -523,6 +525,7 @@ FROM employees | RENAME first_name AS fn, last_name AS ln \`\`\` `, + ignoreTag: true, description: 'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)', } diff --git a/packages/kbn-text-based-editor/src/query_history.tsx b/packages/kbn-text-based-editor/src/query_history.tsx index 5190789de1660..d7272e8d59e12 100644 --- a/packages/kbn-text-based-editor/src/query_history.tsx +++ b/packages/kbn-text-based-editor/src/query_history.tsx @@ -66,7 +66,7 @@ export function QueryHistoryAction({ } > {isHistoryOpen diff --git a/packages/kbn-text-based-editor/src/text_based_languages_editor.styles.ts b/packages/kbn-text-based-editor/src/text_based_languages_editor.styles.ts index 3f5bd008f8409..39a02a35516ab 100644 --- a/packages/kbn-text-based-editor/src/text_based_languages_editor.styles.ts +++ b/packages/kbn-text-based-editor/src/text_based_languages_editor.styles.ts @@ -56,10 +56,12 @@ export const textBasedLanguageEditorStyles = ( width: isCodeEditorExpanded ? '100%' : `calc(100% - ${hasReference ? 80 : 40}px)`, alignItems: isCompactFocused ? 'flex-start' : 'center', border: !isCompactFocused ? euiTheme.border.thin : 'none', - borderTopLeftRadius: euiTheme.border.radius.medium, - borderBottomLeftRadius: euiTheme.border.radius.medium, + borderTopLeftRadius: isCodeEditorExpanded ? 0 : euiTheme.border.radius.medium, + borderBottomLeftRadius: isCodeEditorExpanded ? 0 : euiTheme.border.radius.medium, borderBottomWidth: hasErrors ? '2px' : '1px', borderBottomColor: hasErrors ? euiTheme.colors.danger : euiTheme.colors.lightShade, + borderRight: isCodeEditorExpanded ? euiTheme.border.thin : 'none', + ...(isCodeEditorExpanded && { overflow: 'hidden' }), }, linesBadge: { position: 'absolute' as const, @@ -84,15 +86,16 @@ export const textBasedLanguageEditorStyles = ( ? `2px solid ${euiTheme.colors.danger}` : euiTheme.border.thin : `2px solid ${bottomContainerBorderColor}`, + borderBottom: editorIsInline ? 'none' : euiTheme.border.thin, backgroundColor: euiTheme.colors.lightestShade, paddingLeft: euiTheme.size.base, paddingRight: euiTheme.size.base, paddingTop: editorIsInline ? euiTheme.size.s : euiTheme.size.xs, paddingBottom: editorIsInline ? euiTheme.size.s : euiTheme.size.xs, - width: 'calc(100% + 2px)', + width: isCodeEditorExpanded ? '100%' : 'calc(100% + 2px)', position: 'relative' as const, marginTop: 0, - marginLeft: 0, + marginLeft: isCodeEditorExpanded ? 0 : -1, marginBottom: 0, borderBottomLeftRadius: editorIsInline || historyIsOpen ? 0 : euiTheme.border.radius.medium, borderBottomRightRadius: editorIsInline || historyIsOpen ? 0 : euiTheme.border.radius.medium, @@ -103,7 +106,7 @@ export const textBasedLanguageEditorStyles = ( borderLeft: editorIsInline ? 'none' : euiTheme.border.thin, borderRight: editorIsInline ? 'none' : euiTheme.border.thin, backgroundColor: euiTheme.colors.lightestShade, - width: 'calc(100% + 2px)', + width: '100%', position: 'relative' as const, marginTop: 0, marginLeft: 0, @@ -116,14 +119,15 @@ export const textBasedLanguageEditorStyles = ( borderTopLeftRadius: editorIsInline ? 0 : euiTheme.border.radius.medium, borderTopRightRadius: editorIsInline ? 0 : euiTheme.border.radius.medium, backgroundColor: euiTheme.colors.lightestShade, - paddingLeft: euiTheme.size.base, - paddingRight: euiTheme.size.base, + paddingLeft: euiTheme.size.xs, + paddingRight: euiTheme.size.xs, paddingTop: showHeader ? euiTheme.size.s : euiTheme.size.xs, paddingBottom: showHeader ? euiTheme.size.s : euiTheme.size.xs, - width: 'calc(100% + 2px)', + width: '100%', position: 'relative' as const, marginLeft: 0, marginTop: editorIsInline ? 0 : euiTheme.size.s, + borderBottom: 'none', }, dragResizeContainer: { width: '100%', diff --git a/packages/kbn-text-based-editor/src/text_based_languages_editor.tsx b/packages/kbn-text-based-editor/src/text_based_languages_editor.tsx index cfa472140cd82..65516e498ba15 100644 --- a/packages/kbn-text-based-editor/src/text_based_languages_editor.tsx +++ b/packages/kbn-text-based-editor/src/text_based_languages_editor.tsx @@ -29,7 +29,6 @@ import { type LanguageDocumentationSections, } from '@kbn/language-documentation-popover'; import { ESQLLang, ESQL_LANG_ID, ESQL_THEME_ID, monaco, type ESQLCallbacks } from '@kbn/monaco'; -import { TooltipWrapper } from '@kbn/visualization-utils'; import classNames from 'classnames'; import memoize from 'lodash/memoize'; import React, { memo, useCallback, useEffect, useMemo, useRef, useState } from 'react'; @@ -238,6 +237,28 @@ export const TextBasedLanguagesEditor = memo(function TextBasedLanguagesEditor({ } }, [language, onTextLangQuerySubmit, abortController, isQueryLoading, allowQueryCancellation]); + const onCommentLine = useCallback(() => { + const currentPosition = editor1.current?.getPosition(); + const lineNumber = currentPosition?.lineNumber; + if (lineNumber) { + const lineContent = editorModel.current?.getLineContent(lineNumber) ?? ''; + const hasComment = lineContent?.startsWith('//'); + const commentedLine = hasComment ? lineContent?.replace('//', '') : `//${lineContent}`; + // executeEdits allows to keep edit in history + editor1.current?.executeEdits('comment', [ + { + range: { + startLineNumber: lineNumber, + startColumn: 0, + endLineNumber: lineNumber, + endColumn: (lineContent?.length ?? 0) + 1, + }, + text: commentedLine, + }, + ]); + } + }, []); + useEffect(() => { if (!isLoading) setIsQueryLoading(false); }, [isLoading]); @@ -624,13 +645,10 @@ export const TextBasedLanguagesEditor = memo(function TextBasedLanguagesEditor({ } }, [isCodeEditorExpanded, queryString]); - const linesBreaksButtonsStatus = useMemo(() => { + const isWrappedInPipes = useMemo(() => { const pipes = code?.split('|'); const pipesWithNewLine = code?.split('\n|'); - return { - addLineBreaksDisabled: pipes?.length === pipesWithNewLine?.length, - removeLineBreaksDisabled: pipesWithNewLine?.length === 1, - }; + return pipes?.length === pipesWithNewLine?.length; }, [code]); useEffect(() => { @@ -698,68 +716,53 @@ export const TextBasedLanguagesEditor = memo(function TextBasedLanguagesEditor({ - { - const updatedCode = getWrappedInPipesCode(code, false); - if (code !== updatedCode) { - setCode(updatedCode); - onTextLangQueryChange({ [language]: updatedCode } as AggregateQuery); - } - }} - /> - - - - - { - const updatedCode = getWrappedInPipesCode(code, true); + const updatedCode = getWrappedInPipesCode(code, isWrappedInPipes); if (code !== updatedCode) { setCode(updatedCode); onTextLangQueryChange({ [language]: updatedCode } as AggregateQuery); } }} /> - + @@ -824,12 +827,7 @@ export const TextBasedLanguagesEditor = memo(function TextBasedLanguagesEditor({ )} - + { restoreInitialMode(); @@ -927,6 +925,13 @@ export const TextBasedLanguagesEditor = memo(function TextBasedLanguagesEditor({ onQuerySubmit ); + // on CMD/CTRL + / comment out the entire line + editor.addCommand( + // eslint-disable-next-line no-bitwise + monaco.KeyMod.CtrlCmd | monaco.KeyCode.Slash, + onCommentLine + ); + setMeasuredEditorWidth(editor.getLayoutInfo().width); setMeasuredContentWidth(editor.getContentWidth()); diff --git a/packages/kbn-text-based-editor/tsconfig.json b/packages/kbn-text-based-editor/tsconfig.json index 78cee94bd68c8..fcb296d4d086c 100644 --- a/packages/kbn-text-based-editor/tsconfig.json +++ b/packages/kbn-text-based-editor/tsconfig.json @@ -24,7 +24,6 @@ "@kbn/expressions-plugin", "@kbn/data-views-plugin", "@kbn/index-management", - "@kbn/visualization-utils", "@kbn/code-editor", "@kbn/shared-ux-markdown", ], diff --git a/packages/kbn-unsaved-changes-prompt/README.md b/packages/kbn-unsaved-changes-prompt/README.md new file mode 100644 index 0000000000000..b5bdf1c361e37 --- /dev/null +++ b/packages/kbn-unsaved-changes-prompt/README.md @@ -0,0 +1,30 @@ +# @kbn/unsaved-changes-prompt + +The useUnsavedChangesPrompt function is a custom React hook that prompts users with +a confirmation dialog when they try to leave a page with unsaved changes. It blocks +navigation and shows a dialog using the provided openConfirm function. If the user +confirms, it navigates away; otherwise, it cancels the navigation, ensuring unsaved +changes are not lost. + + +```typescript +import { useUnsavedChangesPrompt } from '@kbn/unsaved-changes-prompt'; + +export const SampleForm = ({ servicesForUnsavedChangesPrompt }) => { + const { form } = useForm(); + const isFormDirty = useFormIsModified({ form }); + + useUnsavedChangesPrompt({ + hasUnsavedChanges: isFormDirty, + ...servicesForUnsavedChangesPrompt, + }); + + return ( + <> +
+ .... +
+ + ); +}; +``` \ No newline at end of file diff --git a/packages/kbn-unsaved-changes-prompt/index.ts b/packages/kbn-unsaved-changes-prompt/index.ts new file mode 100644 index 0000000000000..0e572e40f86a4 --- /dev/null +++ b/packages/kbn-unsaved-changes-prompt/index.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 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 { useUnsavedChangesPrompt } from './src/unsaved_changes_prompt'; diff --git a/packages/kbn-unsaved-changes-prompt/jest.config.js b/packages/kbn-unsaved-changes-prompt/jest.config.js new file mode 100644 index 0000000000000..0db09e6ffcb0b --- /dev/null +++ b/packages/kbn-unsaved-changes-prompt/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-unsaved-changes-prompt'], +}; diff --git a/packages/kbn-unsaved-changes-prompt/kibana.jsonc b/packages/kbn-unsaved-changes-prompt/kibana.jsonc new file mode 100644 index 0000000000000..3d3f2f6199dd6 --- /dev/null +++ b/packages/kbn-unsaved-changes-prompt/kibana.jsonc @@ -0,0 +1,5 @@ +{ + "type": "shared-common", + "id": "@kbn/unsaved-changes-prompt", + "owner": "@elastic/kibana-management" +} diff --git a/packages/kbn-unsaved-changes-prompt/package.json b/packages/kbn-unsaved-changes-prompt/package.json new file mode 100644 index 0000000000000..250b1068ab373 --- /dev/null +++ b/packages/kbn-unsaved-changes-prompt/package.json @@ -0,0 +1,6 @@ +{ + "name": "@kbn/unsaved-changes-prompt", + "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-unsaved-changes-prompt/src/unsaved_changes_prompt/index.ts b/packages/kbn-unsaved-changes-prompt/src/unsaved_changes_prompt/index.ts new file mode 100644 index 0000000000000..7520607519389 --- /dev/null +++ b/packages/kbn-unsaved-changes-prompt/src/unsaved_changes_prompt/index.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 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 { useUnsavedChangesPrompt } from './unsaved_changes_prompt'; diff --git a/packages/kbn-unsaved-changes-prompt/src/unsaved_changes_prompt/unsaved_changes_prompt.test.tsx b/packages/kbn-unsaved-changes-prompt/src/unsaved_changes_prompt/unsaved_changes_prompt.test.tsx new file mode 100644 index 0000000000000..bbd14526a0ac3 --- /dev/null +++ b/packages/kbn-unsaved-changes-prompt/src/unsaved_changes_prompt/unsaved_changes_prompt.test.tsx @@ -0,0 +1,65 @@ +/* + * 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 { createMemoryHistory } from 'history'; +import { renderHook, act } from '@testing-library/react-hooks'; + +import { coreMock } from '@kbn/core/public/mocks'; +import { CoreScopedHistory } from '@kbn/core/public'; + +import { useUnsavedChangesPrompt } from './unsaved_changes_prompt'; + +const basePath = '/mock'; +const memoryHistory = createMemoryHistory({ initialEntries: [basePath] }); +const history = new CoreScopedHistory(memoryHistory, basePath); +const coreStart = coreMock.createStart(); +const navigateToUrl = jest.fn().mockImplementation(async (url) => { + history.push(url); +}); + +describe('useUnsavedChangesPrompt', () => { + it('should not block if not edited', () => { + renderHook(() => + useUnsavedChangesPrompt({ + hasUnsavedChanges: false, + http: coreStart.http, + openConfirm: coreStart.overlays.openConfirm, + history, + navigateToUrl, + }) + ); + + act(() => history.push('/test')); + + expect(history.location.pathname).toBe('/test'); + expect(history.location.search).toBe(''); + expect(coreStart.overlays.openConfirm).not.toBeCalled(); + }); + + it('should block if edited', async () => { + coreStart.overlays.openConfirm.mockResolvedValue(true); + + renderHook(() => + useUnsavedChangesPrompt({ + hasUnsavedChanges: true, + http: coreStart.http, + openConfirm: coreStart.overlays.openConfirm, + history, + navigateToUrl, + }) + ); + + act(() => history.push('/test')); + + // needed because we have an async useEffect + await act(() => new Promise((resolve) => resolve())); + + expect(navigateToUrl).toBeCalledWith('/mock/test', expect.anything()); + expect(coreStart.overlays.openConfirm).toBeCalled(); + }); +}); diff --git a/packages/kbn-unsaved-changes-prompt/src/unsaved_changes_prompt/unsaved_changes_prompt.tsx b/packages/kbn-unsaved-changes-prompt/src/unsaved_changes_prompt/unsaved_changes_prompt.tsx new file mode 100644 index 0000000000000..20d815cffd8b3 --- /dev/null +++ b/packages/kbn-unsaved-changes-prompt/src/unsaved_changes_prompt/unsaved_changes_prompt.tsx @@ -0,0 +1,96 @@ +/* + * 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 { useEffect } from 'react'; +import { i18n } from '@kbn/i18n'; + +import { ApplicationStart, ScopedHistory, OverlayStart, HttpStart } from '@kbn/core/public'; + +const DEFAULT_BODY_TEXT = i18n.translate('unsavedChangesPrompt.defaultModalText', { + defaultMessage: `The data will be lost if you leave this page without saving the changes.`, +}); + +const DEFAULT_TITLE_TEXT = i18n.translate('unsavedChangesPrompt.defaultModalTitle', { + defaultMessage: 'Discard unsaved changes?', +}); + +const DEFAULT_CANCEL_BUTTON = i18n.translate('unsavedChangesPrompt.defaultModalCancel', { + defaultMessage: 'Keep editing', +}); + +const DEFAULT_CONFIRM_BUTTON = i18n.translate('unsavedChangesPrompt.defaultModalConfirm', { + defaultMessage: 'Leave page', +}); + +interface Props { + hasUnsavedChanges: boolean; + http: HttpStart; + openConfirm: OverlayStart['openConfirm']; + history: ScopedHistory; + navigateToUrl: ApplicationStart['navigateToUrl']; + titleText?: string; + messageText?: string; + cancelButtonText?: string; + confirmButtonText?: string; +} + +export const useUnsavedChangesPrompt = ({ + hasUnsavedChanges, + openConfirm, + history, + http, + navigateToUrl, + // Provide overrides for confirm dialog + messageText = DEFAULT_BODY_TEXT, + titleText = DEFAULT_TITLE_TEXT, + confirmButtonText = DEFAULT_CONFIRM_BUTTON, + cancelButtonText = DEFAULT_CANCEL_BUTTON, +}: Props) => { + useEffect(() => { + if (!hasUnsavedChanges) { + return; + } + + const unblock = history.block((state) => { + async function confirmAsync() { + const confirmResponse = await openConfirm(messageText, { + title: titleText, + cancelButtonText, + confirmButtonText, + 'data-test-subj': 'navigationBlockConfirmModal', + }); + + if (confirmResponse) { + // Compute the URL we want to redirect to + const url = http.basePath.prepend(state.pathname) + state.hash + state.search; + // Unload history block + unblock(); + // Navigate away + navigateToUrl(url, { + state: state.state, + }); + } + } + + confirmAsync(); + return false; + }); + + return unblock; + }, [ + history, + hasUnsavedChanges, + openConfirm, + navigateToUrl, + http.basePath, + titleText, + cancelButtonText, + confirmButtonText, + messageText, + ]); +}; diff --git a/packages/kbn-unsaved-changes-prompt/tsconfig.json b/packages/kbn-unsaved-changes-prompt/tsconfig.json new file mode 100644 index 0000000000000..a8d349af93f84 --- /dev/null +++ b/packages/kbn-unsaved-changes-prompt/tsconfig.json @@ -0,0 +1,14 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "outDir": "target/types" + }, + "include": ["*.ts", "src/**/*"], + "exclude": [ + "target/**/*" + ], + "kbn_references": [ + "@kbn/i18n", + "@kbn/core" + ] +} diff --git a/src/dev/build/args.test.ts b/src/dev/build/args.test.ts index 85f799daa8a0d..5d1aabc85a7f6 100644 --- a/src/dev/build/args.test.ts +++ b/src/dev/build/args.test.ts @@ -53,6 +53,7 @@ it('build default and oss dist for current platform, without packages, by defaul "initialize": true, "isRelease": false, "targetAllPlatforms": false, + "targetServerlessPlatforms": false, "versionQualifier": "", "withExamplePlugins": false, "withTestPlugins": false, @@ -94,6 +95,7 @@ it('builds packages if --all-platforms is passed', () => { "initialize": true, "isRelease": false, "targetAllPlatforms": true, + "targetServerlessPlatforms": false, "versionQualifier": "", "withExamplePlugins": false, "withTestPlugins": false, @@ -135,6 +137,7 @@ it('limits packages if --rpm passed with --all-platforms', () => { "initialize": true, "isRelease": false, "targetAllPlatforms": true, + "targetServerlessPlatforms": false, "versionQualifier": "", "withExamplePlugins": false, "withTestPlugins": false, @@ -176,6 +179,7 @@ it('limits packages if --deb passed with --all-platforms', () => { "initialize": true, "isRelease": false, "targetAllPlatforms": true, + "targetServerlessPlatforms": false, "versionQualifier": "", "withExamplePlugins": false, "withTestPlugins": false, @@ -218,6 +222,7 @@ it('limits packages if --docker passed with --all-platforms', () => { "initialize": true, "isRelease": false, "targetAllPlatforms": true, + "targetServerlessPlatforms": false, "versionQualifier": "", "withExamplePlugins": false, "withTestPlugins": false, @@ -267,6 +272,7 @@ it('limits packages if --docker passed with --skip-docker-ubi and --all-platform "initialize": true, "isRelease": false, "targetAllPlatforms": true, + "targetServerlessPlatforms": false, "versionQualifier": "", "withExamplePlugins": false, "withTestPlugins": false, @@ -309,6 +315,7 @@ it('limits packages if --all-platforms passed with --skip-docker-ubuntu', () => "initialize": true, "isRelease": false, "targetAllPlatforms": true, + "targetServerlessPlatforms": false, "versionQualifier": "", "withExamplePlugins": false, "withTestPlugins": false, @@ -351,6 +358,7 @@ it('limits packages if --all-platforms passed with --skip-docker-fips', () => { "initialize": true, "isRelease": false, "targetAllPlatforms": true, + "targetServerlessPlatforms": false, "versionQualifier": "", "withExamplePlugins": false, "withTestPlugins": false, diff --git a/src/dev/build/args.ts b/src/dev/build/args.ts index 9526d10eb2ae1..2ffab8ccb17b9 100644 --- a/src/dev/build/args.ts +++ b/src/dev/build/args.ts @@ -48,6 +48,7 @@ export function readCliArgs(argv: string[]) { 'help', 'with-test-plugins', 'with-example-plugins', + 'serverless', ], string: ['docker-namespace', 'epr-registry'], alias: { @@ -144,11 +145,13 @@ export function readCliArgs(argv: string[]) { isOsPackageDesired('docker-images') && !Boolean(flags['skip-docker-chainguard']), createDockerCloud: isOsPackageDesired('docker-images') && !Boolean(flags['skip-docker-cloud']), createDockerServerless: - isOsPackageDesired('docker-images') && !Boolean(flags['skip-docker-serverless']), + (isOsPackageDesired('docker-images') && !Boolean(flags['skip-docker-serverless'])) || + Boolean(flags.serverless), createDockerUBI: isOsPackageDesired('docker-images') && !Boolean(flags['skip-docker-ubi']), createDockerContexts: !Boolean(flags['skip-docker-contexts']), createDockerFIPS: isOsPackageDesired('docker-images') && !Boolean(flags['skip-docker-fips']), targetAllPlatforms: Boolean(flags['all-platforms']), + targetServerlessPlatforms: Boolean(flags.serverless), eprRegistry: flags['epr-registry'], buildCanvasShareableRuntime: !Boolean(flags['skip-canvas-shareable-runtime']), withExamplePlugins: Boolean(flags['with-example-plugins']), diff --git a/src/dev/build/build_distributables.ts b/src/dev/build/build_distributables.ts index cc23b57530a68..fca37dd46769b 100644 --- a/src/dev/build/build_distributables.ts +++ b/src/dev/build/build_distributables.ts @@ -38,6 +38,7 @@ export interface BuildOptions { createDockerFIPS: boolean; versionQualifier: string | undefined; targetAllPlatforms: boolean; + targetServerlessPlatforms: boolean; withExamplePlugins: boolean; withTestPlugins: boolean; eprRegistry: 'production' | 'snapshot'; @@ -75,7 +76,6 @@ export async function buildDistributables(log: ToolingLog, options: BuildOptions } await run(Tasks.CopyLegacySource); - await run(Tasks.CopyBinScripts); await run(Tasks.CreateEmptyDirsAndFiles); await run(Tasks.CreateReadme); @@ -109,7 +109,7 @@ export async function buildDistributables(log: ToolingLog, options: BuildOptions await run(Tasks.CreateArchivesSources); await run(Tasks.PatchNativeModules); await run(Tasks.InstallChromium); - await run(Tasks.CleanExtraBinScripts); + await run(Tasks.CopyBinScripts); await run(Tasks.CleanNodeBuilds); await run(Tasks.AssertFileTime); diff --git a/src/dev/build/cli.ts b/src/dev/build/cli.ts index 86160988c0f72..105ce366742a5 100644 --- a/src/dev/build/cli.ts +++ b/src/dev/build/cli.ts @@ -38,6 +38,7 @@ if (showHelp) { --all-platforms {dim Produce archives for all platforms, not just this one} --rpm {dim Only build the rpm packages} --deb {dim Only build the deb packages} + --serverless {dim Only build the serverless packages} --docker-images {dim Only build the Docker images} --docker-context-use-local-artifact {dim Use a local artifact when building the Docker context} --docker-cross-compile {dim Produce arm64 and amd64 Docker images} diff --git a/src/dev/build/lib/build.test.ts b/src/dev/build/lib/build.test.ts index 76fa06b04affa..bbace15247286 100644 --- a/src/dev/build/lib/build.test.ts +++ b/src/dev/build/lib/build.test.ts @@ -16,6 +16,7 @@ expect.addSnapshotSerializer(createAbsolutePathSerializer()); const config = new Config( true, + false, { version: '8.0.0', engines: { diff --git a/src/dev/build/lib/build.ts b/src/dev/build/lib/build.ts index c777ad18dc51f..a888da135f2e3 100644 --- a/src/dev/build/lib/build.ts +++ b/src/dev/build/lib/build.ts @@ -22,19 +22,21 @@ export class Build { } resolvePathForPlatform(platform: Platform, ...args: string[]) { + const variant = platform.getVariant() ? `-${platform.getVariant()}` : ''; return this.config.resolveFromRepo( 'build', 'default', - `kibana-${this.config.getBuildVersion()}-${platform.getBuildName()}`, + `kibana${variant}-${this.config.getBuildVersion()}-${platform.getBuildName()}`, ...args ); } getPlatformArchivePath(platform: Platform) { const ext = platform.isWindows() ? 'zip' : 'tar.gz'; + const variant = platform.getVariant() ? `-${platform.getVariant()}` : ''; return this.config.resolveFromRepo( 'target', - `${this.name}-${this.config.getBuildVersion()}-${platform.getBuildName()}.${ext}` + `${this.name}${variant}-${this.config.getBuildVersion()}-${platform.getBuildName()}.${ext}` ); } diff --git a/src/dev/build/lib/config.test.ts b/src/dev/build/lib/config.test.ts index 72b74c6e168cd..76a45ddb2e182 100644 --- a/src/dev/build/lib/config.test.ts +++ b/src/dev/build/lib/config.test.ts @@ -33,6 +33,7 @@ const setup = async ({ return await Config.create({ isRelease, targetAllPlatforms, + targetServerlessPlatforms: false, dockerContextUseLocalArtifact: false, dockerCrossCompile: false, dockerNamespace: null, @@ -123,6 +124,8 @@ describe('#getTargetPlatforms()', () => { "darwin-arm64", "darwin-x64", "linux-arm64", + "linux-arm64", + "linux-x64", "linux-x64", "win32-x64", ] @@ -146,7 +149,15 @@ describe('#getNodePlatforms()', () => { .getTargetPlatforms() .map((p) => p.getNodeArch()) .sort() - ).toEqual(['darwin-arm64', 'darwin-x64', 'linux-arm64', 'linux-x64', 'win32-x64']); + ).toEqual([ + 'darwin-arm64', + 'darwin-x64', + 'linux-arm64', + 'linux-arm64', + 'linux-x64', + 'linux-x64', + 'win32-x64', + ]); }); it('returns this platform and linux, when targetAllPlatforms = false', async () => { diff --git a/src/dev/build/lib/config.ts b/src/dev/build/lib/config.ts index ced8e10afab4b..1cf8faed7dd6e 100644 --- a/src/dev/build/lib/config.ts +++ b/src/dev/build/lib/config.ts @@ -19,11 +19,17 @@ import { } from '@kbn/repo-packages'; import { getVersionInfo, VersionInfo } from './version_info'; -import { PlatformName, PlatformArchitecture, ALL_PLATFORMS } from './platform'; +import { + PlatformName, + PlatformArchitecture, + ALL_PLATFORMS, + SERVERLESS_PLATFORMS, +} from './platform'; interface Options { isRelease: boolean; targetAllPlatforms: boolean; + targetServerlessPlatforms: boolean; versionQualifier?: string; dockerContextUseLocalArtifact: boolean | null; dockerCrossCompile: boolean; @@ -45,6 +51,7 @@ export class Config { return new Config( opts.targetAllPlatforms, + opts.targetServerlessPlatforms, kibanaPackageJson, nodeVersion, REPO_ROOT, @@ -72,6 +79,7 @@ export class Config { constructor( private readonly targetAllPlatforms: boolean, + private readonly targetServerlessPlatforms: boolean, private readonly pkg: KibanaPackageJson, private readonly nodeVersion: string, private readonly repoRoot: string, @@ -164,6 +172,9 @@ export class Config { * specified only the platform for this OS will be returned */ getTargetPlatforms() { + if (this.targetServerlessPlatforms) { + return SERVERLESS_PLATFORMS; + } if (this.targetAllPlatforms) { return ALL_PLATFORMS; } @@ -177,6 +188,9 @@ export class Config { * reliably get the LICENSE file, which isn't included in the windows version */ getNodePlatforms() { + if (this.targetServerlessPlatforms) { + return SERVERLESS_PLATFORMS; + } if (this.targetAllPlatforms) { return ALL_PLATFORMS; } diff --git a/src/dev/build/lib/platform.test.ts b/src/dev/build/lib/platform.test.ts index 193579d1a35c1..facbc0bd1a577 100644 --- a/src/dev/build/lib/platform.test.ts +++ b/src/dev/build/lib/platform.test.ts @@ -10,45 +10,47 @@ import { Platform } from './platform'; describe('getName()', () => { it('returns the name argument', () => { - expect(new Platform('win32', 'x64', 'foo').getName()).toBe('win32'); + expect(new Platform('win32', 'x64', 'foo', null).getName()).toBe('win32'); }); }); describe('getNodeArch()', () => { it('returns the node arch for the passed name', () => { - expect(new Platform('win32', 'x64', 'foo').getNodeArch()).toBe('win32-x64'); + expect(new Platform('win32', 'x64', 'foo', null).getNodeArch()).toBe('win32-x64'); }); }); describe('getBuildName()', () => { it('returns the build name for the passed name', () => { - expect(new Platform('linux', 'arm64', 'linux-aarch64').getBuildName()).toBe('linux-aarch64'); + expect(new Platform('linux', 'arm64', 'linux-aarch64', null).getBuildName()).toBe( + 'linux-aarch64' + ); }); }); describe('isWindows()', () => { it('returns true if name is win32', () => { - expect(new Platform('win32', 'x64', 'foo').isWindows()).toBe(true); - expect(new Platform('linux', 'x64', 'foo').isWindows()).toBe(false); - expect(new Platform('darwin', 'x64', 'foo').isWindows()).toBe(false); - expect(new Platform('darwin', 'arm64', 'foo').isWindows()).toBe(false); + expect(new Platform('win32', 'x64', 'foo', null).isWindows()).toBe(true); + expect(new Platform('linux', 'x64', 'foo', null).isWindows()).toBe(false); + expect(new Platform('darwin', 'x64', 'foo', null).isWindows()).toBe(false); + expect(new Platform('darwin', 'arm64', 'foo', null).isWindows()).toBe(false); }); }); describe('isLinux()', () => { it('returns true if name is linux', () => { - expect(new Platform('win32', 'x64', 'foo').isLinux()).toBe(false); - expect(new Platform('linux', 'x64', 'foo').isLinux()).toBe(true); - expect(new Platform('darwin', 'x64', 'foo').isLinux()).toBe(false); - expect(new Platform('darwin', 'arm64', 'foo').isLinux()).toBe(false); + expect(new Platform('win32', 'x64', 'foo', null).isLinux()).toBe(false); + expect(new Platform('linux', 'x64', 'foo', null).isLinux()).toBe(true); + expect(new Platform('darwin', 'x64', 'foo', null).isLinux()).toBe(false); + expect(new Platform('darwin', 'arm64', 'foo', null).isLinux()).toBe(false); }); }); describe('isMac()', () => { it('returns true if name is darwin', () => { - expect(new Platform('win32', 'x64', 'foo').isMac()).toBe(false); - expect(new Platform('linux', 'x64', 'foo').isMac()).toBe(false); - expect(new Platform('darwin', 'x64', 'foo').isMac()).toBe(true); - expect(new Platform('darwin', 'arm64', 'foo').isMac()).toBe(true); + expect(new Platform('win32', 'x64', 'foo', null).isMac()).toBe(false); + expect(new Platform('linux', 'x64', 'foo', null).isMac()).toBe(false); + expect(new Platform('darwin', 'x64', 'foo', null).isMac()).toBe(true); + expect(new Platform('darwin', 'arm64', 'foo', null).isMac()).toBe(true); }); }); diff --git a/src/dev/build/lib/platform.ts b/src/dev/build/lib/platform.ts index 4c4ec271318d6..dc70fb47dcefc 100644 --- a/src/dev/build/lib/platform.ts +++ b/src/dev/build/lib/platform.ts @@ -8,12 +8,14 @@ export type PlatformName = 'win32' | 'darwin' | 'linux'; export type PlatformArchitecture = 'x64' | 'arm64'; +export type Variant = 'serverless' | null; export class Platform { constructor( private name: PlatformName, private architecture: PlatformArchitecture, - private buildName: string + private buildName: string, + private variant: Variant ) {} getName() { @@ -32,6 +34,10 @@ export class Platform { return `${this.name}-${this.architecture}`; } + getVariant() { + return this.variant; + } + isWindows() { return this.name === 'win32'; } @@ -43,12 +49,23 @@ export class Platform { isLinux() { return this.name === 'linux'; } + + isServerless() { + return this.variant === 'serverless'; + } } -export const ALL_PLATFORMS = [ - new Platform('linux', 'x64', 'linux-x86_64'), - new Platform('linux', 'arm64', 'linux-aarch64'), - new Platform('darwin', 'x64', 'darwin-x86_64'), - new Platform('darwin', 'arm64', 'darwin-aarch64'), - new Platform('win32', 'x64', 'windows-x86_64'), +export const DOWNLOAD_PLATFORMS = [ + new Platform('linux', 'x64', 'linux-x86_64', null), + new Platform('linux', 'arm64', 'linux-aarch64', null), + new Platform('darwin', 'x64', 'darwin-x86_64', null), + new Platform('darwin', 'arm64', 'darwin-aarch64', null), + new Platform('win32', 'x64', 'windows-x86_64', null), ]; + +export const SERVERLESS_PLATFORMS = [ + new Platform('linux', 'x64', 'linux-x86_64', 'serverless'), + new Platform('linux', 'arm64', 'linux-aarch64', 'serverless'), +]; + +export const ALL_PLATFORMS = [...DOWNLOAD_PLATFORMS, ...SERVERLESS_PLATFORMS]; diff --git a/src/dev/build/lib/runner.test.ts b/src/dev/build/lib/runner.test.ts index a8e62219bd414..87220d450f63e 100644 --- a/src/dev/build/lib/runner.test.ts +++ b/src/dev/build/lib/runner.test.ts @@ -45,6 +45,7 @@ const setup = async () => { const config = await Config.create({ isRelease: true, targetAllPlatforms: true, + targetServerlessPlatforms: false, versionQualifier: '-SNAPSHOT', dockerContextUseLocalArtifact: false, dockerCrossCompile: false, diff --git a/src/dev/build/tasks/bin/copy_bin_scripts_task.ts b/src/dev/build/tasks/bin/copy_bin_scripts_task.ts index 5eceb1c346f01..c2faf889a1d29 100644 --- a/src/dev/build/tasks/bin/copy_bin_scripts_task.ts +++ b/src/dev/build/tasks/bin/copy_bin_scripts_task.ts @@ -6,15 +6,43 @@ * Side Public License, v 1. */ +import Mustache from 'mustache'; +import { join } from 'path'; +import { readFileSync, writeFileSync, mkdirSync } from 'fs'; +import globby from 'globby'; import { copyAll, Task } from '../../lib'; export const CopyBinScripts: Task = { - description: 'Copying bin scripts into platform-generic build directory', + description: 'Copying bin scripts into platform-specific build directory', async run(config, log, build) { - await copyAll( - config.resolveFromRepo('src/dev/build/tasks/bin/scripts'), - build.resolvePath('bin') - ); + const scriptsSrc = config.resolveFromRepo('src/dev/build/tasks/bin/scripts'); + for (const platform of config.getTargetPlatforms()) { + const scriptsDest = build.resolvePathForPlatform(platform, 'bin'); + mkdirSync(scriptsDest, { recursive: true }); + + if (platform.isWindows()) { + await copyAll(scriptsSrc, scriptsDest, { + select: ['*.bat'], + }); + } else { + globby + .sync(['*'], { + ignore: ['*.bat'], + cwd: scriptsSrc, + }) + .forEach((script) => { + const template = readFileSync(join(scriptsSrc, script), { encoding: 'utf-8' }); + const output = Mustache.render(template, { + darwin: platform.isMac(), + linux: platform.isLinux(), + serverless: platform.isServerless(), + }); + writeFileSync(join(scriptsDest, script), output, { + mode: '0755', + }); + }); + } + } }, }; diff --git a/src/dev/build/tasks/bin/scripts/kibana b/src/dev/build/tasks/bin/scripts/kibana index 4a27e965dc037..e0957582897f0 100755 --- a/src/dev/build/tasks/bin/scripts/kibana +++ b/src/dev/build/tasks/bin/scripts/kibana @@ -15,17 +15,32 @@ done DIR="$(dirname "${SCRIPT}")/.." CONFIG_DIR=${KBN_PATH_CONF:-"$DIR/config"} -NODE="${DIR}/node/bin/node" -test -x "$NODE" -if [ ! -x "$NODE" ]; then - echo "unable to find usable node.js executable." - exit 1 -fi + +test_node() { + test -x "$NODE" + if [ ! -x "$NODE" ]; then + echo "unable to find usable node.js executable." + exit 1 + fi +} if [ -f "${CONFIG_DIR}/node.options" ]; then KBN_NODE_OPTS="$(grep -v ^# < ${CONFIG_DIR}/node.options | xargs)" fi +{{#darwin}} +NODE="${DIR}/node/default/bin/node" +{{/darwin}} +{{#linux}} +NODE="${DIR}/node/glibc-217/bin/node" +{{#serverless}} +if [ "$KBN_DISABLE_POINTER_COMPRESSION" != 'true' ]; then + NODE="${DIR}/node/pointer-compression/bin/node" +fi +{{/serverless}} +{{/linux}} +test_node + # Enable capturing heap snapshots. See https://nodejs.org/api/cli.html#--heapsnapshot-signalsignal # For now only on POSIX platforms, term signals work differently on Windows. NODE_OPTIONS_HEAPSNAPSHOT_DEFAULT="${NODE_OPTIONS_HEAPSNAPSHOT_DEFAULT:---heapsnapshot-signal=SIGUSR2 --diagnostic-dir=$DIR/data}" diff --git a/src/dev/build/tasks/bin/scripts/kibana-encryption-keys b/src/dev/build/tasks/bin/scripts/kibana-encryption-keys index 0521ca1c39ce7..5f3c5c08c9632 100755 --- a/src/dev/build/tasks/bin/scripts/kibana-encryption-keys +++ b/src/dev/build/tasks/bin/scripts/kibana-encryption-keys @@ -15,7 +15,12 @@ done DIR="$(dirname "${SCRIPT}")/.." CONFIG_DIR=${KBN_PATH_CONF:-"$DIR/config"} -NODE="${DIR}/node/bin/node" +{{#darwin}} +NODE="${DIR}/node/default/bin/node" +{{/darwin}} +{{#linux}} +NODE="${DIR}/node/glibc-217/bin/node" +{{/linux}} test -x "$NODE" if [ ! -x "$NODE" ]; then echo "unable to find usable node.js executable." diff --git a/src/dev/build/tasks/bin/scripts/kibana-encryption-keys.bat b/src/dev/build/tasks/bin/scripts/kibana-encryption-keys.bat index 3ad3c9e8b0797..63bca1df1ce5e 100755 --- a/src/dev/build/tasks/bin/scripts/kibana-encryption-keys.bat +++ b/src/dev/build/tasks/bin/scripts/kibana-encryption-keys.bat @@ -5,7 +5,7 @@ SETLOCAL ENABLEDELAYEDEXPANSION set SCRIPT_DIR=%~dp0 for %%I in ("%SCRIPT_DIR%..") do set DIR=%%~dpfI -set NODE=%DIR%\node\node.exe +set NODE=%DIR%\node\default\node.exe set NODE_ENV=production If Not Exist "%NODE%" ( diff --git a/src/dev/build/tasks/bin/scripts/kibana-health-gateway b/src/dev/build/tasks/bin/scripts/kibana-health-gateway index 6b190ee2d82c4..f2a48c2babdc8 100755 --- a/src/dev/build/tasks/bin/scripts/kibana-health-gateway +++ b/src/dev/build/tasks/bin/scripts/kibana-health-gateway @@ -15,7 +15,12 @@ done DIR="$(dirname "${SCRIPT}")/.." CONFIG_DIR=${KBN_PATH_CONF:-"$DIR/config"} -NODE="${DIR}/node/bin/node" +{{#darwin}} +NODE="${DIR}/node/default/bin/node" +{{/darwin}} +{{#linux}} +NODE="${DIR}/node/glibc-217/bin/node" +{{/linux}} test -x "$NODE" if [ ! -x "$NODE" ]; then echo "unable to find usable node.js executable." diff --git a/src/dev/build/tasks/bin/scripts/kibana-health-gateway.bat b/src/dev/build/tasks/bin/scripts/kibana-health-gateway.bat index 61c3474427d00..bcbc5cfbd5254 100755 --- a/src/dev/build/tasks/bin/scripts/kibana-health-gateway.bat +++ b/src/dev/build/tasks/bin/scripts/kibana-health-gateway.bat @@ -5,7 +5,7 @@ SETLOCAL ENABLEDELAYEDEXPANSION set SCRIPT_DIR=%~dp0 for %%I in ("%SCRIPT_DIR%..") do set DIR=%%~dpfI -set NODE=%DIR%\node\node.exe +set NODE=%DIR%\node\default\node.exe set NODE_ENV=production If Not Exist "%NODE%" ( diff --git a/src/dev/build/tasks/bin/scripts/kibana-keystore b/src/dev/build/tasks/bin/scripts/kibana-keystore index 7f9986b519023..d69f02a1869b6 100755 --- a/src/dev/build/tasks/bin/scripts/kibana-keystore +++ b/src/dev/build/tasks/bin/scripts/kibana-keystore @@ -15,7 +15,12 @@ done DIR="$(dirname "${SCRIPT}")/.." CONFIG_DIR=${KBN_PATH_CONF:-"$DIR/config"} -NODE="${DIR}/node/bin/node" +{{#darwin}} +NODE="${DIR}/node/default/bin/node" +{{/darwin}} +{{#linux}} +NODE="${DIR}/node/glibc-217/bin/node" +{{/linux}} test -x "$NODE" if [ ! -x "$NODE" ]; then echo "unable to find usable node.js executable." diff --git a/src/dev/build/tasks/bin/scripts/kibana-keystore.bat b/src/dev/build/tasks/bin/scripts/kibana-keystore.bat index 8142d4db15d06..91f183f19db08 100755 --- a/src/dev/build/tasks/bin/scripts/kibana-keystore.bat +++ b/src/dev/build/tasks/bin/scripts/kibana-keystore.bat @@ -5,7 +5,7 @@ SETLOCAL ENABLEDELAYEDEXPANSION set SCRIPT_DIR=%~dp0 for %%I in ("%SCRIPT_DIR%..") do set DIR=%%~dpfI -set NODE=%DIR%\node\node.exe +set NODE=%DIR%\node\default\node.exe set NODE_ENV=production If Not Exist "%NODE%" ( diff --git a/src/dev/build/tasks/bin/scripts/kibana-plugin b/src/dev/build/tasks/bin/scripts/kibana-plugin index 78fdb7702643f..4c64970775aef 100755 --- a/src/dev/build/tasks/bin/scripts/kibana-plugin +++ b/src/dev/build/tasks/bin/scripts/kibana-plugin @@ -15,7 +15,12 @@ done DIR="$(dirname "${SCRIPT}")/.." CONFIG_DIR=${KBN_PATH_CONF:-"$DIR/config"} -NODE="${DIR}/node/bin/node" +{{#darwin}} +NODE="${DIR}/node/default/bin/node" +{{/darwin}} +{{#linux}} +NODE="${DIR}/node/glibc-217/bin/node" +{{/linux}} test -x "$NODE" if [ ! -x "$NODE" ]; then echo "unable to find usable node.js executable." diff --git a/src/dev/build/tasks/bin/scripts/kibana-plugin.bat b/src/dev/build/tasks/bin/scripts/kibana-plugin.bat index 1841d1998bba6..a9758fbcbab6b 100755 --- a/src/dev/build/tasks/bin/scripts/kibana-plugin.bat +++ b/src/dev/build/tasks/bin/scripts/kibana-plugin.bat @@ -5,7 +5,7 @@ SETLOCAL ENABLEDELAYEDEXPANSION set SCRIPT_DIR=%~dp0 for %%I in ("%SCRIPT_DIR%..") do set DIR=%%~dpfI -set NODE=%DIR%\node\node.exe +set NODE=%DIR%\node\default\node.exe set NODE_ENV="production" If Not Exist "%NODE%" ( diff --git a/src/dev/build/tasks/bin/scripts/kibana-setup b/src/dev/build/tasks/bin/scripts/kibana-setup index db5ecd2db915c..8ba1ae875263d 100755 --- a/src/dev/build/tasks/bin/scripts/kibana-setup +++ b/src/dev/build/tasks/bin/scripts/kibana-setup @@ -15,7 +15,12 @@ done DIR="$(dirname "${SCRIPT}")/.." CONFIG_DIR=${KBN_PATH_CONF:-"$DIR/config"} -NODE="${DIR}/node/bin/node" +{{#darwin}} +NODE="${DIR}/node/default/bin/node" +{{/darwin}} +{{#linux}} +NODE="${DIR}/node/glibc-217/bin/node" +{{/linux}} test -x "$NODE" if [ ! -x "$NODE" ]; then echo "unable to find usable node.js executable." diff --git a/src/dev/build/tasks/bin/scripts/kibana-verification-code b/src/dev/build/tasks/bin/scripts/kibana-verification-code index d64b05a571246..f7085bd7a0460 100755 --- a/src/dev/build/tasks/bin/scripts/kibana-verification-code +++ b/src/dev/build/tasks/bin/scripts/kibana-verification-code @@ -15,7 +15,12 @@ done DIR="$(dirname "${SCRIPT}")/.." CONFIG_DIR=${KBN_PATH_CONF:-"$DIR/config"} -NODE="${DIR}/node/bin/node" +{{#darwin}} +NODE="${DIR}/node/default/bin/node" +{{/darwin}} +{{#linux}} +NODE="${DIR}/node/glibc-217/bin/node" +{{/linux}} test -x "$NODE" if [ ! -x "$NODE" ]; then echo "unable to find usable node.js executable." diff --git a/src/dev/build/tasks/bin/scripts/kibana-verification-code.bat b/src/dev/build/tasks/bin/scripts/kibana-verification-code.bat index 8eb6cd1773a3d..76091f1207fd5 100755 --- a/src/dev/build/tasks/bin/scripts/kibana-verification-code.bat +++ b/src/dev/build/tasks/bin/scripts/kibana-verification-code.bat @@ -5,7 +5,7 @@ SETLOCAL ENABLEDELAYEDEXPANSION set SCRIPT_DIR=%~dp0 for %%I in ("%SCRIPT_DIR%..") do set DIR=%%~dpfI -set NODE=%DIR%\node\node.exe +set NODE=%DIR%\node\default\node.exe set NODE_ENV=production If Not Exist "%NODE%" ( diff --git a/src/dev/build/tasks/build_canvas_shareable_runtime.ts b/src/dev/build/tasks/build_canvas_shareable_runtime.ts index 6eb43b4dc7070..f84980aa29fcd 100644 --- a/src/dev/build/tasks/build_canvas_shareable_runtime.ts +++ b/src/dev/build/tasks/build_canvas_shareable_runtime.ts @@ -13,6 +13,11 @@ export const BuildCanvasShareableRuntime: Task = { description: 'Build Canvas shareable runtime', async run(config, log, build) { + const onlyServerless = config.getTargetPlatforms().every((platform) => platform.isServerless()); + if (onlyServerless) { + log.info('Skipping Canvas shareable runtime for serverless builds'); + return; + } await del(config.resolveFromRepo('x-pack/plugins/canvas/shareable_runtime/build')); await exec(log, process.execPath, ['plugins/canvas/scripts/shareable_runtime'], { diff --git a/src/dev/build/tasks/clean_tasks.ts b/src/dev/build/tasks/clean_tasks.ts index a9d10dfc0d3c3..6de7cb9dcd058 100644 --- a/src/dev/build/tasks/clean_tasks.ts +++ b/src/dev/build/tasks/clean_tasks.ts @@ -192,26 +192,6 @@ export const CleanExtraFilesFromModules: Task = { }, }; -export const CleanExtraBinScripts: Task = { - description: 'Cleaning extra bin/* scripts from platform-specific builds', - - async run(config, log, build) { - for (const platform of config.getNodePlatforms()) { - if (platform.isWindows()) { - await deleteAll( - [ - build.resolvePathForPlatform(platform, 'bin', '*'), - `!${build.resolvePathForPlatform(platform, 'bin', '*.bat')}`, - ], - log - ); - } else { - await deleteAll([build.resolvePathForPlatform(platform, 'bin', '*.bat')], log); - } - } - }, -}; - export const CleanEmptyFolders: Task = { description: 'Cleaning all empty folders recursively', diff --git a/src/dev/build/tasks/create_archives_sources_task.ts b/src/dev/build/tasks/create_archives_sources_task.ts index 9779896ba8cca..a8c08a2aba4d2 100644 --- a/src/dev/build/tasks/create_archives_sources_task.ts +++ b/src/dev/build/tasks/create_archives_sources_task.ts @@ -6,7 +6,9 @@ * Side Public License, v 1. */ -import { scanCopy, Task } from '../lib'; +import { REPO_ROOT } from '@kbn/repo-info'; +import { resolve } from 'path'; +import { scanCopy, Task, deleteAll, copyAll } from '../lib'; import { getNodeDownloadInfo } from './nodejs'; export const CreateArchivesSources: Task = { @@ -27,12 +29,36 @@ export const CreateArchivesSources: Task = { ); // copy node.js install - await scanCopy({ - source: getNodeDownloadInfo(config, platform).extractDir, - destination: build.resolvePathForPlatform(platform, 'node'), - }); + await Promise.all( + getNodeDownloadInfo(config, platform).map((nodeInfo) => { + return scanCopy({ + source: nodeInfo.extractDir, + destination: build.resolvePathForPlatform(platform, 'node', nodeInfo.variant), + }); + }) + ); log.debug('Node.js copied into', platform.getNodeArch(), 'specific build directory'); + + if (platform.isServerless()) { + await deleteAll( + [ + 'x-pack/plugins/canvas/shareable_runtime/build', + 'node_modules/@kbn/screenshotting-plugin/server/assets', + ].map((path) => build.resolvePathForPlatform(platform, path)), + log + ); + await copyAll( + resolve(REPO_ROOT, 'config'), + build.resolvePathForPlatform(platform, 'config'), + { + select: ['serverless.yml', 'serverless.{es,oblt,security}.yml'], + } + ); + log.debug( + `Serverless adjustments made in serverless-${platform.getNodeArch()} specific build directory` + ); + } }) ); }, diff --git a/src/dev/build/tasks/fetch_agent_versions_list.test.ts b/src/dev/build/tasks/fetch_agent_versions_list.test.ts index e27442beff0b4..b8ac42d033a6e 100644 --- a/src/dev/build/tasks/fetch_agent_versions_list.test.ts +++ b/src/dev/build/tasks/fetch_agent_versions_list.test.ts @@ -20,6 +20,7 @@ jest.mock('../lib'); const config = new Config( true, + false, { version: '8.0.0', engines: { diff --git a/src/dev/build/tasks/install_chromium.ts b/src/dev/build/tasks/install_chromium.ts index 968f9f5b474a3..3ec31f95370ca 100644 --- a/src/dev/build/tasks/install_chromium.ts +++ b/src/dev/build/tasks/install_chromium.ts @@ -18,9 +18,11 @@ export const InstallChromium: Task = { for (const platform of config.getNodePlatforms()) { const pkg = paths.find(platform.getName(), platform.getArchitecture(), preInstalledPackages); - const target = `${platform.getName()}-${platform.getArchitecture()}`; + const target = `${ + platform.getVariant() || 'default' + }-${platform.getName()}-${platform.getArchitecture()}`; - if (!pkg) { + if (!pkg || platform.isServerless()) { log.info(`Skipping Chromium install for ${target}`); // Unbundled chromium packages (for Darwin): Chromium is downloaded at diff --git a/src/dev/build/tasks/nodejs/clean_node_builds_task.ts b/src/dev/build/tasks/nodejs/clean_node_builds_task.ts index 487cf99cf162c..6498efdcce19f 100644 --- a/src/dev/build/tasks/nodejs/clean_node_builds_task.ts +++ b/src/dev/build/tasks/nodejs/clean_node_builds_task.ts @@ -15,12 +15,12 @@ export const CleanNodeBuilds: Task = { for (const platform of config.getTargetPlatforms()) { await deleteAll( [ - build.resolvePathForPlatform(platform, 'node/lib/node_modules'), - build.resolvePathForPlatform(platform, 'node/bin/npm'), - build.resolvePathForPlatform(platform, 'node/bin/npx'), - build.resolvePathForPlatform(platform, 'node/bin/corepack'), - build.resolvePathForPlatform(platform, 'node/CHANGELOG.md'), - build.resolvePathForPlatform(platform, 'node/README.md'), + build.resolvePathForPlatform(platform, '*/node/lib/node_modules'), + build.resolvePathForPlatform(platform, '*/node/bin/npm'), + build.resolvePathForPlatform(platform, '*/node/bin/npx'), + build.resolvePathForPlatform(platform, '*/node/bin/corepack'), + build.resolvePathForPlatform(platform, '*/node/CHANGELOG.md'), + build.resolvePathForPlatform(platform, '*/node/README.md'), ], log ); diff --git a/src/dev/build/tasks/nodejs/download_node_builds_task.test.ts b/src/dev/build/tasks/nodejs/download_node_builds_task.test.ts index a67ccb254cb8b..f873e1648ffaf 100644 --- a/src/dev/build/tasks/nodejs/download_node_builds_task.test.ts +++ b/src/dev/build/tasks/nodejs/download_node_builds_task.test.ts @@ -36,6 +36,7 @@ async function setup({ failOnUrl }: { failOnUrl?: string } = {}) { const config = await Config.create({ isRelease: true, targetAllPlatforms: true, + targetServerlessPlatforms: false, dockerContextUseLocalArtifact: false, dockerCrossCompile: false, dockerNamespace: null, @@ -48,11 +49,13 @@ async function setup({ failOnUrl }: { failOnUrl?: string } = {}) { }); getNodeDownloadInfo.mockImplementation((_: Config, platform: Platform) => { - return { - url: `${platform.getName()}:url`, - downloadPath: `${platform.getName()}:downloadPath`, - downloadName: `${platform.getName()}:downloadName`, - }; + return [ + { + url: `${platform.getName()}:url`, + downloadPath: `${platform.getName()}:downloadPath`, + downloadName: `${platform.getName()}:downloadName`, + }, + ]; }); getNodeShasums.mockReturnValue({ @@ -87,26 +90,6 @@ it('downloads node builds for each platform', async () => { "url": "linux:url", }, ], - Array [ - Object { - "destination": "linux:downloadPath", - "log": , - "maxAttempts": 3, - "shaAlgorithm": "sha256", - "shaChecksum": "linux:sha256", - "url": "linux:url", - }, - ], - Array [ - Object { - "destination": "darwin:downloadPath", - "log": , - "maxAttempts": 3, - "shaAlgorithm": "sha256", - "shaChecksum": "darwin:sha256", - "url": "darwin:url", - }, - ], Array [ Object { "destination": "darwin:downloadPath", diff --git a/src/dev/build/tasks/nodejs/download_node_builds_task.ts b/src/dev/build/tasks/nodejs/download_node_builds_task.ts index 9bc46def46964..d630ccff7f4c1 100644 --- a/src/dev/build/tasks/nodejs/download_node_builds_task.ts +++ b/src/dev/build/tasks/nodejs/download_node_builds_task.ts @@ -14,16 +14,26 @@ export const DownloadNodeBuilds: GlobalTask = { global: true, description: 'Downloading node.js builds for all platforms', async run(config, log) { - const shasums = await getNodeShasums(log, config.getNodeVersion()); + const downloads: Array<{ url: string; destination: string; shaChecksum: string }> = []; + for (const platform of config.getNodePlatforms()) { + for (const nodeInfo of getNodeDownloadInfo(config, platform)) { + const shasums = await getNodeShasums(log, config.getNodeVersion(), nodeInfo.variant); + + if (!downloads.some((download) => download.url === nodeInfo.url)) { + downloads.push({ + url: nodeInfo.url, + destination: nodeInfo.downloadPath, + shaChecksum: shasums[nodeInfo.downloadName], + }); + } + } + } await Promise.all( - config.getNodePlatforms().map(async (platform) => { - const { url, downloadPath, downloadName } = getNodeDownloadInfo(config, platform); - await downloadToDisk({ + downloads.map(function (download) { + return downloadToDisk({ + ...download, log, - url, - shaChecksum: shasums[downloadName], shaAlgorithm: 'sha256', - destination: downloadPath, maxAttempts: 3, }); }) diff --git a/src/dev/build/tasks/nodejs/extract_node_builds_task.test.ts b/src/dev/build/tasks/nodejs/extract_node_builds_task.test.ts index 5ca9fcbe10718..962cde6c4df4f 100644 --- a/src/dev/build/tasks/nodejs/extract_node_builds_task.test.ts +++ b/src/dev/build/tasks/nodejs/extract_node_builds_task.test.ts @@ -39,6 +39,7 @@ async function setup() { const config = await Config.create({ isRelease: true, targetAllPlatforms: true, + targetServerlessPlatforms: false, dockerContextUseLocalArtifact: false, dockerCrossCompile: false, dockerNamespace: null, @@ -81,8 +82,8 @@ it('runs expected fs operations', async () => { Object { "copy": Array [ Array [ - /.node_binaries//node.exe, - /.node_binaries//win32-x64/node.exe, + /.node_binaries//default/node.exe, + /.node_binaries//default/win32-x64/node.exe, Object { "clone": true, }, @@ -90,29 +91,57 @@ it('runs expected fs operations', async () => { ], "untar": Array [ Array [ - /.node_binaries//node-v-linux-x64.tar.gz, - /.node_binaries//linux-x64, + /.node_binaries//glibc-217/node-v-linux-x64.tar.gz, + /.node_binaries//glibc-217/linux-x64, Object { "strip": 1, }, ], Array [ - /.node_binaries//node-v-linux-arm64.tar.gz, - /.node_binaries//linux-arm64, + /.node_binaries//glibc-217/node-v-linux-arm64.tar.gz, + /.node_binaries//glibc-217/linux-arm64, Object { "strip": 1, }, ], Array [ - /.node_binaries//node-v-darwin-x64.tar.gz, - /.node_binaries//darwin-x64, + /.node_binaries//default/node-v-darwin-x64.tar.gz, + /.node_binaries//default/darwin-x64, Object { "strip": 1, }, ], Array [ - /.node_binaries//node-v-darwin-arm64.tar.gz, - /.node_binaries//darwin-arm64, + /.node_binaries//default/node-v-darwin-arm64.tar.gz, + /.node_binaries//default/darwin-arm64, + Object { + "strip": 1, + }, + ], + Array [ + /.node_binaries//glibc-217/node-v-linux-x64.tar.gz, + /.node_binaries//glibc-217/linux-x64, + Object { + "strip": 1, + }, + ], + Array [ + /.node_binaries//pointer-compression/node-v-linux-x64.tar.gz, + /.node_binaries//pointer-compression/linux-x64, + Object { + "strip": 1, + }, + ], + Array [ + /.node_binaries//glibc-217/node-v-linux-arm64.tar.gz, + /.node_binaries//glibc-217/linux-arm64, + Object { + "strip": 1, + }, + ], + Array [ + /.node_binaries//pointer-compression/node-v-linux-arm64.tar.gz, + /.node_binaries//pointer-compression/linux-arm64, Object { "strip": 1, }, diff --git a/src/dev/build/tasks/nodejs/extract_node_builds_task.ts b/src/dev/build/tasks/nodejs/extract_node_builds_task.ts index 234158d5b5bfd..d77c7474bc24b 100644 --- a/src/dev/build/tasks/nodejs/extract_node_builds_task.ts +++ b/src/dev/build/tasks/nodejs/extract_node_builds_task.ts @@ -7,7 +7,7 @@ */ import Path from 'path'; - +import Fs from 'fs'; import { untar, GlobalTask, copy } from '../../lib'; import { getNodeDownloadInfo } from './node_download_info'; @@ -17,15 +17,19 @@ export const ExtractNodeBuilds: GlobalTask = { async run(config) { await Promise.all( config.getNodePlatforms().map(async (platform) => { - const { downloadPath, extractDir } = getNodeDownloadInfo(config, platform); - if (platform.isWindows()) { - // windows executable is not extractable, it's just an .exe file - await copy(downloadPath, Path.resolve(extractDir, 'node.exe'), { - clone: true, - }); - } else { - await untar(downloadPath, extractDir, { strip: 1 }); - } + await Promise.all( + getNodeDownloadInfo(config, platform).map((nodeInfo) => { + if (Fs.existsSync(nodeInfo.extractDir)) return; + if (platform.isWindows()) { + // windows executable is not extractable, it's just an .exe file + return copy(nodeInfo.downloadPath, Path.resolve(nodeInfo.extractDir, 'node.exe'), { + clone: true, + }); + } else { + return untar(nodeInfo.downloadPath, nodeInfo.extractDir, { strip: 1 }); + } + }) + ); }) ); }, diff --git a/src/dev/build/tasks/nodejs/node_download_info.ts b/src/dev/build/tasks/nodejs/node_download_info.ts index 821cdb6973ca9..489ff1fc00947 100644 --- a/src/dev/build/tasks/nodejs/node_download_info.ts +++ b/src/dev/build/tasks/nodejs/node_download_info.ts @@ -13,20 +13,35 @@ import { Config, Platform } from '../../lib'; export function getNodeDownloadInfo(config: Config, platform: Platform) { const version = config.getNodeVersion(); const arch = platform.getNodeArch(); + let variants = ['default']; + if (platform.isLinux()) { + variants = ['glibc-217']; + if (platform.isServerless()) variants.push('pointer-compression'); + } - const downloadName = platform.isWindows() - ? 'win-x64/node.exe' - : `node-v${version}-${arch}.tar.gz`; + return variants.map((variant) => { + const downloadName = platform.isWindows() + ? 'win-x64/node.exe' + : `node-v${version}-${arch}.tar.gz`; - const url = `https://us-central1-elastic-kibana-184716.cloudfunctions.net/kibana-ci-proxy-cache/dist/v${version}/${downloadName}`; - const downloadPath = config.resolveFromRepo('.node_binaries', version, basename(downloadName)); - const extractDir = config.resolveFromRepo('.node_binaries', version, arch); + let variantPath = ''; + if (variant === 'pointer-compression') variantPath = 'node-pointer-compression/'; + const url = `https://us-central1-elastic-kibana-184716.cloudfunctions.net/kibana-ci-proxy-cache/${variantPath}dist/v${version}/${downloadName}`; + const downloadPath = config.resolveFromRepo( + '.node_binaries', + version, + variant, + basename(downloadName) + ); + const extractDir = config.resolveFromRepo('.node_binaries', version, variant, arch); - return { - url, - downloadName, - downloadPath, - extractDir, - version, - }; + return { + url, + downloadName, + downloadPath, + extractDir, + variant, + version, + }; + }); } diff --git a/src/dev/build/tasks/nodejs/node_shasums.test.ts b/src/dev/build/tasks/nodejs/node_shasums.test.ts index fc888851946e2..a1c6e963d4c66 100644 --- a/src/dev/build/tasks/nodejs/node_shasums.test.ts +++ b/src/dev/build/tasks/nodejs/node_shasums.test.ts @@ -61,7 +61,11 @@ import { getNodeShasums } from './node_shasums'; describe('src/dev/build/tasks/nodejs/node_shasums', () => { it('resolves to an object with shasums for node downloads for version', async () => { - const shasums = await getNodeShasums(new ToolingLog(), '8.9.4'); + const shasums = await getNodeShasums(new ToolingLog(), '8.9.4', { + getTarget() { + return null; + }, + } as any); expect(shasums).toEqual( expect.objectContaining({ 'node-v8.9.4.tar.gz': '729b44b32b2f82ecd5befac4f7518de0c4e3add34e8fe878f745740a66cbbc01', diff --git a/src/dev/build/tasks/nodejs/node_shasums.ts b/src/dev/build/tasks/nodejs/node_shasums.ts index 850e28d5d3ead..7e25908185eb9 100644 --- a/src/dev/build/tasks/nodejs/node_shasums.ts +++ b/src/dev/build/tasks/nodejs/node_shasums.ts @@ -9,14 +9,22 @@ import { ToolingLog } from '@kbn/tooling-log'; import { downloadToString } from '../../lib/download'; -export async function getNodeShasums(log: ToolingLog, nodeVersion: string) { - const url = `https://us-central1-elastic-kibana-184716.cloudfunctions.net/kibana-ci-proxy-cache/dist/v${nodeVersion}/SHASUMS256.txt`; +const cache: Record> = {}; + +export async function getNodeShasums(log: ToolingLog, nodeVersion: string, variant: string | null) { + let variantPath = ''; + if (variant === 'pointer-compression') variantPath = 'node-pointer-compression/'; + const url = `https://us-central1-elastic-kibana-184716.cloudfunctions.net/kibana-ci-proxy-cache/${variantPath}dist/v${nodeVersion}/SHASUMS256.txt`; + + if (cache[url]) { + log.debug('Returning cached shasum values for node version', nodeVersion, 'from', url); + return cache[url]; + } log.debug('Downloading shasum values for node version', nodeVersion, 'from', url); const checksum = await downloadToString({ log, url, expectStatus: 200 }); - - return checksum.split('\n').reduce((acc: Record, line: string) => { + const result = checksum.split('\n').reduce((acc: Record, line: string) => { const [sha, platform] = line.split(' '); return { @@ -24,4 +32,6 @@ export async function getNodeShasums(log: ToolingLog, nodeVersion: string) { [platform]: sha, }; }, {}); + cache[url] = result; + return result; } diff --git a/src/dev/build/tasks/nodejs/verify_existing_node_builds_task.test.ts b/src/dev/build/tasks/nodejs/verify_existing_node_builds_task.test.ts index 966012a194ab0..995244e9d2b84 100644 --- a/src/dev/build/tasks/nodejs/verify_existing_node_builds_task.test.ts +++ b/src/dev/build/tasks/nodejs/verify_existing_node_builds_task.test.ts @@ -44,6 +44,7 @@ async function setup(actualShaSums?: Record) { const config = await Config.create({ isRelease: true, targetAllPlatforms: true, + targetServerlessPlatforms: false, dockerContextUseLocalArtifact: false, dockerCrossCompile: false, dockerNamespace: null, @@ -58,16 +59,27 @@ async function setup(actualShaSums?: Record) { getNodeShasums.mockReturnValue( Object.fromEntries( config.getTargetPlatforms().map((platform) => { - return [`${platform.getName()}:${platform.getNodeArch()}:downloadName`, 'valid shasum']; + return [ + `${platform.getName()}:${ + platform.getVariant() || 'default' + }:${platform.getNodeArch()}:downloadName`, + 'valid shasum', + ]; }) ) ); getNodeDownloadInfo.mockImplementation((_: Config, platform: Platform) => { - return { - downloadPath: `${platform.getName()}:${platform.getNodeArch()}:downloadPath`, - downloadName: `${platform.getName()}:${platform.getNodeArch()}:downloadName`, - }; + return [ + { + downloadPath: `${platform.getName()}:${ + platform.getVariant() || 'default' + }:${platform.getNodeArch()}:downloadPath`, + downloadName: `${platform.getName()}:${ + platform.getVariant() || 'default' + }:${platform.getNodeArch()}:downloadName`, + }, + ]; }); getFileHash.mockImplementation((downloadPath: string) => { @@ -97,17 +109,122 @@ it('checks shasums for each downloaded node build', async () => { Array [ , "", + undefined, + ], + Array [ + , + "", + undefined, + ], + Array [ + , + "", + undefined, + ], + Array [ + , + "", + undefined, + ], + Array [ + , + "", + undefined, + ], + Array [ + , + "", + undefined, + ], + Array [ + , + "", + undefined, ], ], "results": Array [ Object { "type": "return", "value": Object { - "darwin:darwin-arm64:downloadName": "valid shasum", - "darwin:darwin-x64:downloadName": "valid shasum", - "linux:linux-arm64:downloadName": "valid shasum", - "linux:linux-x64:downloadName": "valid shasum", - "win32:win32-x64:downloadName": "valid shasum", + "darwin:default:darwin-arm64:downloadName": "valid shasum", + "darwin:default:darwin-x64:downloadName": "valid shasum", + "linux:default:linux-arm64:downloadName": "valid shasum", + "linux:default:linux-x64:downloadName": "valid shasum", + "linux:serverless:linux-arm64:downloadName": "valid shasum", + "linux:serverless:linux-x64:downloadName": "valid shasum", + "win32:default:win32-x64:downloadName": "valid shasum", + }, + }, + Object { + "type": "return", + "value": Object { + "darwin:default:darwin-arm64:downloadName": "valid shasum", + "darwin:default:darwin-x64:downloadName": "valid shasum", + "linux:default:linux-arm64:downloadName": "valid shasum", + "linux:default:linux-x64:downloadName": "valid shasum", + "linux:serverless:linux-arm64:downloadName": "valid shasum", + "linux:serverless:linux-x64:downloadName": "valid shasum", + "win32:default:win32-x64:downloadName": "valid shasum", + }, + }, + Object { + "type": "return", + "value": Object { + "darwin:default:darwin-arm64:downloadName": "valid shasum", + "darwin:default:darwin-x64:downloadName": "valid shasum", + "linux:default:linux-arm64:downloadName": "valid shasum", + "linux:default:linux-x64:downloadName": "valid shasum", + "linux:serverless:linux-arm64:downloadName": "valid shasum", + "linux:serverless:linux-x64:downloadName": "valid shasum", + "win32:default:win32-x64:downloadName": "valid shasum", + }, + }, + Object { + "type": "return", + "value": Object { + "darwin:default:darwin-arm64:downloadName": "valid shasum", + "darwin:default:darwin-x64:downloadName": "valid shasum", + "linux:default:linux-arm64:downloadName": "valid shasum", + "linux:default:linux-x64:downloadName": "valid shasum", + "linux:serverless:linux-arm64:downloadName": "valid shasum", + "linux:serverless:linux-x64:downloadName": "valid shasum", + "win32:default:win32-x64:downloadName": "valid shasum", + }, + }, + Object { + "type": "return", + "value": Object { + "darwin:default:darwin-arm64:downloadName": "valid shasum", + "darwin:default:darwin-x64:downloadName": "valid shasum", + "linux:default:linux-arm64:downloadName": "valid shasum", + "linux:default:linux-x64:downloadName": "valid shasum", + "linux:serverless:linux-arm64:downloadName": "valid shasum", + "linux:serverless:linux-x64:downloadName": "valid shasum", + "win32:default:win32-x64:downloadName": "valid shasum", + }, + }, + Object { + "type": "return", + "value": Object { + "darwin:default:darwin-arm64:downloadName": "valid shasum", + "darwin:default:darwin-x64:downloadName": "valid shasum", + "linux:default:linux-arm64:downloadName": "valid shasum", + "linux:default:linux-x64:downloadName": "valid shasum", + "linux:serverless:linux-arm64:downloadName": "valid shasum", + "linux:serverless:linux-x64:downloadName": "valid shasum", + "win32:default:win32-x64:downloadName": "valid shasum", + }, + }, + Object { + "type": "return", + "value": Object { + "darwin:default:darwin-arm64:downloadName": "valid shasum", + "darwin:default:darwin-x64:downloadName": "valid shasum", + "linux:default:linux-arm64:downloadName": "valid shasum", + "linux:default:linux-x64:downloadName": "valid shasum", + "linux:serverless:linux-arm64:downloadName": "valid shasum", + "linux:serverless:linux-x64:downloadName": "valid shasum", + "win32:default:win32-x64:downloadName": "valid shasum", }, }, ], @@ -122,6 +239,7 @@ it('checks shasums for each downloaded node build', async () => { "architecture": "x64", "buildName": "linux-x86_64", "name": "linux", + "variant": null, }, ], Array [ @@ -130,6 +248,7 @@ it('checks shasums for each downloaded node build', async () => { "architecture": "arm64", "buildName": "linux-aarch64", "name": "linux", + "variant": null, }, ], Array [ @@ -138,6 +257,7 @@ it('checks shasums for each downloaded node build', async () => { "architecture": "x64", "buildName": "darwin-x86_64", "name": "darwin", + "variant": null, }, ], Array [ @@ -146,6 +266,7 @@ it('checks shasums for each downloaded node build', async () => { "architecture": "arm64", "buildName": "darwin-aarch64", "name": "darwin", + "variant": null, }, ], Array [ @@ -154,44 +275,91 @@ it('checks shasums for each downloaded node build', async () => { "architecture": "x64", "buildName": "windows-x86_64", "name": "win32", + "variant": null, + }, + ], + Array [ + , + Platform { + "architecture": "x64", + "buildName": "linux-x86_64", + "name": "linux", + "variant": "serverless", + }, + ], + Array [ + , + Platform { + "architecture": "arm64", + "buildName": "linux-aarch64", + "name": "linux", + "variant": "serverless", }, ], ], "results": Array [ Object { "type": "return", - "value": Object { - "downloadName": "linux:linux-x64:downloadName", - "downloadPath": "linux:linux-x64:downloadPath", - }, + "value": Array [ + Object { + "downloadName": "linux:default:linux-x64:downloadName", + "downloadPath": "linux:default:linux-x64:downloadPath", + }, + ], }, Object { "type": "return", - "value": Object { - "downloadName": "linux:linux-arm64:downloadName", - "downloadPath": "linux:linux-arm64:downloadPath", - }, + "value": Array [ + Object { + "downloadName": "linux:default:linux-arm64:downloadName", + "downloadPath": "linux:default:linux-arm64:downloadPath", + }, + ], }, Object { "type": "return", - "value": Object { - "downloadName": "darwin:darwin-x64:downloadName", - "downloadPath": "darwin:darwin-x64:downloadPath", - }, + "value": Array [ + Object { + "downloadName": "darwin:default:darwin-x64:downloadName", + "downloadPath": "darwin:default:darwin-x64:downloadPath", + }, + ], }, Object { "type": "return", - "value": Object { - "downloadName": "darwin:darwin-arm64:downloadName", - "downloadPath": "darwin:darwin-arm64:downloadPath", - }, + "value": Array [ + Object { + "downloadName": "darwin:default:darwin-arm64:downloadName", + "downloadPath": "darwin:default:darwin-arm64:downloadPath", + }, + ], }, Object { "type": "return", - "value": Object { - "downloadName": "win32:win32-x64:downloadName", - "downloadPath": "win32:win32-x64:downloadPath", - }, + "value": Array [ + Object { + "downloadName": "win32:default:win32-x64:downloadName", + "downloadPath": "win32:default:win32-x64:downloadPath", + }, + ], + }, + Object { + "type": "return", + "value": Array [ + Object { + "downloadName": "linux:serverless:linux-x64:downloadName", + "downloadPath": "linux:serverless:linux-x64:downloadPath", + }, + ], + }, + Object { + "type": "return", + "value": Array [ + Object { + "downloadName": "linux:serverless:linux-arm64:downloadName", + "downloadPath": "linux:serverless:linux-arm64:downloadPath", + }, + ], }, ], } @@ -200,23 +368,31 @@ it('checks shasums for each downloaded node build', async () => { [MockFunction] { "calls": Array [ Array [ - "linux:linux-x64:downloadPath", + "linux:default:linux-x64:downloadPath", "sha256", ], Array [ - "linux:linux-arm64:downloadPath", + "linux:default:linux-arm64:downloadPath", "sha256", ], Array [ - "darwin:darwin-x64:downloadPath", + "darwin:default:darwin-x64:downloadPath", "sha256", ], Array [ - "darwin:darwin-arm64:downloadPath", + "darwin:default:darwin-arm64:downloadPath", "sha256", ], Array [ - "win32:win32-x64:downloadPath", + "win32:default:win32-x64:downloadPath", + "sha256", + ], + Array [ + "linux:serverless:linux-x64:downloadPath", + "sha256", + ], + Array [ + "linux:serverless:linux-arm64:downloadPath", "sha256", ], ], @@ -241,6 +417,14 @@ it('checks shasums for each downloaded node build', async () => { "type": "return", "value": "valid shasum", }, + Object { + "type": "return", + "value": "valid shasum", + }, + Object { + "type": "return", + "value": "valid shasum", + }, ], } `); @@ -248,12 +432,12 @@ it('checks shasums for each downloaded node build', async () => { it('rejects if any download has an incorrect sha256', async () => { const { config } = await setup({ - 'linux:linux-arm64:downloadPath': 'invalid shasum', + 'linux:default:linux-arm64:downloadPath': 'invalid shasum', }); await expect( VerifyExistingNodeBuilds.run(config, log, []) ).rejects.toThrowErrorMatchingInlineSnapshot( - `"Download at linux:linux-arm64:downloadPath does not match expected checksum invalid shasum"` + `"Download at linux:default:linux-arm64:downloadPath does not match expected checksum invalid shasum"` ); }); diff --git a/src/dev/build/tasks/nodejs/verify_existing_node_builds_task.ts b/src/dev/build/tasks/nodejs/verify_existing_node_builds_task.ts index 394e883947eb3..29e86d4ca07b4 100644 --- a/src/dev/build/tasks/nodejs/verify_existing_node_builds_task.ts +++ b/src/dev/build/tasks/nodejs/verify_existing_node_builds_task.ts @@ -14,18 +14,27 @@ export const VerifyExistingNodeBuilds: GlobalTask = { global: true, description: 'Verifying previously downloaded node.js build for all platforms', async run(config, log) { - const shasums = await getNodeShasums(log, config.getNodeVersion()); + const builds: Array<{ downloadPath: string; shaChecksum: string }> = []; + for (const platform of config.getNodePlatforms()) { + for (const nodeInfo of getNodeDownloadInfo(config, platform)) { + const shasums = await getNodeShasums(log, config.getNodeVersion(), nodeInfo.variant); + if (!builds.some((build) => build.downloadPath === nodeInfo.downloadName)) { + builds.push({ + downloadPath: nodeInfo.downloadPath, + shaChecksum: shasums[nodeInfo.downloadName], + }); + } + } + } await Promise.all( - config.getNodePlatforms().map(async (platform) => { - const { downloadPath, downloadName } = getNodeDownloadInfo(config, platform); - + builds.map(async ({ shaChecksum, downloadPath }) => { const sha256 = await getFileHash(downloadPath, 'sha256'); - if (sha256 !== shasums[downloadName]) { + if (sha256 !== shaChecksum) { throw new Error(`Download at ${downloadPath} does not match expected checksum ${sha256}`); } - log.success(`Download for ${platform.getNodeArch()} matches checksum`); + log.success(`Download at ${downloadPath} matches checksum`); }) ); }, diff --git a/src/dev/build/tasks/notice_file_task.ts b/src/dev/build/tasks/notice_file_task.ts index 2b38e379bc9da..62847f0076fc7 100644 --- a/src/dev/build/tasks/notice_file_task.ts +++ b/src/dev/build/tasks/notice_file_task.ts @@ -36,7 +36,7 @@ export const CreateNoticeFile: Task = { }); log.info('Generating build notice'); - const { extractDir: nodeDir, version: nodeVersion } = getNodeDownloadInfo( + const [{ extractDir: nodeDir, version: nodeVersion }] = getNodeDownloadInfo( config, config.getPlatform('linux', 'x64') ); diff --git a/src/dev/build/tasks/os_packages/docker_generator/run.ts b/src/dev/build/tasks/os_packages/docker_generator/run.ts index a0aed0a71c1f7..88de0e92e868f 100644 --- a/src/dev/build/tasks/os_packages/docker_generator/run.ts +++ b/src/dev/build/tasks/os_packages/docker_generator/run.ts @@ -64,7 +64,9 @@ export async function runDockerGenerator( const imageTag = `docker.elastic.co/${imageNamespace}/kibana`; const version = config.getBuildVersion(); const artifactArchitecture = flags.architecture === 'aarch64' ? 'aarch64' : 'x86_64'; - const artifactPrefix = `kibana-${version}-linux`; + let artifactVariant = ''; + if (flags.serverless) artifactVariant = '-serverless'; + const artifactPrefix = `kibana${artifactVariant}-${version}-linux`; const artifactTarball = `${artifactPrefix}-${artifactArchitecture}.tar.gz`; const beatsArchitecture = flags.architecture === 'aarch64' ? 'arm64' : 'x86_64'; const metricbeatTarball = `metricbeat-${version}-linux-${beatsArchitecture}.tar.gz`; diff --git a/src/dev/build/tasks/os_packages/docker_generator/templates/base/Dockerfile b/src/dev/build/tasks/os_packages/docker_generator/templates/base/Dockerfile index d9e67b8389326..e7f515ed3bfe2 100644 --- a/src/dev/build/tasks/os_packages/docker_generator/templates/base/Dockerfile +++ b/src/dev/build/tasks/os_packages/docker_generator/templates/base/Dockerfile @@ -35,11 +35,6 @@ COPY {{artifactTarball}} /tmp/kibana.tar.gz RUN mkdir /usr/share/kibana WORKDIR /usr/share/kibana RUN tar \ -{{#serverless}} -# Exclude serverless.yml disabled assets - --exclude=screenshotting-plugin/chromium \ - --exclude=screenshotting-plugin/server/assets \ -{{/serverless}} --strip-components=1 \ -zxf /tmp/kibana.tar.gz # Ensure that group permissions are the same as user permissions. @@ -173,10 +168,6 @@ ENV PATH=/usr/share/kibana/bin:$PATH # Set some Kibana configuration defaults. COPY --chown=1000:0 config/kibana.yml /usr/share/kibana/config/kibana.yml {{#serverless}} -COPY --chown=1000:0 config/serverless.yml /usr/share/kibana/config/serverless.yml -COPY --chown=1000:0 config/serverless.es.yml /usr/share/kibana/config/serverless.es.yml -COPY --chown=1000:0 config/serverless.oblt.yml /usr/share/kibana/config/serverless.oblt.yml -COPY --chown=1000:0 config/serverless.security.yml /usr/share/kibana/config/serverless.security.yml ENV PROFILER_SIGNAL=SIGUSR1 {{/serverless}} {{^opensslLegacyProvider}} diff --git a/src/plugins/ai_assistant_management/selection/public/routes/components/ai_assistant_selection_page.tsx b/src/plugins/ai_assistant_management/selection/public/routes/components/ai_assistant_selection_page.tsx index 62687625db86d..41422212fa08b 100644 --- a/src/plugins/ai_assistant_management/selection/public/routes/components/ai_assistant_selection_page.tsx +++ b/src/plugins/ai_assistant_management/selection/public/routes/components/ai_assistant_selection_page.tsx @@ -75,7 +75,7 @@ export function AiAssistantSelectionPage() { Features.', @@ -124,7 +124,7 @@ export function AiAssistantSelectionPage() { Features.', diff --git a/src/plugins/console/public/application/containers/editor/legacy/console_editor/editor.tsx b/src/plugins/console/public/application/containers/editor/legacy/console_editor/editor.tsx index abdd7c5a5ab96..d7cc6073b5660 100644 --- a/src/plugins/console/public/application/containers/editor/legacy/console_editor/editor.tsx +++ b/src/plugins/console/public/application/containers/editor/legacy/console_editor/editor.tsx @@ -289,7 +289,7 @@ function EditorUI({ initialTextValue, setEditorInstance }: EditorProps) { > @@ -297,7 +297,7 @@ function EditorUI({ initialTextValue, setEditorInstance }: EditorProps) { color="primary" onClick={sendCurrentRequest} data-test-subj="sendRequestButton" - aria-label={i18n.translate('console.sendRequestButtonTooltip', { + aria-label={i18n.translate('console.sendRequestButtonTooltipAriaLabel', { defaultMessage: 'Click to send request', })} > diff --git a/src/plugins/console/public/application/containers/editor/monaco/monaco_editor.tsx b/src/plugins/console/public/application/containers/editor/monaco/monaco_editor.tsx index b54e6fa900b6e..bc9d6cf2ee3c9 100644 --- a/src/plugins/console/public/application/containers/editor/monaco/monaco_editor.tsx +++ b/src/plugins/console/public/application/containers/editor/monaco/monaco_editor.tsx @@ -125,7 +125,7 @@ export const MonacoEditor = ({ initialTextValue }: EditorProps) => { > @@ -133,7 +133,7 @@ export const MonacoEditor = ({ initialTextValue }: EditorProps) => { color="primary" onClick={sendRequestsCallback} data-test-subj="sendRequestButton" - aria-label={i18n.translate('console.sendRequestButtonTooltip', { + aria-label={i18n.translate('console.sendRequestButtonTooltipAriaLabel', { defaultMessage: 'Click to send request', })} > diff --git a/src/plugins/dashboard/public/dashboard_app/top_nav/share/show_share_modal.test.tsx b/src/plugins/dashboard/public/dashboard_app/top_nav/share/show_share_modal.test.tsx index 7d716528148d1..65b435303ca3e 100644 --- a/src/plugins/dashboard/public/dashboard_app/top_nav/share/show_share_modal.test.tsx +++ b/src/plugins/dashboard/public/dashboard_app/top_nav/share/show_share_modal.test.tsx @@ -124,6 +124,20 @@ describe('ShowShareModal', () => { query: { query: 'bye', language: 'kuery' }, } as unknown as DashboardContainerInput; const showModalProps = getPropsAndShare(unsavedDashboardState); + showModalProps.getDashboardState = () => { + return { + panels: { + panel_1: { + type: 'panel_type', + gridData: { w: 0, h: 0, x: 0, y: 0, i: '0' }, + panelRefName: 'superPanel', + explicitInput: { + id: 'superPanel', + }, + }, + }, + } as unknown as DashboardContainerInput; + }; ShowShareModal(showModalProps); expect(toggleShareMenuSpy).toHaveBeenCalledTimes(1); const shareLocatorParams = ( @@ -175,6 +189,14 @@ describe('ShowShareModal', () => { changedKey2: 'definitely NOT changed', }, }, + panel_3: { + gridData: { w: 0, h: 0, x: 0, y: 0, i: '0' }, + type: 'superType', + explicitInput: { + id: 'whatever2', + changedKey3: 'should still exist', + }, + }, }, } as unknown as DashboardContainerInput; }; @@ -197,5 +219,6 @@ describe('ShowShareModal', () => { expect(shareLocatorParams.panels).toBeDefined(); expect(shareLocatorParams.panels![0].embeddableConfig.changedKey1).toBe('changed'); expect(shareLocatorParams.panels![1].embeddableConfig.changedKey2).toBe('definitely changed'); + expect(shareLocatorParams.panels![2].embeddableConfig.changedKey3).toBe('should still exist'); }); }); diff --git a/src/plugins/dashboard/public/dashboard_app/top_nav/share/show_share_modal.tsx b/src/plugins/dashboard/public/dashboard_app/top_nav/share/show_share_modal.tsx index c9c7891d6b352..9adebbacd1248 100644 --- a/src/plugins/dashboard/public/dashboard_app/top_nav/share/show_share_modal.tsx +++ b/src/plugins/dashboard/public/dashboard_app/top_nav/share/show_share_modal.tsx @@ -127,40 +127,50 @@ export function ShowShareModal({ let unsavedStateForLocator: DashboardLocatorParams = {}; - const { dashboardState: unsavedDashboardState, panels: unsavedPanelStates } = + const { dashboardState: unsavedDashboardState, panels: panelModifications } = dashboardBackup.getState(savedObjectId) ?? {}; - const latestPanels = getDashboardState().panels; - const unsavedPanelsMap = unsavedPanelStates - ? Object.entries(unsavedPanelStates).reduce((acc, [panelId, unsavedPanel]) => { - if (unsavedPanel && latestPanels?.[panelId]) { - acc[panelId] = { - ...latestPanels[panelId], - explicitInput: { - ...latestPanels?.[panelId].explicitInput, - ...unsavedPanel, - id: panelId, - }, - }; - } - return acc; - }, {} as DashboardPanelMap) - : {}; - - const allPanels: DashboardPanelMap = { - ...(unsavedDashboardState?.panels ?? {}), - ...unsavedPanelsMap, - }; + const allUnsavedPanels = (() => { + if ( + Object.keys(unsavedDashboardState?.panels ?? {}).length === 0 && + Object.keys(panelModifications ?? {}).length === 0 + ) { + // if this dashboard has no modifications or unsaved panels return early. No overrides needed. + return; + } + + const latestPanels = getDashboardState().panels; + // apply modifications to panels. + const modifiedPanels = panelModifications + ? Object.entries(panelModifications).reduce((acc, [panelId, unsavedPanel]) => { + if (unsavedPanel && latestPanels?.[panelId]) { + acc[panelId] = { + ...latestPanels[panelId], + explicitInput: { + ...latestPanels?.[panelId].explicitInput, + ...unsavedPanel, + id: panelId, + }, + }; + } + return acc; + }, {} as DashboardPanelMap) + : {}; + + // The latest state of panels to share. This will overwrite panels from the saved object on Dashboard load. + const allUnsavedPanelsMap = { + ...latestPanels, + ...modifiedPanels, + }; + return convertPanelMapToSavedPanels(allUnsavedPanelsMap); + })(); if (unsavedDashboardState) { unsavedStateForLocator = { query: unsavedDashboardState.query, filters: unsavedDashboardState.filters, controlGroupInput: unsavedDashboardState.controlGroupInput as SerializableControlGroupInput, - panels: - allPanels && Object.keys(allPanels).length > 0 - ? (convertPanelMapToSavedPanels(allPanels) as DashboardLocatorParams['panels']) - : undefined, + panels: allUnsavedPanels as DashboardLocatorParams['panels'], // options useMargins: unsavedDashboardState?.useMargins, diff --git a/src/plugins/dashboard/public/dashboard_container/embeddable/api/run_save_functions.tsx b/src/plugins/dashboard/public/dashboard_container/embeddable/api/run_save_functions.tsx index fe2a383291f7c..049bfaf00e5dd 100644 --- a/src/plugins/dashboard/public/dashboard_container/embeddable/api/run_save_functions.tsx +++ b/src/plugins/dashboard/public/dashboard_container/embeddable/api/run_save_functions.tsx @@ -268,47 +268,72 @@ export async function runInteractiveSave(this: DashboardContainer, interactionMo } }; - let customModalTitle; - let newTitle = currentState.title; - - if (lastSavedId) { - const [baseTitle, baseCount] = extractTitleAndCount(currentState.title); - newTitle = `${baseTitle} (${baseCount + 1})`; + (async () => { + try { + let customModalTitle; + let newTitle = currentState.title; + + if (lastSavedId) { + const [baseTitle, baseCount] = extractTitleAndCount(newTitle); + let copyCount = baseCount + 1; + newTitle = `${baseTitle} (${copyCount})`; + + // increment count until we find a unique title + while ( + !(await checkForDuplicateDashboardTitle({ + title: newTitle, + lastSavedTitle: currentState.title, + copyOnSave: true, + isTitleDuplicateConfirmed: false, + })) + ) { + copyCount++; + newTitle = `${baseTitle} (${copyCount})`; + } - switch (interactionMode) { - case ViewMode.EDIT: { - customModalTitle = i18n.translate('dashboard.topNav.editModeInteractiveSave.modalTitle', { - defaultMessage: 'Save as new dashboard', - }); - break; - } - case ViewMode.VIEW: { - customModalTitle = i18n.translate('dashboard.topNav.viewModeInteractiveSave.modalTitle', { - defaultMessage: 'Duplicate dashboard', - }); - break; - } - default: { - customModalTitle = undefined; + switch (interactionMode) { + case ViewMode.EDIT: { + customModalTitle = i18n.translate( + 'dashboard.topNav.editModeInteractiveSave.modalTitle', + { + defaultMessage: 'Save as new dashboard', + } + ); + break; + } + case ViewMode.VIEW: { + customModalTitle = i18n.translate( + 'dashboard.topNav.viewModeInteractiveSave.modalTitle', + { + defaultMessage: 'Duplicate dashboard', + } + ); + break; + } + default: { + customModalTitle = undefined; + } + } } - } - } - const dashboardDuplicateModal = ( - resolve(undefined)} - timeRestore={currentState.timeRestore} - showStoreTimeOnSave={!lastSavedId} - description={currentState.description ?? ''} - showCopyOnSave={false} - onSave={onSaveAttempt} - customModalTitle={customModalTitle} - /> - ); - - this.clearOverlays(); - showSaveModal(dashboardDuplicateModal); + const dashboardDuplicateModal = ( + resolve(undefined)} + timeRestore={currentState.timeRestore} + showStoreTimeOnSave={!lastSavedId} + description={currentState.description ?? ''} + showCopyOnSave={false} + onSave={onSaveAttempt} + customModalTitle={customModalTitle} + /> + ); + this.clearOverlays(); + showSaveModal(dashboardDuplicateModal); + } catch (error) { + reject(error); + } + })(); }); } diff --git a/src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts b/src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts index 9332315f57cd2..ca8881cba5f97 100644 --- a/src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts +++ b/src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts @@ -6,197 +6,115 @@ * Side Public License, v 1. */ -import { i18n } from '@kbn/i18n'; import moment from 'moment'; +import { + dayLabel, + hourLabel, + yearLabel, + minuteLabel, + secondLabel, + millisecondLabel, + infinityLabel, + monthLabel, +} from './i18n_messages'; + export const boundsDescendingRaw = [ { bound: Infinity, interval: moment.duration(1, 'year'), - boundLabel: i18n.translate('data.search.timeBuckets.infinityLabel', { - defaultMessage: 'More than a year', - }), - intervalLabel: i18n.translate('data.search.timeBuckets.yearLabel', { - defaultMessage: 'a year', - }), + boundLabel: infinityLabel(), + intervalLabel: yearLabel(), }, { bound: moment.duration(1, 'year'), interval: moment.duration(1, 'month'), - boundLabel: i18n.translate('data.search.timeBuckets.yearLabel', { - defaultMessage: 'a year', - }), - intervalLabel: i18n.translate('data.search.timeBuckets.monthLabel', { - defaultMessage: 'a month', - }), + boundLabel: yearLabel(), + intervalLabel: monthLabel(), }, { bound: moment.duration(3, 'week'), interval: moment.duration(1, 'week'), - boundLabel: i18n.translate('data.search.timeBuckets.dayLabel', { - defaultMessage: '{amount, plural, one {a day} other {# days}}', - values: { amount: 21 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.dayLabel', { - defaultMessage: '{amount, plural, one {a day} other {# days}}', - values: { amount: 7 }, - }), + boundLabel: dayLabel(21), + intervalLabel: dayLabel(7), }, { bound: moment.duration(1, 'week'), interval: moment.duration(1, 'd'), - boundLabel: i18n.translate('data.search.timeBuckets.dayLabel', { - defaultMessage: '{amount, plural, one {a day} other {# days}}', - values: { amount: 7 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.dayLabel', { - defaultMessage: '{amount, plural, one {a day} other {# days}}', - values: { amount: 1 }, - }), + boundLabel: dayLabel(7), + intervalLabel: dayLabel(1), }, { bound: moment.duration(24, 'hour'), interval: moment.duration(12, 'hour'), - boundLabel: i18n.translate('data.search.timeBuckets.dayLabel', { - defaultMessage: '{amount, plural, one {a day} other {# days}}', - values: { amount: 1 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.hourLabel', { - defaultMessage: '{amount, plural, one {an hour} other {# hours}}', - values: { amount: 12 }, - }), + boundLabel: dayLabel(1), + intervalLabel: hourLabel(12), }, { bound: moment.duration(6, 'hour'), interval: moment.duration(3, 'hour'), - boundLabel: i18n.translate('data.search.timeBuckets.hourLabel', { - defaultMessage: '{amount, plural, one {an hour} other {# hours}}', - values: { amount: 6 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.hourLabel', { - defaultMessage: '{amount, plural, one {an hour} other {# hours}}', - values: { amount: 3 }, - }), + boundLabel: hourLabel(6), + intervalLabel: hourLabel(3), }, { bound: moment.duration(2, 'hour'), interval: moment.duration(1, 'hour'), - boundLabel: i18n.translate('data.search.timeBuckets.hourLabel', { - defaultMessage: '{amount, plural, one {an hour} other {# hours}}', - values: { amount: 2 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.hourLabel', { - defaultMessage: '{amount, plural, one {an hour} other {# hours}}', - values: { amount: 1 }, - }), + boundLabel: hourLabel(2), + intervalLabel: hourLabel(1), }, { bound: moment.duration(45, 'minute'), interval: moment.duration(30, 'minute'), - boundLabel: i18n.translate('data.search.timeBuckets.minuteLabel', { - defaultMessage: '{amount, plural, one {a minute} other {# minutes}}', - values: { amount: 45 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.minuteLabel', { - defaultMessage: '{amount, plural, one {a minute} other {# minutes}}', - values: { amount: 30 }, - }), + boundLabel: minuteLabel(45), + intervalLabel: minuteLabel(30), }, { bound: moment.duration(20, 'minute'), interval: moment.duration(10, 'minute'), - boundLabel: i18n.translate('data.search.timeBuckets.minuteLabel', { - defaultMessage: '{amount, plural, one {a minute} other {# minutes}}', - values: { amount: 20 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.minuteLabel', { - defaultMessage: '{amount, plural, one {a minute} other {# minutes}}', - values: { amount: 10 }, - }), + boundLabel: minuteLabel(20), + intervalLabel: minuteLabel(10), }, { bound: moment.duration(9, 'minute'), interval: moment.duration(5, 'minute'), - boundLabel: i18n.translate('data.search.timeBuckets.minuteLabel', { - defaultMessage: '{amount, plural, one {a minute} other {# minutes}}', - values: { amount: 9 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.minuteLabel', { - defaultMessage: '{amount, plural, one {a minute} other {# minutes}}', - values: { amount: 5 }, - }), + boundLabel: minuteLabel(9), + intervalLabel: minuteLabel(5), }, { bound: moment.duration(3, 'minute'), interval: moment.duration(1, 'minute'), - boundLabel: i18n.translate('data.search.timeBuckets.minuteLabel', { - defaultMessage: '{amount, plural, one {a minute} other {# minutes}}', - values: { amount: 3 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.minuteLabel', { - defaultMessage: '{amount, plural, one {a minute} other {# minutes}}', - values: { amount: 1 }, - }), + boundLabel: minuteLabel(3), + intervalLabel: minuteLabel(1), }, { bound: moment.duration(45, 'second'), interval: moment.duration(30, 'second'), - boundLabel: i18n.translate('data.search.timeBuckets.secondLabel', { - defaultMessage: '{amount, plural, one {a second} other {# seconds}}', - values: { amount: 45 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.secondLabel', { - defaultMessage: '{amount, plural, one {a second} other {# seconds}}', - values: { amount: 30 }, - }), + boundLabel: secondLabel(45), + intervalLabel: secondLabel(30), }, { bound: moment.duration(15, 'second'), interval: moment.duration(10, 'second'), - boundLabel: i18n.translate('data.search.timeBuckets.secondLabel', { - defaultMessage: '{amount, plural, one {a second} other {# seconds}}', - values: { amount: 15 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.secondLabel', { - defaultMessage: '{amount, plural, one {a second} other {# seconds}}', - values: { amount: 10 }, - }), + boundLabel: secondLabel(15), + intervalLabel: secondLabel(10), }, { bound: moment.duration(7.5, 'second'), interval: moment.duration(5, 'second'), - boundLabel: i18n.translate('data.search.timeBuckets.secondLabel', { - defaultMessage: '{amount, plural, one {a second} other {# seconds}}', - values: { amount: 7.5 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.secondLabel', { - defaultMessage: '{amount, plural, one {a second} other {# seconds}}', - values: { amount: 5 }, - }), + boundLabel: secondLabel(7.5), + intervalLabel: secondLabel(5), }, { bound: moment.duration(5, 'second'), interval: moment.duration(1, 'second'), - boundLabel: i18n.translate('data.search.timeBuckets.secondLabel', { - defaultMessage: '{amount, plural, one {a second} other {# seconds}}', - values: { amount: 5 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.secondLabel', { - defaultMessage: '{amount, plural, one {a second} other {# seconds}}', - values: { amount: 1 }, - }), + boundLabel: secondLabel(5), + intervalLabel: secondLabel(1), }, { bound: moment.duration(500, 'ms'), interval: moment.duration(100, 'ms'), - boundLabel: i18n.translate('data.search.timeBuckets.millisecondLabel', { - defaultMessage: '{amount, plural, one {a millisecond} other {# milliseconds}}', - values: { amount: 500 }, - }), - intervalLabel: i18n.translate('data.search.timeBuckets.millisecondLabel', { - defaultMessage: '{amount, plural, one {a millisecond} other {# milliseconds}}', - values: { amount: 100 }, - }), + boundLabel: millisecondLabel(500), + intervalLabel: millisecondLabel(100), }, ]; diff --git a/src/plugins/data/common/search/aggs/buckets/lib/time_buckets/i18n_messages.ts b/src/plugins/data/common/search/aggs/buckets/lib/time_buckets/i18n_messages.ts new file mode 100644 index 0000000000000..56cfdc920317e --- /dev/null +++ b/src/plugins/data/common/search/aggs/buckets/lib/time_buckets/i18n_messages.ts @@ -0,0 +1,54 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { i18n } from '@kbn/i18n'; + +export const dayLabel = (amount: number) => + i18n.translate('data.search.timeBuckets.dayLabel', { + defaultMessage: '{amount, plural, one {a day} other {# days}}', + values: { amount }, + }); + +export const hourLabel = (amount: number) => + i18n.translate('data.search.timeBuckets.hourLabel', { + defaultMessage: '{amount, plural, one {an hour} other {# hours}}', + values: { amount }, + }); + +export const yearLabel = () => + i18n.translate('data.search.timeBuckets.yearLabel', { + defaultMessage: 'a year', + }); + +export const minuteLabel = (amount: number) => + i18n.translate('data.search.timeBuckets.minuteLabel', { + defaultMessage: '{amount, plural, one {a minute} other {# minutes}}', + values: { amount }, + }); + +export const secondLabel = (amount: number) => + i18n.translate('data.search.timeBuckets.secondLabel', { + defaultMessage: '{amount, plural, one {a second} other {# seconds}}', + values: { amount }, + }); + +export const millisecondLabel = (amount: number) => + i18n.translate('data.search.timeBuckets.millisecondLabel', { + defaultMessage: '{amount, plural, one {a millisecond} other {# milliseconds}}', + values: { amount }, + }); + +export const infinityLabel = () => + i18n.translate('data.search.timeBuckets.infinityLabel', { + defaultMessage: 'More than a year', + }); + +export const monthLabel = () => + i18n.translate('data.search.timeBuckets.monthLabel', { + defaultMessage: 'a month', + }); diff --git a/src/plugins/data/common/search/search_source/index.ts b/src/plugins/data/common/search/search_source/index.ts index 189538415ab53..0bc25a0fe85d0 100644 --- a/src/plugins/data/common/search/search_source/index.ts +++ b/src/plugins/data/common/search/search_source/index.ts @@ -15,3 +15,4 @@ export * from './fetch'; export * from './search_source'; export * from './search_source_service'; export * from './types'; +export * from './query_to_fields'; diff --git a/src/plugins/data/common/search/search_source/query_to_fields.ts b/src/plugins/data/common/search/search_source/query_to_fields.ts new file mode 100644 index 0000000000000..5c64a95a0a927 --- /dev/null +++ b/src/plugins/data/common/search/search_source/query_to_fields.ts @@ -0,0 +1,58 @@ +/* + * 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 { DataViewLazy } from '@kbn/data-views-plugin/common'; +import { fromKueryExpression, getKqlFieldNames } from '@kbn/es-query'; +import type { SearchRequest } from './fetch'; +import { EsQuerySortValue } from '../..'; + +export async function queryToFields({ + dataView, + sort, + request, +}: { + dataView: DataViewLazy; + sort?: EsQuerySortValue | EsQuerySortValue[]; + request: SearchRequest; +}) { + let fields = dataView.timeFieldName ? [dataView.timeFieldName] : []; + if (sort) { + const sortArr = Array.isArray(sort) ? sort : [sort]; + fields.push(...sortArr.flatMap((s) => Object.keys(s))); + } + for (const query of request.query) { + if (query.query) { + const nodes = fromKueryExpression(query.query); + const queryFields = getKqlFieldNames(nodes); + fields = fields.concat(queryFields); + } + } + const filters = request.filters; + if (filters) { + const filtersArr = Array.isArray(filters) ? filters : [filters]; + for (const f of filtersArr) { + // unified search bar filters have meta object and key (regular filters) + // unified search bar "custom" filters ("Edit as query DSL", where meta.key is not present but meta is) + // Any other Elasticsearch query DSL filter that gets passed in by consumers (not coming from unified search, and these probably won't have a meta key at all) + if (f?.meta?.key && f.meta.disabled !== true) { + fields.push(f.meta.key); + } + } + } + + // if source filtering is enabled, we need to fetch all the fields + const fieldName = + dataView.getSourceFiltering() && dataView.getSourceFiltering().excludes.length ? ['*'] : fields; + + if (fieldName.length) { + return (await dataView.getFields({ fieldName })).getFieldMapSorted(); + } + + // no fields needed to be loaded for query + return {}; +} diff --git a/src/plugins/data/common/search/search_source/search_source.ts b/src/plugins/data/common/search/search_source/search_source.ts index 6f0807cb42248..a5009f350bd3a 100644 --- a/src/plugins/data/common/search/search_source/search_source.ts +++ b/src/plugins/data/common/search/search_source/search_source.ts @@ -77,11 +77,9 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { buildEsQuery, Filter, - fromKueryExpression, isOfQueryType, isPhraseFilter, isPhrasesFilter, - getKqlFieldNames, } from '@kbn/es-query'; import { fieldWildcardFilter } from '@kbn/kibana-utils-plugin/common'; import { getHighlightRequest } from '@kbn/field-formats-plugin/common'; @@ -95,6 +93,7 @@ import type { ISearchGeneric, IKibanaSearchResponse, IEsSearchResponse } from '@ import { normalizeSortRequest } from './normalize_sort_request'; import { AggConfigSerialized, DataViewField, SerializedSearchSourceFields } from '../..'; +import { queryToFields } from './query_to_fields'; import { AggConfigs, EsQuerySortValue } from '../..'; import type { @@ -778,43 +777,7 @@ export class SearchSource { public async loadDataViewFields(dataView: DataViewLazy) { const request = this.mergeProps(this, { body: {} }); - let fields = dataView.timeFieldName ? [dataView.timeFieldName] : []; - const sort = this.getField('sort'); - if (sort) { - const sortArr = Array.isArray(sort) ? sort : [sort]; - for (const s of sortArr) { - const keys = Object.keys(s); - fields = fields.concat(keys); - } - } - for (const query of request.query) { - if (query.query) { - const nodes = fromKueryExpression(query.query); - const queryFields = getKqlFieldNames(nodes); - fields = fields.concat(queryFields); - } - } - const filters = request.filters; - if (filters) { - const filtersArr = Array.isArray(filters) ? filters : [filters]; - for (const f of filtersArr) { - fields = fields.concat(f.meta.key); - } - } - fields = fields.filter((f) => Boolean(f)); - - if (dataView.getSourceFiltering() && dataView.getSourceFiltering().excludes.length) { - // if source filtering is enabled, we need to fetch all the fields - return (await dataView.getFields({ fieldName: ['*'] })).getFieldMapSorted(); - } else if (fields.length) { - return ( - await dataView.getFields({ - fieldName: fields, - }) - ).getFieldMapSorted(); - } - // no fields needed to be loaded for query - return {}; + return await queryToFields({ dataView, request }); } private flatten() { diff --git a/src/plugins/data/public/utils/table_inspector_view/components/data_table_selector.tsx b/src/plugins/data/public/utils/table_inspector_view/components/data_table_selector.tsx index faea07d402f18..0ecbe9e7fabd0 100644 --- a/src/plugins/data/public/utils/table_inspector_view/components/data_table_selector.tsx +++ b/src/plugins/data/public/utils/table_inspector_view/components/data_table_selector.tsx @@ -96,7 +96,7 @@ export class TableSelector extends Component diff --git a/src/plugins/data/server/ui_settings.ts b/src/plugins/data/server/ui_settings.ts index 7c314d66c1901..1a850152e2d32 100644 --- a/src/plugins/data/server/ui_settings.ts +++ b/src/plugins/data/server/ui_settings.ts @@ -204,7 +204,7 @@ export function getUiSettings(
  • {sessionId}: restricts operations to execute all search requests on the same shards. This has the benefit of reusing shard caches across requests.
  • {custom}: allows you to define a your own preference. - Use \''courier:customRequestPreference\'' to customize your preference value.
    • + Use courier:customRequestPreference to customize your preference value.
  • {none}: means do not set a preference. This might provide better performance because requests can be spread across all shard copies. However, results might be inconsistent because different shards might be in different refresh states.
    • diff --git a/src/plugins/data_views/common/data_views/data_views.ts b/src/plugins/data_views/common/data_views/data_views.ts index adce2a0079945..182429de37ef9 100644 --- a/src/plugins/data_views/common/data_views/data_views.ts +++ b/src/plugins/data_views/common/data_views/data_views.ts @@ -39,6 +39,12 @@ import { DuplicateDataViewError, DataViewInsufficientAccessError } from '../erro const MAX_ATTEMPTS_TO_RESOLVE_CONFLICTS = 3; +const createFetchFieldErrorTitle = ({ id, title }: { id?: string; title?: string }) => + i18n.translate('dataViews.fetchFieldErrorTitle', { + defaultMessage: 'Error fetching fields for data view {title} (ID: {id})', + values: { id, title }, + }); + /* * Attributes of the data view saved object * @public @@ -661,9 +667,9 @@ export class DataViewsService { this.onError( err, { - title: i18n.translate('dataViews.fetchFieldErrorTitle', { - defaultMessage: 'Error fetching fields for data view {title} (ID: {id})', - values: { id: dataView.id, title: dataView.getIndexPattern() }, + title: createFetchFieldErrorTitle({ + id: dataView.id, + title: dataView.getIndexPattern(), }), }, dataView.getIndexPattern() @@ -722,10 +728,7 @@ export class DataViewsService { this.onError( err, { - title: i18n.translate('dataViews.fetchFieldErrorTitle', { - defaultMessage: 'Error fetching fields for data view {title} (ID: {id})', - values: { id, title }, - }), + title: createFetchFieldErrorTitle({ id, title }), }, title ); @@ -884,10 +887,7 @@ export class DataViewsService { this.onError( err, { - title: i18n.translate('dataViews.fetchFieldErrorTitle', { - defaultMessage: 'Error fetching fields for data view {title} (ID: {id})', - values: { id: savedObject.id, title: spec.title }, - }), + title: createFetchFieldErrorTitle({ id: savedObject.id, title: spec.title }), }, spec.title || '' ); diff --git a/src/plugins/data_views/server/deprecations/scripted_fields.ts b/src/plugins/data_views/server/deprecations/scripted_fields.ts index 198a44ed45555..934bb71c85875 100644 --- a/src/plugins/data_views/server/deprecations/scripted_fields.ts +++ b/src/plugins/data_views/server/deprecations/scripted_fields.ts @@ -66,6 +66,7 @@ export const createScriptedFieldsDeprecationsConfig: ( allTitles: indexPatternTitles.join('; '), numberOfIndexPatternsWithScriptedFields: indexPatternsWithScriptedFields.length, }, + ignoreTag: true, }), ], }, diff --git a/src/plugins/discover/public/application/main/state_management/discover_saved_search_container.ts b/src/plugins/discover/public/application/main/state_management/discover_saved_search_container.ts index 0a41f087c75ab..c6a380cad98e2 100644 --- a/src/plugins/discover/public/application/main/state_management/discover_saved_search_container.ts +++ b/src/plugins/discover/public/application/main/state_management/discover_saved_search_container.ts @@ -408,6 +408,10 @@ function getSavedSearchFieldForComparison( return visContext; } + if (fieldName === 'breakdownField') { + return savedSearch.breakdownField || ''; // ignore the difference between an empty string and undefined + } + return savedSearch[fieldName]; } diff --git a/src/plugins/discover/public/application/main/state_management/discover_state.test.ts b/src/plugins/discover/public/application/main/state_management/discover_state.test.ts index db8666cf72751..b56600b196944 100644 --- a/src/plugins/discover/public/application/main/state_management/discover_state.test.ts +++ b/src/plugins/discover/public/application/main/state_management/discover_state.test.ts @@ -453,7 +453,6 @@ describe('Test discover state actions', () => { const { searchSource, ...savedSearch } = state.savedSearchState.getState(); expect(savedSearch).toMatchInlineSnapshot(` Object { - "breakdownField": undefined, "columns": Array [ "default_column", ], diff --git a/src/plugins/discover/public/application/main/state_management/utils/resolve_data_view.ts b/src/plugins/discover/public/application/main/state_management/utils/resolve_data_view.ts index 55e18899a4e33..8ab6570f9d610 100644 --- a/src/plugins/discover/public/application/main/state_management/utils/resolve_data_view.ts +++ b/src/plugins/discover/public/application/main/state_management/utils/resolve_data_view.ts @@ -89,7 +89,7 @@ export async function loadDataView({ if (!fetchedDataView) { try { defaultDataView = await dataViews.getDefaultDataView({ - displayErrors: false, + displayErrors: true, // notify the user about access issues refreshFields: true, }); } catch (e) { diff --git a/src/plugins/discover/public/application/main/state_management/utils/update_saved_search.test.ts b/src/plugins/discover/public/application/main/state_management/utils/update_saved_search.test.ts index 3af2b38d679c0..eea38b05503c1 100644 --- a/src/plugins/discover/public/application/main/state_management/utils/update_saved_search.test.ts +++ b/src/plugins/discover/public/application/main/state_management/utils/update_saved_search.test.ts @@ -124,6 +124,40 @@ describe('updateSavedSearch', () => { }); }); + it('should pass breakdownField if state has breakdownField', async () => { + const savedSearch = { + ...savedSearchMock, + searchSource: savedSearchMock.searchSource.createCopy(), + }; + expect(savedSearch.breakdownField).toBeUndefined(); + updateSavedSearch({ + savedSearch, + globalStateContainer: createGlobalStateContainer(), + services: discoverServiceMock, + state: { + breakdownField: 'test', + }, + }); + expect(savedSearch.breakdownField).toEqual('test'); + }); + + it('should pass an empty string if state already has breakdownField', async () => { + const savedSearch = { + ...savedSearchMock, + searchSource: savedSearchMock.searchSource.createCopy(), + breakdownField: 'test', + }; + updateSavedSearch({ + savedSearch, + globalStateContainer: createGlobalStateContainer(), + services: discoverServiceMock, + state: { + breakdownField: undefined, + }, + }); + expect(savedSearch.breakdownField).toEqual(''); + }); + it('should set query and filters from services', async () => { const savedSearch = { ...savedSearchMock, diff --git a/src/plugins/discover/public/application/main/state_management/utils/update_saved_search.ts b/src/plugins/discover/public/application/main/state_management/utils/update_saved_search.ts index 19a5cd6c7fb88..6638e511f6b2f 100644 --- a/src/plugins/discover/public/application/main/state_management/utils/update_saved_search.ts +++ b/src/plugins/discover/public/application/main/state_management/utils/update_saved_search.ts @@ -74,7 +74,12 @@ export function updateSavedSearch({ savedSearch.viewMode = state.viewMode; } - savedSearch.breakdownField = state.breakdownField || undefined; // `undefined` instead of an empty string + if (typeof state.breakdownField !== 'undefined') { + savedSearch.breakdownField = state.breakdownField; + } else if (savedSearch.breakdownField) { + savedSearch.breakdownField = ''; + } + savedSearch.hideAggregatedPreview = state.hideAggregatedPreview; // add a flag here to identify ES|QL queries diff --git a/src/plugins/home/server/tutorials/instructions/heartbeat_instructions.ts b/src/plugins/home/server/tutorials/instructions/heartbeat_instructions.ts index 1fbea1ddf58a1..c1ada0fd8d4cb 100644 --- a/src/plugins/home/server/tutorials/instructions/heartbeat_instructions.ts +++ b/src/plugins/home/server/tutorials/instructions/heartbeat_instructions.ts @@ -71,7 +71,7 @@ export const createHeartbeatInstructions = (context: TutorialContext) => { 'sudo rpm -vi heartbeat-{config.kibana.version}-x86_64.rpm', ], textPost: i18n.translate( - 'home.tutorials.common.heartbeatInstructions.install.debTextPost', + 'home.tutorials.common.heartbeatInstructions.install.rpmTextPost', { defaultMessage: 'Looking for the 32-bit packages? See the [Download page]({link}).', values: { link: 'https://www.elastic.co/downloads/beats/heartbeat' }, diff --git a/src/plugins/home/server/tutorials/instructions/metricbeat_instructions.ts b/src/plugins/home/server/tutorials/instructions/metricbeat_instructions.ts index fc83af9062100..859015613e658 100644 --- a/src/plugins/home/server/tutorials/instructions/metricbeat_instructions.ts +++ b/src/plugins/home/server/tutorials/instructions/metricbeat_instructions.ts @@ -82,7 +82,7 @@ export const createMetricbeatInstructions = memoize( 'sudo rpm -vi metricbeat-{config.kibana.version}-x86_64.rpm', ], textPost: i18n.translate( - 'home.tutorials.common.metricbeatInstructions.install.debTextPost', + 'home.tutorials.common.metricbeatInstructions.install.rpmTextPost', { defaultMessage: 'Looking for the 32-bit packages? See the [Download page]({link}).', values: { link: 'https://www.elastic.co/downloads/beats/metricbeat' }, diff --git a/test/functional/apps/dashboard/group1/create_and_add_embeddables.ts b/test/functional/apps/dashboard/group1/create_and_add_embeddables.ts index 9531606e649f3..1219fb03fd1c2 100644 --- a/test/functional/apps/dashboard/group1/create_and_add_embeddables.ts +++ b/test/functional/apps/dashboard/group1/create_and_add_embeddables.ts @@ -34,7 +34,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.dashboard.clickNewDashboard(); await PageObjects.dashboard.switchToEditMode(); await dashboardAddPanel.clickEditorMenuButton(); - await dashboardAddPanel.clickAddNewEmbeddableLink('LOG_STREAM_EMBEDDABLE'); + await dashboardAddPanel.clickAddNewPanelFromUIActionLink('Log stream'); await dashboardAddPanel.expectEditorMenuClosed(); }); diff --git a/test/functional/apps/dashboard/group4/dashboard_clone.ts b/test/functional/apps/dashboard/group4/dashboard_clone.ts index 438f01061dda8..1e15f4d44e740 100644 --- a/test/functional/apps/dashboard/group4/dashboard_clone.ts +++ b/test/functional/apps/dashboard/group4/dashboard_clone.ts @@ -42,5 +42,12 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { expect(panelTitles).to.eql(PageObjects.dashboard.getTestVisualizationNames()); }); }); + + it('Clone should suggest a unique title', async function () { + await PageObjects.dashboard.loadSavedDashboard(clonedDashboardName); + await PageObjects.dashboard.duplicateDashboard(); + await PageObjects.dashboard.gotoDashboardLandingPage(); + await listingTable.searchAndExpectItemsCount('dashboard', `${dashboardName} (2)`, 1); + }); }); } diff --git a/tsconfig.base.json b/tsconfig.base.json index a3cb9e15a770d..31f05377e4d4c 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -1006,6 +1006,8 @@ "@kbn/interactive-setup-test-endpoints-plugin/*": ["test/interactive_setup_api_integration/plugins/test_endpoints/*"], "@kbn/interpreter": ["packages/kbn-interpreter"], "@kbn/interpreter/*": ["packages/kbn-interpreter/*"], + "@kbn/investigate-plugin": ["x-pack/plugins/observability_solution/investigate"], + "@kbn/investigate-plugin/*": ["x-pack/plugins/observability_solution/investigate/*"], "@kbn/io-ts-utils": ["packages/kbn-io-ts-utils"], "@kbn/io-ts-utils/*": ["packages/kbn-io-ts-utils/*"], "@kbn/ipynb": ["packages/kbn-ipynb"], @@ -1778,6 +1780,8 @@ "@kbn/unified-search-plugin/*": ["src/plugins/unified_search/*"], "@kbn/unsaved-changes-badge": ["packages/kbn-unsaved-changes-badge"], "@kbn/unsaved-changes-badge/*": ["packages/kbn-unsaved-changes-badge/*"], + "@kbn/unsaved-changes-prompt": ["packages/kbn-unsaved-changes-prompt"], + "@kbn/unsaved-changes-prompt/*": ["packages/kbn-unsaved-changes-prompt/*"], "@kbn/upgrade-assistant-plugin": ["x-pack/plugins/upgrade_assistant"], "@kbn/upgrade-assistant-plugin/*": ["x-pack/plugins/upgrade_assistant/*"], "@kbn/uptime-plugin": ["x-pack/plugins/observability_solution/uptime"], diff --git a/x-pack/.i18nrc.json b/x-pack/.i18nrc.json index 2de23279fac72..8059502946861 100644 --- a/x-pack/.i18nrc.json +++ b/x-pack/.i18nrc.json @@ -51,6 +51,7 @@ "xpack.logsShared": "plugins/observability_solution/logs_shared", "xpack.fleet": "plugins/fleet", "xpack.ingestPipelines": "plugins/ingest_pipelines", + "xpack.investigate": "plugins/observability_solution/investigate", "xpack.kubernetesSecurity": "plugins/kubernetes_security", "xpack.lens": "plugins/lens", "xpack.licenseApiGuard": "plugins/license_api_guard", diff --git a/x-pack/packages/kbn-slo-schema/src/schema/indicators.ts b/x-pack/packages/kbn-slo-schema/src/schema/indicators.ts index f24f85e4f3ac4..6c3149c3c35e1 100644 --- a/x-pack/packages/kbn-slo-schema/src/schema/indicators.ts +++ b/x-pack/packages/kbn-slo-schema/src/schema/indicators.ts @@ -25,9 +25,9 @@ const filtersSchema = t.array( isMultiIndex: t.boolean, type: t.string, key: t.string, + field: t.string, params: t.any, value: t.string, - field: t.string, }), query: t.record(t.string, t.any), }) @@ -54,6 +54,7 @@ const apmTransactionDurationIndicatorSchema = t.type({ }), t.partial({ filter: querySchema, + dataViewId: t.string, }), ]), }); @@ -71,6 +72,7 @@ const apmTransactionErrorRateIndicatorSchema = t.type({ }), t.partial({ filter: querySchema, + dataViewId: t.string, }), ]), }); @@ -87,6 +89,7 @@ const kqlCustomIndicatorSchema = t.type({ }), t.partial({ filter: querySchema, + dataViewId: t.string, }), ]), }); @@ -164,6 +167,7 @@ const timesliceMetricIndicatorSchema = t.type({ }), t.partial({ filter: querySchema, + dataViewId: t.string, }), ]), }); @@ -205,6 +209,7 @@ const metricCustomIndicatorSchema = t.type({ }), t.partial({ filter: querySchema, + dataViewId: t.string, }), ]), }); @@ -250,6 +255,7 @@ const histogramIndicatorSchema = t.type({ }), t.partial({ filter: querySchema, + dataViewId: t.string, }), ]), }); @@ -270,6 +276,7 @@ const syntheticsAvailabilityIndicatorSchema = t.type({ tags: t.array(syntheticsParamSchema), projects: t.array(syntheticsParamSchema), filter: querySchema, + dataViewId: t.string, }), ]), }); diff --git a/x-pack/plugins/canvas/public/components/workpad_header/share_menu/flyout/hooks/use_download_runtime.ts b/x-pack/plugins/canvas/public/components/workpad_header/share_menu/flyout/hooks/use_download_runtime.ts index cb158fd3958c1..cd1635d65a573 100644 --- a/x-pack/plugins/canvas/public/components/workpad_header/share_menu/flyout/hooks/use_download_runtime.ts +++ b/x-pack/plugins/canvas/public/components/workpad_header/share_menu/flyout/hooks/use_download_runtime.ts @@ -26,7 +26,7 @@ const strings = { getShareableZipErrorTitle: (workpadName: string) => i18n.translate('xpack.canvas.workpadHeaderShareMenu.shareWebsiteErrorTitle', { defaultMessage: - "Failed to create {ZIP} file for '{workpadName}'. The workpad may be too large. You'll need to download the files separately.", + "Failed to create {ZIP} file for ''{workpadName}''. The workpad may be too large. You'll need to download the files separately.", values: { ZIP, workpadName, diff --git a/x-pack/plugins/cloud_security_posture/public/components/csp_inline_description_list.tsx b/x-pack/plugins/cloud_security_posture/public/components/csp_inline_description_list.tsx index e573ff0225274..6992b205b79c6 100644 --- a/x-pack/plugins/cloud_security_posture/public/components/csp_inline_description_list.tsx +++ b/x-pack/plugins/cloud_security_posture/public/components/csp_inline_description_list.tsx @@ -6,12 +6,41 @@ */ import React from 'react'; -import { EuiDescriptionList, useEuiTheme, type EuiDescriptionListProps } from '@elastic/eui'; +import { EuiDescriptionList, useEuiTheme, EuiIcon, EuiCopy } from '@elastic/eui'; +import type { EuiDescriptionListProps } from '@elastic/eui'; +import { css } from '@emotion/react'; -const getModifiedTitlesListItems = (listItems: EuiDescriptionListProps['listItems']) => +const CopyButton = ({ copyText }: { copyText: string }) => ( + + {(copy) => ( + + )} + +); + +const getModifiedTitlesListItems = (listItems?: EuiDescriptionListProps['listItems']) => listItems ?.filter((item) => !!item?.title && !!item?.description) - .map((item) => ({ ...item, title: `${item.title}:` })); + .map((item) => ({ + ...item, + title: `${item.title}:`, + description: + typeof item.description === 'string' ? ( + + {item.description} + + ) : ( + item.description + ), + })); // eui size m is 12px which is too small, and next after it is base which is 16px which is too big const fontSize = '1rem'; diff --git a/x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/findings_flyout.tsx b/x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/findings_flyout.tsx index 160b9c463c907..1e576fef9f368 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/findings_flyout.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/findings_flyout.tsx @@ -23,11 +23,15 @@ import { EuiPagination, EuiFlyoutFooter, EuiToolTip, + EuiDescriptionListProps, } from '@elastic/eui'; import { assertNever } from '@kbn/std'; import { i18n } from '@kbn/i18n'; import type { HttpSetup } from '@kbn/core/public'; import { generatePath } from 'react-router-dom'; +import { css } from '@emotion/react'; +import { euiThemeVars } from '@kbn/ui-theme'; +import { truthy } from '../../../../common/utils/helpers'; import { benchmarksNavigation } from '../../../common/navigation/constants'; import cisLogoIcon from '../../../assets/icons/cis_logo.svg'; import { CspFinding } from '../../../../common/schemas/csp_finding'; @@ -40,9 +44,10 @@ import { RuleTab } from './rule_tab'; import type { BenchmarkId } from '../../../../common/types_old'; import { CISBenchmarkIcon } from '../../../components/cis_benchmark_icon'; import { BenchmarkName } from '../../../../common/types_old'; -import { FINDINGS_FLYOUT } from '../test_subjects'; +import { FINDINGS_FLYOUT, FINDINGS_MISCONFIGS_FLYOUT_DESCRIPTION_LIST } from '../test_subjects'; import { useKibana } from '../../../common/hooks/use_kibana'; import { createDetectionRuleFromBenchmarkRule } from '../utils/create_detection_rule_from_benchmark'; +import { CspInlineDescriptionList } from '../../../components/csp_inline_description_list'; const tabs = [ { @@ -112,6 +117,23 @@ export const CisKubernetesIcons = ({     ); +const getFlyoutDescriptionList = (finding: CspFinding): EuiDescriptionListProps['listItems'] => + [ + finding.resource?.id && { + title: i18n.translate('xpack.csp.findings.findingsFlyout.flyoutDescriptionList.resourceId', { + defaultMessage: 'Resource ID', + }), + description: finding.resource.id, + }, + finding.resource?.name && { + title: i18n.translate( + 'xpack.csp.findings.findingsFlyout.flyoutDescriptionList.resourceName', + { defaultMessage: 'Resource Name' } + ), + description: finding.resource.name, + }, + ].filter(truthy); + const FindingsTab = ({ tab, findings }: { findings: CspFinding; tab: FindingsTab }) => { const { application } = useKibana().services; @@ -164,6 +186,17 @@ export const FindingsRuleFlyout = ({     +
    + +
    {tabs.map((v) => ( diff --git a/x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/overview_tab.tsx b/x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/overview_tab.tsx index 15fbbe608ec81..9835204768861 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/overview_tab.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/overview_tab.tsx @@ -77,18 +77,6 @@ const getDetailsList = (data: CspFinding, ruleFlyoutLink: string, discoverIndexL }), description: moment(data['@timestamp']).format(CSP_MOMENT_FORMAT), }, - { - title: i18n.translate('xpack.csp.findings.findingsFlyout.overviewTab.resourceIdTitle', { - defaultMessage: 'Resource ID', - }), - description: data.resource.id, - }, - { - title: i18n.translate('xpack.csp.findings.findingsFlyout.overviewTab.resourceNameTitle', { - defaultMessage: 'Resource Name', - }), - description: data.resource.name, - }, { title: i18n.translate('xpack.csp.findings.findingsFlyout.overviewTab.frameworkSourcesTitle', { defaultMessage: 'Framework Sources', diff --git a/x-pack/plugins/cloud_security_posture/public/pages/configurations/test_subjects.ts b/x-pack/plugins/cloud_security_posture/public/pages/configurations/test_subjects.ts index b465b58f45887..b8a670e8ba58b 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/configurations/test_subjects.ts +++ b/x-pack/plugins/cloud_security_posture/public/pages/configurations/test_subjects.ts @@ -33,3 +33,6 @@ export const RESOURCES_FINDINGS_CONTAINER = 'resources_findings_container'; export const RESOURCES_FINDINGS_TABLE = 'resource_findings_table'; export const getResourceFindingsTableRowTestId = (id: string) => `resource_findings_table_row_${id}`; + +export const FINDINGS_MISCONFIGS_FLYOUT_DESCRIPTION_LIST = + 'misconfigs-findings-flyout-description-list'; diff --git a/x-pack/plugins/cloud_security_posture/public/pages/vulnerabilities/vulnerabilities_finding_flyout/vulnerability_finding_flyout.test.tsx b/x-pack/plugins/cloud_security_posture/public/pages/vulnerabilities/vulnerabilities_finding_flyout/vulnerability_finding_flyout.test.tsx index da7587cfc8ad0..4cefa850bf127 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/vulnerabilities/vulnerabilities_finding_flyout/vulnerability_finding_flyout.test.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/vulnerabilities/vulnerabilities_finding_flyout/vulnerability_finding_flyout.test.tsx @@ -40,7 +40,7 @@ describe('', () => { getByText(mockVulnerabilityHit.vulnerability.description); const descriptionList = getByTestId(FINDINGS_VULNERABILITY_FLYOUT_DESCRIPTION_LIST); expect(descriptionList.textContent).toEqual( - `Resource ID:${mockVulnerabilityHit.resource?.id}Resource Name:${mockVulnerabilityHit.resource?.name}Package:${mockVulnerabilityHit.package.name}Version:${mockVulnerabilityHit.package.version}` + `Resource ID:${mockVulnerabilityHit.resource?.id} Resource Name:${mockVulnerabilityHit.resource?.name} Package:${mockVulnerabilityHit.package.name} Version:${mockVulnerabilityHit.package.version} ` ); getByText(mockVulnerabilityHit.vulnerability.severity!); }); diff --git a/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/components/i18n.ts b/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/components/i18n.ts index 01b3fb0d93be6..bbcb7f5b2c6b3 100644 --- a/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/components/i18n.ts +++ b/x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/components/i18n.ts @@ -10,7 +10,7 @@ import { i18n } from '@kbn/i18n'; export const txtDestinationDashboardNotFound = (dashboardId?: string) => i18n.translate('xpack.dashboard.drilldown.errorDestinationDashboardIsMissing', { defaultMessage: - "Destination dashboard ('{dashboardId}') no longer exists. Choose another dashboard.", + "Destination dashboard (''{dashboardId}'') no longer exists. Choose another dashboard.", values: { dashboardId, }, diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/result_settings/result_settings_table/column_headers.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/result_settings/result_settings_table/column_headers.tsx index b36d71a49de13..8bc4da27dcbb7 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/result_settings/result_settings_table/column_headers.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/result_settings/result_settings_table/column_headers.tsx @@ -43,6 +43,7 @@ export const ColumnHeaders: React.FC = () => { { defaultMessage: 'A snippet is an escaped representaiton of a field value. Query matches are encapsulated in tags for highlighting. Fallback will look for a snippet match, but fallback to an escaped raw value if none is found. Range is between 20-1000. Defaults to 100.', + ignoreTag: true, } )} /> diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/single_page_layout/hooks/form.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/single_page_layout/hooks/form.tsx index 5fe50e7e20711..e2c8ae42d63e4 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/single_page_layout/hooks/form.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/single_page_layout/hooks/form.tsx @@ -378,7 +378,7 @@ export function useOnSubmit({ notifications.toasts.addSuccess({ title: i18n.translate('xpack.fleet.createPackagePolicy.addedNotificationTitle', { - defaultMessage: `'{packagePolicyName}' integration added.`, + defaultMessage: `''{packagePolicyName}'' integration added.`, values: { packagePolicyName: packagePolicy.name, }, diff --git a/x-pack/plugins/index_management/public/application/sections/home/index_list/index_table/index_table.js b/x-pack/plugins/index_management/public/application/sections/home/index_list/index_table/index_table.js index 8ad11dbdbeb80..a6c8ca92a70b2 100644 --- a/x-pack/plugins/index_management/public/application/sections/home/index_list/index_table/index_table.js +++ b/x-pack/plugins/index_management/public/application/sections/home/index_list/index_table/index_table.js @@ -429,7 +429,6 @@ export class IndexTable extends Component { > { @@ -696,7 +695,6 @@ export class IndexTable extends Component { id="selectAllIndexes" checked={this.areAllItemsSelected()} onChange={this.toggleAll} - type="inList" aria-label={i18n.translate( 'xpack.idxMgmt.indexTable.selectAllIndicesAriaLabel', { diff --git a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/pipeline_form.helpers.ts b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/pipeline_form.helpers.ts index 16d56be207268..bfbd3316a4b18 100644 --- a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/pipeline_form.helpers.ts +++ b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/pipeline_form.helpers.ts @@ -29,19 +29,16 @@ export const getFormActions = (testBed: TestBed) => { component.update(); }; - const toggleVersionSwitch = () => { - act(() => { - form.toggleEuiSwitch('versionToggle'); + const toggleSwitch = async (testSubject: string) => { + await act(async () => { + form.toggleEuiSwitch(testSubject); }); component.update(); }; - const toggleMetaSwitch = () => { - act(() => { - form.toggleEuiSwitch('metaToggle'); - }); - }; + const getToggleValue = (testSubject: string): boolean => + find(testSubject).props()['aria-checked']; const setMetaField = (value: object) => { find('metaEditor').getDOMNode().setAttribute('data-currentvalue', JSON.stringify(value)); @@ -49,10 +46,10 @@ export const getFormActions = (testBed: TestBed) => { }; return { + getToggleValue, clickSubmitButton, clickShowRequestLink, - toggleVersionSwitch, - toggleMetaSwitch, + toggleSwitch, setMetaField, }; }; diff --git a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/setup_environment.tsx b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/setup_environment.tsx index 01efbc3063870..58701ffb1dd64 100644 --- a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/setup_environment.tsx +++ b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/helpers/setup_environment.tsx @@ -19,7 +19,9 @@ import { scopedHistoryMock, uiSettingsServiceMock, applicationServiceMock, + overlayServiceMock, } from '@kbn/core/public/mocks'; +import { httpServiceMock } from '@kbn/core-http-browser-mocks'; import { usageCollectionPluginMock } from '@kbn/usage-collection-plugin/public/mocks'; @@ -66,6 +68,8 @@ const appServices = { share: { url: new MockUrlService(), }, + overlays: overlayServiceMock.createStartContract(), + http: httpServiceMock.createStartContract({ basePath: '/mock' }), }; export const setupEnvironment = () => { diff --git a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_create.test.tsx b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_create.test.tsx index fb0ab215393f4..3acda54c401dd 100644 --- a/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_create.test.tsx +++ b/x-pack/plugins/ingest_pipelines/__jest__/client_integration/ingest_pipelines_create.test.tsx @@ -62,25 +62,21 @@ describe('', () => { test('should toggle the version field', async () => { const { actions, exists } = testBed; - // Version field should be hidden by default - expect(exists('versionField')).toBe(false); + // Version field toggle should be disabled by default + expect(actions.getToggleValue('versionToggle')).toBe(false); - actions.toggleVersionSwitch(); + await actions.toggleSwitch('versionToggle'); expect(exists('versionField')).toBe(true); }); test('should toggle the _meta field', async () => { - const { exists, component, actions } = testBed; + const { exists, actions } = testBed; - // Meta editor should be hidden by default - expect(exists('metaEditor')).toBe(false); + // Meta field toggle should be disabled by default + expect(actions.getToggleValue('metaToggle')).toBe(false); - await act(async () => { - actions.toggleMetaSwitch(); - }); - - component.update(); + await actions.toggleSwitch('metaToggle'); expect(exists('metaEditor')).toBe(true); }); @@ -149,12 +145,10 @@ describe('', () => { }); test('should send the correct payload', async () => { - const { component, actions } = testBed; + const { actions } = testBed; + + await actions.toggleSwitch('metaToggle'); - await act(async () => { - actions.toggleMetaSwitch(); - }); - component.update(); const metaData = { field1: 'hello', field2: 10, diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/bulk_request_panel.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/bulk_request_panel.tsx new file mode 100644 index 0000000000000..527f7d3689fe7 --- /dev/null +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/bulk_request_panel.tsx @@ -0,0 +1,68 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState } from 'react'; +import { FormattedMessage } from '@kbn/i18n-react'; +import { + EuiSpacer, + EuiPanel, + EuiCodeBlock, + EuiText, + EuiSwitch, + EuiSwitchEvent, +} from '@elastic/eui'; + +const bulkRequestExample = `PUT books/_bulk?pipeline=my-pipeline +{ "create":{ } } +{ "name": "Snow Crash", "author": "Neal Stephenson" } +{ "create":{ } } +{ "name": "Revelation Space", "author": "Alastair Reynolds" } +`; + +const singleRequestExample = `POST books/_doc?pipeline=my-pipeline-name +{ + "name": "Snow Crash", + "author": "Neal Stephenson" +} +`; + +export const BulkRequestPanel = () => { + const [showBulkToggle, setShowBulkToggle] = useState(true); + + return ( + + + + + + + + + + + } + checked={showBulkToggle} + onChange={(e: EuiSwitchEvent) => setShowBulkToggle(e.target.checked)} + /> + + + + + {showBulkToggle ? bulkRequestExample : singleRequestExample} + + + ); +}; diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/collapsible_panel.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/collapsible_panel.tsx new file mode 100644 index 0000000000000..1a736b83cf5f8 --- /dev/null +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/collapsible_panel.tsx @@ -0,0 +1,107 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState, useEffect, ReactNode } from 'react'; +import { FormattedMessage } from '@kbn/i18n-react'; +import { + EuiSpacer, + EuiSwitch, + EuiPanel, + EuiAccordion, + EuiAccordionProps, + useGeneratedHtmlId, + EuiSwitchEvent, + EuiSwitchProps, +} from '@elastic/eui'; +import { useFormContext, useFormData } from '../../../shared_imports'; + +export interface CollapsiblePanelRenderProps { + isEnabled: boolean; +} + +interface Props { + title: ReactNode | string; + fieldName: string; + initialToggleState: boolean; + toggleProps?: Partial; + accordionProps?: Partial; + children: (options: CollapsiblePanelRenderProps) => ReactNode; +} + +type AccordionStatus = 'open' | 'closed'; + +export const CollapsiblePanel: React.FunctionComponent = ({ + title, + children, + fieldName, + toggleProps, + accordionProps, + initialToggleState, +}) => { + const form = useFormContext(); + const [formData] = useFormData({ form }); + + const accordionId = useGeneratedHtmlId({ prefix: 'collapsiblerPanel' }); + const [isEnabled, setIsEnabled] = useState(initialToggleState); + const [trigger, setTrigger] = useState(isEnabled ? 'open' : 'closed'); + + // We need to keep track of the initial field value for when the user + // disable the enabled toggle (set field value to null) and then re-enable it. + // In this scenario we want to show the initial value of the form. + const [initialValue, setInitialValue] = useState(); + useEffect(() => { + if (initialValue === undefined && formData[fieldName]) { + setInitialValue(formData[fieldName]); + } + }, [formData, initialValue, fieldName]); + + const onToggleChange = (e: EuiSwitchEvent) => { + const isChecked = !!e.target.checked; + + setIsEnabled(isChecked); + setTrigger(isChecked ? 'open' : 'closed'); + + if (isChecked) { + form.setFieldValue(fieldName, initialValue || ''); + } else { + form.setFieldValue(fieldName, ''); + } + }; + + const onAccordionToggle = (isOpen: boolean) => { + const newState = isOpen ? 'open' : 'closed'; + setTrigger(newState); + }; + + return ( + + + } + checked={isEnabled} + onChange={onToggleChange} + /> + } + > + + {children({ isEnabled })} + + + ); +}; diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form.tsx index 65e19b2178baf..30637d00f495c 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form.tsx @@ -6,14 +6,18 @@ */ import React, { useState, useCallback, useRef } from 'react'; +import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import { EuiButton, EuiButtonEmpty, EuiFlexGroup, EuiFlexItem, EuiSpacer } from '@elastic/eui'; -import { useForm, Form, FormConfig } from '../../../shared_imports'; +import { useUnsavedChangesPrompt } from '@kbn/unsaved-changes-prompt'; import { Pipeline, Processor } from '../../../../common/types'; +import { useForm, Form, FormConfig, useFormIsModified } from '../../../shared_imports'; +import { useKibana } from '../../../shared_imports'; import { OnUpdateHandlerArg, OnUpdateHandler } from '../pipeline_editor'; +import { deepEqualIgnoreUndefined } from './utils'; import { PipelineRequestFlyout } from './pipeline_request_flyout'; import { PipelineFormFields } from './pipeline_form_fields'; import { PipelineFormError } from './pipeline_form_error'; @@ -48,7 +52,16 @@ export const PipelineForm: React.FunctionComponent = ({ onCancel, canEditName, }) => { + const { + overlays, + history, + application: { navigateToUrl }, + http, + } = useKibana().services; + const [isRequestVisible, setIsRequestVisible] = useState(false); + const [areProcessorsDirty, setAreProcessorsDirty] = useState(false); + const [hasSubmittedForm, setHasSubmittedForm] = useState(false); const { processors: initialProcessors, @@ -74,6 +87,11 @@ export const PipelineForm: React.FunctionComponent = ({ if (processorStateRef.current) { const state = processorStateRef.current; if (await state.validate()) { + // We only want to show unsaved changed prompts to the user when the form + // hasnt been submitted. + setHasSubmittedForm(true); + + // Save the form state, this will also trigger a redirect to pipelines list onSave({ ...formData, ...state.getData() }); } } @@ -85,6 +103,8 @@ export const PipelineForm: React.FunctionComponent = ({ onSubmit: handleSave, }); + const isFormDirty = useFormIsModified({ form }); + const onEditorFlyoutOpen = useCallback(() => { setIsRequestVisible(false); }, [setIsRequestVisible]); @@ -107,10 +127,48 @@ export const PipelineForm: React.FunctionComponent = ({ ); const onProcessorsChangeHandler = useCallback( - (arg) => (processorStateRef.current = arg), - [] + (arg) => { + processorStateRef.current = arg; + + const currentProcessorsState = processorStateRef.current?.getData(); + + // Calculate if the current processor state has changed compared to the + // initial processors state. + setAreProcessorsDirty( + !deepEqualIgnoreUndefined( + { + processors: processorsState?.processors || [], + onFailure: processorsState?.onFailure || [], + }, + { + processors: currentProcessorsState?.processors || [], + onFailure: currentProcessorsState?.on_failure || [], + } + ) + ); + }, + [processorsState] ); + /* + We need to check if the form is dirty and also if the form has been submitted. + Because on form submission we also redirect the user to the pipelines list, + and this could otherwise trigger an unwanted unsaved changes prompt. + */ + useUnsavedChangesPrompt({ + titleText: i18n.translate('xpack.ingestPipelines.form.unsavedPrompt.title', { + defaultMessage: `Exit pipeline creation without saving changes?`, + }), + messageText: i18n.translate('xpack.ingestPipelines.form.unsavedPrompt.body', { + defaultMessage: `The data will be lost if you leave this page without saving the pipeline changes`, + }), + hasUnsavedChanges: (isFormDirty || areProcessorsDirty) && !hasSubmittedForm, + openConfirm: overlays.openConfirm, + history, + http, + navigateToUrl, + }); + return ( <>
    = ({ canEditName={canEditName} /> + + {/* Form submission */} diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx index 97911aab2aa81..79732e6187824 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx @@ -5,14 +5,22 @@ * 2.0. */ -import React, { useState } from 'react'; +import React from 'react'; import { FormattedMessage } from '@kbn/i18n-react'; -import { EuiSpacer, EuiSwitch } from '@elastic/eui'; +import { + EuiSpacer, + EuiFlexGroup, + EuiFlexItem, + useIsWithinBreakpoints, + EuiText, +} from '@elastic/eui'; import { i18n } from '@kbn/i18n'; +import { BulkRequestPanel } from './bulk_request_panel'; +import { CollapsiblePanel, CollapsiblePanelRenderProps } from './collapsible_panel'; import { Processor } from '../../../../common/types'; -import { getUseField, getFormRow, Field, JsonEditorField } from '../../../shared_imports'; +import { getFormRow, getUseField, Field, JsonEditorField } from '../../../shared_imports'; import { ProcessorsEditorContextProvider, @@ -36,20 +44,20 @@ interface Props { const UseField = getUseField({ component: Field }); const FormRow = getFormRow({ titleTag: 'h3' }); +const COLUMN_MAX_WIDTH = 420; + export const PipelineFormFields: React.FunctionComponent = ({ processors, onFailure, onLoadJson, onProcessorsUpdate, - isEditing, hasVersion, hasMeta, onEditorFlyoutOpen, canEditName, + isEditing, }) => { - const [isVersionVisible, setIsVersionVisible] = useState(hasVersion); - - const [isMetaVisible, setIsMetaVisible] = useState(hasMeta); + const shouldHaveFixedWidth = useIsWithinBreakpoints(['l', 'xl']); return ( <> @@ -57,24 +65,10 @@ export const PipelineFormFields: React.FunctionComponent = ({ } description={ - <> - - - - } - checked={isVersionVisible} - onChange={(e) => setIsVersionVisible(e.target.checked)} - data-test-subj="versionToggle" - /> - + } > = ({ euiFieldProps: { disabled: canEditName === false || Boolean(isEditing) }, }} /> - - {isVersionVisible && ( - - )} + + {/* Description field */} = ({ /> - {/* Pipeline Processors Editor */} - - - + - {/* _meta field */} - - } - description={ - <> - - - - - + + {/* Pipeline Processors Editor */} + + + + + + + + + + + + } + fieldName="version" + toggleProps={{ + 'data-test-subj': 'versionToggle', + }} + accordionProps={{ + 'data-test-subj': 'versionAccordion', + }} + initialToggleState={hasVersion} + > + {({ isEnabled }: CollapsiblePanelRenderProps) => ( + <> + - } - checked={isMetaVisible} - onChange={(e) => setIsMetaVisible(e.target.checked)} - data-test-subj="metaToggle" - /> - - } - > - {isMetaVisible && ( - + )} + + + + + + + + + + } + fieldName="_meta" + toggleProps={{ + 'data-test-subj': 'metaToggle', }} - /> - )} - + accordionProps={{ + 'data-test-subj': 'metaAccordion', + }} + initialToggleState={hasMeta} + > + {({ isEnabled }: CollapsiblePanelRenderProps) => ( + <> + + + + + + + + + )} + + + + + + + ); }; diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/utils.test.ts b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/utils.test.ts new file mode 100644 index 0000000000000..081400a8f599d --- /dev/null +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/utils.test.ts @@ -0,0 +1,39 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { removeUndefinedValues, deepEqualIgnoreUndefined } from './utils'; + +describe('deepEqualIgnoreUndefined', () => { + const testObjectA = Object.freeze({ + a: 1, + b: { + c: 2, + d: undefined, + }, + }); + + const testObjectB = Object.freeze({ + a: 1, + b: { + c: 2, + d: undefined, + }, + }); + + it('knows how to remove undefined values', () => { + expect(removeUndefinedValues(testObjectA)).toStrictEqual({ + a: 1, + b: { + c: 2, + }, + }); + }); + + it('knows how to compare two objects and see if they are equal ignoring undefined values', () => { + expect(deepEqualIgnoreUndefined(testObjectA, testObjectB)).toBe(true); + }); +}); diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/utils.ts b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/utils.ts new file mode 100644 index 0000000000000..df6b16b3ef2b7 --- /dev/null +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/utils.ts @@ -0,0 +1,35 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { transform, isObject, isEqual } from 'lodash'; + +export function removeUndefinedValues(obj: object) { + // If the input is an object, recursively clean each key-value pair. + if (isObject(obj)) { + // Use transform to iterate over the object and build a new result object. + return transform( + obj, + (result: Record, value: any, key: string) => { + const cleanedValue = removeUndefinedValues(value); + if (cleanedValue !== undefined) { + // Only add the key-value pair if the value is not undefined. + result[key as keyof typeof obj] = cleanedValue; + } + }, + {} + ); + } + return obj; +} + +export function deepEqualIgnoreUndefined(obj1: object, obj2: object) { + // Clean both objects by removing undefined values. + const cleanedObj1 = removeUndefinedValues(obj1); + const cleanedObj2 = removeUndefinedValues(obj2); + + return isEqual(cleanedObj1, cleanedObj2); +} diff --git a/x-pack/plugins/ingest_pipelines/public/application/index.tsx b/x-pack/plugins/ingest_pipelines/public/application/index.tsx index 982fc487957d1..6ec215db8b043 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/index.tsx +++ b/x-pack/plugins/ingest_pipelines/public/application/index.tsx @@ -10,7 +10,7 @@ import React from 'react'; import { render, unmountComponentAtNode } from 'react-dom'; import { ApplicationStart } from '@kbn/core/public'; -import { NotificationsSetup, IUiSettingsClient } from '@kbn/core/public'; +import { NotificationsSetup, IUiSettingsClient, OverlayStart, HttpStart } from '@kbn/core/public'; import { ManagementAppMountParams } from '@kbn/management-plugin/public'; import type { ConsolePluginStart } from '@kbn/console-plugin/public'; import type { SharePluginStart } from '@kbn/share-plugin/public'; @@ -48,6 +48,8 @@ export interface AppServices { application: ApplicationStart; license: ILicense | null; consolePlugin?: ConsolePluginStart; + overlays: OverlayStart; + http: HttpStart; } type StartServices = Pick; diff --git a/x-pack/plugins/ingest_pipelines/public/application/mount_management_section.ts b/x-pack/plugins/ingest_pipelines/public/application/mount_management_section.ts index ea6a229cfb73c..4b6ca4f35cd3f 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/mount_management_section.ts +++ b/x-pack/plugins/ingest_pipelines/public/application/mount_management_section.ts @@ -28,7 +28,7 @@ export async function mountManagementSection( ) { const { element, setBreadcrumbs, history, license } = params; const [coreStart, depsStart] = await getStartServices(); - const { docLinks, application, executionContext } = coreStart; + const { docLinks, application, executionContext, overlays } = coreStart; documentationService.setup(docLinks); breadcrumbService.setup(setBreadcrumbs); @@ -49,6 +49,8 @@ export async function mountManagementSection( executionContext, license, consolePlugin: depsStart.console, + overlays, + http, }; return renderApp(element, services, { ...coreStart, http }); diff --git a/x-pack/plugins/ingest_pipelines/public/shared_imports.ts b/x-pack/plugins/ingest_pipelines/public/shared_imports.ts index 420da38be6c54..0e24e3c984af9 100644 --- a/x-pack/plugins/ingest_pipelines/public/shared_imports.ts +++ b/x-pack/plugins/ingest_pipelines/public/shared_imports.ts @@ -62,6 +62,7 @@ export { FormDataProvider, getFieldValidityAndErrorMessage, useFormData, + useFormIsModified, } from '@kbn/es-ui-shared-plugin/static/forms/hook_form_lib'; export { fieldFormatters, fieldValidators } from '@kbn/es-ui-shared-plugin/static/forms/helpers'; diff --git a/x-pack/plugins/ingest_pipelines/tsconfig.json b/x-pack/plugins/ingest_pipelines/tsconfig.json index 8d14d5f11412d..1f8fd6eb5f758 100644 --- a/x-pack/plugins/ingest_pipelines/tsconfig.json +++ b/x-pack/plugins/ingest_pipelines/tsconfig.json @@ -33,7 +33,9 @@ "@kbn/code-editor", "@kbn/react-kibana-context-render", "@kbn/console-plugin", - "@kbn/react-kibana-context-theme" + "@kbn/react-kibana-context-theme", + "@kbn/unsaved-changes-prompt", + "@kbn/core-http-browser-mocks" ], "exclude": [ "target/**/*", diff --git a/x-pack/plugins/ml/public/application/components/custom_selection_table/custom_selection_table.js b/x-pack/plugins/ml/public/application/components/custom_selection_table/custom_selection_table.js index d1597cce0fb08..2846b4de6f6ed 100644 --- a/x-pack/plugins/ml/public/application/components/custom_selection_table/custom_selection_table.js +++ b/x-pack/plugins/ml/public/application/components/custom_selection_table/custom_selection_table.js @@ -197,7 +197,6 @@ export function CustomSelectionTable({ label={mobile ? selectAll : null} checked={areAllItemsSelected()} onChange={toggleAll} - type={mobile ? null : 'inList'} /> ); } @@ -283,7 +282,6 @@ export function CustomSelectionTable({ data-test-subj={`${item[tableItemId]}-checkbox`} checked={isItemSelected(item[tableItemId])} onChange={() => toggleItem(item[tableItemId])} - type="inList" /> )} {singleSelection && ( diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/advanced_step/advanced_step_form.tsx b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/advanced_step/advanced_step_form.tsx index bb344a2b373a1..6e93775486ed7 100644 --- a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/advanced_step/advanced_step_form.tsx +++ b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/advanced_step/advanced_step_form.tsx @@ -402,6 +402,7 @@ export const AdvancedStepForm: FC = ({ { defaultMessage: 'Define the name of the prediction field in the results. The default is _prediction.', + ignoreTag: true, } )} > diff --git a/x-pack/plugins/observability_solution/infra/public/alerting/inventory/components/metric.tsx b/x-pack/plugins/observability_solution/infra/public/alerting/inventory/components/metric.tsx index dfe22251fb599..e4a6185cce807 100644 --- a/x-pack/plugins/observability_solution/infra/public/alerting/inventory/components/metric.tsx +++ b/x-pack/plugins/observability_solution/infra/public/alerting/inventory/components/metric.tsx @@ -269,6 +269,7 @@ export const MetricExpression = ({ helpText={i18n.translate('xpack.infra.waffle.alerting.customMetrics.helpText', { defaultMessage: 'Choose a name to help identify your custom metric. Defaults to " of ".', + ignoreTag: true, })} > & { - id: string; - queryField: string; - dateRange: TimeRange; - assetId: string; - }; +export type ChartProps = Pick & { + id: string; + queryField: string; + dateRange: TimeRange; + assetId: string; + lensAttributes: LensConfig; +}; -export const Chart = ({ id, queryField, overrides, dateRange, assetId, ...props }: ChartProps) => { +export const Chart = ({ + id, + queryField, + overrides, + dateRange, + assetId, + lensAttributes, +}: ChartProps) => { const { setDateRange } = useDatePickerContext(); const { searchSessionId } = useLoadingStateContext(); const { @@ -34,7 +41,7 @@ export const Chart = ({ id, queryField, overrides, dateRange, assetId, ...props const { value: filters = [] } = useAsync(async () => { const resolvedDataView = await resolveDataView({ - dataViewId: (props.dataset as LensDataviewDataset)?.index, + dataViewId: (lensAttributes.dataset as LensDataviewDataset)?.index, dataViewsService: dataViews, }); @@ -45,7 +52,7 @@ export const Chart = ({ id, queryField, overrides, dateRange, assetId, ...props dataView: resolvedDataView.dataViewReference, }), ]; - }, [assetId, dataViews, props.dataset, queryField]); + }, [assetId, dataViews, lensAttributes.dataset, queryField]); const handleBrushEnd = useCallback( ({ range, preventDefault }: BrushEndArgs) => { @@ -75,13 +82,13 @@ export const Chart = ({ id, queryField, overrides, dateRange, assetId, ...props return ( ( {charts.map((chart) => ( ( const { charts } = useHostCharts({ metric, dataViewId: dataView?.id, - options: { overview }, + overview, }); return ( @@ -91,10 +91,11 @@ export const HostCharts = React.forwardRef( {charts.map((chart) => ( ))} diff --git a/x-pack/plugins/observability_solution/infra/public/components/asset_details/charts/kubernetes_charts.tsx b/x-pack/plugins/observability_solution/infra/public/components/asset_details/charts/kubernetes_charts.tsx index b386b1e9d8cbc..55771a47d09b2 100644 --- a/x-pack/plugins/observability_solution/infra/public/components/asset_details/charts/kubernetes_charts.tsx +++ b/x-pack/plugins/observability_solution/infra/public/components/asset_details/charts/kubernetes_charts.tsx @@ -27,7 +27,7 @@ export const KubernetesNodeCharts = React.forwardRef { const { charts } = useKubernetesCharts({ dataViewId: dataView?.id, - options: { overview }, + overview, }); const hasIntegration = useIntegrationCheck({ dependsOn: INTEGRATIONS.kubernetesNode }); @@ -63,10 +63,11 @@ export const KubernetesNodeCharts = React.forwardRef {charts.map((chart) => ( ))} @@ -127,8 +128,9 @@ export const KubernetesContainerCharts = React.forwardRef< {charts.map((chart) => ( string; - }; + getSubtitle?: (formulaValue: string) => string; loading?: boolean; } @@ -28,7 +26,7 @@ export const HostKpiCharts = ({ dateRange, dataView, filters, - options, + getSubtitle, query, searchSessionId, loading = false, @@ -36,10 +34,8 @@ export const HostKpiCharts = ({ const { euiTheme } = useEuiTheme(); const charts = useHostKpiCharts({ dataViewId: dataView?.id, - options: { - getSubtitle: options?.getSubtitle, - seriesColor: euiTheme.colors.lightestShade, - }, + getSubtitle, + seriesColor: euiTheme.colors.lightestShade, }); return ( diff --git a/x-pack/plugins/observability_solution/infra/public/components/asset_details/components/kpis/kpi.tsx b/x-pack/plugins/observability_solution/infra/public/components/asset_details/components/kpis/kpi.tsx index 6652bd2b12b99..3545a54d813db 100644 --- a/x-pack/plugins/observability_solution/infra/public/components/asset_details/components/kpis/kpi.tsx +++ b/x-pack/plugins/observability_solution/infra/public/components/asset_details/components/kpis/kpi.tsx @@ -36,11 +36,11 @@ export const Kpi = ({ return ( { export const useDockerContainerKpiCharts = ({ dataViewId, - options, + seriesColor, }: { dataViewId?: string; - options?: { seriesColor: string; getSubtitle?: (formulaValue: string) => string }; + seriesColor?: string; }) => { const { value: charts = [] } = useAsync(async () => { const model = findInventoryModel('container'); @@ -113,9 +113,8 @@ export const useDockerContainerKpiCharts = ({ return [cpu.metric.dockerContainerCpuUsage, memory.metric.dockerContainerMemoryUsage].map( (chart) => ({ ...chart, - seriesColor: options?.seriesColor, + seriesColor, decimals: 1, - subtitle: getSubtitle(options, chart), ...(dataViewId && { dataset: { index: dataViewId, @@ -123,17 +122,17 @@ export const useDockerContainerKpiCharts = ({ }), }) ); - }, [dataViewId, options?.seriesColor, options?.getSubtitle]); + }, [dataViewId, seriesColor]); return charts; }; export const useK8sContainerKpiCharts = ({ dataViewId, - options, + seriesColor, }: { dataViewId?: string; - options?: { seriesColor: string; getSubtitle?: (formulaValue: string) => string }; + seriesColor?: string; }) => { const { value: charts = [] } = useAsync(async () => { const model = findInventoryModel('container'); @@ -142,9 +141,9 @@ export const useK8sContainerKpiCharts = ({ return [cpu.metric.k8sContainerCpuUsage, memory.metric.k8sContainerMemoryUsage].map( (chart) => ({ ...chart, - seriesColor: options?.seriesColor, + seriesColor, decimals: 1, - subtitle: getSubtitle(options, chart), + subtitle: getSubtitle(chart), ...(dataViewId && { dataset: { index: dataViewId, @@ -152,16 +151,11 @@ export const useK8sContainerKpiCharts = ({ }), }) ); - }, [dataViewId, options?.seriesColor, options?.getSubtitle]); + }, [dataViewId, seriesColor]); return charts; }; -function getSubtitle( - options: { getSubtitle?: ((formulaValue: string) => string) | undefined } | undefined, - chart: { value: string } -) { - return options?.getSubtitle - ? options?.getSubtitle(chart.value) - : getSubtitleFromFormula(chart.value); +function getSubtitle(chart: { value: string }) { + return getSubtitleFromFormula(chart.value); } diff --git a/x-pack/plugins/observability_solution/infra/public/components/asset_details/hooks/use_data_views.ts b/x-pack/plugins/observability_solution/infra/public/components/asset_details/hooks/use_data_views.ts index 6ef5ab61f517d..7740b968e74db 100644 --- a/x-pack/plugins/observability_solution/infra/public/components/asset_details/hooks/use_data_views.ts +++ b/x-pack/plugins/observability_solution/infra/public/components/asset_details/hooks/use_data_views.ts @@ -34,7 +34,7 @@ const useDataViews = () => { const { value: logsDataView, loading: logsDataViewLoading } = useAsync( () => getLogsDataView(logViewReference), - [logViewReference] + [logViewReference, getLogsDataView] ); return { diff --git a/x-pack/plugins/observability_solution/infra/public/components/asset_details/hooks/use_host_metrics_charts.test.ts b/x-pack/plugins/observability_solution/infra/public/components/asset_details/hooks/use_host_metrics_charts.test.ts index c4e3815f5e0f8..006fae9bec753 100644 --- a/x-pack/plugins/observability_solution/infra/public/components/asset_details/hooks/use_host_metrics_charts.test.ts +++ b/x-pack/plugins/observability_solution/infra/public/components/asset_details/hooks/use_host_metrics_charts.test.ts @@ -61,7 +61,7 @@ describe('useHostCharts', () => { const expectedOrder = getHostChartsExpectedOrder(metric, true); const { result, waitForNextUpdate } = renderHook(() => - useHostCharts({ dataViewId, metric, options: { overview: true } }) + useHostCharts({ dataViewId, metric, overview: true }) ); await waitForNextUpdate(); @@ -81,7 +81,7 @@ describe('useHostCharts', () => { describe('useKubernetesCharts', () => { it('should return an array of charts with correct order - overview', async () => { const { result, waitForNextUpdate } = renderHook(() => - useKubernetesCharts({ dataViewId, options: { overview: true } }) + useKubernetesCharts({ dataViewId, overview: true }) ); await waitForNextUpdate(); @@ -141,7 +141,7 @@ describe('useHostKpiCharts', () => { }; const { result, waitForNextUpdate } = renderHook(() => - useHostKpiCharts({ dataViewId, options }) + useHostKpiCharts({ dataViewId, ...options }) ); await waitForNextUpdate(); diff --git a/x-pack/plugins/observability_solution/infra/public/components/asset_details/hooks/use_host_metrics_charts.ts b/x-pack/plugins/observability_solution/infra/public/components/asset_details/hooks/use_host_metrics_charts.ts index 6d5381caf6187..57c9a5a0d7d42 100644 --- a/x-pack/plugins/observability_solution/infra/public/components/asset_details/hooks/use_host_metrics_charts.ts +++ b/x-pack/plugins/observability_solution/infra/public/components/asset_details/hooks/use_host_metrics_charts.ts @@ -7,24 +7,21 @@ import { i18n } from '@kbn/i18n'; import { findInventoryModel } from '@kbn/metrics-data-access-plugin/common'; +import { useMemo } from 'react'; import useAsync from 'react-use/lib/useAsync'; import { HostMetricTypes } from '../charts/types'; -interface UseChartsOptions { - overview?: boolean; -} - export const useHostCharts = ({ metric, dataViewId, - options, + overview, }: { metric: HostMetricTypes; dataViewId?: string; - options?: UseChartsOptions; + overview?: boolean; }) => { const { value: charts = [], error } = useAsync(async () => { - const hostCharts = await getHostsCharts({ metric, options }); + const hostCharts = await getHostsCharts({ metric, overview }); return hostCharts.map((chart) => ({ ...chart, ...(dataViewId && { @@ -33,24 +30,24 @@ export const useHostCharts = ({ }, }), })); - }, [dataViewId]); + }, [dataViewId, metric, overview]); return { charts, error }; }; export const useKubernetesCharts = ({ dataViewId, - options, + overview, }: { dataViewId?: string; - options?: UseChartsOptions; + overview?: boolean; }) => { - const model = findInventoryModel('host'); + const model = useMemo(() => findInventoryModel('host'), []); const { value: charts = [], error } = useAsync(async () => { const { kibernetesNode } = await model.metrics.getCharts(); - const items = options?.overview + const items = overview ? [kibernetesNode.xy.nodeCpuCapacity, kibernetesNode.xy.nodeMemoryCapacity] : [ kibernetesNode.xy.nodeCpuCapacity, @@ -69,7 +66,7 @@ export const useKubernetesCharts = ({ }), }; }); - }, [dataViewId, options?.overview]); + }, [dataViewId, overview, model.metrics]); return { charts, error }; }; @@ -83,10 +80,12 @@ const getSubtitleFromFormula = (value: string) => export const useHostKpiCharts = ({ dataViewId, - options, + seriesColor, + getSubtitle, }: { dataViewId?: string; - options?: { seriesColor: string; getSubtitle?: (formulaValue: string) => string }; + seriesColor?: string; + getSubtitle?: (formulaValue: string) => string; }) => { const { value: charts = [] } = useAsync(async () => { const model = findInventoryModel('host'); @@ -99,33 +98,33 @@ export const useHostKpiCharts = ({ disk.metric.diskUsage, ].map((chart) => ({ ...chart, - seriesColor: options?.seriesColor, + seriesColor, decimals: 1, - subtitle: getSubtitle(options, chart), + subtitle: getSubtitle ? getSubtitle(chart.value) : getSubtitleFromFormula(chart.value), ...(dataViewId && { dataset: { index: dataViewId, }, }), })); - }, [dataViewId, options?.seriesColor, options?.getSubtitle]); + }, [dataViewId, seriesColor, getSubtitle]); return charts; }; const getHostsCharts = async ({ metric, - options, + overview, }: { metric: HostMetricTypes; - options?: UseChartsOptions; + overview?: boolean; }) => { const model = findInventoryModel('host'); const { cpu, memory, network, disk, logs } = await model.metrics.getCharts(); switch (metric) { case 'cpu': - return options?.overview + return overview ? [cpu.xy.cpuUsage, cpu.xy.normalizedLoad1m] : [ cpu.xy.cpuUsage, @@ -134,13 +133,13 @@ const getHostsCharts = async ({ cpu.xy.loadBreakdown, ]; case 'memory': - return options?.overview + return overview ? [memory.xy.memoryUsage] : [memory.xy.memoryUsage, memory.xy.memoryUsageBreakdown]; case 'network': return [network.xy.rxTx]; case 'disk': - return options?.overview + return overview ? [disk.xy.diskUsageByMountPoint, disk.xy.diskIOReadWrite] : [disk.xy.diskUsageByMountPoint, disk.xy.diskIOReadWrite, disk.xy.diskThroughputReadWrite]; case 'log': @@ -149,12 +148,3 @@ const getHostsCharts = async ({ return []; } }; - -function getSubtitle( - options: { getSubtitle?: ((formulaValue: string) => string) | undefined } | undefined, - chart: { value: string } -) { - return options?.getSubtitle - ? options?.getSubtitle(chart.value) - : getSubtitleFromFormula(chart.value); -} diff --git a/x-pack/plugins/observability_solution/infra/public/components/lens/lens_chart.tsx b/x-pack/plugins/observability_solution/infra/public/components/lens/lens_chart.tsx index e9cd4407fb5b2..c69b3b8bc34ce 100644 --- a/x-pack/plugins/observability_solution/infra/public/components/lens/lens_chart.tsx +++ b/x-pack/plugins/observability_solution/infra/public/components/lens/lens_chart.tsx @@ -16,12 +16,13 @@ import { ChartLoadError } from './chart_load_error'; const MIN_HEIGHT = 300; -export type LensChartProps = UseLensAttributesParams & - BaseChartProps & +export type LensChartProps = BaseChartProps & Pick & { toolTip?: React.ReactElement; searchSessionId?: string; description?: string; + } & { + lensAttributes: UseLensAttributesParams; }; export const LensChart = React.memo( @@ -41,9 +42,9 @@ export const LensChart = React.memo( disableTriggers = false, height = MIN_HEIGHT, loading = false, - ...lensAttributesParams + lensAttributes, }: LensChartProps) => { - const { formula, attributes, getExtraActions, error } = useLensAttributes(lensAttributesParams); + const { formula, attributes, getExtraActions, error } = useLensAttributes(lensAttributes); const isLoading = loading || !attributes; diff --git a/x-pack/plugins/observability_solution/infra/public/components/log_stream/constants.ts b/x-pack/plugins/observability_solution/infra/public/components/log_stream/constants.ts new file mode 100644 index 0000000000000..c573295aeb81c --- /dev/null +++ b/x-pack/plugins/observability_solution/infra/public/components/log_stream/constants.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export const LOG_STREAM_EMBEDDABLE = 'LOG_STREAM_EMBEDDABLE'; +export const ADD_LOG_STREAM_ACTION_ID = 'ADD_SEARCH_ACTION_ID'; diff --git a/x-pack/plugins/observability_solution/infra/public/components/log_stream/log_stream_embeddable.tsx b/x-pack/plugins/observability_solution/infra/public/components/log_stream/log_stream_embeddable.tsx deleted file mode 100644 index 9d8be340d9bd5..0000000000000 --- a/x-pack/plugins/observability_solution/infra/public/components/log_stream/log_stream_embeddable.tsx +++ /dev/null @@ -1,133 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { Query, Filter } from '@kbn/es-query'; -import { AppMountParameters, CoreStart } from '@kbn/core/public'; -import React, { FC, PropsWithChildren } from 'react'; -import ReactDOM from 'react-dom'; -import { Subscription } from 'rxjs'; -import type { TimeRange } from '@kbn/es-query'; -import { Embeddable, EmbeddableInput, IContainer } from '@kbn/embeddable-plugin/public'; -import { EuiThemeProvider } from '@kbn/kibana-react-plugin/common'; -import { LogStream } from '@kbn/logs-shared-plugin/public'; -import { KibanaRenderContextProvider } from '@kbn/react-kibana-context-render'; -import { InfraClientStartDeps, InfraClientStartExports } from '../../types'; -import { datemathToEpochMillis } from '../../utils/datemath'; -import { useKibanaContextForPluginProvider } from '../../hooks/use_kibana'; - -export const LOG_STREAM_EMBEDDABLE = 'LOG_STREAM_EMBEDDABLE'; - -export interface LogStreamEmbeddableInput extends EmbeddableInput { - filters: Filter[]; - timeRange: TimeRange; - query: Query; -} - -export class LogStreamEmbeddable extends Embeddable { - public readonly type = LOG_STREAM_EMBEDDABLE; - private node?: HTMLElement; - private subscription: Subscription; - private isDarkMode = false; - - constructor( - private core: CoreStart, - private pluginDeps: InfraClientStartDeps, - private pluginStart: InfraClientStartExports, - initialInput: LogStreamEmbeddableInput, - parent?: IContainer - ) { - super(initialInput, {}, parent); - - this.subscription = new Subscription(); - - this.subscription.add( - core.theme?.theme$.subscribe((theme) => (this.isDarkMode = theme.darkMode)) - ); - - this.subscription.add(this.getInput$().subscribe(() => this.renderComponent())); - } - - public render(node: HTMLElement) { - if (this.node) { - ReactDOM.unmountComponentAtNode(this.node); - } - this.node = node; - - this.renderComponent(); - } - - public destroy() { - super.destroy(); - this.subscription.unsubscribe(); - if (this.node) { - ReactDOM.unmountComponentAtNode(this.node); - } - } - - public async reload() {} - - private renderComponent() { - if (!this.node) { - return; - } - - const startTimestamp = datemathToEpochMillis(this.input.timeRange.from); - const endTimestamp = datemathToEpochMillis(this.input.timeRange.to, 'up'); - - if (!startTimestamp || !endTimestamp) { - return; - } - - ReactDOM.render( - - -
    - -
    -     -     , - this.node - ); - } -} - -export interface LogStreamEmbeddableProvidersProps { - core: CoreStart; - pluginStart: InfraClientStartExports; - plugins: InfraClientStartDeps; - theme$: AppMountParameters['theme$']; -} - -export const LogStreamEmbeddableProviders: FC< - PropsWithChildren -> = ({ children, core, pluginStart, plugins }) => { - const KibanaContextProviderForPlugin = useKibanaContextForPluginProvider( - core, - plugins, - pluginStart - ); - - return ( - - - {children} - - - ); -}; diff --git a/x-pack/plugins/observability_solution/infra/public/components/log_stream/log_stream_embeddable_factory.ts b/x-pack/plugins/observability_solution/infra/public/components/log_stream/log_stream_embeddable_factory.ts deleted file mode 100644 index 3d472654c0860..0000000000000 --- a/x-pack/plugins/observability_solution/infra/public/components/log_stream/log_stream_embeddable_factory.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { i18n } from '@kbn/i18n'; -import { EmbeddableFactoryDefinition, IContainer } from '@kbn/embeddable-plugin/public'; -import { InfraClientStartServicesAccessor } from '../../types'; -import { - LogStreamEmbeddable, - LogStreamEmbeddableInput, - LOG_STREAM_EMBEDDABLE, -} from './log_stream_embeddable'; - -export class LogStreamEmbeddableFactoryDefinition - implements EmbeddableFactoryDefinition -{ - public readonly type = LOG_STREAM_EMBEDDABLE; - - constructor(private getStartServices: InfraClientStartServicesAccessor) {} - - public async isEditable() { - const [{ application }] = await this.getStartServices(); - return application.capabilities.logs.save as boolean; - } - - public async create(initialInput: LogStreamEmbeddableInput, parent?: IContainer) { - const [core, plugins, pluginStart] = await this.getStartServices(); - return new LogStreamEmbeddable(core, plugins, pluginStart, initialInput, parent); - } - - public getDisplayName() { - return i18n.translate('xpack.infra.logStreamEmbeddable.displayName', { - defaultMessage: 'Log stream', - }); - } - - public getDescription() { - return i18n.translate('xpack.infra.logStreamEmbeddable.description', { - defaultMessage: 'Add a table of live streaming logs.', - }); - } - - public getIconType() { - return 'logsApp'; - } - - public async getExplicitInput() { - return { - title: i18n.translate('xpack.infra.logStreamEmbeddable.title', { - defaultMessage: 'Log stream', - }), - }; - } -} diff --git a/x-pack/plugins/observability_solution/infra/public/components/log_stream/log_stream_react_embeddable.tsx b/x-pack/plugins/observability_solution/infra/public/components/log_stream/log_stream_react_embeddable.tsx new file mode 100644 index 0000000000000..313eb476c4ae5 --- /dev/null +++ b/x-pack/plugins/observability_solution/infra/public/components/log_stream/log_stream_react_embeddable.tsx @@ -0,0 +1,123 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { FC, PropsWithChildren, useEffect, useMemo, useState } from 'react'; +import { ReactEmbeddableFactory } from '@kbn/embeddable-plugin/public'; +import { + initializeTimeRange, + initializeTitles, + useFetchContext, +} from '@kbn/presentation-publishing'; +import { LogStream } from '@kbn/logs-shared-plugin/public'; +import { AppMountParameters, CoreStart } from '@kbn/core/public'; +import { EuiThemeProvider } from '@kbn/kibana-react-plugin/common'; +import { Query } from '@kbn/es-query'; +import { KibanaRenderContextProvider } from '@kbn/react-kibana-context-render'; +import type { LogStreamApi, LogStreamSerializedState, Services } from './types'; +import { datemathToEpochMillis } from '../../utils/datemath'; +import { LOG_STREAM_EMBEDDABLE } from './constants'; +import { useKibanaContextForPluginProvider } from '../../hooks/use_kibana'; +import { InfraClientStartDeps, InfraClientStartExports } from '../../types'; + +export function getLogStreamEmbeddableFactory(services: Services) { + const factory: ReactEmbeddableFactory = { + type: LOG_STREAM_EMBEDDABLE, + deserializeState: (state) => state.rawState, + buildEmbeddable: async (state, buildApi) => { + const timeRangeContext = initializeTimeRange(state); + const { titlesApi, titleComparators, serializeTitles } = initializeTitles(state); + + const api = buildApi( + { + ...timeRangeContext.api, + ...titlesApi, + serializeState: () => { + return { + rawState: { + ...timeRangeContext.serialize(), + ...serializeTitles(), + }, + }; + }, + }, + { + ...timeRangeContext.comparators, + ...titleComparators, + } + ); + + return { + api, + Component: () => { + const { filters, query, timeRange } = useFetchContext(api); + const { startTimestamp, endTimestamp } = useMemo(() => { + return { + startTimestamp: timeRange ? datemathToEpochMillis(timeRange.from) : undefined, + endTimestamp: timeRange ? datemathToEpochMillis(timeRange.to, 'up') : undefined, + }; + }, [timeRange]); + + const [darkMode, setDarkMode] = useState(false); + useEffect(() => { + const subscription = services.coreStart.theme.theme$.subscribe((theme) => { + setDarkMode(theme.darkMode); + }); + return () => subscription.unsubscribe(); + }, []); + + return !startTimestamp || !endTimestamp ? null : ( + + +
    + +
    +     +     + ); + }, + }; + }, + }; + return factory; +} + +export interface LogStreamEmbeddableProvidersProps { + core: CoreStart; + pluginStart: InfraClientStartExports; + plugins: InfraClientStartDeps; + theme$: AppMountParameters['theme$']; +} + +export const LogStreamEmbeddableProviders: FC< + PropsWithChildren +> = ({ children, core, pluginStart, plugins }) => { + const KibanaContextProviderForPlugin = useKibanaContextForPluginProvider( + core, + plugins, + pluginStart + ); + + return ( + + + {children} + + + ); +}; diff --git a/x-pack/plugins/observability_solution/infra/public/components/log_stream/types.ts b/x-pack/plugins/observability_solution/infra/public/components/log_stream/types.ts new file mode 100644 index 0000000000000..26a9201c41a94 --- /dev/null +++ b/x-pack/plugins/observability_solution/infra/public/components/log_stream/types.ts @@ -0,0 +1,21 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { CoreStart } from '@kbn/core/public'; +import { DefaultEmbeddableApi } from '@kbn/embeddable-plugin/public'; +import { SerializedTimeRange, SerializedTitles } from '@kbn/presentation-publishing'; +import { InfraClientStartDeps, InfraClientStartExports } from '../../types'; + +export type LogStreamSerializedState = SerializedTitles & SerializedTimeRange; + +export type LogStreamApi = DefaultEmbeddableApi; + +export interface Services { + coreStart: CoreStart; + pluginDeps: InfraClientStartDeps; + pluginStart: InfraClientStartExports; +} diff --git a/x-pack/plugins/observability_solution/infra/public/components/logging/log_analysis_setup/initial_configuration_step/index_setup_dataset_filter.tsx b/x-pack/plugins/observability_solution/infra/public/components/logging/log_analysis_setup/initial_configuration_step/index_setup_dataset_filter.tsx index 24884730ad97c..7d494e97ea656 100644 --- a/x-pack/plugins/observability_solution/infra/public/components/logging/log_analysis_setup/initial_configuration_step/index_setup_dataset_filter.tsx +++ b/x-pack/plugins/observability_solution/infra/public/components/logging/log_analysis_setup/initial_configuration_step/index_setup_dataset_filter.tsx @@ -68,7 +68,7 @@ export const IndexSetupDatasetFilter: React.FC<{ > { const builder = new LensConfigBuilder(dataViews, formulaAPI); return builder.build(params) as Promise; - }, [params.chartType, params.dataset, dataViews]); + }, [params, dataViews, lens]); const injectFilters = useCallback( ({ filters, query }: { filters: Filter[]; query: Query }): LensAttributes | null => { diff --git a/x-pack/plugins/observability_solution/infra/public/hooks/use_log_view_reference.ts b/x-pack/plugins/observability_solution/infra/public/hooks/use_log_view_reference.ts index 56ba82b697338..da68b88115584 100644 --- a/x-pack/plugins/observability_solution/infra/public/hooks/use_log_view_reference.ts +++ b/x-pack/plugins/observability_solution/infra/public/hooks/use_log_view_reference.ts @@ -28,7 +28,7 @@ export const useLogViewReference = ({ id, name, extraFields = [] }: Props) => { const { loading, value: defaultLogView } = useAsync( () => logsShared.logViews.client.getLogView(DEFAULT_LOG_VIEW), - [] + [logsShared.logViews.client] ); const logViewReference = useLazyRef(() => { diff --git a/x-pack/plugins/observability_solution/infra/public/pages/logs/log_entry_rate/sections/anomalies/table.tsx b/x-pack/plugins/observability_solution/infra/public/pages/logs/log_entry_rate/sections/anomalies/table.tsx index 34075a301c911..257f8cb1b37b3 100644 --- a/x-pack/plugins/observability_solution/infra/public/pages/logs/log_entry_rate/sections/anomalies/table.tsx +++ b/x-pack/plugins/observability_solution/infra/public/pages/logs/log_entry_rate/sections/anomalies/table.tsx @@ -230,7 +230,7 @@ const AnomalyMessage = ({ anomaly }: { anomaly: TableItem }) => { 'xpack.infra.logs.analysis.anomaliesTableMoreThanExpectedAnomalyMessage', { defaultMessage: - 'more log messages in this {type, select, logRate {dataset} logCategory {category}} than expected', + 'more log messages in this {type, select, logRate {dataset} logCategory {category} other{#}} than expected', values: { type }, } ); @@ -239,7 +239,7 @@ const AnomalyMessage = ({ anomaly }: { anomaly: TableItem }) => { 'xpack.infra.logs.analysis.anomaliesTableFewerThanExpectedAnomalyMessage', { defaultMessage: - 'fewer log messages in this {type, select, logRate {dataset} logCategory {category}} than expected', + 'fewer log messages in this {type, select, logRate {dataset} logCategory {category} other{#}} than expected', values: { type }, } ); diff --git a/x-pack/plugins/observability_solution/infra/public/pages/metrics/hosts/components/kpis/kpi_charts.tsx b/x-pack/plugins/observability_solution/infra/public/pages/metrics/hosts/components/kpis/kpi_charts.tsx index 9b349441c5876..d0ff61c66abc6 100644 --- a/x-pack/plugins/observability_solution/infra/public/pages/metrics/hosts/components/kpis/kpi_charts.tsx +++ b/x-pack/plugins/observability_solution/infra/public/pages/metrics/hosts/components/kpis/kpi_charts.tsx @@ -76,7 +76,7 @@ export const KpiCharts = () => { filters={afterLoadedState.filters} query={afterLoadedState.query} searchSessionId={afterLoadedState.searchSessionId} - options={{ getSubtitle: afterLoadedState.getSubtitle }} + getSubtitle={afterLoadedState.getSubtitle} loading={loading} /> ); diff --git a/x-pack/plugins/observability_solution/infra/public/pages/metrics/hosts/components/tabs/metrics/chart.tsx b/x-pack/plugins/observability_solution/infra/public/pages/metrics/hosts/components/tabs/metrics/chart.tsx index ac6c370a7ce6c..77f45445f0023 100644 --- a/x-pack/plugins/observability_solution/infra/public/pages/metrics/hosts/components/tabs/metrics/chart.tsx +++ b/x-pack/plugins/observability_solution/infra/public/pages/metrics/hosts/components/tabs/metrics/chart.tsx @@ -62,11 +62,12 @@ export const Chart = ({ id, ...chartProps }: ChartProps) => { chartProps.dataset, searchCriteria.filters, searchCriteria.panelFilters, + shouldUseSearchCriteria, ]); return ( { - const model = findInventoryModel('host'); - const { value: charts = [] } = useAsync(async () => { + const model = findInventoryModel('host'); const { cpu, disk, memory, network } = await model.metrics.getCharts(); return [ diff --git a/x-pack/plugins/observability_solution/infra/public/plugin.ts b/x-pack/plugins/observability_solution/infra/public/plugin.ts index 20a6d85092c86..20f819b7eb34d 100644 --- a/x-pack/plugins/observability_solution/infra/public/plugin.ts +++ b/x-pack/plugins/observability_solution/infra/public/plugin.ts @@ -19,12 +19,14 @@ import { enableInfrastructureHostsView } from '@kbn/observability-plugin/public' import { ObservabilityTriggerId } from '@kbn/observability-shared-plugin/common'; import { BehaviorSubject, combineLatest, from } from 'rxjs'; import { map } from 'rxjs'; +import type { EmbeddableApiContext } from '@kbn/presentation-publishing'; +import { apiCanAddNewPanel } from '@kbn/presentation-containers'; +import { IncompatibleActionError } from '@kbn/ui-actions-plugin/public'; import type { InfraPublicConfig } from '../common/plugin_config_types'; import { createInventoryMetricRuleType } from './alerting/inventory'; import { createLogThresholdRuleType } from './alerting/log_threshold'; import { createMetricThresholdRuleType } from './alerting/metric_threshold'; -import { LOG_STREAM_EMBEDDABLE } from './components/log_stream/log_stream_embeddable'; -import { LogStreamEmbeddableFactoryDefinition } from './components/log_stream/log_stream_embeddable_factory'; +import { ADD_LOG_STREAM_ACTION_ID, LOG_STREAM_EMBEDDABLE } from './components/log_stream/constants'; import { type InfraLocators, InfraLogsLocatorDefinition, @@ -44,6 +46,7 @@ import type { InfraClientStartExports, } from './types'; import { getLogsHasDataFetcher, getLogsOverviewDataFetcher } from './utils/logs_overview_fetchers'; +import type { LogStreamSerializedState } from './components/log_stream/types'; export class Plugin implements InfraClientPluginClass { public config: InfraPublicConfig; @@ -173,10 +176,17 @@ export class Plugin implements InfraClientPluginClass { ) ); - pluginsSetup.embeddable.registerEmbeddableFactory( - LOG_STREAM_EMBEDDABLE, - new LogStreamEmbeddableFactoryDefinition(core.getStartServices) - ); + pluginsSetup.embeddable.registerReactEmbeddableFactory(LOG_STREAM_EMBEDDABLE, async () => { + const { getLogStreamEmbeddableFactory } = await import( + './components/log_stream/log_stream_react_embeddable' + ); + const [coreStart, pluginDeps, pluginStart] = await core.getStartServices(); + return getLogStreamEmbeddableFactory({ + coreStart, + pluginDeps, + pluginStart, + }); + }); // Register Locators const logsLocator = this.config.featureFlags.logsUIEnabled @@ -388,6 +398,37 @@ export class Plugin implements InfraClientPluginClass { const telemetry = this.telemetry.start(); + plugins.uiActions.registerAction({ + id: ADD_LOG_STREAM_ACTION_ID, + getDisplayName: () => + i18n.translate('xpack.infra.logStreamEmbeddable.displayName', { + defaultMessage: 'Log stream', + }), + getDisplayNameTooltip: () => + i18n.translate('xpack.infra.logStreamEmbeddable.description', { + defaultMessage: 'Add a table of live streaming logs.', + }), + getIconType: () => 'logsApp', + isCompatible: async ({ embeddable }) => { + return apiCanAddNewPanel(embeddable); + }, + execute: async ({ embeddable }) => { + if (!apiCanAddNewPanel(embeddable)) throw new IncompatibleActionError(); + embeddable.addNewPanel( + { + panelType: LOG_STREAM_EMBEDDABLE, + initialState: { + title: i18n.translate('xpack.infra.logStreamEmbeddable.title', { + defaultMessage: 'Log stream', + }), + }, + }, + true + ); + }, + }); + plugins.uiActions.attachAction('ADD_PANEL_TRIGGER', ADD_LOG_STREAM_ACTION_ID); + const startContract: InfraClientStartExports = { inventoryViews, metricsExplorerViews, diff --git a/x-pack/plugins/observability_solution/infra/server/lib/alerting/common/utils.ts b/x-pack/plugins/observability_solution/infra/server/lib/alerting/common/utils.ts index e91f80dccbac9..9c506d215355a 100644 --- a/x-pack/plugins/observability_solution/infra/server/lib/alerting/common/utils.ts +++ b/x-pack/plugins/observability_solution/infra/server/lib/alerting/common/utils.ts @@ -196,7 +196,7 @@ export const doFieldsExist = async ( // Get all supported fields const respMapping = await esClient.fieldCaps({ index, - fields: '*', + fields, }); const fieldsExisted: Record = {}; diff --git a/x-pack/plugins/observability_solution/infra/tsconfig.json b/x-pack/plugins/observability_solution/infra/tsconfig.json index 22f3fb1d16d70..cb98f8ab0859e 100644 --- a/x-pack/plugins/observability_solution/infra/tsconfig.json +++ b/x-pack/plugins/observability_solution/infra/tsconfig.json @@ -104,6 +104,8 @@ "@kbn/router-utils", "@kbn/react-kibana-context-render", "@kbn/react-kibana-context-theme", + "@kbn/presentation-publishing", + "@kbn/presentation-containers", "@kbn/deeplinks-observability" ], "exclude": [ diff --git a/x-pack/plugins/observability_solution/investigate/README.md b/x-pack/plugins/observability_solution/investigate/README.md new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/x-pack/plugins/observability_solution/investigate/common/index.ts b/x-pack/plugins/observability_solution/investigate/common/index.ts new file mode 100644 index 0000000000000..1cfdb87f4803a --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/common/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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +export type { + InvestigateTimeline, + InvestigateWidget, + InvestigateWidgetCreate, + WorkflowBlock, +} from './types'; + +export { InvestigateWidgetColumnSpan } from './types'; diff --git a/x-pack/plugins/observability_solution/investigate/common/types.ts b/x-pack/plugins/observability_solution/investigate/common/types.ts new file mode 100644 index 0000000000000..0f593a9a6cde9 --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/common/types.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { EuiThemeComputed } from '@elastic/eui'; +import type { Filter } from '@kbn/es-query'; +import type { DeepPartial, PickByValue } from 'utility-types'; + +export interface InvestigateUser { + name: string; +} + +export interface GlobalWidgetParameters { + timeRange: { + from: string; + to: string; + }; + query: { + query: string; + language: 'kuery'; + }; + filters: Filter[]; +} + +export enum InvestigateWidgetColumnSpan { + One = 1, + Two = 2, + Three = 3, + Four = 4, +} + +export interface InvestigateTimeline { + id: string; + title: string; + '@timestamp': number; + user: InvestigateUser; + items: InvestigateWidget[]; +} + +export interface InvestigateWidget< + TParameters extends Record = {}, + TData extends Record = {} +> { + id: string; + created: number; + last_updated: number; + type: string; + user: InvestigateUser; + parameters: GlobalWidgetParameters & TParameters; + data: TData; + title: string; + description?: string; + columns: InvestigateWidgetColumnSpan; + rows: number; + locked: boolean; +} + +export type InvestigateWidgetCreate = {}> = Pick< + InvestigateWidget, + 'title' | 'description' | 'columns' | 'rows' | 'type' | 'locked' +> & { + parameters: DeepPartial & TParameters; +}; + +export interface WorkflowBlock { + id: string; + content?: string; + description?: string; + loading: boolean; + onClick?: () => void; + color?: keyof PickByValue['colors'], string>; + children?: React.ReactNode; +} diff --git a/x-pack/plugins/observability_solution/investigate/jest.config.js b/x-pack/plugins/observability_solution/investigate/jest.config.js new file mode 100644 index 0000000000000..bba3a2285005e --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/jest.config.js @@ -0,0 +1,23 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: [ + '/x-pack/plugins/observability_solution/investigate/public', + '/x-pack/plugins/observability_solution/investigate/common', + '/x-pack/plugins/observability_solution/investigate/server', + ], + setupFiles: [], + collectCoverage: true, + collectCoverageFrom: [ + '/x-pack/plugins/observability_solution/investigate/{common,public,server}/**/*.{js,ts,tsx}', + ], + + coverageReporters: ['html'], +}; diff --git a/x-pack/plugins/observability_solution/investigate/kibana.jsonc b/x-pack/plugins/observability_solution/investigate/kibana.jsonc new file mode 100644 index 0000000000000..ff0d3a58670d8 --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/kibana.jsonc @@ -0,0 +1,18 @@ +{ + "type": "plugin", + "id": "@kbn/investigate-plugin", + "owner": "@elastic/obs-ai-assistant", + "plugin": { + "id": "investigate", + "server": true, + "browser": true, + "configPath": ["xpack", "investigate"], + "requiredPlugins": [ + "observabilityAIAssistant" + ], + "requiredBundles": [ + ], + "optionalPlugins": [], + "extraPublicDirs": [] + } +} diff --git a/x-pack/plugins/observability_solution/investigate/public/create_widget.ts b/x-pack/plugins/observability_solution/investigate/public/create_widget.ts new file mode 100644 index 0000000000000..7528565d06165 --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/public/create_widget.ts @@ -0,0 +1,42 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { DeepPartial } from 'utility-types'; +import { InvestigateWidgetColumnSpan, InvestigateWidgetCreate } from '../common'; +import { GlobalWidgetParameters } from '../common/types'; + +type MakePartial, K extends keyof T> = Omit & + DeepPartial>; + +type PredefinedKeys = 'rows' | 'columns' | 'locked' | 'type'; + +type AllowedDefaultKeys = 'rows' | 'columns'; + +export type WidgetFactory> = < + T extends MakePartial, PredefinedKeys> +>( + widgetCreate: T +) => Pick, PredefinedKeys> & + Omit & { parameters: T['parameters'] & DeepPartial }; + +export function createWidgetFactory>( + type: string, + defaults?: Pick, AllowedDefaultKeys> +): WidgetFactory { + const createWidget: WidgetFactory = (widgetCreate) => { + return { + rows: 12, + columns: InvestigateWidgetColumnSpan.Four, + locked: false, + type, + ...defaults, + ...widgetCreate, + }; + }; + + return createWidget; +} diff --git a/x-pack/plugins/observability_solution/investigate/public/esql_widget/constants.ts b/x-pack/plugins/observability_solution/investigate/public/esql_widget/constants.ts new file mode 100644 index 0000000000000..068d4b49fcf80 --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/public/esql_widget/constants.ts @@ -0,0 +1,8 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export const ESQL_WIDGET_NAME = 'esql'; diff --git a/x-pack/plugins/observability_solution/investigate/public/esql_widget/create_esql_widget.ts b/x-pack/plugins/observability_solution/investigate/public/esql_widget/create_esql_widget.ts new file mode 100644 index 0000000000000..f3226afd14198 --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/public/esql_widget/create_esql_widget.ts @@ -0,0 +1,12 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { createWidgetFactory } from '../create_widget'; +import { ESQL_WIDGET_NAME } from './constants'; +import type { EsqlWidgetParameters } from './types'; + +export const createEsqlWidget = createWidgetFactory(ESQL_WIDGET_NAME); diff --git a/x-pack/plugins/observability_solution/investigate/public/esql_widget/types.ts b/x-pack/plugins/observability_solution/investigate/public/esql_widget/types.ts new file mode 100644 index 0000000000000..53ae2fcd87c82 --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/public/esql_widget/types.ts @@ -0,0 +1,39 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { IconType } from '@elastic/eui'; +import type { Ast } from '@kbn/interpreter'; +import type { InvestigateWidgetCreate } from '../../common'; +import type { GlobalWidgetParameters } from '../../common/types'; + +// copied over from the Lens plugin to prevent dependency hell +type TableChangeType = 'initial' | 'unchanged' | 'reduced' | 'extended' | 'reorder' | 'layers'; + +interface Suggestion { + visualizationId: string; + datasourceState?: V; + datasourceId?: string; + columns: number; + score: number; + title: string; + visualizationState: T; + previewExpression?: Ast | string; + previewIcon: IconType; + hide?: boolean; + // flag to indicate if the visualization is incomplete + incomplete?: boolean; + changeType: TableChangeType; + keptLayerIds: string[]; +} + +export interface EsqlWidgetParameters { + esql: string; + suggestion?: Suggestion; + predefined?: Partial; +} + +export type EsqlWidgetCreate = InvestigateWidgetCreate; diff --git a/x-pack/plugins/observability_solution/investigate/public/index.ts b/x-pack/plugins/observability_solution/investigate/public/index.ts new file mode 100644 index 0000000000000..c43ce3d7b14e5 --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/public/index.ts @@ -0,0 +1,47 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import type { PluginInitializer, PluginInitializerContext } from '@kbn/core/public'; + +import { InvestigatePlugin } from './plugin'; +import type { + InvestigatePublicSetup, + InvestigatePublicStart, + InvestigateSetupDependencies, + InvestigateStartDependencies, + ConfigSchema, + OnWidgetAdd, + WidgetRenderAPI, +} from './types'; + +export type { InvestigatePublicSetup, InvestigatePublicStart, OnWidgetAdd, WidgetRenderAPI }; + +export { + type InvestigateTimeline, + type InvestigateWidget, + type InvestigateWidgetCreate, + InvestigateWidgetColumnSpan, + type GlobalWidgetParameters, + type InvestigateUser, + type WorkflowBlock, +} from '../common/types'; + +export { ChromeOption } from './types'; + +export { createWidgetFactory } from './create_widget'; +export { getEsFilterFromGlobalParameters } from './util/get_es_filters_from_global_parameters'; + +export { ESQL_WIDGET_NAME } from './esql_widget/constants'; +export { createEsqlWidget } from './esql_widget/create_esql_widget'; +export type { EsqlWidgetParameters } from './esql_widget/types'; + +export const plugin: PluginInitializer< + InvestigatePublicSetup, + InvestigatePublicStart, + InvestigateSetupDependencies, + InvestigateStartDependencies +> = (pluginInitializerContext: PluginInitializerContext) => + new InvestigatePlugin(pluginInitializerContext); diff --git a/x-pack/plugins/observability_solution/investigate/public/plugin.tsx b/x-pack/plugins/observability_solution/investigate/public/plugin.tsx new file mode 100644 index 0000000000000..1dd248681edad --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/public/plugin.tsx @@ -0,0 +1,45 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import type { CoreSetup, CoreStart, PluginInitializerContext, Plugin } from '@kbn/core/public'; +import type { Logger } from '@kbn/logging'; +import type { + ConfigSchema, + InvestigatePublicSetup, + InvestigatePublicStart, + InvestigateSetupDependencies, + InvestigateStartDependencies, +} from './types'; +import { WidgetRegistry } from './widget_registry'; + +export class InvestigatePlugin + implements + Plugin< + InvestigatePublicSetup, + InvestigatePublicStart, + InvestigateSetupDependencies, + InvestigateStartDependencies + > +{ + logger: Logger; + + widgetRegistry: WidgetRegistry = new WidgetRegistry(); + + constructor(context: PluginInitializerContext) { + this.logger = context.logger.get(); + } + setup(coreSetup: CoreSetup, pluginsSetup: InvestigateSetupDependencies): InvestigatePublicSetup { + return { + registerWidget: this.widgetRegistry.registerWidget, + }; + } + + start(coreStart: CoreStart, pluginsStart: InvestigateStartDependencies): InvestigatePublicStart { + return { + getWidgetDefinitions: this.widgetRegistry.getWidgetDefinitions, + }; + } +} diff --git a/x-pack/plugins/observability_solution/investigate/public/types.ts b/x-pack/plugins/observability_solution/investigate/public/types.ts new file mode 100644 index 0000000000000..2bdef7bb0cf49 --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/public/types.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +/* eslint-disable @typescript-eslint/no-empty-interface*/ +import type { FromSchema } from 'json-schema-to-ts'; +import type { CompatibleJSONSchema } from '@kbn/observability-ai-assistant-plugin/public'; +import type { InvestigateWidget, WorkflowBlock } from '../common'; +import type { GlobalWidgetParameters, InvestigateWidgetCreate } from '../common/types'; + +export enum ChromeOption { + disabled = 'disabled', + static = 'static', + dynamic = 'dynamic', +} + +export type OnWidgetAdd = (create: InvestigateWidgetCreate) => Promise; + +type UnregisterFunction = () => void; + +export interface WidgetRenderAPI { + onDelete: () => void; + onWidgetAdd: OnWidgetAdd; + blocks: { + publish: (blocks: WorkflowBlock[]) => UnregisterFunction; + }; +} + +type WidgetRenderOptions = { + widget: TInvestigateWidget; +} & WidgetRenderAPI; + +export interface WidgetDefinition { + type: string; + description: string; + schema: CompatibleJSONSchema; + generate: (options: { + parameters: GlobalWidgetParameters; + signal: AbortSignal; + }) => Promise>; + render: (options: WidgetRenderOptions) => React.ReactNode; + chrome?: ChromeOption; +} + +type RegisterWidgetOptions = Omit; + +type MaybeSchemaFrom = + {} & (TSchema extends CompatibleJSONSchema ? FromSchema : {}); + +type GenerateCallback< + TSchema extends CompatibleJSONSchema | undefined, + TData extends Record | undefined +> = (options: { + parameters: MaybeSchemaFrom & GlobalWidgetParameters; + signal: AbortSignal; +}) => Promise; + +export type RegisterWidget = < + TSchema extends CompatibleJSONSchema, + TData extends Record +>( + definition: Omit & { schema: TSchema }, + generateCallback: GenerateCallback, + renderCallback: ( + options: WidgetRenderOptions, TData>> + ) => React.ReactNode +) => void; + +export interface ConfigSchema {} + +export interface InvestigateSetupDependencies {} + +export interface InvestigateStartDependencies {} + +export interface InvestigatePublicSetup { + registerWidget: RegisterWidget; +} + +export interface InvestigatePublicStart { + getWidgetDefinitions: () => WidgetDefinition[]; +} diff --git a/x-pack/plugins/observability_solution/investigate/public/util/get_es_filters_from_global_parameters.ts b/x-pack/plugins/observability_solution/investigate/public/util/get_es_filters_from_global_parameters.ts new file mode 100644 index 0000000000000..19ad31a025769 --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/public/util/get_es_filters_from_global_parameters.ts @@ -0,0 +1,30 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { type BoolQuery, buildEsQuery } from '@kbn/es-query'; +import type { GlobalWidgetParameters } from '../../common/types'; + +export function getEsFilterFromGlobalParameters({ + query, + filters, + timeRange, +}: Partial): { bool: BoolQuery } { + const esFilter = buildEsQuery(undefined, query ?? [], filters ?? []); + + if (timeRange) { + esFilter.bool.filter.push({ + range: { + '@timestamp': { + gte: timeRange.from, + lte: timeRange.to, + }, + }, + }); + } + + return esFilter; +} diff --git a/x-pack/plugins/observability_solution/investigate/public/widget_registry.ts b/x-pack/plugins/observability_solution/investigate/public/widget_registry.ts new file mode 100644 index 0000000000000..f76adf5a72506 --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/public/widget_registry.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { RegisterWidget, WidgetDefinition } from './types'; + +export class WidgetRegistry { + private readonly definitions: WidgetDefinition[] = []; + + constructor() {} + + registerWidget: RegisterWidget = (definition, generateCallback, renderCallback) => { + this.definitions.push({ + ...definition, + generate: generateCallback as WidgetDefinition['generate'], + render: renderCallback as WidgetDefinition['render'], + }); + }; + + getWidgetDefinitions = (): WidgetDefinition[] => { + return this.definitions; + }; +} diff --git a/x-pack/plugins/observability_solution/investigate/server/config.ts b/x-pack/plugins/observability_solution/investigate/server/config.ts new file mode 100644 index 0000000000000..081a30150dbea --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/server/config.ts @@ -0,0 +1,14 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { schema, type TypeOf } from '@kbn/config-schema'; + +export const config = schema.object({ + enabled: schema.boolean({ defaultValue: true }), +}); + +export type InvestigateConfig = TypeOf; diff --git a/x-pack/plugins/observability_solution/investigate/server/index.ts b/x-pack/plugins/observability_solution/investigate/server/index.ts new file mode 100644 index 0000000000000..a6773966b9a97 --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/server/index.ts @@ -0,0 +1,36 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import type { + PluginInitializer, + PluginInitializerContext, + PluginConfigDescriptor, +} from '@kbn/core/server'; +import { InvestigateConfig } from './config'; + +import { InvestigatePlugin } from './plugin'; +import type { + InvestigateServerSetup, + InvestigateServerStart, + InvestigateSetupDependencies, + InvestigateStartDependencies, +} from './types'; + +import { config as configSchema } from './config'; + +export type { InvestigateServerSetup, InvestigateServerStart }; + +export const config: PluginConfigDescriptor = { + schema: configSchema, +}; + +export const plugin: PluginInitializer< + InvestigateServerSetup, + InvestigateServerStart, + InvestigateSetupDependencies, + InvestigateStartDependencies +> = async (pluginInitializerContext: PluginInitializerContext) => + await new InvestigatePlugin(pluginInitializerContext); diff --git a/x-pack/plugins/observability_solution/investigate/server/plugin.ts b/x-pack/plugins/observability_solution/investigate/server/plugin.ts new file mode 100644 index 0000000000000..baa1303302d46 --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/server/plugin.ts @@ -0,0 +1,39 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { CoreSetup, CoreStart, Plugin, PluginInitializerContext } from '@kbn/core/server'; +import type { Logger } from '@kbn/logging'; +import type { InvestigateConfig } from './config'; +import type { + InvestigateServerSetup, + InvestigateServerStart, + InvestigateSetupDependencies, + InvestigateStartDependencies, +} from './types'; + +export class InvestigatePlugin + implements + Plugin< + InvestigateServerSetup, + InvestigateServerStart, + InvestigateSetupDependencies, + InvestigateStartDependencies + > +{ + logger: Logger; + + constructor(context: PluginInitializerContext) { + this.logger = context.logger.get(); + } + setup(coreSetup: CoreSetup, pluginsSetup: InvestigateSetupDependencies): InvestigateServerSetup { + return {}; + } + + start(coreStart: CoreStart, pluginsStart: InvestigateStartDependencies): InvestigateServerStart { + return {}; + } +} diff --git a/x-pack/plugins/observability_solution/investigate/server/types.ts b/x-pack/plugins/observability_solution/investigate/server/types.ts new file mode 100644 index 0000000000000..1bb0d2a01f32b --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/server/types.ts @@ -0,0 +1,16 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +/* eslint-disable @typescript-eslint/no-empty-interface*/ + +export interface InvestigateSetupDependencies {} + +export interface InvestigateStartDependencies {} + +export interface InvestigateServerSetup {} + +export interface InvestigateServerStart {} diff --git a/x-pack/plugins/observability_solution/investigate/tsconfig.json b/x-pack/plugins/observability_solution/investigate/tsconfig.json new file mode 100644 index 0000000000000..042aa7d32a1a9 --- /dev/null +++ b/x-pack/plugins/observability_solution/investigate/tsconfig.json @@ -0,0 +1,23 @@ +{ + "extends": "../../../../tsconfig.base.json", + "compilerOptions": { + "outDir": "target/types" + }, + "include": [ + "../../../typings/**/*", + "common/**/*", + "public/**/*", + "typings/**/*", + "public/**/*.json", + "server/**/*" + ], + "kbn_references": [ + "@kbn/core", + "@kbn/logging", + "@kbn/config-schema", + "@kbn/observability-ai-assistant-plugin", + "@kbn/es-query", + "@kbn/interpreter", + ], + "exclude": ["target/**/*"] +} diff --git a/x-pack/plugins/observability_solution/logs_explorer/public/customizations/custom_control_column.tsx b/x-pack/plugins/observability_solution/logs_explorer/public/customizations/custom_control_column.tsx index 9bb71a3055a68..43edee4cf73af 100644 --- a/x-pack/plugins/observability_solution/logs_explorer/public/customizations/custom_control_column.tsx +++ b/x-pack/plugins/observability_solution/logs_explorer/public/customizations/custom_control_column.tsx @@ -141,7 +141,6 @@ export const createCustomControlColumnsConfiguration = }; return { - leadingControlColumns: [checkBoxColumn], - trailingControlColumns: [actionsColumn], + leadingControlColumns: [checkBoxColumn, actionsColumn], }; }; diff --git a/x-pack/plugins/observability_solution/logs_shared/public/components/logging/log_entry_flyout/log_entry_flyout.tsx b/x-pack/plugins/observability_solution/logs_shared/public/components/logging/log_entry_flyout/log_entry_flyout.tsx index 52bda2fbda367..32ddf912bf740 100644 --- a/x-pack/plugins/observability_solution/logs_shared/public/components/logging/log_entry_flyout/log_entry_flyout.tsx +++ b/x-pack/plugins/observability_solution/logs_shared/public/components/logging/log_entry_flyout/log_entry_flyout.tsx @@ -209,6 +209,9 @@ export const LogEntryFlyout = ({ ); }; +// eslint-disable-next-line import/no-default-export +export default LogEntryFlyout; + const loadingProgressMessage = i18n.translate('xpack.logsShared.logFlyout.loadingMessage', { defaultMessage: 'Searching log entry in shards', }); diff --git a/x-pack/plugins/observability_solution/logs_shared/public/containers/logs/log_summary/with_summary.ts b/x-pack/plugins/observability_solution/logs_shared/public/containers/logs/log_summary/with_summary.ts index 5d18926cca294..bb8fe69d4356e 100644 --- a/x-pack/plugins/observability_solution/logs_shared/public/containers/logs/log_summary/with_summary.ts +++ b/x-pack/plugins/observability_solution/logs_shared/public/containers/logs/log_summary/with_summary.ts @@ -38,3 +38,6 @@ export const WithSummary = ({ serializedParsedQuery, children }: WithSummaryProp return children({ buckets, start, end }); }; + +// eslint-disable-next-line import/no-default-export +export default WithSummary; diff --git a/x-pack/plugins/observability_solution/logs_shared/public/index.ts b/x-pack/plugins/observability_solution/logs_shared/public/index.ts index 63b8a7d69834f..80b8dd3638924 100644 --- a/x-pack/plugins/observability_solution/logs_shared/public/index.ts +++ b/x-pack/plugins/observability_solution/logs_shared/public/index.ts @@ -33,8 +33,6 @@ export { useLogHighlightsStateContext, } from './containers/logs/log_highlights'; export type { LogSummaryBuckets, WithSummaryProps } from './containers/logs/log_summary'; -export { useLogSummary, WithSummary } from './containers/logs/log_summary'; -export { useLogEntryFlyout } from './components/logging/log_entry_flyout'; // Shared components export type { LogAIAssistantDocument } from './components/log_ai_assistant/log_ai_assistant'; @@ -46,10 +44,13 @@ export { iconColumnId, useColumnWidths, } from './components/logging/log_text_stream/log_entry_column'; -export { LogEntryFlyout } from './components/logging/log_entry_flyout'; export type { LogAIAssistantProps } from './components/log_ai_assistant/log_ai_assistant'; export type { LogStreamProps } from './components/log_stream/log_stream'; +export const WithSummary = dynamic(() => import('./containers/logs/log_summary/with_summary')); +export const LogEntryFlyout = dynamic( + () => import('./components/logging/log_entry_flyout/log_entry_flyout') +); export const LogAIAssistant = dynamic( () => import('./components/log_ai_assistant/log_ai_assistant') ); diff --git a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/utils.ts b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/utils.ts index 2a7a69f591e8c..88f1febca71c0 100644 --- a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/utils.ts +++ b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/utils.ts @@ -130,7 +130,7 @@ export const doFieldsExist = async ( // Get all supported fields const respMapping = await esClient.fieldCaps({ index, - fields: '*', + fields, }); const fieldsExisted: Record = {}; diff --git a/x-pack/plugins/observability_solution/observability/server/plugin.ts b/x-pack/plugins/observability_solution/observability/server/plugin.ts index fad3db3f5fd10..dad2dd7ee572a 100644 --- a/x-pack/plugins/observability_solution/observability/server/plugin.ts +++ b/x-pack/plugins/observability_solution/observability/server/plugin.ts @@ -36,6 +36,7 @@ import { RuleRegistryPluginSetupContract } from '@kbn/rule-registry-plugin/serve import { SharePluginSetup } from '@kbn/share-plugin/server'; import { SpacesPluginSetup, SpacesPluginStart } from '@kbn/spaces-plugin/server'; import { UsageCollectionSetup } from '@kbn/usage-collection-plugin/server'; +import { DataViewsServerPluginStart } from '@kbn/data-views-plugin/server'; import { ObservabilityConfig } from '.'; import { casesFeatureId, observabilityFeatureId } from '../common'; import { @@ -71,6 +72,7 @@ interface PluginSetup { interface PluginStart { alerting: PluginStartContract; spaces?: SpacesPluginStart; + dataViews: DataViewsServerPluginStart; } const o11yRuleTypes = [ @@ -294,6 +296,7 @@ export class ObservabilityPlugin implements Plugin { ...plugins, core, }, + dataViews: pluginStart.dataViews, spaces: pluginStart.spaces, ruleDataService, assistant: { diff --git a/x-pack/plugins/observability_solution/observability/server/routes/register_routes.ts b/x-pack/plugins/observability_solution/observability/server/routes/register_routes.ts index 373e91d89a1c3..f0f41a70bec81 100644 --- a/x-pack/plugins/observability_solution/observability/server/routes/register_routes.ts +++ b/x-pack/plugins/observability_solution/observability/server/routes/register_routes.ts @@ -17,6 +17,7 @@ import { import { SpacesPluginStart } from '@kbn/spaces-plugin/server'; import axios from 'axios'; import * as t from 'io-ts'; +import { DataViewsServerPluginStart } from '@kbn/data-views-plugin/server'; import { ObservabilityConfig } from '..'; import { getHTTPResponseCode, ObservabilityError } from '../errors'; import { AlertDetailsContextualInsightsService } from '../services'; @@ -35,6 +36,7 @@ export interface RegisterRoutesDependencies { pluginsSetup: { core: CoreSetup; }; + dataViews: DataViewsServerPluginStart; spaces?: SpacesPluginStart; ruleDataService: RuleDataPluginService; assistant: { diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/public/index.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/public/index.ts index 4648fe10cf5a8..7f0c1f8bb4c09 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant/public/index.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant/public/index.ts @@ -5,6 +5,7 @@ * 2.0. */ import type { PluginInitializer, PluginInitializerContext } from '@kbn/core/public'; +export type { CompatibleJSONSchema } from '../common/functions/types'; import { ObservabilityAIAssistantPlugin } from './plugin'; import type { diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/public/service/create_service.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/public/service/create_service.ts index 9e0adc5a94d8f..7232078d2efe8 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant/public/service/create_service.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant/public/service/create_service.ts @@ -72,10 +72,6 @@ export function createService({ return of( createFunctionRequestMessage({ name: 'context', - args: { - queries: [], - categories: [], - }, }), createFunctionResponseMessage({ name: 'context', diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/server/functions/context.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/server/functions/context.ts index 4bc32a2330acd..baf006844c516 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant/server/functions/context.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant/server/functions/context.ts @@ -40,34 +40,10 @@ export function registerContextFunction({ description: 'This function provides context as to what the user is looking at on their screen, and recalled documents from the knowledge base that matches their query', visibility: FunctionVisibility.Internal, - parameters: { - type: 'object', - properties: { - queries: { - type: 'array', - description: 'The query for the semantic search', - items: { - type: 'string', - }, - }, - categories: { - type: 'array', - description: - 'Categories of internal documentation that you want to search for. By default internal documentation will be excluded. Use `apm` to get internal APM documentation, `lens` to get internal Lens documentation, or both.', - items: { - type: 'string', - enum: ['apm', 'lens'], - }, - }, - }, - required: ['queries', 'categories'], - } as const, }, - async ({ arguments: args, messages, screenContexts, chat }, signal) => { + async ({ messages, screenContexts, chat }, signal) => { const { analytics } = (await resources.context.core).coreStart; - const { queries, categories } = args; - async function getContext() { const screenDescription = compact( screenContexts.map((context) => context.screenDescription) @@ -94,30 +70,21 @@ export function registerContextFunction({ messages.filter((message) => message.message.role === MessageRole.User) ); - const nonEmptyQueries = compact(queries); - - const queriesOrUserPrompt = nonEmptyQueries.length - ? nonEmptyQueries - : compact([userMessage?.message.content]); - - queriesOrUserPrompt.push(screenDescription); - - const suggestions = await retrieveSuggestions({ - client, - categories, - queries: queriesOrUserPrompt, - }); + const userPrompt = userMessage?.message.content; + const queries = [{ text: userPrompt, boost: 3 }, { text: screenDescription }].filter( + ({ text }) => text + ) as Array<{ text: string; boost?: number }>; + const suggestions = await retrieveSuggestions({ client, queries }); if (suggestions.length === 0) { - return { - content, - }; + return { content }; } try { const { relevantDocuments, scores } = await scoreSuggestions({ suggestions, - queries: queriesOrUserPrompt, + screenDescription, + userPrompt, messages, chat, signal, @@ -125,7 +92,7 @@ export function registerContextFunction({ }); analytics.reportEvent(RecallRankingEventType, { - prompt: queriesOrUserPrompt.join('|'), + prompt: queries.map((query) => query.text).join('|'), scoredDocuments: suggestions.map((suggestion) => { const llmScore = scores.find((score) => score.id === suggestion.id); return { @@ -178,15 +145,12 @@ export function registerContextFunction({ async function retrieveSuggestions({ queries, client, - categories, }: { - queries: string[]; + queries: Array<{ text: string; boost?: number }>; client: ObservabilityAIAssistantClient; - categories: Array<'apm' | 'lens'>; }) { const recallResponse = await client.recall({ queries, - categories, }); return recallResponse.entries.map((entry) => omit(entry, 'labels', 'is_correction')); @@ -208,14 +172,16 @@ const scoreFunctionArgumentsRt = t.type({ async function scoreSuggestions({ suggestions, messages, - queries, + userPrompt, + screenDescription, chat, signal, logger, }: { suggestions: Awaited>; messages: Message[]; - queries: string[]; + userPrompt: string | undefined; + screenDescription: string; chat: FunctionCallChatFunction; signal: AbortSignal; logger: Logger; @@ -237,7 +203,10 @@ async function scoreSuggestions({ - The document contains new information not mentioned before in the conversation Question: - ${queries.join('\n')} + ${userPrompt} + + Screen description: + ${screenDescription} Documents: ${JSON.stringify(indexedSuggestions, null, 2)}`); diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/server/routes/functions/route.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/server/routes/functions/route.ts index 58c93737b6617..52be33c2a372d 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant/server/routes/functions/route.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant/server/routes/functions/route.ts @@ -33,7 +33,7 @@ const getFunctionsRoute = createObservabilityAIAssistantServerRoute({ const client = await service.getClient({ request }); - const [functionClient, knowledgeBaseInstructions] = await Promise.all([ + const [functionClient, userInstructions] = await Promise.all([ service.getFunctionClient({ signal: controller.signal, resources, @@ -41,7 +41,7 @@ const getFunctionsRoute = createObservabilityAIAssistantServerRoute({ screenContexts: [], }), // error is caught in client - client.fetchKnowledgeBaseInstructions(), + client.fetchUserInstructions(), ]); const functionDefinitions = functionClient.getFunctions().map((fn) => fn.definition); @@ -52,7 +52,7 @@ const getFunctionsRoute = createObservabilityAIAssistantServerRoute({ functionDefinitions: functionClient.getFunctions().map((fn) => fn.definition), systemMessage: getSystemMessageFromInstructions({ registeredInstructions: functionClient.getInstructions(), - knowledgeBaseInstructions, + userInstructions, requestInstructions: [], availableFunctionNames, }), @@ -65,7 +65,16 @@ const functionRecallRoute = createObservabilityAIAssistantServerRoute({ params: t.type({ body: t.intersection([ t.type({ - queries: t.array(nonEmptyStringRt), + queries: t.array( + t.intersection([ + t.type({ + text: t.string, + }), + t.partial({ + boost: t.number, + }), + ]) + ), }), t.partial({ categories: t.array(t.string), diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/get_context_function_request_if_needed.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/get_context_function_request_if_needed.ts index 74cc19d8aa153..e5ea0ad0ff829 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/get_context_function_request_if_needed.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/get_context_function_request_if_needed.ts @@ -28,9 +28,5 @@ export function getContextFunctionRequestIfNeeded( return createFunctionRequestMessage({ name: CONTEXT_FUNCTION_NAME, - args: { - queries: [], - categories: [], - }, }); } diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/index.test.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/index.test.ts index 829f0097875f8..0349d597b7ba0 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/index.test.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/index.test.ts @@ -112,7 +112,7 @@ describe('Observability AI Assistant client', () => { const knowledgeBaseServiceMock: DeeplyMockedKeys = { recall: jest.fn(), - getInstructions: jest.fn(), + getUserInstructions: jest.fn(), } as any; let loggerMock: DeeplyMockedKeys = {} as any; @@ -171,7 +171,7 @@ describe('Observability AI Assistant client', () => { fields: [], } as any); - knowledgeBaseServiceMock.getInstructions.mockResolvedValue([]); + knowledgeBaseServiceMock.getUserInstructions.mockResolvedValue([]); functionClientMock.getInstructions.mockReturnValue(['system']); @@ -1232,7 +1232,6 @@ describe('Observability AI Assistant client', () => { role: MessageRole.Assistant, function_call: { name: CONTEXT_FUNCTION_NAME, - arguments: JSON.stringify({ queries: [], categories: [] }), trigger: MessageRole.Assistant, }, }, @@ -1456,7 +1455,6 @@ describe('Observability AI Assistant client', () => { role: MessageRole.Assistant, function_call: { name: CONTEXT_FUNCTION_NAME, - arguments: JSON.stringify({ queries: [], categories: [] }), trigger: MessageRole.Assistant, }, }, diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/index.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/index.ts index 6af7ee9aa36ee..9739a59125011 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/index.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/index.ts @@ -211,17 +211,17 @@ export class ObservabilityAIAssistantClient { ); } - const kbInstructions$ = from(this.fetchKnowledgeBaseInstructions()).pipe(shareReplay()); + const userInstructions$ = from(this.fetchUserInstructions()).pipe(shareReplay()); // from the initial messages, override any system message with // the one that is based on the instructions (registered, request, kb) - const messagesWithUpdatedSystemMessage$ = kbInstructions$.pipe( - map((knowledgeBaseInstructions) => { + const messagesWithUpdatedSystemMessage$ = userInstructions$.pipe( + map((userInstructions) => { // this is what we eventually store in the conversation const messagesWithUpdatedSystemMessage = replaceSystemMessage( getSystemMessageFromInstructions({ registeredInstructions: functionClient.getInstructions(), - knowledgeBaseInstructions, + userInstructions, requestInstructions, availableFunctionNames: functionClient .getFunctions() @@ -268,9 +268,9 @@ export class ObservabilityAIAssistantClient { // messages and the knowledge base instructions const nextEvents$ = combineLatest([ messagesWithUpdatedSystemMessage$, - kbInstructions$, + userInstructions$, ]).pipe( - switchMap(([messagesWithUpdatedSystemMessage, knowledgeBaseInstructions]) => { + switchMap(([messagesWithUpdatedSystemMessage, userInstructions]) => { // if needed, inject a context function request here const contextRequest = functionClient.hasFunction(CONTEXT_FUNCTION_NAME) ? getContextFunctionRequestIfNeeded(messagesWithUpdatedSystemMessage) @@ -298,7 +298,7 @@ export class ObservabilityAIAssistantClient { // start out with the max number of function calls functionCallsLeft: MAX_FUNCTION_CALLS, functionClient, - knowledgeBaseInstructions, + userInstructions, requestInstructions, signal, logger: this.dependencies.logger, @@ -694,7 +694,7 @@ export class ObservabilityAIAssistantClient { queries, categories, }: { - queries: string[]; + queries: Array<{ text: string; boost?: number }>; categories?: string[]; }): Promise<{ entries: RecalledEntry[] }> => { return this.dependencies.knowledgeBaseService.recall({ @@ -756,12 +756,10 @@ export class ObservabilityAIAssistantClient { return this.dependencies.knowledgeBaseService.deleteEntry({ id }); }; - fetchKnowledgeBaseInstructions = async () => { - const knowledgeBaseInstructions = await this.dependencies.knowledgeBaseService.getInstructions( + fetchUserInstructions = async () => { + return this.dependencies.knowledgeBaseService.getUserInstructions( this.dependencies.namespace, this.dependencies.user ); - - return knowledgeBaseInstructions; }; } diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/instrumentation/init_langtrace.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/instrumentation/init_langtrace.ts index 77f39c470f43b..9a198cdc902a4 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/instrumentation/init_langtrace.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/instrumentation/init_langtrace.ts @@ -5,19 +5,19 @@ * 2.0. */ -import { init } from '@langtrase/typescript-sdk'; +// import { init } from '@langtrase/typescript-sdk'; export function initLangtrace() { const apiKey = process.env.LANGTRACE_API_KEY; const apiHost = process.env.LANGTRACE_API_HOST; if (apiKey && apiHost) { - init({ - api_host: apiHost, - api_key: apiKey, - write_to_langtrace_cloud: true, - disable_instrumentations: { - only: [], - }, - }); + // init({ + // api_host: apiHost, + // api_key: apiKey, + // write_to_langtrace_cloud: true, + // disable_instrumentations: { + // only: [], + // }, + // }); } } diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/operators/continue_conversation.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/operators/continue_conversation.ts index b7b134afc955c..2ab26cb4799ae 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/operators/continue_conversation.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/client/operators/continue_conversation.ts @@ -164,7 +164,7 @@ export function continueConversation({ signal, functionCallsLeft, requestInstructions, - knowledgeBaseInstructions, + userInstructions, logger, disableFunctions, tracer, @@ -175,7 +175,7 @@ export function continueConversation({ signal: AbortSignal; functionCallsLeft: number; requestInstructions: Array; - knowledgeBaseInstructions: UserInstruction[]; + userInstructions: UserInstruction[]; logger: Logger; disableFunctions: boolean; tracer: LangTracer; @@ -193,7 +193,7 @@ export function continueConversation({ const messagesWithUpdatedSystemMessage = replaceSystemMessage( getSystemMessageFromInstructions({ registeredInstructions: functionClient.getInstructions(), - knowledgeBaseInstructions, + userInstructions, requestInstructions, availableFunctionNames: definitions.map((def) => def.name), }), @@ -314,7 +314,7 @@ export function continueConversation({ functionCallsLeft: nextFunctionCallsLeft, functionClient, signal, - knowledgeBaseInstructions, + userInstructions, requestInstructions, logger, disableFunctions, diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/knowledge_base_service/index.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/knowledge_base_service/index.ts index 1f9ad5bc936f8..7c504aa43c38c 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/knowledge_base_service/index.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/knowledge_base_service/index.ts @@ -303,7 +303,7 @@ export class KnowledgeBaseService { user, modelId, }: { - queries: string[]; + queries: Array<{ text: string; boost?: number }>; categories?: string[]; namespace: string; user?: { name: string }; @@ -311,11 +311,12 @@ export class KnowledgeBaseService { }): Promise { const query = { bool: { - should: queries.map((text) => ({ + should: queries.map(({ text, boost = 1 }) => ({ text_expansion: { 'ml.tokens': { model_text: text, model_id: modelId, + boost, }, }, })), @@ -385,7 +386,7 @@ export class KnowledgeBaseService { uiSettingsClient, modelId, }: { - queries: string[]; + queries: Array<{ text: string; boost?: number }>; asCurrentUser: ElasticsearchClient; uiSettingsClient: IUiSettingsClient; modelId: string; @@ -414,15 +415,16 @@ export class KnowledgeBaseService { const vectorField = `${ML_INFERENCE_PREFIX}${field}_expanded.predicted_value`; const modelField = `${ML_INFERENCE_PREFIX}${field}_expanded.model_id`; - return queries.map((query) => { + return queries.map(({ text, boost = 1 }) => { return { bool: { should: [ { text_expansion: { [vectorField]: { - model_text: query, + model_text: text, model_id: modelId, + boost, }, }, }, @@ -470,7 +472,7 @@ export class KnowledgeBaseService { asCurrentUser, uiSettingsClient, }: { - queries: string[]; + queries: Array<{ text: string; boost?: number }>; categories?: string[]; user?: { name: string }; namespace: string; @@ -537,7 +539,7 @@ export class KnowledgeBaseService { }; }; - getInstructions = async ( + getUserInstructions = async ( namespace: string, user?: { name: string } ): Promise => { diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/util/get_system_message_from_instructions.test.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/util/get_system_message_from_instructions.test.ts index 9706871a63c62..99a2c34bc33d7 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/util/get_system_message_from_instructions.test.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/util/get_system_message_from_instructions.test.ts @@ -11,7 +11,7 @@ describe('getSystemMessageFromInstructions', () => { expect( getSystemMessageFromInstructions({ registeredInstructions: ['first', 'second'], - knowledgeBaseInstructions: [], + userInstructions: [], requestInstructions: [], availableFunctionNames: [], }) @@ -27,7 +27,7 @@ describe('getSystemMessageFromInstructions', () => { return availableFunctionNames[0]; }, ], - knowledgeBaseInstructions: [], + userInstructions: [], requestInstructions: [], availableFunctionNames: ['myFunction'], }) @@ -38,7 +38,7 @@ describe('getSystemMessageFromInstructions', () => { expect( getSystemMessageFromInstructions({ registeredInstructions: ['first'], - knowledgeBaseInstructions: [{ doc_id: 'second', text: 'second_kb' }], + userInstructions: [{ doc_id: 'second', text: 'second_kb' }], requestInstructions: [{ doc_id: 'second', text: 'second_request' }], availableFunctionNames: [], }) @@ -51,7 +51,7 @@ describe('getSystemMessageFromInstructions', () => { expect( getSystemMessageFromInstructions({ registeredInstructions: ['first'], - knowledgeBaseInstructions: [{ doc_id: 'second', text: 'second_kb' }], + userInstructions: [{ doc_id: 'second', text: 'second_kb' }], requestInstructions: [], availableFunctionNames: [], }) @@ -69,7 +69,7 @@ describe('getSystemMessageFromInstructions', () => { return undefined; }, ], - knowledgeBaseInstructions: [], + userInstructions: [], requestInstructions: [], availableFunctionNames: [], }) diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/util/get_system_message_from_instructions.ts b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/util/get_system_message_from_instructions.ts index 4ea5aaecb67f9..ece79b9f78485 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/util/get_system_message_from_instructions.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant/server/service/util/get_system_message_from_instructions.ts @@ -13,12 +13,12 @@ import { RegisteredInstruction } from '../types'; export function getSystemMessageFromInstructions({ registeredInstructions, - knowledgeBaseInstructions, + userInstructions, requestInstructions, availableFunctionNames, }: { registeredInstructions: RegisteredInstruction[]; - knowledgeBaseInstructions: UserInstruction[]; + userInstructions: UserInstruction[]; requestInstructions: Array; availableFunctionNames: string[]; }): string { @@ -39,9 +39,7 @@ export function getSystemMessageFromInstructions({ // all request instructions, and those from the KB that are not defined as a request instruction const allUserInstructions = requestInstructionsWithId.concat( - knowledgeBaseInstructions.filter( - (instruction) => !requestOverrideIds.includes(instruction.doc_id) - ) + userInstructions.filter((instruction) => !requestOverrideIds.includes(instruction.doc_id)) ); const instructionsWithinBudget = withTokenBudget(allUserInstructions, 1000); diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/common/functions/visualize_esql.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/common/functions/visualize_esql.ts index 28e63384f8834..8855e067487ab 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/common/functions/visualize_esql.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/common/functions/visualize_esql.ts @@ -7,6 +7,8 @@ import type { FromSchema } from 'json-schema-to-ts'; import { FunctionVisibility } from '@kbn/observability-ai-assistant-plugin/common'; import { VISUALIZE_ESQL_USER_INTENTIONS } from '@kbn/observability-ai-assistant-plugin/common/functions/visualize_esql'; +import type { ESQLRow } from '@kbn/es-types'; +import type { DatatableColumn } from '@kbn/expressions-plugin/common'; export const visualizeESQLFunction = { name: 'visualize_query', @@ -29,4 +31,22 @@ export const visualizeESQLFunction = { contexts: ['core'], }; +export interface VisualizeQueryResponsev0 { + content: DatatableColumn[]; +} + +export interface VisualizeQueryResponsev1 { + data: { + columns: DatatableColumn[]; + rows: ESQLRow[]; + userOverrides?: unknown; + }; + content: { + message: string; + errorMessages: string[]; + }; +} + +export type VisualizeQueryResponse = VisualizeQueryResponsev0 | VisualizeQueryResponsev1; + export type VisualizeESQLFunctionArguments = FromSchema; diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/components/chat/chat_body.test.tsx b/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/components/chat/chat_body.test.tsx index e39bcf5d1891e..65ac65264f307 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/components/chat/chat_body.test.tsx +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/components/chat/chat_body.test.tsx @@ -40,7 +40,7 @@ describe('', () => { role: 'assistant', function_call: { name: CONTEXT_FUNCTION_NAME, - arguments: '{"queries":[],"categories":[]}', + arguments: '{}', trigger: 'assistant', }, content: '', @@ -88,7 +88,7 @@ describe('', () => { role: 'assistant', function_call: { name: CONTEXT_FUNCTION_NAME, - arguments: '{"queries":[],"categories":[]}', + arguments: '{}', trigger: 'assistant', }, content: '', diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/components/nav_control/index.tsx b/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/components/nav_control/index.tsx index 8757b9f8235bf..4bb7f1404117c 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/components/nav_control/index.tsx +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/components/nav_control/index.tsx @@ -56,7 +56,7 @@ export function NavControl({}: {}) { }) : undefined; }, - [service, hasBeenOpened] + [service, hasBeenOpened, notifications.toasts] ); const [isOpen, setIsOpen] = useState(false); diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/functions/lens.tsx b/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/functions/lens.tsx index cd2a522755f65..ec51efb85efce 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/functions/lens.tsx +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/functions/lens.tsx @@ -57,7 +57,7 @@ function Lens({ title: indexPattern, timeFieldName: timeField, }); - }, [indexPattern]); + }, [indexPattern, dataViews, timeField]); const [isSaveModalOpen, setIsSaveModalOpen] = useState(false); diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/functions/visualize_esql.tsx b/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/functions/visualize_esql.tsx index fe850b18f4d5d..97c46a6a2d759 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/functions/visualize_esql.tsx +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/functions/visualize_esql.tsx @@ -42,7 +42,10 @@ import React, { useCallback, useContext, useEffect, useMemo, useState } from 're import ReactDOM from 'react-dom'; import useAsync from 'react-use/lib/useAsync'; import { v4 as uuidv4 } from 'uuid'; -import { VisualizeESQLFunctionArguments } from '../../common/functions/visualize_esql'; +import type { + VisualizeESQLFunctionArguments, + VisualizeQueryResponse, +} from '../../common/functions/visualize_esql'; import { ObservabilityAIAssistantAppPluginStartDependencies } from '../types'; enum ChartType { @@ -58,24 +61,6 @@ enum ChartType { Table = 'Table', } -interface VisualizeQueryResponsev0 { - content: DatatableColumn[]; -} - -interface VisualizeQueryResponsev1 { - data: { - columns: DatatableColumn[]; - rows: ESQLRow[]; - userOverrides?: unknown; - }; - content: { - message: string; - errorMessages: string[]; - }; -} - -type VisualizeQueryResponse = VisualizeQueryResponsev0 | VisualizeQueryResponsev1; - interface VisualizeESQLProps { /** Lens start contract, get the ES|QL charts suggestions api */ lens: LensPublicStart; @@ -105,6 +90,19 @@ interface VisualizeESQLProps { function generateId() { return uuidv4(); } +const saveVisualizationLabel = i18n.translate( + 'xpack.observabilityAiAssistant.lensESQLFunction.save', + { + defaultMessage: 'Save visualization', + } +); + +const editVisualizationLabel = i18n.translate( + 'xpack.observabilityAiAssistant.lensESQLFunction.edit', + { + defaultMessage: 'Edit visualization', + } +); export function VisualizeESQL({ lens, @@ -132,7 +130,8 @@ export function VisualizeESQL({ } return dataView; }); - }, [indexPattern]); + }, [indexPattern, dataViews]); + const chatFlyoutSecondSlotHandler = useContext(ObservabilityAIAssistantMultipaneFlyoutContext); const [isSaveModalOpen, setIsSaveModalOpen] = useState(false); @@ -259,150 +258,135 @@ export function VisualizeESQL({ return ( <> - {!isLensInputTable && ( - - {Boolean(errorMessages?.length) && ( - <> - - {i18n.translate('xpack.observabilityAiAssistant.lensESQLFunction.errorMessage', { - defaultMessage: 'There were some errors in the generated query', - })} - - - {errorMessages?.map((error, index) => { - return ( - - - - - - {error} - - - ); - })} - - - )} - - - - - - setIsTableVisible(!isTableVisible)} - data-test-subj="observabilityAiAssistantLensESQLDisplayTableButton" - aria-label={ + + {!!errorMessages?.length && ( + <> + + {i18n.translate('xpack.observabilityAiAssistant.lensESQLFunction.errorMessage', { + defaultMessage: 'There were some errors in the generated query', + })} + + + {errorMessages.map((error, index) => { + return ( + + + + + + {error} + + + ); + })} + + + )} + {!isLensInputTable && ( + <> + + + + - - - - { - chatFlyoutSecondSlotHandler?.setVisibility?.(true); - if (triggerOptions) { - uiActions.getTrigger('IN_APP_EMBEDDABLE_EDIT_TRIGGER').exec(triggerOptions); + : i18n.translate('xpack.observabilityAiAssistant.lensESQLFunction.table', { + defaultMessage: 'Table of results', + }) } - }} - data-test-subj="observabilityAiAssistantLensESQLEditButton" - aria-label={i18n.translate( - 'xpack.observabilityAiAssistant.lensESQLFunction.edit', - { - defaultMessage: 'Edit visualization', - } - )} - /> - - - + > + setIsTableVisible(!isTableVisible)} + data-test-subj="observabilityAiAssistantLensESQLDisplayTableButton" + aria-label={ + isTableVisible + ? i18n.translate( + 'xpack.observabilityAiAssistant.lensESQLFunction.displayChart', + { + defaultMessage: 'Display chart', + } + ) + : i18n.translate( + 'xpack.observabilityAiAssistant.lensESQLFunction.displayTable', + { + defaultMessage: 'Display table', + } + ) + } + /> + + + setIsSaveModalOpen(true)} - data-test-subj="observabilityAiAssistantLensESQLSaveButton" - aria-label={i18n.translate( - 'xpack.observabilityAiAssistant.lensESQLFunction.save', - { - defaultMessage: 'Save visualization', + iconType="pencil" + onClick={() => { + chatFlyoutSecondSlotHandler?.setVisibility?.(true); + if (triggerOptions) { + uiActions.getTrigger('IN_APP_EMBEDDABLE_EDIT_TRIGGER').exec(triggerOptions); } - )} + }} + data-test-subj="observabilityAiAssistantLensESQLEditButton" + aria-label={editVisualizationLabel} /> - - - - - {isTableVisible ? ( - - ) : ( - - )} + + + setIsSaveModalOpen(true)} + data-test-subj="observabilityAiAssistantLensESQLSaveButton" + aria-label={saveVisualizationLabel} + /> + + + + + + {isTableVisible ? ( + + ) : ( + + )} + + + )} + {/* hide the grid in case of errors (as the user can't fix them) */} + {isLensInputTable && !errorMessages?.length && ( + + - - )} - {isLensInputTable && ( -
    - -
    - )} + )} + + {isSaveModalOpen ? ( { if (!displayedConversationId) { diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/hooks/use_knowledge_base.tsx b/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/hooks/use_knowledge_base.tsx index 0df3ab16c421f..bca9b38485695 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/hooks/use_knowledge_base.tsx +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/public/hooks/use_knowledge_base.tsx @@ -39,11 +39,14 @@ export function useKnowledgeBase(): UseKnowledgeBaseResult { } = useKibana().services; const service = useObservabilityAIAssistantAppService(); - const status = useAbortableAsync(({ signal }) => { - return service.callApi('GET /internal/observability_ai_assistant/kb/status', { - signal, - }); - }, []); + const status = useAbortableAsync( + ({ signal }) => { + return service.callApi('GET /internal/observability_ai_assistant/kb/status', { + signal, + }); + }, + [service] + ); const [isInstalling, setIsInstalling] = useState(false); diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/cli.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/cli.ts index 61504b7ea46d2..23fb67f77bbd7 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/cli.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/cli.ts @@ -13,9 +13,29 @@ export enum EvaluateWith { other = 'other', } -export function options(y: Argv) { - const config = readKibanaConfig(); +const config = readKibanaConfig(); + +export const kibanaOption = { + describe: 'Where Kibana is running', + string: true as const, + default: process.env.KIBANA_HOST || 'http://localhost:5601', +}; +export const elasticsearchOption = { + alias: 'es', + describe: 'Where Elasticsearch is running', + string: true as const, + default: format({ + ...parse(config['elasticsearch.hosts']), + auth: `${config['elasticsearch.username']}:${config['elasticsearch.password']}`, + }), +}; + +export const connectorIdOption = { + describe: 'The ID of the connector', + string: true as const, +}; +export function options(y: Argv) { return y .option('files', { string: true as const, @@ -27,30 +47,15 @@ export function options(y: Argv) { array: false, describe: 'A string or regex to filter scenarios by', }) - .option('kibana', { - describe: 'Where Kibana is running', - string: true, - default: process.env.KIBANA_HOST || 'http://localhost:5601', - }) + .option('kibana', kibanaOption) .option('spaceId', { describe: 'The space to use. If space is set, conversations will only be cleared for that spaceId', string: true, array: false, }) - .option('elasticsearch', { - alias: 'es', - describe: 'Where Elasticsearch is running', - string: true, - default: format({ - ...parse(config['elasticsearch.hosts']), - auth: `${config['elasticsearch.username']}:${config['elasticsearch.password']}`, - }), - }) - .option('connectorId', { - describe: 'The ID of the connector', - string: true, - }) + .option('elasticsearch', elasticsearchOption) + .option('connectorId', connectorIdOption) .option('persist', { describe: 'Whether the conversations should be stored. Adding this will generate a link at which the conversation can be opened.', diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/evaluation.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/evaluation.ts index 4ec8a7714fd96..97a4fe176f30b 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/evaluation.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/evaluation.ts @@ -8,7 +8,6 @@ import { Client } from '@elastic/elasticsearch'; import { run } from '@kbn/dev-cli-runner'; import * as fastGlob from 'fast-glob'; -import inquirer from 'inquirer'; import yargs from 'yargs'; import chalk from 'chalk'; import { castArray, omit } from 'lodash'; @@ -18,7 +17,6 @@ import Path from 'path'; import * as table from 'table'; import { TableUserConfig } from 'table'; import { format, parse } from 'url'; -import { ToolingLog } from '@kbn/tooling-log'; import { MessageRole } from '@kbn/observability-ai-assistant-plugin/common'; import { EvaluateWith, options } from './cli'; import { getServiceUrls } from './get_service_urls'; @@ -26,40 +24,7 @@ import { KibanaClient } from './kibana_client'; import { initServices } from './services'; import { setupSynthtrace } from './setup_synthtrace'; import { EvaluationResult } from './types'; - -async function selectConnector({ - connectors, - preferredId, - log, - message = 'Select a connector', -}: { - connectors: Awaited>; - preferredId?: string; - log: ToolingLog; - message?: string; -}) { - let connector = connectors.find((item) => item.id === preferredId); - - if (!connector && preferredId) { - log.warning(`Could not find connector ${preferredId}`); - } - - if (!connector && connectors.length === 1) { - connector = connectors[0]; - log.debug('Using the only connector found'); - } else if (!connector) { - const connectorChoice = await inquirer.prompt({ - type: 'list', - name: 'connector', - message, - choices: connectors.map((item) => ({ name: `${item.name} (${item.id})`, value: item.id })), - }); - - connector = connectors.find((item) => item.id === connectorChoice.connector)!; - } - - return connector; -} +import { selectConnector } from './select_connector'; function runEvaluations() { yargs(process.argv.slice(2)) diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/get_service_urls.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/get_service_urls.ts index ce909c7a97394..859b47987a470 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/get_service_urls.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/get_service_urls.ts @@ -117,10 +117,6 @@ export async function getServiceUrls({ elasticsearch = 'http://127.0.0.1:9200'; } - if (!elasticsearch) { - throw new Error('Could not determine an Elasticsearch target'); - } - const parsedTarget = parse(elasticsearch); let auth = parsedTarget.auth; diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/kibana_client.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/kibana_client.ts index 4361caf828381..72f90b176bcfc 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/kibana_client.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/kibana_client.ts @@ -48,10 +48,7 @@ import { } from 'rxjs'; import { format, parse, UrlObject } from 'url'; import { inspect } from 'util'; -import type { - ObservabilityAIAssistantAPIClientRequestParamsOf, - APIReturnType, -} from '@kbn/observability-ai-assistant-plugin/public'; +import type { ObservabilityAIAssistantAPIClientRequestParamsOf } from '@kbn/observability-ai-assistant-plugin/public'; import { EvaluationResult } from './types'; // eslint-disable-next-line spaced-comment @@ -193,7 +190,7 @@ export class KibanaClient { connectorId: string; evaluationConnectorId: string; persist: boolean; - suite: Mocha.Suite; + suite?: Mocha.Suite; }): ChatClient { function getMessages(message: string | Array): Array { if (typeof message === 'string') { @@ -209,36 +206,27 @@ export class KibanaClient { const that = this; - async function getFunctions() { - const { - data: { functionDefinitions }, - }: AxiosResponse> = - await that.axios.get( - that.getUrl({ pathname: '/internal/observability_ai_assistant/functions' }) - ); - - return { functionDefinitions }; - } - let currentTitle: string = ''; let firstSuiteName: string = ''; - suite.beforeEach(function () { - const currentTest: Mocha.Test = this.currentTest; - const titles: string[] = []; - titles.push(this.currentTest.title); - let parent = currentTest.parent; - while (parent) { - titles.push(parent.title); - parent = parent.parent; - } - currentTitle = titles.reverse().join(' '); - firstSuiteName = titles.filter((item) => item !== '')[0]; - }); + if (suite) { + suite.beforeEach(function () { + const currentTest: Mocha.Test = this.currentTest; + const titles: string[] = []; + titles.push(this.currentTest.title); + let parent = currentTest.parent; + while (parent) { + titles.push(parent.title); + parent = parent.parent; + } + currentTitle = titles.reverse().join(' '); + firstSuiteName = titles.filter((item) => item !== '')[0]; + }); - suite.afterEach(function () { - currentTitle = ''; - }); + suite.afterEach(function () { + currentTitle = ''; + }); + } const onResultCallbacks: Array<{ callback: (result: EvaluationResult) => void; @@ -278,13 +266,12 @@ export class KibanaClient { { message: error.message, status: error.status, - response: error.response?.data, }, { depth: 10 } ) ); } else { - that.log.error(inspect(error, { depth: 10 })); + that.log.error(inspect(error, { depth: 5 })); } if (error.message.includes('Status code: 429')) { @@ -359,14 +346,13 @@ export class KibanaClient { return { chat: async (message) => { - const { functionDefinitions } = await getFunctions(); const messages = [ ...getMessages(message).map((msg) => ({ message: msg, '@timestamp': new Date().toISOString(), })), ]; - return chat('chat', { messages, functions: functionDefinitions }); + return chat('chat', { messages, functions: [] }); }, complete: async (...args) => { that.log.info(`Complete`); diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/scenarios/esql/index.spec.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/scenarios/esql/index.spec.ts index 6c2296316c333..4aabd3566b994 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/scenarios/esql/index.spec.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/scenarios/esql/index.spec.ts @@ -29,7 +29,7 @@ async function evaluateEsqlQuery({ ...(expected ? [ `Returns a ES|QL query that is functionally equivalent to: - ${expected}`, + ${expected}. It's OK if column names are slightly different, as long as the expected end result is the same.`, ] : []), ...(execute @@ -90,7 +90,7 @@ describe('ES|QL query generation', () => { it('top 10 unique domains', async () => { await evaluateEsqlQuery({ question: - 'For standard Elastic ECS compliant packetbeat data view, shows the top 10 unique destination.domain with more docs', + 'For standard Elastic ECS compliant packetbeat data view, show me the top 10 unique destination.domain with the most docs', expected: `FROM packetbeat-* | STATS doc_count = COUNT(*) BY destination.domain | SORT doc_count DESC diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/select_connector.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/select_connector.ts new file mode 100644 index 0000000000000..f2aecfabdba76 --- /dev/null +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/select_connector.ts @@ -0,0 +1,44 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import inquirer from 'inquirer'; +import { ToolingLog } from '@kbn/tooling-log'; +import { KibanaClient } from './kibana_client'; + +export async function selectConnector({ + connectors, + preferredId, + log, + message = 'Select a connector', +}: { + connectors: Awaited>; + preferredId?: string; + log: ToolingLog; + message?: string; +}) { + let connector = connectors.find((item) => item.id === preferredId); + + if (!connector && preferredId) { + log.warning(`Could not find connector ${preferredId}`); + } + + if (!connector && connectors.length === 1) { + connector = connectors[0]; + log.debug('Using the only connector found'); + } else if (!connector) { + const connectorChoice = await inquirer.prompt({ + type: 'list', + name: 'connector', + message, + choices: connectors.map((item) => ({ name: `${item.name} (${item.id})`, value: item.id })), + }); + + connector = connectors.find((item) => item.id === connectorChoice.connector)!; + } + + return connector; +} diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/load_esql_docs/format_esql_examples.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/load_esql_docs/format_esql_examples.ts deleted file mode 100644 index 4bb578f91f6c1..0000000000000 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/load_esql_docs/format_esql_examples.ts +++ /dev/null @@ -1,19 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -export function formatEsqlExamples(content: string) { - // Regular expression to match the queries - const queryRegex = /(\s*(FROM |ROW |SHOW ).*?)(?=\n[^|\s]|$)/gs; - - // Function to format a matched query - const formatQuery = (match: string) => { - return `\n\`\`\`esql\n${match.trim()}\n\`\`\`\n`; - }; - - // Replace all matches in the input string - return content.replace(queryRegex, formatQuery); -} diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/load_esql_docs/load_esql_docs.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/load_esql_docs/load_esql_docs.ts index 1584afe55063e..b8a90c2b62e46 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/load_esql_docs/load_esql_docs.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/load_esql_docs/load_esql_docs.ts @@ -9,28 +9,78 @@ import $, { load } from 'cheerio'; import { SingleBar } from 'cli-progress'; import FastGlob from 'fast-glob'; import Fs from 'fs/promises'; -import { once, partition } from 'lodash'; +import { once, partition, compact } from 'lodash'; import pLimit from 'p-limit'; import Path from 'path'; import git, { SimpleGitProgressEvent } from 'simple-git'; import yargs, { Argv } from 'yargs'; +import { MessageRole } from '@kbn/observability-ai-assistant-plugin/common'; +import { validateQuery } from '@kbn/esql-validation-autocomplete'; +import { EditorError, ESQLMessage, getAstAndSyntaxErrors } from '@kbn/esql-ast'; +import { connectorIdOption, elasticsearchOption, kibanaOption } from '../evaluation/cli'; +import { getServiceUrls } from '../evaluation/get_service_urls'; +import { KibanaClient } from '../evaluation/kibana_client'; +import { selectConnector } from '../evaluation/select_connector'; import { extractSections } from './extract_sections'; -import { formatEsqlExamples } from './format_esql_examples'; +import { correctCommonEsqlMistakes } from '../../server/functions/query/correct_common_esql_mistakes'; +import { INLINE_ESQL_QUERY_REGEX } from '../../server/functions/query/constants'; yargs(process.argv.slice(2)) .command( '*', 'Extract ES|QL documentation for the Observability AI Assistant', (y: Argv) => - y.option('logLevel', { - describe: 'Log level', - string: true, - default: process.env.LOG_LEVEL || 'info', - choices: ['info', 'debug', 'silent', 'verbose'], - }), + y + .option('logLevel', { + describe: 'Log level', + string: true, + default: process.env.LOG_LEVEL || 'info', + choices: ['info', 'debug', 'silent', 'verbose'], + }) + .option('only', { + describe: 'Only regenerate these files', + string: true, + array: true, + }) + .option('dryRun', { + describe: 'Do not write or delete any files', + boolean: true, + default: false, + }) + .option('kibana', kibanaOption) + .option('elasticsearch', elasticsearchOption) + .option('connectorId', connectorIdOption), (argv) => { run( async ({ log }) => { + const serviceUrls = await getServiceUrls({ + log, + elasticsearch: argv.elasticsearch, + kibana: argv.kibana, + }); + + const kibanaClient = new KibanaClient(log, serviceUrls.kibanaUrl); + + const connectors = await kibanaClient.getConnectors(); + + if (!connectors.length) { + throw new Error('No connectors found'); + } + + const connector = await selectConnector({ + connectors, + preferredId: argv.connectorId, + log, + }); + + const chatClient = kibanaClient.createChatClient({ + connectorId: connector.id, + evaluationConnectorId: connector.id, + persist: false, + }); + + log.info(`Using connector ${connector.id}`); + const builtDocsDir = Path.join(__dirname, '../../../../../../../built-docs'); log.debug(`Looking in ${builtDocsDir} for built-docs repository`); @@ -91,144 +141,187 @@ yargs(process.argv.slice(2)) throw new Error('No files found'); } - const limiter = pLimit(10); + const fsLimiter = pLimit(10); stop(); log.info(`Processing ${files.length} files`); - const documents: Array> = await Promise.all( - files.map((file) => - limiter(async () => { - const fileContents = await Fs.readFile(file); - const $element = load(fileContents.toString())('*'); - - function getSimpleText() { - $element.remove('.navfooter'); - $element.remove('#sticky_content'); - $element.find('code').each(function () { - $(this).replaceWith('`' + $(this).text() + '`'); - }); - return $element - .find('.section,section,.part') - .last() - .text() - .replaceAll(/([\n]\s*){2,}/g, '\n'); - } + async function extractContents( + file: string + ): Promise< + Array<{ title: string; content: string; instructions?: string; skip?: boolean }> + > { + const fileContents = await Fs.readFile(file); + const $element = load(fileContents.toString())('*'); + + function getSimpleText() { + $element.remove('.navfooter'); + $element.remove('#sticky_content'); + $element.find('code').each(function () { + $(this).replaceWith('`' + $(this).text() + '`'); + }); + return $element + .find('.section,section,.part') + .last() + .text() + .replaceAll(/([\n]\s*){2,}/g, '\n'); + } - switch (Path.basename(file)) { - case 'esql-commands.html': - return extractSections($element); - - case 'esql-limitations.html': - return [ - { - title: 'Limitations', - content: getSimpleText(), - }, - ]; - - case 'esql-syntax.html': - return [ - { - title: 'Syntax', - content: getSimpleText(), - }, - ]; - case 'esql.html': - return [ - { - title: 'Overview', - content: getSimpleText().replace( - /The ES\|QL documentation is organized in these sections(.*)$/, - '' - ), - }, - ]; - - case 'esql-cross-clusters.html': - return [ - { - title: 'CROSS_CLUSTER', - content: getSimpleText(), - }, - ]; - - case 'esql-query-api.html': - return [ - { - title: 'API', - content: getSimpleText(), - }, - ]; - - case 'esql-kibana.html': - return [ - { - title: 'Kibana', - content: getSimpleText(), - }, - ]; - - case 'esql-functions-operators.html': - const sections = extractSections($element); - - const searches = [ - 'Binary operators', - 'Equality', - 'Inequality', - 'Less than', - 'Greater than', - 'Add +', - 'Subtract -', - 'Multiply *', - 'Divide /', - 'Modulus %', - 'Unary operators', - 'Logical operators', - 'IS NULL', - ]; - - const matches = [ - 'CIDR_MATCH', - 'ENDS_WITH', - 'IN', - 'IS_FINITE', - 'IS_INFINITE', - 'IS_NAN', - 'LIKE', - 'RLIKE', - 'STARTS_WITH', - ]; - - const [operatorSections, allOtherSections] = partition(sections, (section) => { - return ( - matches.includes(section.title) || - searches.some((search) => - section.title.toLowerCase().startsWith(search.toLowerCase()) - ) - ); - }); + switch (Path.basename(file)) { + case 'esql-commands.html': + return extractSections($element) + .filter(({ title }) => !!title.match(/^[A-Z_]+$/)) + .map((doc) => ({ + ...doc, + instructions: `For this command, generate a Markdown document containing the following sections: + + ## {Title} + + {What this command does, the use cases, and any limitations from this document or esql-limitations.txt} + + ### Examples + + {example ES|QL queries using this command. prefer to copy mentioned queries, but make sure there are at least three different examples, focusing on different usages of this command}`, + })); + + case 'esql-limitations.html': + return [ + { + title: 'Limitations', + content: getSimpleText(), + skip: true, + }, + ]; + + case 'esql-syntax.html': + return [ + { + title: 'Syntax', + content: getSimpleText(), + instructions: `Generate a description of ES|QL syntax. Be as complete as possible. + For timespan literals, generate at least five examples of full ES|QL queries, using a mix commands and functions, using different intervals and units. + **Make sure you use timespan literals, such as \`1 day\` or \`24h\` or \`7 weeks\` in these examples**. + Combine ISO timestamps with time span literals and NOW(). + Make sure the example queries are using different combinations of syntax, commands and functions for each. + When using DATE_TRUNC, make sure you DO NOT wrap the timespan in single or double quotes. + Do not use the Cast operator. + `, + }, + ]; + + case 'esql.html': + return [ + { + title: 'Overview', + content: getSimpleText().replace( + /The ES\|QL documentation is organized in these sections(.*)$/, + '' + ), + instructions: `Generate a description of ES|QL as a language. Ignore links to other documents. From Limitations, include the known limitations, but ignore limitations that are specific to a command. + Include a summary of what is mentioned in the CROSS_CLUSTER, Kibana and API sections. Explain how to use the REST API with an example and mention important information for Kibana usage and cross cluster querying.`, + }, + ]; + + case 'esql-cross-clusters.html': + return [ + { + title: 'CROSS_CLUSTER', + content: getSimpleText(), + skip: true, + }, + ]; + + case 'esql-query-api.html': + return [ + { + title: 'API', + content: getSimpleText(), + skip: true, + }, + ]; + + case 'esql-kibana.html': + return [ + { + title: 'Kibana', + content: getSimpleText(), + skip: true, + }, + ]; + + case 'esql-functions-operators.html': + const sections = extractSections($element); + + const searches = [ + 'Binary operators', + 'Equality', + 'Inequality', + 'Less than', + 'Greater than', + 'Add +', + 'Subtract -', + 'Multiply *', + 'Divide /', + 'Modulus %', + 'Unary operators', + 'Logical operators', + 'IS NULL', + 'IS NOT NULL', + 'Cast (::)', + ]; + + const matches = ['IN', 'LIKE', 'RLIKE']; + + const [operatorSections, allOtherSections] = partition(sections, (section) => { + return ( + matches.includes(section.title) || + searches.some((search) => + section.title.toLowerCase().startsWith(search.toLowerCase()) + ) + ); + }); - return allOtherSections.concat({ - title: 'Operators', - content: operatorSections - .map(({ title, content }) => `${title}\n${content}`) - .join('\n'), - }); + return allOtherSections + .map((section) => ({ + ...section, + instructions: `For each function, use the following template: + + ## {Title} + + {description of what this function does} + + ### Examples + + {at least two examples of full ES|QL queries. prefer the ones in the document verbatim} + `, + })) + .concat({ + title: 'Operators', + content: operatorSections + .map(({ title, content }) => `${title}\n${content}`) + .join('\n'), + instructions: + 'Generate a document describing the operators. For each type of operator (binary, unary, logical, and the remaining), generate a section. For each operator, generate at least one full ES|QL query as an example of its usage. Keep it short, e.g. only a ```esql\nFROM ...\n| WHERE ... ```', + }); - default: - log.debug('Dropping file', file); - break; - } - return []; - }) - ) + default: + log.debug('Dropping file', file); + break; + } + return []; + } + + const documents = await Promise.all( + files.map((file) => fsLimiter(() => extractContents(file))) ); const flattened = documents.flat().filter((doc) => { // ES|QL aggregate functions, ES|QL mathematical functions, ES|QL string functions etc - const isOverviewArticle = doc.title.startsWith('ES|QL'); + const isOverviewArticle = + doc.title.startsWith('ES|QL') || + doc.title === 'Functions overview' || + doc.title === 'Operators overview'; if (isOverviewArticle) { log.debug('Dropping overview article', doc.title); @@ -241,36 +334,167 @@ yargs(process.argv.slice(2)) '../../../observability_ai_assistant_app/server/functions/query/esql_docs' ); - log.info(`Writing ${flattened.length} documents to disk to ${outDir}`); - - log.debug(`Clearing ${outDir}`); + if (!argv.dryRun) { + log.info(`Writing ${flattened.length} documents to disk to ${outDir}`); + } - await Fs.rm(outDir, { recursive: true }); + if (!argv.only && !argv.dryRun) { + log.debug(`Clearing ${outDir}`); - await Fs.mkdir(outDir); + await Fs.rm(outDir, { recursive: true }).catch((error) => + error.code === 'ENOENT' ? Promise.resolve() : error + ); + } - await Promise.all( - flattened.map((doc) => - limiter(async () => { - const fileName = Path.join( - outDir, - `esql-${doc.title.replaceAll(' ', '-').toLowerCase()}.txt` + if (!argv.dryRun) { + await Fs.mkdir(outDir).catch((error) => + error.code === 'EEXIST' ? Promise.resolve() : error + ); + } + const chatLimiter = pLimit(10); + + const allContent = flattened + .map((doc) => `## ${doc.title}\n\n${doc.content}\n\(end of ${doc.title})`) + .join('\n\n'); + + const allErrors: Array<{ + title: string; + fileName: string; + errors: Array<{ query: string; errors: Array }>; + }> = []; + + async function writeFile(doc: { title: string; content: string }) { + const fileName = Path.join( + outDir, + `esql-${doc.title.replaceAll(' ', '-').toLowerCase()}.txt` + ); + + doc.content = doc.content.replaceAll(INLINE_ESQL_QUERY_REGEX, (match, query) => { + const correctionResult = correctCommonEsqlMistakes(query); + if (correctionResult.isCorrection) { + log.info( + `Corrected ES|QL, from:\n${correctionResult.input}\nto:\n${correctionResult.output}` ); + } + return '```esql\n' + correctionResult.output + '\n```'; + }); + + const queriesWithSyntaxErrors = compact( + await Promise.all( + Array.from(doc.content.matchAll(INLINE_ESQL_QUERY_REGEX)).map( + async ([match, query]) => { + const { errors, warnings } = await validateQuery(query, getAstAndSyntaxErrors, { + // setting this to true, we don't want to validate the index / fields existence + ignoreOnMissingCallbacks: true, + }); - // We ask the LLM to output queries wrapped in ```esql...```, - // so we try to format ES|QL examples in the docs in the same - // way. The hope is that this creates a stronger relation in the - // output. - const formattedContent = formatEsqlExamples(doc.content); + const all = [...errors, ...warnings]; + if (all.length) { + log.warning( + `Error in ${fileName}:\n${JSON.stringify({ errors, warnings }, null, 2)}` + ); + return { + errors: all, + query, + }; + } + } + ) + ) + ); + + if (queriesWithSyntaxErrors.length) { + allErrors.push({ + title: doc.title, + fileName, + errors: queriesWithSyntaxErrors, + }); + } - log.debug({ - content: doc.content, - formattedContent, - }); + if (!argv.dryRun) { + await Fs.writeFile(fileName, doc.content); + } + } + + await Promise.all( + flattened.map(async (doc) => { + if (doc.skip || (argv.only && !argv.only.includes(doc.title))) { + return undefined; + } + + if (!doc.instructions) { + return fsLimiter(() => writeFile(doc)); + } + + return chatLimiter(async () => { + try { + const response = await chatClient.chat([ + { + role: MessageRole.System, + content: `## System instructions + + Your job is to generate Markdown documentation off of content that is scraped from the Elasticsearch website. + + The documentation is about ES|QL, or the Elasticsearch Query Language, which is a new piped language that can be + used for loading, extracting and transforming data stored in Elasticsearch. The audience for the documentation + you generate, is intended for an LLM, to be able to answer questions about ES|QL or generate and execute ES|QL + queries. + + If you need to generate example queries, make sure they are different, in that they use different commands, and arguments, + to show case how a command, function or operator can be used in different ways. + + When you generate a complete ES|QL query, always wrap it in code blocks with the language being \`esql\`.. Here's an example: + + \`\`\`esql + FROM logs-* + | WHERE @timestamp <= NOW() + \`\`\` + + **If you are describing the syntax of a command, only wrap it in SINGLE backticks. + Leave out the esql part**. Eg: + ### Syntax: + + \`DISSECT input "pattern" [APPEND_SEPARATOR=""]\` + + #### Context + + These is the entire documentation, use it as context for answering questions + + ${allContent} + `, + }, + { + role: MessageRole.User, + content: `Generate Markdown for the following document: + + ## ${doc.title} + + ### Instructions + + ${doc.instructions} + + ### Content of file + + ${doc.content}`, + }, + ]); + + return fsLimiter(() => + writeFile({ title: doc.title, content: response.content! }) + ); + } catch (error) { + log.error(`Error processing ${doc.title}: ${error.message}`); + } + }); + }) + ); - await Fs.writeFile(fileName, formattedContent); - }) - ) + log.warning( + `Please verify the following queries that had syntax errors\n${JSON.stringify( + allErrors, + null, + 2 + )}` ); }, { log: { defaultLevel: argv.logLevel as any }, flags: { allowUnexpected: true } } diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/constants.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/constants.ts new file mode 100644 index 0000000000000..99d7def64d4ff --- /dev/null +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/constants.ts @@ -0,0 +1,8 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export const INLINE_ESQL_QUERY_REGEX = /```esql\s*(.*?)\s*```/gms; diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/correct_common_esql_mistakes.test.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/correct_common_esql_mistakes.test.ts index ffb26e035cf0f..ad8e0f6cfd664 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/correct_common_esql_mistakes.test.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/correct_common_esql_mistakes.test.ts @@ -4,23 +4,15 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ -import dedent from 'dedent'; -import { noop } from 'lodash'; import { correctCommonEsqlMistakes } from './correct_common_esql_mistakes'; describe('correctCommonEsqlMistakes', () => { - const fakeLogger = { - debug: noop, - } as any; - - function renderQuery(query: string) { - return '```esql\n' + dedent(query) + '\n```'; + function normalize(input: string) { + return input.replaceAll(/[\t|\s]*\n[\t|\s]*/gms, '\n'); } function expectQuery(input: string, expectedOutput: string) { - expect(correctCommonEsqlMistakes(renderQuery(input), fakeLogger)).toEqual( - renderQuery(expectedOutput) - ); + expect(normalize(correctCommonEsqlMistakes(input).output)).toEqual(normalize(expectedOutput)); } it('replaces aliasing via the AS keyword with the = operator', () => { @@ -106,6 +98,11 @@ describe('correctCommonEsqlMistakes', () => { `FROM logs-* | KEEP date, whatever | RENAME whatever AS forever | SORT forever DESC`, `FROM logs-*\n| KEEP date, whatever\n| RENAME whatever AS forever\n| SORT forever DESC` ); + + expectQuery( + 'FROM employees\n| KEEP first_name, last_name\n| RENAME first_name AS fn, last_name AS ln', + 'FROM employees\n| KEEP first_name, last_name\n| RENAME first_name AS fn, last_name AS ln' + ); }); it(`escapes the column name if SORT uses an expression`, () => { @@ -118,6 +115,20 @@ describe('correctCommonEsqlMistakes', () => { 'FROM logs-* \n| STATS COUNT(*) by service.name\n| SORT COUNT(*) DESC, @timestamp ASC', 'FROM logs-*\n| STATS COUNT(*) BY service.name\n| SORT `COUNT(*)` DESC, @timestamp ASC' ); + + expectQuery( + `FROM employees\n| KEEP first_name, last_name, height\n| SORT first_name ASC NULLS FIRST`, + `FROM employees\n| KEEP first_name, last_name, height\n| SORT first_name ASC NULLS FIRST` + ); + + expectQuery( + `FROM employees + | STATS my_count = COUNT() BY LEFT(last_name, 1) + | SORT \`LEFT(last_name, 1)\``, + `FROM employees + | STATS my_count = COUNT() BY LEFT(last_name, 1) + | SORT \`LEFT(last_name, 1)\`` + ); }); it(`handles complicated queries correctly`, () => { @@ -140,10 +151,10 @@ describe('correctCommonEsqlMistakes', () => { | EVAL total_events = span.destination.service.response_time.count | EVAL total_latency = span.destination.service.response_time.sum.us | EVAL is_failure = CASE(event.outcome == "failure", 1, 0) - | STATS - avg_throughput = AVG(total_events), - avg_latency_per_request = AVG(total_latency / total_events), - failure_rate = AVG(is_failure) + | STATS + avg_throughput = AVG(total_events), + avg_latency_per_request = AVG(total_latency / total_events), + failure_rate = AVG(is_failure) BY span.destination.service.resource`, `FROM metrics-apm* | WHERE metricset.name == "service_destination" AND @timestamp > NOW() - 24 hours @@ -152,5 +163,20 @@ describe('correctCommonEsqlMistakes', () => { | EVAL is_failure = CASE(event.outcome == "failure", 1, 0) | STATS avg_throughput = AVG(total_events), avg_latency_per_request = AVG(total_latency / total_events), failure_rate = AVG(is_failure) BY span.destination.service.resource` ); + + expectQuery( + `FROM sample_data + | EVAL successful = CASE( + STARTS_WITH(message, "Connected to"), 1, + message == "Connection error", 0 + ) + | STATS success_rate = AVG(successful)`, + `FROM sample_data + | EVAL successful = CASE( + STARTS_WITH(message, "Connected to"), 1, + message == "Connection error", 0 + ) + | STATS success_rate = AVG(successful)` + ); }); }); diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/correct_common_esql_mistakes.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/correct_common_esql_mistakes.ts index 4c20f979a42d7..73f2d31b4b35b 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/correct_common_esql_mistakes.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/correct_common_esql_mistakes.ts @@ -5,10 +5,7 @@ * 2.0. */ -import { isArray } from 'lodash'; -import type { Logger } from '@kbn/logging'; - -const DELIMITER_TOKENS = ['`', "'", '"', ['(', ')']]; +const STRING_DELIMITER_TOKENS = ['`', "'", '"']; const ESCAPE_TOKEN = '\\\\'; // this function splits statements by a certain token, @@ -18,6 +15,9 @@ function split(value: string, splitToken: string) { const statements: string[] = []; let delimiterToken: string | undefined; + + let groupingCount: number = 0; + let currentStatement: string = ''; const trimmed = value.trim().split(''); @@ -27,6 +27,7 @@ function split(value: string, splitToken: string) { if ( !delimiterToken && + groupingCount === 0 && trimmed .slice(index, index + splitToken.length) .join('') @@ -44,13 +45,16 @@ function split(value: string, splitToken: string) { // end identifier delimiterToken = undefined; } else if (!delimiterToken && trimmed[index - 1] !== ESCAPE_TOKEN) { - const applicableToken = DELIMITER_TOKENS.find( - (token) => token === char || (isArray(token) && token[0] === char) - ); + const applicableToken = STRING_DELIMITER_TOKENS.includes(char) ? char : undefined; + if (applicableToken) { // start identifier - delimiterToken = isArray(applicableToken) ? applicableToken[1] : applicableToken; + delimiterToken = applicableToken; continue; + } else if (char === '(') { + groupingCount++; + } else if (char === ')') { + groupingCount--; } } } @@ -104,7 +108,7 @@ function isValidColumnName(column: string) { } function escapeColumns(line: string) { - const [, command, body] = line.match(/^([A-Za-z_]+)(.*)$/s) ?? ['', '', '']; + const [, command, body] = line.match(/^([A-Za-z_]+)(.*)$/ms) ?? ['', '', '']; const escapedBody = split(body.trim(), ',') .map((statement) => { @@ -130,7 +134,7 @@ function verifyKeepColumns( const availableColumns = columnsInKeep.concat(); for (const { name, command } of nextCommands) { - if (['STATS', 'KEEP', 'DROP', 'DISSECT', 'GROK', 'ENRICH'].includes(name || '')) { + if (['STATS', 'KEEP', 'DROP', 'DISSECT', 'GROK', 'ENRICH', 'RENAME'].includes(name || '')) { // these operations alter columns in a way that is hard to analyze, so we abort break; } @@ -179,14 +183,15 @@ function escapeExpressionsInSort(sortCommand: string) { const columnsInSort = split(sortCommand.replace(/^SORT\s*/, ''), ',') .map((statement) => split(statement, '=')?.[0].trim()) .map((columnAndSortOrder) => { - let [, column, sortOrder = ''] = columnAndSortOrder.match(/^(.*?)\s*(ASC|DESC)?$/i) || []; + let [, column, sortOrder = ''] = + columnAndSortOrder.match(/^(.*?)\s+(ASC|DESC\s*([A-Z\s]+)?)?$/i) || []; if (!column) { return columnAndSortOrder; } if (sortOrder) sortOrder = ` ${sortOrder}`; - if (!column.match(/^[a-zA-Z0-9_\.@]+$/)) { + if (!column.match(/^`?[a-zA-Z0-9_\.@]+`?$/)) { column = `\`${column}\``; } @@ -220,59 +225,63 @@ function ensureEqualityOperators(whereCommand: string) { return `WHERE ${next}`; } -export function correctCommonEsqlMistakes(content: string, log: Logger) { - return content.replaceAll(/```esql\n(.*?)\n```/gms, (_, query: string) => { - const commands = splitIntoCommands(query.trim()); - - const formattedCommands: string[] = commands.map(({ name, command }, index) => { - let formattedCommand = command; - - switch (name) { - case 'FROM': - formattedCommand = formattedCommand - .replaceAll(/FROM "(.*)"/g, 'FROM $1') - .replaceAll(/FROM '(.*)'/g, 'FROM $1') - .replaceAll(/FROM `(.*)`/g, 'FROM $1'); - break; - - case 'WHERE': - formattedCommand = replaceSingleQuotesWithDoubleQuotes(formattedCommand); - formattedCommand = ensureEqualityOperators(formattedCommand); - break; - - case 'EVAL': - formattedCommand = replaceSingleQuotesWithDoubleQuotes(formattedCommand); - formattedCommand = escapeColumns(formattedCommand); - break; - - case 'STATS': - formattedCommand = replaceAsKeywordWithAssignments(formattedCommand); - const [before, after] = split(formattedCommand, ' BY '); - formattedCommand = escapeColumns(before); - if (after) { - formattedCommand += ` BY ${after}`; - } - break; - - case 'KEEP': - formattedCommand = verifyKeepColumns(formattedCommand, commands.slice(index + 1)); - break; - - case 'SORT': - formattedCommand = escapeExpressionsInSort(formattedCommand); - break; - } - return formattedCommand; - }); - - const correctedFormattedQuery = formattedCommands.join('\n| '); +export function correctCommonEsqlMistakes(query: string): { + isCorrection: boolean; + input: string; + output: string; +} { + const commands = splitIntoCommands(query.trim()); + + const formattedCommands: string[] = commands.map(({ name, command }, index) => { + let formattedCommand = command; + + switch (name) { + case 'FROM': + formattedCommand = formattedCommand + .replaceAll(/FROM "(.*)"/g, 'FROM $1') + .replaceAll(/FROM '(.*)'/g, 'FROM $1') + .replaceAll(/FROM `(.*)`/g, 'FROM $1'); + break; + + case 'WHERE': + formattedCommand = replaceSingleQuotesWithDoubleQuotes(formattedCommand); + formattedCommand = ensureEqualityOperators(formattedCommand); + break; + + case 'EVAL': + formattedCommand = replaceSingleQuotesWithDoubleQuotes(formattedCommand); + formattedCommand = escapeColumns(formattedCommand); + break; + + case 'STATS': + formattedCommand = replaceAsKeywordWithAssignments(formattedCommand); + const [before, after] = split(formattedCommand, ' BY '); + formattedCommand = escapeColumns(before); + if (after) { + formattedCommand += ` BY ${after}`; + } + break; - const originalFormattedQuery = commands.map((cmd) => cmd.command).join('\n| '); + case 'KEEP': + formattedCommand = verifyKeepColumns(formattedCommand, commands.slice(index + 1)); + break; - if (originalFormattedQuery !== correctedFormattedQuery) { - log.debug(`Modified query from: ${originalFormattedQuery}\nto:\n${correctedFormattedQuery}`); + case 'SORT': + formattedCommand = escapeExpressionsInSort(formattedCommand); + break; } - - return '```esql\n' + correctedFormattedQuery + '\n```'; + return formattedCommand; }); + + const output = formattedCommands.join('\n| '); + + const originalFormattedQuery = commands.map((cmd) => cmd.command).join('\n| '); + + const isCorrection = output !== originalFormattedQuery; + + return { + input: query, + output, + isCorrection, + }; } diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-abs.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-abs.txt index 5c436a9dfa0ce..c31ec9882e371 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-abs.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-abs.txt @@ -1,18 +1,30 @@ -ABS - -Syntax -Parameters -number -Numeric expression. If null, the function returns null. -DescriptionReturns the absolute value.Supported types -Examples +## ABS + +The `ABS` function in ES|QL returns the absolute value of a numeric expression. + +### Syntax + +`ABS(number)` + +#### Parameters + +`number`: Numeric expression. If null, the function returns null. + +### Examples + +Here are a couple of examples of how to use the `ABS` function in ES|QL: + ```esql ROW number = -1.0 | EVAL abs_number = ABS(number) ``` +In this example, the `ABS` function is used to calculate the absolute value of `-1.0`, which results in `1.0`. + ```esql FROM employees | KEEP first_name, last_name, height | EVAL abs_height = ABS(0.0 - height) ``` + +In this example, the `ABS` function is used to calculate the absolute value of the height of employees. The height is subtracted from `0.0` to get a negative value, and then the `ABS` function is applied to get the absolute value. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-acos.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-acos.txt index d4befd0a17aa2..2a5dab6453787 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-acos.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-acos.txt @@ -1,12 +1,29 @@ -ACOS - -Syntax -Parameters -number -Number between -1 and 1. If null, the function returns null. -DescriptionReturns the arccosine of n as an angle, expressed in radians.Supported types -Example +## ACOS + +The `ACOS` function in ES|QL returns the arccosine of a number as an angle, expressed in radians. The number should be between -1 and 1. If the input is null, the function will return null. + +### Syntax + +`ACOS(number)` + +#### Parameters + +`number`: A number between -1 and 1. If null, the function returns null. + +### Examples + +Here are a couple of examples of how to use the `ACOS` function in ES|QL queries: + ```esql ROW a=.9 -| EVAL acos=ACOS(a) +| EVAL acos = ACOS(a) +``` + +In this example, the `ACOS` function is used to calculate the arccosine of 0.9. + +```esql +ROW a=-.5 +| EVAL acos = ACOS(a) ``` + +In this example, the `ACOS` function is used to calculate the arccosine of -0.5. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-api.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-api.txt deleted file mode 100644 index 30555ee481ca9..0000000000000 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-api.txt +++ /dev/null @@ -1,61 +0,0 @@ - -ES|QL query APIedit -Returns search results for an ES|QL (Elasticsearch query language) query. -POST /_query -{ - "query": """ -```esql -FROM library - | EVAL year = DATE_TRUNC(1 YEARS, release_date) - | STATS MAX(page_count) BY year - | SORT year - | LIMIT 5 - """, -``` - -} -Requestedit -`POST _query` -Prerequisitesedit -If the Elasticsearch security features are enabled, you must have the `read` -index privilege for the data stream, index, -or alias you search. -Query parametersedit -`delimiter` -(Optional, string) Separator for CSV results. Defaults to `,`. The API only -supports this parameter for CSV responses. -`drop_null_columns` -(Optional, boolean) Should columns that are entirely `null` be removed from -the `columns` and `values` portion of the results? Defaults to `false`. If -`true` the the response will include an extra section under the name -`all_columns` which has the name of all columns. -`format` -(Optional, string) Format for the response. For valid values, refer to -Response formats. -You can also specify a format using the `Accept` HTTP header. If you specify -both this parameter and the `Accept` HTTP header, this parameter takes -precedence. -Request bodyedit -`columnar` -(Optional, Boolean) If `true`, returns results in a columnar format. Defaults to -`false`. The API only supports this parameter for CBOR, JSON, SMILE, and YAML -responses. See Columnar results. -`locale` -(Optional, string) Returns results (especially dates) formatted per the conventions of the locale. -For syntax, refer to Returning localized results. -`params` -(Optional, array) Values for parameters in the `query`. For syntax, refer to -Passing parameters to a query. -`query` -(Required, string) ES|QL query to run. For syntax, refer to Syntax reference. -Response bodyedit -`columns` -(array of objects) -Column `name` and `type` for each column returned in `values`. Each object is a single column. -`all_columns` -(array of objects) -Column `name` and `type` for each queried column. Each object is a single column. This is only -returned if `drop_null_columns` is sent with the request. -`rows` -(array of arrays) -Values for the search results. diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-asin.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-asin.txt index 79abf14656d69..0c03646864a7a 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-asin.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-asin.txt @@ -1,12 +1,21 @@ -ASIN - -Syntax -Parameters -number -Number between -1 and 1. If null, the function returns null. -DescriptionReturns the arcsine of the input numeric expression as an angle, expressed in radians.Supported types -Example +## ASIN + +The `ASIN` function in ES|QL returns the arcsine of the input numeric expression as an angle, expressed in radians. This function only accepts numbers between -1 and 1. If the input is null, the function will return null. + +### Examples + +Here are a couple of examples of how you can use the `ASIN` function in your ES|QL queries: + ```esql ROW a=.9 -| EVAL asin=ASIN(a) +| EVAL asin = ASIN(a) ``` + +In this example, the `ASIN` function is used to calculate the arcsine of 0.9. The result is stored in the `asin` column. + +```esql +ROW a=-.5 +| EVAL asin_value = ASIN(a) +``` + +In this second example, the `ASIN` function is used to calculate the arcsine of -0.5. The result is stored in the `asin_value` column. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-atan.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-atan.txt index 9c8f0a080a1fd..3c40607d25a82 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-atan.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-atan.txt @@ -1,12 +1,29 @@ -ATAN - -Syntax -Parameters -number -Numeric expression. If null, the function returns null. -DescriptionReturns the arctangent of the input numeric expression as an angle, expressed in radians.Supported types -Example +## ATAN + +The `ATAN` function in ES|QL is used to calculate the arctangent of a given numeric expression. The result is expressed in radians. If the input is null, the function will return null. + +### Syntax + +`ATAN(number)` + +#### Parameters + +- `number`: A numeric expression. If null, the function returns null. + +### Examples + +Here are a couple of examples of how you can use the `ATAN` function in ES|QL: + ```esql ROW a=12.9 -| EVAL atan=ATAN(a) +| EVAL atan = ATAN(a) +``` + +In this example, the `ATAN` function is used to calculate the arctangent of the number 12.9. + +```esql +ROW b=7.5 +| EVAL atan_value = ATAN(b) ``` + +In this second example, the `ATAN` function is used to calculate the arctangent of the number 7.5. The result is stored in the `atan_value` variable. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-atan2.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-atan2.txt index 9caa5eca10d50..9377a71c2eb6d 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-atan2.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-atan2.txt @@ -1,14 +1,30 @@ -ATAN2 - -Syntax -Parameters -y_coordinate -y coordinate. If null, the function returns null. -x_coordinate -x coordinate. If null, the function returns null. -DescriptionThe angle between the positive x-axis and the ray from the origin to the point (x , y) in the Cartesian plane, expressed in radians.Supported types -Example +## ATAN2 + +ATAN2 is a function in ES|QL that calculates the angle between the positive x-axis and the ray from the origin to the point (x , y) in the Cartesian plane, expressed in radians. + +### Syntax + +`ATAN2(y_coordinate, x_coordinate)` + +#### Parameters + +- `y_coordinate`: The y coordinate. If null, the function returns null. +- `x_coordinate`: The x coordinate. If null, the function returns null. + +### Examples + +Here are a couple of examples of how you can use the `ATAN2` function in ES|QL queries: + ```esql ROW y=12.9, x=.6 -| EVAL atan2=ATAN2(y, x) +| EVAL atan2 = ATAN2(y, x) +``` + +In this example, the `ATAN2` function is used to calculate the angle between the positive x-axis and the ray from the origin to the point (0.6 , 12.9) in the Cartesian plane. + +```esql +ROW y=5, x=3 +| EVAL atan2 = ATAN2(y, x) ``` + +In this second example, the `ATAN2` function is used to calculate the angle between the positive x-axis and the ray from the origin to the point (3 , 5) in the Cartesian plane. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-avg.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-avg.txt index 5ee99389900ed..bfd9c161bba1f 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-avg.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-avg.txt @@ -1,19 +1,21 @@ -AVG +## AVG -Syntax -AVG(expression) -expression -Numeric expression. -DescriptionThe average of a numeric expression.Supported typesThe result is always a double no matter the input type.Examples -```esql +The `AVG` function in ES|QL calculates the average of a numeric expression. The result is always a double, regardless of the input type. + +### Examples + +Here are a couple of examples of how you can use the `AVG` function in ES|QL queries: + +1. Calculating the average height of employees: + + ```esql FROM employees | STATS AVG(height) ``` -The expression can use inline functions. For example, to calculate the average -over a multivalued column, first use MV_AVG to average the multiple values per -row, and use the result with the AVG function: -```esql +2. Calculating the average salary change, where the salary change is a multivalued column. In this case, the `MV_AVG` function is used to first average the multiple values per row, and then the `AVG` function is used on the result: + + ```esql FROM employees | STATS avg_salary_change = ROUND(AVG(MV_AVG(salary_change)), 10) -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-bucket.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-bucket.txt index d74334af52ed7..2eed9008f6870 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-bucket.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-bucket.txt @@ -1,103 +1,22 @@ -BUCKET +## BUCKET -Syntax -Parameters -field -Numeric or date expression from which to derive buckets. -buckets -Target number of buckets. -from -Start of the range. Can be a number or a date expressed as a string. -to -End of the range. Can be a number or a date expressed as a string. -DescriptionCreates groups of values - buckets - out of a datetime or numeric input. The size of the buckets can either be provided directly, or chosen based on a recommended count and values range.Supported types -ExamplesBUCKET can work in two modes: one in which the size of the bucket is computed -based on a buckets count recommendation (four parameters) and a range, and -another in which the bucket size is provided directly (two parameters).Using a target number of buckets, a start of a range, and an end of a range, -BUCKET picks an appropriate bucket size to generate the target number of buckets or fewer. -For example, asking for at most 20 buckets over a year results in monthly buckets: -```esql -FROM employees -| WHERE hire_date >= "1985-01-01T00:00:00Z" AND hire_date < "1986-01-01T00:00:00Z" -| STATS hire_date = MV_SORT(VALUES(hire_date)) BY month = BUCKET(hire_date, 20, "1985-01-01T00:00:00Z", "1986-01-01T00:00:00Z") -| SORT hire_date -``` +BUCKET function creates groups of values - buckets - out of a datetime or numeric input. The size of the buckets can either be provided directly, or chosen based on a recommended count and values range. -The goal isn’t to provide exactly the target number of buckets, -it’s to pick a range that people are comfortable with that provides at most the target number of buckets.Combine BUCKET with an aggregation to create a histogram: -```esql -FROM employees -| WHERE hire_date >= "1985-01-01T00:00:00Z" AND hire_date < "1986-01-01T00:00:00Z" -| STATS hires_per_month = COUNT(*) BY month = BUCKET(hire_date, 20, "1985-01-01T00:00:00Z", "1986-01-01T00:00:00Z") -| SORT month -``` +### Examples -BUCKET does not create buckets that don’t match any documents. -That’s why this example is missing 1985-03-01 and other dates. -Asking for more buckets can result in a smaller range. -For example, asking for at most 100 buckets in a year results in weekly buckets: -```esql -FROM employees -| WHERE hire_date >= "1985-01-01T00:00:00Z" AND hire_date < "1986-01-01T00:00:00Z" -| STATS hires_per_week = COUNT(*) BY week = BUCKET(hire_date, 100, "1985-01-01T00:00:00Z", "1986-01-01T00:00:00Z") -| SORT week -``` +In this example, BUCKET function is used to create a histogram of salaries: -BUCKET does not filter any rows. It only uses the provided range to pick a good bucket size. -For rows with a value outside of the range, it returns a bucket value that corresponds to a bucket outside the range. -Combine`BUCKET` with WHERE to filter rows. -If the desired bucket size is known in advance, simply provide it as the second -argument, leaving the range out: ```esql FROM employees -| WHERE hire_date >= "1985-01-01T00:00:00Z" AND hire_date < "1986-01-01T00:00:00Z" -| STATS hires_per_week = COUNT(*) BY week = BUCKET(hire_date, 1 week) -| SORT week -``` - -When providing the bucket size as the second parameter, it must be a time -duration or date period. -BUCKET can also operate on numeric fields. For example, to create a salary histogram: -```esql -FROM employees -| STATS COUNT(*) by bs = BUCKET(salary, 20, 25324, 74999) +| STATS COUNT(*) BY bs = BUCKET(salary, 20, 25324, 74999) | SORT bs ``` -Unlike the earlier example that intentionally filters on a date range, you rarely want to filter on a numeric range. -You have to find the min and max separately. ES|QL doesn’t yet have an easy way to do that automatically.The range can be omitted if the desired bucket size is known in advance. Simply -provide it as the second argument: -```esql -FROM employees -| WHERE hire_date >= "1985-01-01T00:00:00Z" AND hire_date < "1986-01-01T00:00:00Z" -| STATS c = COUNT(1) BY b = BUCKET(salary, 5000.) -| SORT b -``` - -When providing the bucket size as the second parameter, it must be -of a floating point type. -Create hourly buckets for the last 24 hours, and calculate the number of events per hour: -```esql -FROM sample_data -| WHERE @timestamp >= NOW() - 1 day and @timestamp < NOW() -| STATS COUNT(*) BY bucket = BUCKET(@timestamp, 25, NOW() - 1 day, NOW()) -``` +In the following example, BUCKET function is used to create monthly buckets for the year 1985, and calculate the average salary by hiring month: -Create monthly buckets for the year 1985, and calculate the average salary by hiring month ```esql FROM employees | WHERE hire_date >= "1985-01-01T00:00:00Z" AND hire_date < "1986-01-01T00:00:00Z" | STATS AVG(salary) BY bucket = BUCKET(hire_date, 20, "1985-01-01T00:00:00Z", "1986-01-01T00:00:00Z") | SORT bucket -``` - -BUCKET may be used in both the aggregating and grouping part of the -STATS …​ BY …​ command provided that in the aggregating -part the function is referenced by an alias defined in the -grouping part, or that it is invoked with the exact same expression: -```esql -FROM employees -| STATS s1 = b1 + 1, s2 = BUCKET(salary / 1000 + 999, 50.) + 2 BY b1 = BUCKET(salary / 100 + 99, 50.), b2 = BUCKET(salary / 1000 + 999, 50.) -| SORT b1, b2 -| KEEP s1, b1, s2, b2 -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-case.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-case.txt index a8d2ca35fb1c8..66fed29cea823 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-case.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-case.txt @@ -1,19 +1,13 @@ -CASE - -Syntax -CASE(condition1, value1[, ..., conditionN, valueN][, default_value]) -Parameters -conditionX -A condition. -valueX -The value that’s returned when the corresponding condition is the first to -evaluate to true. -default_value -The default value that’s is returned when no condition matches. -DescriptionAccepts pairs of conditions and values. The function returns the value that -belongs to the first condition that evaluates to true.If the number of arguments is odd, the last argument is the default value which -is returned when no condition matches. If the number of arguments is even, and -no condition matches, the function returns null.ExampleDetermine whether employees are monolingual, bilingual, or polyglot: +## CASE + +The `CASE` function in ES|QL accepts pairs of conditions and values. It returns the value that belongs to the first condition that evaluates to true. If the number of arguments is odd, the last argument is the default value which is returned when no condition matches. If the number of arguments is even, and no condition matches, the function returns null. + +### Examples + +Here are a couple of examples of how you can use the `CASE` function in ES|QL: + +1. Determine whether employees are monolingual, bilingual, or polyglot: + ```esql FROM employees | EVAL type = CASE( @@ -23,7 +17,8 @@ FROM employees | KEEP emp_no, languages, type ``` -Calculate the total connection success rate based on log messages: +2. Calculate the total connection success rate based on log messages: + ```esql FROM sample_data | EVAL successful = CASE( @@ -33,12 +28,12 @@ FROM sample_data | STATS success_rate = AVG(successful) ``` -Calculate an hourly error rate as a percentage of the total number of log -messages: +3. Calculate an hourly error rate as a percentage of the total number of log messages: + ```esql FROM sample_data | EVAL error = CASE(message LIKE "*error*", 1, 0) | EVAL hour = DATE_TRUNC(1 hour, @timestamp) -| STATS error_rate = AVG(error) by hour +| STATS error_rate = AVG(error) BY hour | SORT hour -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cbrt.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cbrt.txt new file mode 100644 index 0000000000000..4a5af259aabeb --- /dev/null +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cbrt.txt @@ -0,0 +1,29 @@ +## CBRT + +The `CBRT` function in ES|QL is used to calculate the cube root of a number. The input can be any numeric value and the return value is always a double. If the input is an infinity, the function returns null. + +### Syntax + +`CBRT(number)` + +#### Parameters + +- `number`: A numeric expression. If null, the function returns null. + +### Examples + +Here are a couple of examples of how to use the `CBRT` function in ES|QL: + +```esql +ROW d = 27.0 +| EVAL c = CBRT(d) +``` + +In this example, the `CBRT` function is used to calculate the cube root of 27. The result would be 3. + +```esql +ROW d = 64.0 +| EVAL c = CBRT(d) +``` + +In this example, the `CBRT` function is used to calculate the cube root of 64. The result would be 4. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-ceil.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-ceil.txt index d8bea9d574ea1..3cac4dbf7c63b 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-ceil.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-ceil.txt @@ -1,14 +1,21 @@ -CEIL - -Syntax -Parameters -number -Numeric expression. If null, the function returns null. -DescriptionRound a number up to the nearest integer. -This is a noop for long (including unsigned) and integer. For double this picks the closest double value to the integer similar to Math.ceil. -Supported types -Example +## CEIL + +The `CEIL` function in ES|QL is used to round a number up to the nearest integer. This function does not perform any operation for long (including unsigned) and integer types. For double, this function picks the closest double value to the integer, similar to the `Math.ceil` function in JavaScript. + +### Examples + +Here are a couple of examples of how you can use the `CEIL` function in ES|QL queries: + ```esql ROW a=1.8 -| EVAL a=CEIL(a) +| EVAL a = CEIL(a) ``` + +In this example, the `CEIL` function is used to round the value of `a` (1.8) up to the nearest integer (2). + +```esql +ROW b=3.3 +| EVAL b = CEIL(b) +``` + +In this second example, the `CEIL` function is used to round the value of `b` (3.3) up to the nearest integer (4). \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cidr_match.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cidr_match.txt new file mode 100644 index 0000000000000..d66963e5efaaa --- /dev/null +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cidr_match.txt @@ -0,0 +1,32 @@ +## CIDR_MATCH + +CIDR_MATCH is a function in ES|QL that checks if a provided IP address is contained in one or more provided CIDR blocks. It returns a boolean value - true if the IP is contained in the CIDR block(s), and false if it is not. + +### Syntax + +`CIDR_MATCH(ip, blockX)` + +### Parameters + +- `ip`: IP address of type ip (both IPv4 and IPv6 are supported). +- `blockX`: CIDR block to test the IP against. + +### Examples + +Here are a couple of examples of how you can use the CIDR_MATCH function in ES|QL queries: + +```esql +FROM hosts +| WHERE CIDR_MATCH(ip1, "127.0.0.2/32", "127.0.0.3/32") +| KEEP card, host, ip0, ip1 +``` + +In this example, the query checks if the `ip1` field of the `hosts` index is contained in either the "127.0.0.2/32" or "127.0.0.3/32" CIDR blocks. If it is, the `card`, `host`, `ip0`, and `ip1` fields are kept in the results. + +```esql +FROM network_logs +| WHERE CIDR_MATCH(source_ip, "192.168.1.0/24") +| KEEP timestamp, source_ip, destination_ip +``` + +In this second example, the query checks if the `source_ip` field of the `network_logs` index is contained in the "192.168.1.0/24" CIDR block. If it is, the `timestamp`, `source_ip`, and `destination_ip` fields are kept in the results. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-coalesce.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-coalesce.txt index 87e4de6189078..f1fbc77e6c341 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-coalesce.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-coalesce.txt @@ -1,14 +1,30 @@ -COALESCE - -Syntax -COALESCE(expression1 [, ..., expressionN]) -Parameters -first -Expression to evaluate -rest -Other expression to evaluate -DescriptionReturns the first of its arguments that is not null. If all arguments are null, it returns null.Example +## COALESCE + +The `COALESCE` function in ES|QL is used to return the first of its arguments that is not null. If all arguments are null, it returns null. + +### Syntax + +`COALESCE(first, rest)` + +#### Parameters + +- `first`: The first expression to evaluate. +- `rest`: Other expressions to evaluate. + +### Examples + +Here are a couple of examples of how you can use the `COALESCE` function in ES|QL: + ```esql ROW a=null, b="b" | EVAL COALESCE(a, b) ``` + +In this example, the `COALESCE` function is used to evaluate the expressions `a` and `b`. Since `a` is null, the function returns the value of `b`, which is "b". + +```esql +ROW a=null, b=null, c="c" +| EVAL COALESCE(a, b, c) +``` + +In this second example, the `COALESCE` function evaluates the expressions `a`, `b`, and `c`. Since both `a` and `b` are null, the function returns the value of `c`, which is "c". \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-concat.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-concat.txt index b58d7e13649f7..60f1c33a6fa57 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-concat.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-concat.txt @@ -1,15 +1,22 @@ -CONCAT - -Syntax -Parameters -string1 -Strings to concatenate. -string2 -Strings to concatenate. -DescriptionConcatenates two or more strings.Supported types -Example +## CONCAT + +The `CONCAT` function in ES|QL is used to concatenate two or more strings together. + +### Examples + +Here are a couple of examples of how you can use the `CONCAT` function in ES|QL: + ```esql FROM employees | KEEP first_name, last_name | EVAL fullname = CONCAT(first_name, " ", last_name) ``` + +In this example, the `CONCAT` function is used to combine the `first_name` and `last_name` fields from the `employees` index, with a space in between, to create a new field called `fullname`. + +```esql +FROM logs-* +| EVAL message = CONCAT("Error occurred at ", @timestamp, ": ", error_message) +``` + +In this second example, the `CONCAT` function is used to create a descriptive error message by combining a static string, the `@timestamp` field, and the `error_message` field from the `logs-*` index. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cos.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cos.txt index 09154626e1853..1489bfcfedf7a 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cos.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cos.txt @@ -1,12 +1,21 @@ -COS - -Syntax -Parameters -angle -An angle, in radians. If null, the function returns null. -DescriptionReturns the cosine of an angle.Supported types -Example +## COS + +The `COS` function in ES|QL is used to calculate the cosine of an angle. The angle should be provided in radians. + +### Examples + +Here are a couple of examples of how you can use the `COS` function in ES|QL: + ```esql ROW a=1.8 -| EVAL cos=COS(a) +| EVAL cos = COS(a) ``` + +In this example, the `COS` function is used to calculate the cosine of the angle `1.8` radians. The result is stored in the `cos` column. + +```esql +ROW a=3.14 +| EVAL cos_value = COS(a) +``` + +In this second example, the `COS` function is used to calculate the cosine of the angle `3.14` radians (which is approximately equal to π, the angle for which the cosine is `-1`). The result is stored in the `cos_value` column. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cosh.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cosh.txt index 5fa95d2a204b4..903746bb07c02 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cosh.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cosh.txt @@ -1,12 +1,21 @@ -COSH - -Syntax -Parameters -angle -An angle, in radians. If null, the function returns null. -DescriptionReturns the hyperbolic cosine of an angle.Supported types -Example +## COSH + +The `COSH` function in ES|QL returns the hyperbolic cosine of an angle. The angle should be provided in radians. If the provided angle is null, the function will return null. + +### Examples + +Here are a couple of examples of how you can use the `COSH` function in ES|QL: + ```esql ROW a=1.8 -| EVAL cosh=COSH(a) +| EVAL cosh = COSH(a) ``` + +In this example, the `COSH` function is used to calculate the hyperbolic cosine of the angle `1.8` radians. + +```esql +ROW a=0 +| EVAL cosh = COSH(a) +``` + +In this second example, the `COSH` function is used to calculate the hyperbolic cosine of the angle `0` radians. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-count.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-count.txt index 326d5c2e1caae..97c49b44471a7 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-count.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-count.txt @@ -1,27 +1,35 @@ -COUNT - -Syntax -COUNT([expression]) -Parameters -expression -Expression that outputs values to be counted. -If omitted, equivalent to COUNT(*) (the number of rows). -DescriptionReturns the total number (count) of input values.Supported typesCan take any field type as input.Examples +## COUNT + +The `COUNT` function in ES|QL returns the total number (count) of input values. It can take any field type as input. If the expression is omitted, it is equivalent to `COUNT(*)` which counts the number of rows. + +### Examples + +Here are a couple of examples of how you can use the `COUNT` function in ES|QL: + +1. Counting a specific field: + ```esql FROM employees | STATS COUNT(height) ``` -To count the number of rows, use COUNT() or COUNT(*): +In this example, the `COUNT` function is used to count the number of `height` values in the `employees` index. + +2. Counting the number of rows: + ```esql FROM employees | STATS count = COUNT(*) BY languages | SORT languages DESC ``` -The expression can use inline functions. This example splits a string into -multiple values using the SPLIT function and counts the values: +In this example, the `COUNT(*)` function is used to count the number of rows in the `employees` index, grouped by `languages`. + +3. Using inline functions with `COUNT`: + ```esql ROW words="foo;bar;baz;qux;quux;foo" | STATS word_count = COUNT(SPLIT(words, ";")) ``` + +In this example, the `SPLIT` function is used to split a string into multiple values, and then the `COUNT` function is used to count these values. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-count_distinct.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-count_distinct.txt index db129e784b2e1..bc977ed744b07 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-count_distinct.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-count_distinct.txt @@ -1,54 +1,37 @@ -COUNT_DISTINCT - -Syntax -COUNT_DISTINCT(expression[, precision_threshold]) -Parameters -expression -Expression that outputs the values on which to perform a distinct count. -precision_threshold -Precision threshold. Refer to Counts are approximate. The -maximum supported value is 40000. Thresholds above this number will have the -same effect as a threshold of 40000. The default value is 3000. -DescriptionReturns the approximate number of distinct values.Supported typesCan take any field type as input.Examples +## COUNT_DISTINCT + +The `COUNT_DISTINCT` function returns the approximate number of distinct values. It can take any field type as input. This function is based on the HyperLogLog++ algorithm, which counts based on the hashes of the values with some interesting properties such as configurable precision, excellent accuracy on low-cardinality sets, and fixed memory usage. + +### Syntax + +`COUNT_DISTINCT(expression[, precision_threshold])` + +#### Parameters + +- `expression`: Expression that outputs the values on which to perform a distinct count. +- `precision_threshold`: Precision threshold. The maximum supported value is 40000. Thresholds above this number will have the same effect as a threshold of 40000. The default value is 3000. + +### Examples + +Here are a couple of examples of how to use the `COUNT_DISTINCT` function in ES|QL queries: + ```esql FROM hosts | STATS COUNT_DISTINCT(ip0), COUNT_DISTINCT(ip1) ``` -With the optional second parameter to configure the precision threshold: +In this example, the `COUNT_DISTINCT` function is used to count the distinct values of `ip0` and `ip1` from the `hosts` index. + ```esql FROM hosts | STATS COUNT_DISTINCT(ip0, 80000), COUNT_DISTINCT(ip1, 5) ``` -The expression can use inline functions. This example splits a string into -multiple values using the SPLIT function and counts the unique values: +In this example, the `COUNT_DISTINCT` function is used with an optional second parameter to configure the precision threshold. + ```esql ROW words="foo;bar;baz;qux;quux;foo" | STATS distinct_word_count = COUNT_DISTINCT(SPLIT(words, ";")) ``` -Counts are approximateeditComputing exact counts requires loading values into a set and returning its -size. This doesn’t scale when working on high-cardinality sets and/or large -values as the required memory usage and the need to communicate those -per-shard sets between nodes would utilize too many resources of the cluster.This COUNT_DISTINCT function is based on the -HyperLogLog++ -algorithm, which counts based on the hashes of the values with some interesting -properties: -configurable precision, which decides on how to trade memory for accuracy, -excellent accuracy on low-cardinality sets, -fixed memory usage: no matter if there are tens or billions of unique values, -memory usage only depends on the configured precision. -For a precision threshold of c, the implementation that we are using requires -about c * 8 bytes.The following chart shows how the error varies before and after the threshold:For all 3 thresholds, counts have been accurate up to the configured threshold. -Although not guaranteed, this is likely to be the case. Accuracy in practice depends -on the dataset in question. In general, most datasets show consistently good -accuracy. Also note that even with a threshold as low as 100, the error -remains very low (1-6% as seen in the above graph) even when counting millions of items.The HyperLogLog++ algorithm depends on the leading zeros of hashed -values, the exact distributions of hashes in a dataset can affect the -accuracy of the cardinality.The COUNT_DISTINCT function takes an optional second parameter to configure -the precision threshold. The precision_threshold options allows to trade memory -for accuracy, and defines a unique count below which counts are expected to be -close to accurate. Above this value, counts might become a bit more fuzzy. The -maximum supported value is 40000, thresholds above this number will have the -same effect as a threshold of 40000. The default value is 3000. \ No newline at end of file +In this example, the `COUNT_DISTINCT` function is used with the `SPLIT` function to count the unique values in a string. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cross_cluster.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cross_cluster.txt deleted file mode 100644 index 715a15fa06edd..0000000000000 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-cross_cluster.txt +++ /dev/null @@ -1,225 +0,0 @@ - -Prerequisitesedit -Cross-cluster search requires remote clusters. To set up remote clusters on Elasticsearch Service, -see configure remote clusters on Elasticsearch Service. If you -run Elasticsearch on your own hardware, see Remote clusters. -To ensure your remote cluster configuration supports cross-cluster search, see -Supported cross-cluster search configurations. -For full cross-cluster search capabilities, the local and remote cluster must be on the same -subscription level. -The local coordinating node must have the -`remote_cluster_client` node role. -If you use sniff mode, the local coordinating node -must be able to connect to seed and gateway nodes on the remote cluster. -We recommend using gateway nodes capable of serving as coordinating nodes. -The seed nodes can be a subset of these gateway nodes. -If you use proxy mode, the local coordinating node must be able -to connect to the configured `proxy_address`. The proxy at this address must be -able to route connections to gateway and coordinating nodes on the remote -cluster. -Cross-cluster search requires different security privileges on the local cluster and -remote cluster. See Configure privileges for cross-cluster search and -Remote clusters. -Remote cluster setupedit -The following cluster update settings API request -adds three remote clusters: `cluster_one`, `cluster_two`, and `cluster_three`. -response = client.cluster.put_settings( - body: { - persistent: { - cluster: { - remote: { - cluster_one: { - seeds: [ - '35.238.149.1:9300' - ], - skip_unavailable: true - }, - cluster_two: { - seeds: [ - '35.238.149.2:9300' - ], - skip_unavailable: false - }, - cluster_three: { - seeds: [ - '35.238.149.3:9300' - ] - } - } - } - } - } -) -puts response -PUT _cluster/settings -{ - "persistent": { - "cluster": { - "remote": { - "cluster_one": { - "seeds": [ - "35.238.149.1:9300" - ], - "skip_unavailable": true - }, - "cluster_two": { - "seeds": [ - "35.238.149.2:9300" - ], - "skip_unavailable": false - }, - "cluster_three": { - "seeds": [ - "35.238.149.3:9300" - ] - } - } - } - } -} -Since `skip_unavailable` was not set on `cluster_three`, it uses -the default of `false`. See the Optional remote clusters -section for details. -Query across multiple clustersedit -In the `FROM` command, specify data streams and indices on remote clusters -using the format `:`. For instance, the following -ES|QL request queries the `my-index-000001` index on a single remote cluster -named `cluster_one`: -```esql -FROM cluster_one:my-index-000001 -| LIMIT 10 -``` - -Similarly, this ES|QL request queries the `my-index-000001` index from -three clusters: -The local ("querying") cluster -Two remote clusters, `cluster_one` and `cluster_two` -```esql -FROM my-index-000001,cluster_one:my-index-000001,cluster_two:my-index-000001 -| LIMIT 10 -``` - -Likewise, this ES|QL request queries the `my-index-000001` index from all -remote clusters (`cluster_one`, `cluster_two`, and `cluster_three`): -```esql -FROM *:my-index-000001 -| LIMIT 10 -``` - -Enrich across clustersedit -Enrich in ES|QL across clusters operates similarly to local enrich. -If the enrich policy and its enrich indices are consistent across all clusters, simply -write the enrich command as you would without remote clusters. In this default mode, -ES|QL can execute the enrich command on either the querying cluster or the fulfilling -clusters, aiming to minimize computation or inter-cluster data transfer. Ensuring that -the policy exists with consistent data on both the querying cluster and the fulfilling -clusters is critical for ES|QL to produce a consistent query result. -In the following example, the enrich with `hosts` policy can be executed on -either the querying cluster or the remote cluster `cluster_one`. -```esql -FROM my-index-000001,cluster_one:my-index-000001 -| ENRICH hosts ON ip -| LIMIT 10 -``` - -Enrich with an ES|QL query against remote clusters only can also happen on -the querying cluster. This means the below query requires the `hosts` enrich -policy to exist on the querying cluster as well. -```esql -FROM cluster_one:my-index-000001,cluster_two:my-index-000001 -| LIMIT 10 -| ENRICH hosts ON ip -``` - -Enrich with coordinator modeedit -ES|QL provides the enrich `_coordinator` mode to force ES|QL to execute the enrich -command on the querying cluster. This mode should be used when the enrich policy is -not available on the remote clusters or maintaining consistency of enrich indices -across clusters is challenging. -```esql -FROM my-index-000001,cluster_one:my-index-000001 -| ENRICH _coordinator:hosts ON ip -| SORT host_name -| LIMIT 10 -``` - -Enrich with the `_coordinator` mode usually increases inter-cluster data transfer and -workload on the querying cluster. -Enrich with remote modeedit -ES|QL also provides the enrich `_remote` mode to force ES|QL to execute the enrich -command independently on each fulfilling cluster where the target indices reside. -This mode is useful for managing different enrich data on each cluster, such as detailed -information of hosts for each region where the target (main) indices contain -log events from these hosts. -In the below example, the `hosts` enrich policy is required to exist on all -fulfilling clusters: the `querying` cluster (as local indices are included), -the remote cluster `cluster_one`, and `cluster_two`. -```esql -FROM my-index-000001,cluster_one:my-index-000001,cluster_two:my-index-000001 -| ENRICH _remote:hosts ON ip -| SORT host_name -| LIMIT 10 -``` - -A `_remote` enrich cannot be executed after a stats -command. The following example would result in an error: -```esql -FROM my-index-000001,cluster_one:my-index-000001,cluster_two:my-index-000001 -| STATS COUNT(*) BY ip -| ENRICH _remote:hosts ON ip -| SORT host_name -| LIMIT 10 -``` - -Multiple enrich commandsedit -You can include multiple enrich commands in the same query with different -modes. ES|QL will attempt to execute them accordingly. For example, this -query performs two enriches, first with the `hosts` policy on any cluster -and then with the `vendors` policy on the querying cluster. -```esql -FROM my-index-000001,cluster_one:my-index-000001,cluster_two:my-index-000001 -| ENRICH hosts ON ip -| ENRICH _coordinator:vendors ON os -| LIMIT 10 -``` - -A `_remote` enrich command can’t be executed after a `_coordinator` enrich -command. The following example would result in an error. -```esql -FROM my-index-000001,cluster_one:my-index-000001,cluster_two:my-index-000001 -| ENRICH _coordinator:hosts ON ip -| ENRICH _remote:vendors ON os -| LIMIT 10 -``` - -Excluding clusters or indices from ES|QL queryedit -To exclude an entire cluster, prefix the cluster alias with a minus sign in -the `FROM` command, for example: `-my_cluster:*`: -```esql -FROM my-index-000001,cluster*:my-index-000001,-cluster_three:* -| LIMIT 10 -``` - -To exclude a specific remote index, prefix the index with a minus sign in -the `FROM` command, such as `my_cluster:-my_index`: -```esql -FROM my-index-000001,cluster*:my-index-*,cluster_three:-my-index-000001 -| LIMIT 10 -``` - -Optional remote clustersedit -Cross-cluster search for ES|QL currently does not respect the `skip_unavailable` -setting. As a result, if a remote cluster specified in the request is -unavailable or failed, cross-cluster search for ES|QL queries will fail regardless of the setting. -We are actively working to align the behavior of cross-cluster search for ES|QL with other -cross-cluster search APIs. This includes providing detailed execution information for each cluster -in the response, such as execution time, selected target indices, and shards. -Query across clusters during an upgradeedit -You can still search a remote cluster while performing a -rolling upgrade on the local cluster. However, the local -coordinating node’s "upgrade from" and "upgrade to" version must be compatible -with the remote cluster’s gateway node. -Running multiple versions of Elasticsearch in the same cluster beyond the -duration of an upgrade is not supported. -For more information about upgrades, see -Upgrading Elasticsearch. diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_diff.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_diff.txt index b93f502498591..ef9ccdb30d44b 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_diff.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_diff.txt @@ -1,21 +1,33 @@ -DATE_DIFF - -Syntax -Parameters -unit -Time difference unit -startTimestamp -A string representing a start timestamp -endTimestamp -A string representing an end timestamp -DescriptionSubtracts the startTimestamp from the endTimestamp and returns the difference in multiples of unit. If startTimestamp is later than the endTimestamp, negative values are returned. -Note that while there is an overlap between the function’s supported units and -ES|QL’s supported time span literals, these sets are distinct and not -interchangeable. Similarly, the supported abbreviations are conveniently shared -with implementations of this function in other established products and not -necessarily common with the date-time nomenclature used by Elasticsearch.Supported types -Example +## DATE_DIFF + +The `DATE_DIFF` function subtracts the `startTimestamp` from the `endTimestamp` and returns the difference in multiples of a specified unit. If `startTimestamp` is later than the `endTimestamp`, negative values are returned. + +Note that while there is an overlap between the function’s supported units and ES|QL’s supported time span literals, these sets are distinct and not interchangeable. Similarly, the supported abbreviations are conveniently shared with implementations of this function in other established products and not necessarily common with the date-time nomenclature used by Elasticsearch. + +### Syntax + +`DATE_DIFF(unit, startTimestamp, endTimestamp)` + +#### Parameters + +- `unit`: Time difference unit +- `startTimestamp`: A string representing a start timestamp +- `endTimestamp`: A string representing an end timestamp + +### Examples + +Here are a couple of examples of how to use the `DATE_DIFF` function in ES|QL queries: + ```esql ROW date1 = TO_DATETIME("2023-12-02T11:00:00.000Z"), date2 = TO_DATETIME("2023-12-02T11:00:00.001Z") | EVAL dd_ms = DATE_DIFF("microseconds", date1, date2) ``` + +In this example, the `DATE_DIFF` function is used to calculate the difference in microseconds between two timestamps. + +```esql +ROW date1 = TO_DATETIME("2023-12-02T11:00:00.000Z"), date2 = TO_DATETIME("2023-12-03T11:00:00.000Z") +| EVAL dd_days = DATE_DIFF("days", date1, date2) +``` + +In this second example, the `DATE_DIFF` function is used to calculate the difference in days between two timestamps. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_extract.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_extract.txt index 0debd6f2eeb51..36c0272e3c479 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_extract.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_extract.txt @@ -1,20 +1,28 @@ -DATE_EXTRACT - -Syntax -Parameters -datePart -Part of the date to extract. Can be: aligned_day_of_week_in_month, aligned_day_of_week_in_year, aligned_week_of_month, aligned_week_of_year, ampm_of_day, clock_hour_of_ampm, clock_hour_of_day, day_of_month, day_of_week, day_of_year, epoch_day, era, hour_of_ampm, hour_of_day, instant_seconds, micro_of_day, micro_of_second, milli_of_day, milli_of_second, minute_of_day, minute_of_hour, month_of_year, nano_of_day, nano_of_second, offset_seconds, proleptic_month, second_of_day, second_of_minute, year, or year_of_era. Refer to java.time.temporal.ChronoField for a description of these values. If null, the function returns null. -date -Date expression. If null, the function returns null. -DescriptionExtracts parts of a date, like year, month, day, hour.Supported types -Examples +## DATE_EXTRACT + +The `DATE_EXTRACT` function is used to extract specific parts of a date, such as the year, month, day, or hour. + +### Syntax + +`DATE_EXTRACT(datePart, date)` + +#### Parameters + +- `datePart`: Part of the date to extract. Can be: `aligned_day_of_week_in_month`, `aligned_day_of_week_in_year`, `aligned_week_of_month`, `aligned_week_of_year`, `ampm_of_day`, `clock_hour_of_ampm`, `clock_hour_of_day`, `day_of_month`, `day_of_week`, `day_of_year`, `epoch_day`, `era`, `hour_of_ampm`, `hour_of_day`, `instant_seconds`, `micro_of_day`, `micro_of_second`, `milli_of_day`, `milli_of_second`, `minute_of_day`, `minute_of_hour`, `month_of_year`, `nano_of_day`, `nano_of_second`, `offset_seconds`, `proleptic_month`, `second_of_day`, `second_of_minute`, `year`, or `year_of_era`. Refer to `java.time.temporal.ChronoField` for a description of these values. If null, the function returns null. +- `date`: Date expression. If null, the function returns null. + +### Examples + +The following ES|QL query uses the `DATE_EXTRACT` function to extract the year from a date: + ```esql ROW date = DATE_PARSE("yyyy-MM-dd", "2022-05-06") | EVAL year = DATE_EXTRACT("year", date) ``` -Find all events that occurred outside of business hours (before 9 AM or after 5PM), on any given date: +This ES|QL query uses the `DATE_EXTRACT` function to find all events that occurred outside of business hours (before 9 AM or after 5 PM), on any given date: + ```esql FROM sample_data | WHERE DATE_EXTRACT("hour_of_day", @timestamp) < 9 AND DATE_EXTRACT("hour_of_day", @timestamp) >= 17 -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_format.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_format.txt index 481b9fed4695f..c2221c5add437 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_format.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_format.txt @@ -1,15 +1,32 @@ -DATE_FORMAT - -Syntax -Parameters -dateFormat -Date format (optional). If no format is specified, the yyyy-MM-dd'T'HH:mm:ss.SSSZ format is used. If null, the function returns null. -date -Date expression. If null, the function returns null. -DescriptionReturns a string representation of a date, in the provided format.Supported types -Example +## DATE_FORMAT + +The `DATE_FORMAT` function in ES|QL is used to return a string representation of a date, in the provided format. If no format is specified, the `yyyy-MM-dd'T'HH:mm:ss.SSSZ` format is used. + +### Syntax + +`DATE_FORMAT(dateFormat, date)` + +#### Parameters + +- `dateFormat`: Date format (optional). If no format is specified, the `yyyy-MM-dd'T'HH:mm:ss.SSSZ` format is used. If null, the function returns null. +- `date`: Date expression. If null, the function returns null. + +### Examples + +Here are a couple of examples of how you can use the `DATE_FORMAT` function in your ES|QL queries: + ```esql FROM employees | KEEP first_name, last_name, hire_date | EVAL hired = DATE_FORMAT("YYYY-MM-dd", hire_date) ``` + +In this example, the `DATE_FORMAT` function is used to format the `hire_date` field in the "YYYY-MM-dd" format. + +```esql +FROM logs-* +| WHERE @timestamp <= NOW() +| EVAL log_date = DATE_FORMAT("YYYY-MM-dd HH:mm:ss", @timestamp) +``` + +In this second example, the `DATE_FORMAT` function is used to format the `@timestamp` field in the "YYYY-MM-dd HH:mm:ss" format. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_parse.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_parse.txt index 98650dd05f73a..0eab64ed4fcf2 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_parse.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_parse.txt @@ -1,14 +1,30 @@ -DATE_PARSE - -Syntax -Parameters -datePattern -The date format. Refer to the DateTimeFormatter documentation for the syntax. If null, the function returns null. -dateString -Date expression as a string. If null or an empty string, the function returns null. -DescriptionReturns a date by parsing the second argument using the format specified in the first argument.Supported types -Example +## DATE_PARSE + +DATE_PARSE is a function in ES|QL that allows you to parse a date string using a specified format. This function is useful when you need to convert a string into a date format for further processing or analysis. + +### Syntax + +`DATE_PARSE(datePattern, dateString)` + +#### Parameters + +- `datePattern`: The date format. Refer to the DateTimeFormatter documentation for the syntax. If null, the function returns null. +- `dateString`: Date expression as a string. If null or an empty string, the function returns null. + +### Examples + +Here are a couple of examples of how you can use the DATE_PARSE function in ES|QL queries: + ```esql ROW date_string = "2022-05-06" | EVAL date = DATE_PARSE("yyyy-MM-dd", date_string) ``` + +In this example, the DATE_PARSE function is used to convert the string "2022-05-06" into a date format using the "yyyy-MM-dd" pattern. + +```esql +ROW date_string = "06-05-2022" +| EVAL date = DATE_PARSE("dd-MM-yyyy", date_string) +``` + +In this second example, the DATE_PARSE function is used to convert the string "06-05-2022" into a date format using the "dd-MM-yyyy" pattern. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_trunc.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_trunc.txt index 073ac87c7ab3b..5e8c1318fc2c3 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_trunc.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-date_trunc.txt @@ -1,21 +1,30 @@ -DATE_TRUNC - -Syntax -Parameters -interval -Interval; expressed using the timespan literal syntax. -date -Date expression -DescriptionRounds down a date to the closest interval.Supported types -Examples +## DATE_TRUNC + +The `DATE_TRUNC` function in ES|QL rounds down a date to the closest interval. This can be useful for creating date histograms or calculating rates over specific time intervals. + +### Syntax + +`DATE_TRUNC(interval, date)` + +#### Parameters + +- `interval`: Interval; expressed using the timespan literal syntax. +- `date`: Date expression + +### Examples + +Here are a couple of examples of how you can use the `DATE_TRUNC` function in ES|QL queries: + +1. To round down the hire date of employees to the closest year and keep the first name, last name, and hire date: + ```esql FROM employees | KEEP first_name, last_name, hire_date | EVAL year_hired = DATE_TRUNC(1 year, hire_date) ``` -Combine DATE_TRUNC with STATS ... BY to create date histograms. For -example, the number of hires per year: +2. To create a date histogram showing the number of hires per year: + ```esql FROM employees | EVAL year = DATE_TRUNC(1 year, hire_date) @@ -23,11 +32,12 @@ FROM employees | SORT year ``` -Or an hourly error rate: +3. To calculate an hourly error rate: + ```esql FROM sample_data | EVAL error = CASE(message LIKE "*error*", 1, 0) | EVAL hour = DATE_TRUNC(1 hour, @timestamp) -| STATS error_rate = AVG(error) by hour +| STATS error_rate = AVG(error) BY hour | SORT hour -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-dissect.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-dissect.txt index f323c2078a79b..ec764da51518b 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-dissect.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-dissect.txt @@ -1,30 +1,47 @@ -DISSECT - -Syntax -DISSECT input "pattern" [APPEND_SEPARATOR=""] -Parameters -input -The column that contains the string you want to structure. If the column has -multiple values, DISSECT will process each value. -pattern -A dissect pattern. - -A string used as the separator between appended values, when using the append modifier. -DescriptionDISSECT enables you to extract -structured data out of a string. DISSECT matches the string against a -delimiter-based pattern, and extracts the specified keys as columns.Refer to Process data with DISSECT for the syntax of dissect patterns.ExamplesThe following example parses a string that contains a timestamp, some text, and -an IP address: +## DISSECT + +The `DISSECT` command in ES|QL allows you to extract structured data from a string. It matches the string against a delimiter-based pattern and extracts the specified keys as columns. This can be particularly useful when you need to parse a string that contains multiple pieces of information, such as a timestamp, some text, and an IP address. + +### Syntax + +The syntax for the `DISSECT` command is as follows: + + +`DISSECT input "pattern" [APPEND_SEPARATOR=""]` + +Here, `input` is the column that contains the string you want to structure. If the column has multiple values, `DISSECT` will process each value. `pattern` is a dissect pattern that you want to match against the string. `` is an optional string used as the separator between appended values when using the append modifier. + +### Examples + +Here are some examples of how you can use the `DISSECT` command in ES|QL: + +**Example 1:** + ```esql ROW a = "2023-01-23T12:15:00.000Z - some text - 127.0.0.1" | DISSECT a "%{date} - %{msg} - %{ip}" | KEEP date, msg, ip ``` -By default, DISSECT outputs keyword string columns. To convert to another -type, use Type conversion functions: +In this example, the `DISSECT` command is used to parse a string that contains a timestamp, some text, and an IP address. The command matches the string against the pattern `"%{date} - %{msg} - %{ip}"` and extracts the date, message, and IP address as separate columns. + +**Example 2:** + ```esql ROW a = "2023-01-23T12:15:00.000Z - some text - 127.0.0.1" | DISSECT a "%{date} - %{msg} - %{ip}" | KEEP date, msg, ip | EVAL date = TO_DATETIME(date) ``` + +This example is similar to the first one, but it also includes a `TO_DATETIME` function to convert the `date` column to a datetime type. + +**Example 3:** + +```esql +ROW a = "John Doe - john.doe@example.com - 123 Main St" +| DISSECT a "%{name} - %{email} - %{address}" +| KEEP name, email, address +``` + +In this example, the `DISSECT` command is used to parse a string that contains a name, email address, and physical address. The command matches the string against the pattern `"%{name} - %{email} - %{address}"` and extracts the name, email, and address as separate columns. diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-drop.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-drop.txt index f84f9b9613de0..5484d69dd191e 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-drop.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-drop.txt @@ -1,19 +1,46 @@ -DROP +## DROP -Syntax +The `DROP` command in ES|QL is used to remove one or more columns from the data. This can be useful in scenarios where certain columns are not needed for further data processing or analysis. + +The command supports the use of wildcards, allowing for the removal of all columns that match a specific pattern. This can be particularly useful when dealing with large datasets with numerous columns. + +### Syntax + +The syntax for the `DROP` command is as follows: + +``` DROP columns -Parameters -columns -A comma-separated list of columns to remove. Supports wildcards. -DescriptionThe DROP processing command removes one or more columns.Examples +``` + +Here, `columns` is a comma-separated list of columns to be removed. Wildcards are supported. + +### Examples + +Here are some examples of how the `DROP` command can be used in ES|QL queries: + +1. Removing a single column: + ```esql FROM employees | DROP height ``` -Rather than specify each column by name, you can use wildcards to drop all -columns with a name that matches a pattern: +In this example, the `height` column is removed from the `employees` data. + +2. Removing multiple columns: + +```esql +FROM employees +| DROP height, weight, age +``` + +Here, the `height`, `weight`, and `age` columns are all removed from the `employees` data. + +3. Using wildcards to remove all columns that match a pattern: + ```esql FROM employees | DROP height* ``` + +In this example, all columns that start with `height` are removed from the `employees` data. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-e.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-e.txt index 48a4adf1d3186..10bb5d6cd667b 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-e.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-e.txt @@ -1,8 +1,19 @@ -E +## E + +The `E` function in ES|QL returns Euler's number. + +### Examples + +Here are a couple of examples of how you can use the `E` function in ES|QL queries: -Syntax -ParametersDescriptionReturns Euler’s number.Supported types -Example ```esql ROW E() ``` + +This query simply returns the Euler's number. + +```esql +ROW a = E() +``` + +This query assigns the Euler's number to a variable `a`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-ends_with.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-ends_with.txt new file mode 100644 index 0000000000000..0ea4ca64a5245 --- /dev/null +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-ends_with.txt @@ -0,0 +1,33 @@ +## ENDS_WITH + +The `ENDS_WITH` function in ES|QL is used to check if a keyword string ends with another string. It returns a boolean value indicating the result of this check. + +### Syntax + +The syntax for using the `ENDS_WITH` function is as follows: + +`ENDS_WITH(str, suffix)` + +#### Parameters + +- `str`: This is a string expression. If null, the function returns null. +- `suffix`: This is a string expression. If null, the function returns null. + +### Examples + +Here are a couple of examples showing how to use the `ENDS_WITH` function in ES|QL queries: + +```esql +FROM employees +| KEEP last_name +| EVAL ln_E = ENDS_WITH(last_name, "d") +``` + +In this example, the `ENDS_WITH` function is used to check if the `last_name` of employees ends with the letter "d". The result is stored in the `ln_E` field. + +```esql +FROM logs-* +| WHERE ENDS_WITH(file_path, ".log") +``` + +In this second example, the `ENDS_WITH` function is used in a `WHERE` clause to filter out logs that don't have a file path ending with ".log". \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-enrich.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-enrich.txt index 39b03a08f1c3d..c18a8cddbcb86 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-enrich.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-enrich.txt @@ -1,62 +1,50 @@ -ENRICH - -Syntax -ENRICH policy [ON match_field] [WITH [new_name1 = ]field1, [new_name2 = ]field2, ...] -Parameters -policy -The name of the enrich policy. You need to create -and execute the enrich policy first. -mode -The mode of the enrich command in cross cluster ES|QL. -See enrich across clusters. -match_field -The match field. ENRICH uses its value to look for records in the enrich -index. If not specified, the match will be performed on the column with the same -name as the match_field defined in the enrich policy. -fieldX -The enrich fields from the enrich index that are added to the result as new -columns. If a column with the same name as the enrich field already exists, the -existing column will be replaced by the new column. If not specified, each of -the enrich fields defined in the policy is added -new_nameX -Enables you to change the name of the column that’s added for each of the enrich -fields. Defaults to the enrich field name. -DescriptionENRICH enables you to add data from existing indices as new columns using an -enrich policy. Refer to Data enrichment for information about setting up a -policy. -Before you can use ENRICH, you need to create -and execute an enrich policy. -ExamplesThe following example uses the languages_policy enrich policy to add a new -column for each enrich field defined in the policy. The match is performed using -the match_field defined in the enrich policy and -requires that the input table has a column with the same name (language_code -in this example). ENRICH will look for records in the -enrich index based on the match field value. +## ENRICH + +The `ENRICH` command in ES|QL allows you to add data from existing indices as new columns using an enrich policy. This can be particularly useful when you need to supplement your query data with additional information stored in other indices. + +Before you can use `ENRICH`, you need to create and execute an enrich policy. Refer to the [Data enrichment](https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-enriching-data.html) documentation for information about setting up a policy. + +Please note that in case of name collisions, the newly created columns will override existing columns. + +### Syntax + +`ENRICH policy [ON match_field] [WITH [new_name1 = ]field1, [new_name2 = ]field2, ...]` + +#### Parameters + +- `policy`: The name of the enrich policy. You need to create and execute the enrich policy first. +- `match_field`: The match field. ENRICH uses its value to look for records in the enrich index. If not specified, the match will be performed on the column with the same name as the match_field defined in the enrich policy. +- `fieldX`: The enrich fields from the enrich index that are added to the result as new columns. If a column with the same name as the enrich field already exists, the existing column will be replaced by the new column. If not specified, each of the enrich fields defined in the policy is added. +- `new_nameX`: Enables you to change the name of the column that’s added for each of the enrich fields. Defaults to the enrich field name. + +### Examples + +The following examples showcase different usages of the `ENRICH` command: + +1. Using the `languages_policy` enrich policy to add a new column for each enrich field defined in the policy. The match is performed using the `match_field` defined in the enrich policy and requires that the input table has a column with the same name (`language_code` in this example). + ```esql ROW language_code = "1" | ENRICH languages_policy ``` -To use a column with a different name than the match_field defined in the -policy as the match field, use ON : +2. Using a column with a different name than the `match_field` defined in the policy as the match field: + ```esql ROW a = "1" | ENRICH languages_policy ON a ``` -By default, each of the enrich fields defined in the policy is added as a -column. To explicitly select the enrich fields that are added, use -WITH , , ...: +3. Explicitly selecting the enrich fields that are added using `WITH , , ...`: + ```esql ROW a = "1" | ENRICH languages_policy ON a WITH language_name ``` -You can rename the columns that are added using WITH new_name=: +4. Renaming the columns that are added using `WITH new_name=`: + ```esql ROW a = "1" | ENRICH languages_policy ON a WITH name = language_name -``` - -In case of name collisions, the newly created columns will override existing -columns. \ No newline at end of file +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-eval.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-eval.txt index 991fae551af1e..f98b4987a9e06 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-eval.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-eval.txt @@ -1,46 +1,44 @@ -EVAL - -Syntax -EVAL [column1 =] value1[, ..., [columnN =] valueN] -Parameters -columnX -The column name. -valueX -The value for the column. Can be a literal, an expression, or a -function. -DescriptionThe EVAL processing command enables you to append new columns with calculated -values. EVAL supports various functions for calculating values. Refer to -Functions for more information.Examples -```esql +## EVAL + +The `EVAL` command in ES|QL allows you to append new columns with calculated values to your data. It supports various functions for calculating these values. This command is particularly useful when you need to perform calculations on your data and store the results in new columns for further analysis or visualization. + +However, it's important to note that if the specified column already exists, the existing column will be dropped, and the new column will be appended to the table. + +### Examples + +Here are some examples of how you can use the `EVAL` command in ES|QL: + +1. Calculate the height of employees in feet and centimeters and store the results in new columns: + + ```esql FROM employees | SORT emp_no | KEEP first_name, last_name, height | EVAL height_feet = height * 3.281, height_cm = height * 100 ``` -If the specified column already exists, the existing column will be dropped, and -the new column will be appended to the table: -```esql +2. Overwrite an existing column with new calculated values: + + ```esql FROM employees | SORT emp_no | KEEP first_name, last_name, height | EVAL height = height * 3.281 ``` -Specifying the output column name is optional. If not specified, the new column -name is equal to the expression. The following query adds a column named -height*3.281: -```esql +3. Add a new column with a name that is equal to the expression: + + ```esql FROM employees | SORT emp_no | KEEP first_name, last_name, height | EVAL height * 3.281 ``` -Because this name contains special characters, it needs to be -quoted with backticks (`) when using it in subsequent commands: -```esql + Since this name contains special characters, it needs to be quoted with backticks (`) when using it in subsequent commands: + + ```esql FROM employees | EVAL height * 3.281 | STATS avg_height_feet = AVG(`height * 3.281`) -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-floor.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-floor.txt index d994fd9439fc4..7daabcc3954f3 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-floor.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-floor.txt @@ -1,16 +1,29 @@ -FLOOR - -Syntax -Parameters -number -Numeric expression. If null, the function returns null. -DescriptionRound a number down to the nearest integer. -This is a noop for long (including unsigned) and integer. -For double this picks the closest double value to the integer -similar to Math.floor. -Supported types -Example +## FLOOR + +The `FLOOR` function in ES|QL is used to round a number down to the nearest integer. This operation is a no-op for long (including unsigned) and integer types. For double types, this function picks the closest double value to the integer, similar to the `Math.floor` function in JavaScript. + +### Syntax + +`FLOOR(number)` + +#### Parameters + +- `number`: Numeric expression. If null, the function returns null. + +### Examples + +Here are a couple of examples of how to use the `FLOOR` function in ES|QL: + ```esql ROW a=1.8 -| EVAL a=FLOOR(a) +| EVAL a = FLOOR(a) +``` + +In this example, the `FLOOR` function is used to round down the value of `a` (1.8) to the nearest integer (1). + +```esql +ROW b=3.14159 +| EVAL b = FLOOR(b) ``` + +In this second example, the `FLOOR` function is used to round down the value of `b` (3.14159) to the nearest integer (3). \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-from.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-from.txt index 54f6b16211fb8..98548000a334e 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-from.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-from.txt @@ -1,63 +1,53 @@ -FROM +## FROM -Syntax -```esql -FROM index_pattern [METADATA fields] -``` - -Parameters -index_pattern -A list of indices, data streams or aliases. Supports wildcards and date math. -fields -A comma-separated list of metadata fields to retrieve. -DescriptionThe -```esql -FROM source command returns a table with data from a data stream, index, -``` +The `FROM` command in ES|QL is a source command that returns a table with data from a data stream, index, or alias. Each row in the resulting table represents a document, and each column corresponds to a field, which can be accessed by the name of that field. -or alias. Each row in the resulting table represents a document. Each column -corresponds to a field, and can be accessed by the name of that field. -By default, an ES|QL query without an explicit LIMIT uses an implicit -limit of 1000. This applies to -```esql -FROM too. A FROM command without LIMIT: -``` +By default, an ES|QL query without an explicit `LIMIT` uses an implicit limit of 1000. This applies to `FROM` too. For example, a `FROM` command without `LIMIT`: ```esql FROM employees ``` is executed as: + ```esql FROM employees | LIMIT 1000 ``` -Examples -```esql -FROM employees -``` +You can use date math to refer to indices, aliases and data streams, which can be useful for time series data. For example, to access today’s index: -You can use date math to refer to indices, aliases -and data streams. This can be useful for time series data, for example to access -today’s index: ```esql FROM ``` -Use comma-separated lists or wildcards to query multiple data streams, indices, -or aliases: +You can use comma-separated lists or wildcards to query multiple data streams, indices, or aliases: + ```esql FROM employees-00001,other-employees-* ``` -Use the format : to query data streams and indices -on remote clusters: +You can also use the format `:` to query data streams and indices on remote clusters: + ```esql FROM cluster_one:employees-00001,cluster_two:other-employees-* ``` -See using ES|QL across clusters.Use the optional METADATA directive to enable metadata fields: +The optional `METADATA` directive can be used to enable metadata fields: + ```esql FROM employees METADATA _id ``` + +### Syntax + +`FROM index_pattern [METADATA fields]` + +#### Parameters + +- `index_pattern`: A list of indices, data streams or aliases. Supports wildcards and date math. +- `fields`: A comma-separated list of metadata fields to retrieve. + +### Limitations + +Please note that the `FROM` command does not support querying time series data streams (TSDS). For more details on the limitations of ES|QL, refer to the [ES|QL limitations](https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-limitations.html) documentation. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-from_base64.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-from_base64.txt index c6a1f21e67090..7e7c6b8ee3ab7 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-from_base64.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-from_base64.txt @@ -1,10 +1,19 @@ -FROM_BASE64 - -Syntax -Parameters -string -A base64 string. -DescriptionDecode a base64 string.Supported types -Example -row a = "ZWxhc3RpYw==" -| eval d = from_base64(a) +## FROM_BASE64 + +FROM_BASE64 function decodes a base64 string. + +### Examples + +Here are a couple of examples of full ES|QL queries using the FROM_BASE64 function: + +Example 1: +```esql +ROW a = "ZWxhc3RpYw==" +| EVAL d = FROM_BASE64(a) +``` + +Example 2: +```esql +ROW b = "SGVsbG8gd29ybGQ=" +| EVAL e = FROM_BASE64(b) +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-functions-overview.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-functions-overview.txt deleted file mode 100644 index 637d66d3ff681..0000000000000 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-functions-overview.txt +++ /dev/null @@ -1,125 +0,0 @@ -Functions overview - - -Aggregate functions -AVG -COUNT -COUNT_DISTINCT -MAX -MEDIAN -MEDIAN_ABSOLUTE_DEVIATION -MIN -PERCENTILE -[preview] -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -ST_CENTROID_AGG -SUM -VALUES -Grouping functions -BUCKET -Conditional functions and expressions -CASE -COALESCE -GREATEST -LEAST -Date and time functions -DATE_DIFF -DATE_EXTRACT -DATE_FORMAT -DATE_PARSE -DATE_TRUNC -NOW -IP functions -CIDR_MATCH -Math functions -ABS -ACOS -ASIN -ATAN -ATAN2 -CEIL -COS -COSH -E -FLOOR -LOG -LOG10 -PI -POW -ROUND -SIGNUM -SIN -SINH -SQRT -TAN -TANH -TAU -Spatial functions -[preview] -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -ST_INTERSECTS -[preview] -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -ST_DISJOINT -[preview] -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -ST_CONTAINS -[preview] -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -ST_WITHIN -[preview] -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -ST_X -[preview] -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -ST_Y -String functions -CONCAT -ENDS_WITH -FROM_BASE64 -LEFT -LENGTH -LOCATE -LTRIM -REPLACE -RIGHT -RTRIM -SPLIT -STARTS_WITH -SUBSTRING -TO_BASE64 -TO_LOWER -TO_UPPER -TRIM -Type conversion functions -TO_BOOLEAN -TO_CARTESIANPOINT -TO_CARTESIANSHAPE -TO_DATETIME -TO_DEGREES -TO_DOUBLE -TO_GEOPOINT -TO_GEOSHAPE -TO_INTEGER -TO_IP -TO_LONG -TO_RADIANS -TO_STRING -[preview] -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -TO_UNSIGNED_LONG -TO_VERSION -Multi value functions -MV_AVG -MV_CONCAT -MV_COUNT -MV_DEDUPE -MV_FIRST -MV_LAST -MV_MAX -MV_MEDIAN -MV_MIN -MV_SORT -MV_SLICE -MV_SUM -MV_ZIP diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-greatest.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-greatest.txt index 740bb14a7c141..5ab87d292bea4 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-greatest.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-greatest.txt @@ -1,19 +1,30 @@ -GREATEST - -Syntax -Parameters -first -First of the columns to evaluate. -rest -The rest of the columns to evaluate. -DescriptionReturns the maximum value from multiple columns. This is similar to MV_MAX -except it is intended to run on multiple columns at once. -When run on keyword or text fields, this returns the last string - in alphabetical order. When run on boolean columns this will return - true if any values are true. -Supported types -Example +## GREATEST + +The `GREATEST` function in ES|QL returns the maximum value from multiple columns. This function is similar to `MV_MAX` but is intended to run on multiple columns at once. When run on keyword or text fields, this function returns the last string in alphabetical order. When run on boolean columns, this function will return true if any values are true. + +### Syntax + +`GREATEST(first, rest)` + +#### Parameters + +- `first`: First of the columns to evaluate. +- `rest`: The rest of the columns to evaluate. + +### Examples + +Here are a couple of examples of how to use the `GREATEST` function in ES|QL: + ```esql ROW a = 10, b = 20 | EVAL g = GREATEST(a, b) ``` + +In this example, the `GREATEST` function is used to find the maximum value between the columns `a` and `b`. + +```esql +ROW a = 10, b = 20, c = 30, d = 40 +| EVAL g = GREATEST(a, b, c, d) +``` + +In this example, the `GREATEST` function is used to find the maximum value among the columns `a`, `b`, `c`, and `d`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-grok.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-grok.txt index 4b940e5c2c7f1..9c5e1354e681c 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-grok.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-grok.txt @@ -1,36 +1,42 @@ -GROK - -Syntax -GROK input "pattern" -Parameters -input -The column that contains the string you want to structure. If the column has -multiple values, GROK will process each value. -pattern -A grok pattern. -DescriptionGROK enables you to extract -structured data out of a string. GROK matches the string against patterns, -based on regular expressions, and extracts the specified patterns as columns.Refer to Process data with GROK for the syntax of grok patterns.ExamplesThe following example parses a string that contains a timestamp, an IP address, -an email address, and a number: +## GROK + +The `GROK` command in ES|QL enables you to extract structured data out of a string. It matches the string against patterns, based on regular expressions, and extracts the specified patterns as columns. This can be particularly useful when you need to parse a string that contains multiple pieces of information, such as a timestamp, an IP address, an email address, and a number. + +### Limitations + +By default, `GROK` outputs keyword string columns. Integer (`int`) and float types can be converted by appending `:type` to the semantics in the pattern. For other type conversions, you need to use Type conversion functions. + +### Examples + +Here are some examples of how you can use the `GROK` command in ES|QL: + +**Example 1: Parsing a string with multiple pieces of information** + ```esql ROW a = "2023-01-23T12:15:00.000Z 127.0.0.1 some.email@foo.com 42" | GROK a "%{TIMESTAMP_ISO8601:date} %{IP:ip} %{EMAILADDRESS:email} %{NUMBER:num}" | KEEP date, ip, email, num ``` -By default, GROK outputs keyword string columns. int and float types can -be converted by appending :type to the semantics in the pattern. For example -{NUMBER:num:int}: +In this example, the `GROK` command is used to parse a string that contains a timestamp, an IP address, an email address, and a number. The `KEEP` command is then used to keep only the extracted date, IP, email, and number columns. + +**Example 2: Converting types with GROK** + ```esql ROW a = "2023-01-23T12:15:00.000Z 127.0.0.1 some.email@foo.com 42" | GROK a "%{TIMESTAMP_ISO8601:date} %{IP:ip} %{EMAILADDRESS:email} %{NUMBER:num:int}" | KEEP date, ip, email, num ``` -For other type conversions, use Type conversion functions: +In this example, the `GROK` command is used similarly to the first example, but with an additional `:int` appended to the `NUMBER` semantic in the pattern. This converts the extracted number to an integer type. + +**Example 3: Using type conversion functions with GROK** + ```esql ROW a = "2023-01-23T12:15:00.000Z 127.0.0.1 some.email@foo.com 42" | GROK a "%{TIMESTAMP_ISO8601:date} %{IP:ip} %{EMAILADDRESS:email} %{NUMBER:num:int}" | KEEP date, ip, email, num | EVAL date = TO_DATETIME(date) ``` + +In this example, the `GROK` command is used to parse a string and convert the extracted number to an integer type. Then, the `EVAL` command is used with the `TO_DATETIME` function to convert the extracted date string to a datetime type. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-keep.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-keep.txt index d1a3753abb26e..d51104612b7cb 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-keep.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-keep.txt @@ -1,52 +1,48 @@ -KEEP - -Syntax -KEEP columns -Parameters -columns -A comma-separated list of columns to keep. Supports wildcards. -DescriptionThe KEEP processing command enables you to specify what columns are returned -and the order in which they are returned.Precedence rules are applied when a field name matches multiple expressions. -Fields are added in the order they appear. If one field matches multiple expressions, the following precedence rules apply (from highest to lowest priority): -Complete field name (no wildcards) -Partial wildcard expressions (for example: fieldNam*) -Wildcard only (*) -If a field matches two expressions with the same precedence, the right-most expression wins.Refer to the examples for illustrations of these precedence rules.ExamplesThe columns are returned in the specified order: +## KEEP + +The `KEEP` command in ES|QL allows you to specify which columns are returned and the order in which they are returned. This can be particularly useful when you want to focus on specific data in your Elasticsearch indices and ignore the rest. + +The command supports wildcards, allowing you to match and return all columns with a name that fits a certain pattern. Precedence rules are applied when a field name matches multiple expressions. If a field matches two expressions with the same precedence, the right-most expression wins. + +### Limitations + +There are no known limitations for the `KEEP` command in ES|QL. + +### Examples + +Here are some examples of how you can use the `KEEP` command in ES|QL: + +1. Return specified columns in the order they are listed: + ```esql FROM employees | KEEP emp_no, first_name, last_name, height ``` -Rather than specify each column by name, you can use wildcards to return all -columns with a name that matches a pattern: +2. Use wildcards to return all columns with a name that matches a pattern: + ```esql FROM employees | KEEP h* ``` -The asterisk wildcard (*) by itself translates to all columns that do not -match the other arguments.This query will first return all columns with a name -that starts with h, followed by all other columns: +3. Use the asterisk wildcard by itself to return all columns that do not match the other arguments: + ```esql FROM employees | KEEP h*, * ``` -The following examples show how precedence rules work when a field name matches multiple expressions.Complete field name has precedence over wildcard expressions: -```esql -FROM employees -| KEEP first_name, last_name, first_name* -``` +4. Show how precedence rules work when a field name matches multiple expressions: -Wildcard expressions have the same priority, but last one wins (despite being less specific): ```esql FROM employees | KEEP first_name*, last_name, first_na* ``` -A simple wildcard expression * has the lowest precedence. -Output order is determined by the other arguments: +5. Use a simple wildcard expression `*` which has the lowest precedence: + ```esql FROM employees | KEEP *, first_name -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-kibana.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-kibana.txt deleted file mode 100644 index 798a9befd7647..0000000000000 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-kibana.txt +++ /dev/null @@ -1,158 +0,0 @@ - -Using ES|QL in Kibanaedit -You can use ES|QL in Kibana to query and aggregate your data, create -visualizations, and set up alerts. -This guide shows you how to use ES|QL in Kibana. To follow along with the -queries, load the "Sample web logs" sample data set by clicking Try sample -data from the Kibana Home, selecting Other sample data sets, and clicking Add -data on the Sample web logs card. -Get started with ES|QLedit -To get started with ES|QL in Discover, open the main menu and select -Discover. Next, from the Data views menu, select Try ES|QL. -The ability to select ES|QL from the Data views menu can be enabled and -disabled using the `discover:enableESQL` setting from -Advanced Settings. -The query baredit -After switching to ES|QL mode, the query bar shows a sample query. For example: -from kibana_sample_data_logs | limit 10 -Every query starts with a source command. In this query, the -source command is `FROM`. `FROM` retrieves data from data streams, indices, or -aliases. In this example, the data is retrieved from `kibana_sample_data_logs`. -A source command can be followed by one or more processing -commands. In this query, the processing command is `LIMIT`. `LIMIT` -limits the number of rows that are retrieved. -Click the help icon () to open the -in-product reference documentation for all commands and functions. -To make it easier to write queries, auto-complete offers suggestions with -possible commands and functions: -ES|QL keywords are case-insensitive. The following query is identical to the -previous one: -```esql -FROM kibana_sample_data_logs | LIMIT 10 -``` - -Expand the query baredit -For readability, you can put each processing command on a new line. The -following query is identical to the previous one: -```esql -FROM kibana_sample_data_logs -| LIMIT 10 -``` - -To make it easier to write multi-line queries, click the double-headed arrow -button () to expand the query -bar: -To return to a compact query bar, click the minimize editor button -(). -Warningsedit -A query may result in warnings, for example when querying an unsupported field -type. When that happens, a warning symbol is shown in the query bar. To see the -detailed warning, expand the query bar, and click warnings. -The results tableedit -For the example query, the results table shows 10 rows. Omitting the `LIMIT` -command, the results table defaults to up to 1000 rows. Using `LIMIT`, you can -increase the limit to up to 10,000 rows. -the 10,000 row limit only applies to the number of rows that are retrieved -by the query and displayed in Discover. Any query or aggregation runs on the -full data set. -Each row shows two columns for the example query: a column with the `@timestamp` -field and a column with the full document. To display specific fields from the -documents, use the `KEEP` command: -```esql -FROM kibana_sample_data_logs -| KEEP @timestamp, bytes, geo.dest -``` - -To display all fields as separate columns, use `KEEP *`: -```esql -FROM kibana_sample_data_logs -| KEEP * -``` - -The maximum number of columns in Discover is 50. If a query returns more -than 50 columns, Discover only shows the first 50. -Sortingedit -To sort on one of the columns, click the column name you want to sort on and -select the sort order. Note that this performs client-side sorting. It only -sorts the rows that were retrieved by the query, which may not be the full -dataset because of the (implicit) limit. To sort the full data set, use the -`SORT` command: -```esql -FROM kibana_sample_data_logs -| KEEP @timestamp, bytes, geo.dest -| SORT bytes DESC -``` - -Time filteringedit -To display data within a specified time range, use the -time filter. The time filter is only enabled -when the indices you’re querying have a field called `@timestamp`. -If your indices do not have a timestamp field called `@timestamp`, you can limit -the time range using the `WHERE` command and the `NOW` function. -For example, if the timestamp field is called `timestamp`, to query the last 15 -minutes of data: -```esql -FROM kibana_sample_data_logs -| WHERE timestamp > NOW() - 15minutes -``` - -Analyze and visualize dataedit -Between the query bar and the results table, Discover shows a date histogram -visualization. If the indices you’re querying do not contain an `@timestamp` -field, the histogram is not shown. -The visualization adapts to the query. A query’s nature determines the type of -visualization. For example, this query aggregates the total number of bytes per -destination country: -```esql -FROM kibana_sample_data_logs -| STATS total_bytes = SUM(bytes) BY geo.dest -| SORT total_bytes DESC -| LIMIT 3 -``` - -The resulting visualization is a bar chart showing the top 3 countries: -To change the visualization into another type, click the visualization type -dropdown: -To make other changes to the visualization, like the axes and colors, click the -pencil button (). This opens -an in-line editor: -You can save the visualization to a new or existing dashboard by clicking the -save button (). Once saved -to a dashboard, you can continue to make changes to visualization. Click the -options button in the top-right () and -select Edit ESQL visualization to open the in-line editor: -Create an enrich policyedit -The ES|QL `ENRICH` command enables you to enrich -your query dataset with fields from another dataset. Before you can use -`ENRICH`, you need to create and execute an enrich -policy. If a policy exists, it will be suggested by auto-complete. If not, -click Click to create to create one. -Next, you can enter a policy name, the policy type, source indices, and -optionally a query: -Click Next to select the match field and enrich fields: -Finally, click Create and execute. -Now, you can use the enrich policy in an ES|QL query: -Create an alerting ruleedit -You can use ES|QL queries to create alerts. From Discover, click Alerts and -select Create search threshold rule. This opens a panel that enables you to -create a rule using an ES|QL query. Next, you can test the query, add a -connector, and save the rule. -Limitationsedit -The user interface to filter data is not enabled when Discover is in ES|QL -mode. To filter data, write a query that uses the `WHERE` command -instead. -In ES|QL mode, clicking a field in the field list in Discover does not show -quick statistics for that field. -Discover shows no more than 10,000 rows. This limit only applies to the number -of rows that are retrieved by the query and displayed in Discover. Queries and -aggregations run on the full data set. -Discover shows no more than 50 columns. If a query returns -more than 50 columns, Discover only shows the first 50. -CSV export from Discover shows no more than 10,000 rows. This limit only applies to the number -of rows that are retrieved by the query and displayed in Discover. Queries and -aggregations run on the full data set. -Querying many indices at once without any filters can cause an error in -kibana which looks like `[esql] > Unexpected error from Elasticsearch: The -content length (536885793) is bigger than the maximum allowed string -(536870888)`. The response from ES|QL is too long. Use `DROP` or -`KEEP` to limit the number of fields returned. diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-least.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-least.txt index ee76f5a43ac0d..4c34db4d38e01 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-least.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-least.txt @@ -1,19 +1,30 @@ -LEAST - -Syntax -Parameters -first -First of the columns to evaluate. -rest -The rest of the columns to evaluate. -DescriptionReturns the minimum value from multiple columns. This is similar to -MV_MIN except it is intended to run on multiple columns at once. -When run on keyword or text fields, this returns the first string - in alphabetical order. When run on boolean columns this will return - false if any values are false. -Supported types -Example +## LEAST + +The `LEAST` function in ES|QL is used to return the minimum value from multiple columns. This function is similar to `MV_MIN` but is intended to run on multiple columns at once. + +### Syntax + +`LEAST(first, rest)` + +#### Parameters + +- `first`: The first column to evaluate. +- `rest`: The rest of the columns to evaluate. + +### Examples + +Here are a couple of examples of how to use the `LEAST` function in ES|QL: + ```esql ROW a = 10, b = 20 | EVAL l = LEAST(a, b) ``` + +In this example, the `LEAST` function is used to find the minimum value between the columns `a` and `b`. + +```esql +ROW a = 10, b = 20, c = 30, d = 40 +| EVAL l = LEAST(a, b, c, d) +``` + +In this second example, the `LEAST` function is used to find the minimum value among four columns: `a`, `b`, `c`, and `d`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-left.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-left.txt index 1aae39f111122..e62a50ae7a273 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-left.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-left.txt @@ -1,13 +1,20 @@ -LEFT - -Syntax -Parameters -string -The string from which to return a substring. -length -The number of characters to return. -DescriptionReturns the substring that extracts length chars from string starting from the left.Supported types -Example +## LEFT + +The `LEFT` function in ES|QL is used to extract a substring from a string, starting from the left. The number of characters to return is specified by the `length` parameter. + +### Syntax + +`LEFT(string, length)` + +#### Parameters + +- `string`: The string from which to return a substring. +- `length`: The number of characters to return. + +### Examples + +Here are a couple of examples of how to use the `LEFT` function in ES|QL: + ```esql FROM employees | KEEP last_name @@ -15,3 +22,12 @@ FROM employees | SORT last_name ASC | LIMIT 5 ``` + +In this example, the `LEFT` function is used to extract the first three characters from the `last_name` field of the `employees` index. The query then sorts the results in ascending order by `last_name` and limits the output to the first 5 records. + +```esql +FROM logs-* +| EVAL left_chars = LEFT(message, 10) +``` + +In this second example, the `LEFT` function is used to extract the first 10 characters from the `message` field of the `logs-*` index. The result is stored in the `left_chars` field. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-length.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-length.txt index e63ea02da87eb..8ed8bf3f31a2c 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-length.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-length.txt @@ -1,13 +1,29 @@ -LENGTH - -Syntax -Parameters -string -String expression. If null, the function returns null. -DescriptionReturns the character length of a string.Supported types -Example +## LENGTH + +The `LENGTH` function in ES|QL is used to return the character length of a string. + +### Syntax + +`LENGTH(string)` + +#### Parameters + +- `string`: This is a string expression. If null, the function returns null. + +### Examples + +Here are a couple of examples of how you can use the `LENGTH` function in ES|QL: + ```esql FROM employees -| KEEP first_name, last_name -| EVAL fn_length = LENGTH(first_name) +| EVAL name_length = LENGTH(first_name) +``` + +In this example, the `LENGTH` function is used to calculate the length of the `first_name` field for each record in the `employees` index. + +```esql +FROM logs-* +| EVAL message_length = LENGTH(message) ``` + +In this second example, the `LENGTH` function is used to calculate the length of the `message` field for each record in the `logs-*` index. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-limit.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-limit.txt index 5ee1f5fd6999d..4d0dce6fe6edd 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-limit.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-limit.txt @@ -1,26 +1,42 @@ -LIMIT - -Syntax -LIMIT max_number_of_rows -Parameters -max_number_of_rows -The maximum number of rows to return. -DescriptionThe LIMIT processing command enables you to limit the number of rows that are -returned. -Queries do not return more than 10,000 rows, regardless of the LIMIT command’s -value.This limit only applies to the number of rows that are retrieved by the query. -Queries and aggregations run on the full data set.To overcome this limitation: -Reduce the result set size by modifying the query to only return relevant -data. Use WHERE to select a smaller subset of the data. -Shift any post-query processing to the query itself. You can use the ES|QL -STATS ... BY command to aggregate data in the query. -The default and maximum limits can be changed using these dynamic cluster -settings: -esql.query.result_truncation_default_size -esql.query.result_truncation_max_size -Example -```esql +## LIMIT + +The `LIMIT` command in ES|QL is a processing command that allows you to limit the number of rows that are returned in a query. This can be particularly useful in scenarios where you only need a specific number of rows from a larger dataset. + +However, it's important to note that queries do not return more than 10,000 rows, regardless of the `LIMIT` command’s value. This limit only applies to the number of rows that are retrieved by the query. Queries and aggregations run on the full data set. + +To overcome this limitation, you can: + +- Reduce the result set size by modifying the query to only return relevant data. Use `WHERE` to select a smaller subset of the data. +- Shift any post-query processing to the query itself. You can use the ES|QL `STATS ... BY` command to aggregate data in the query. + +The default and maximum limits can be changed using these dynamic cluster settings: + +- `esql.query.result_truncation_default_size` +- `esql.query.result_truncation_max_size` + +### Examples + +Here are some examples of how you can use the `LIMIT` command in ES|QL: + +1. Limit the number of rows returned to 5, sorted by employee number in ascending order: + + ```esql FROM employees | SORT emp_no ASC | LIMIT 5 ``` + +2. Retrieve only the top 10 employees with the highest salary: + + ```esql +FROM employees +| SORT salary DESC +| LIMIT 10 +``` + +3. Get the first 100 rows from a logs data stream: + + ```esql +FROM logs-* +| LIMIT 100 +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-limitations.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-limitations.txt deleted file mode 100644 index 03c4cf1416eb6..0000000000000 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-limitations.txt +++ /dev/null @@ -1,166 +0,0 @@ - -You are looking at preliminary documentation for a future release. -Not what you want? See the -current release documentation. -Elastic Docs -›Elasticsearch Guide [master] -›ES|QL -« ES|QL language versions -ES|QL examples » -ES|QL limitationsedit -Result set size limitedit -By default, an ES|QL query returns up to 1000 rows. You can increase the number -of rows up to 10,000 using the `LIMIT` command. -Queries do not return more than 10,000 rows, regardless of the `LIMIT` command’s -value. -This limit only applies to the number of rows that are retrieved by the query. -Queries and aggregations run on the full data set. -To overcome this limitation: -Reduce the result set size by modifying the query to only return relevant -data. Use `WHERE` to select a smaller subset of the data. -Shift any post-query processing to the query itself. You can use the ES|QL -`STATS ... BY` command to aggregate data in the query. -The default and maximum limits can be changed using these dynamic cluster -settings: -`esql.query.result_truncation_default_size` -`esql.query.result_truncation_max_size` -Field typesedit -Supported typesedit -ES|QL currently supports the following field types: -`alias` -`boolean` -`date` -`double` (`float`, `half_float`, `scaled_float` are represented as `double`) -`ip` -`keyword` family including `keyword`, `constant_keyword`, and `wildcard` -`int` (`short` and `byte` are represented as `int`) -`long` -`null` -`text` -[preview] -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -`unsigned_long` -`version` -Spatial types -`geo_point` -`geo_shape` -`point` -`shape` -Unsupported typesedit -ES|QL does not yet support the following field types: -TSDB metrics -`counter` -`position` -`aggregate_metric_double` -Date/time -`date_nanos` -`date_range` -Other types -`binary` -`completion` -`dense_vector` -`double_range` -`flattened` -`float_range` -`histogram` -`integer_range` -`ip_range` -`long_range` -`nested` -`rank_feature` -`rank_features` -`search_as_you_type` -Querying a column with an unsupported type returns an error. If a column with an -unsupported type is not explicitly used in a query, it is returned with `null` -values, with the exception of nested fields. Nested fields are not returned at -all. -Limitations on supported typesedit -Some field types are not supported in all contexts: -Spatial types are not supported in the SORT processing command. -Specifying a column of one of these types as a sort parameter will result in an error: -`geo_point` -`geo_shape` -`cartesian_point` -`cartesian_shape` -_source availabilityedit -ES|QL does not support configurations where the -_source field is disabled. -[preview] -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -ES|QL’s support for synthetic `_source` -is currently experimental. -Full-text search is not supportededit -Because of the way ES|QL treats `text` values, -full-text search is not yet supported. Queries on `text` fields are like queries -on `keyword` fields: they are case-sensitive and need to match the full string. -For example, after indexing a field of type `text` with the value `Elasticsearch -query language`, the following `WHERE` clause does not match because the `LIKE` -operator is case-sensitive: -| WHERE field LIKE "elasticsearch query language" -The following `WHERE` clause does not match either, because the `LIKE` operator -tries to match the whole string: -| WHERE field LIKE "Elasticsearch" -As a workaround, use wildcards and regular expressions. For example: -| WHERE field RLIKE "[Ee]lasticsearch.*" -`text` fields behave like `keyword` fieldsedit -While ES|QL supports `text` fields, ES|QL does not treat these fields -like the Search API does. ES|QL queries do not query or aggregate the -analyzed string. Instead, an ES|QL query will try to get a `text` -field’s subfield of the keyword family type and query/aggregate -that. If it’s not possible to retrieve a `keyword` subfield, ES|QL will get the -string from a document’s `_source`. If the `_source` cannot be retrieved, for -example when using synthetic source, `null` is returned. -Note that ES|QL’s retrieval of `keyword` subfields may have unexpected -consequences. An ES|QL query on a `text` field is case-sensitive. Furthermore, -a subfield may have been mapped with a normalizer, which can -transform the original string. Or it may have been mapped with `ignore_above`, -which can truncate the string. None of these mapping operations are applied to -an ES|QL query, which may lead to false positives or negatives. -To avoid these issues, a best practice is to be explicit about the field that -you query, and query `keyword` sub-fields instead of `text` fields. -Time series data streams are not supportededit -ES|QL does not support querying time series data streams (TSDS). -Date math limitationsedit -Date math expressions work well when the leftmost expression is a datetime, for -example: -now() + 1 year - 2hour + ... -But using parentheses or putting the datetime to the right is not always supported yet. For example, the following expressions fail: -1year + 2hour + now() -now() + (1year + 2hour) -Date math does not allow subtracting two datetimes, for example: -now() - 2023-10-26 -Enrich limitationsedit -The ES|QL `ENRICH` command only supports enrich policies of type `match`. -Furthermore, `ENRICH` only supports enriching on a column of type `keyword`. -Dissect limitationsedit -The `DISSECT` command does not support reference keys. -Grok limitationsedit -The `GROK` command does not support configuring custom -patterns, or multiple patterns. The `GROK` command is not -subject to Grok watchdog settings. -Multivalue limitationsedit -ES|QL supports multivalued fields, but functions -return `null` when applied to a multivalued field, unless documented otherwise. -Work around this limitation by converting the field to single value with one of -the multivalue functions. -Timezone supportedit -ES|QL only supports the UTC timezone. -Kibana limitationsedit -The user interface to filter data is not enabled when Discover is in ES|QL -mode. To filter data, write a query that uses the `WHERE` command -instead. -In ES|QL mode, clicking a field in the field list in Discover does not show -quick statistics for that field. -Discover shows no more than 10,000 rows. This limit only applies to the number -of rows that are retrieved by the query and displayed in Discover. Queries and -aggregations run on the full data set. -Discover shows no more than 50 columns. If a query returns -more than 50 columns, Discover only shows the first 50. -CSV export from Discover shows no more than 10,000 rows. This limit only applies to the number -of rows that are retrieved by the query and displayed in Discover. Queries and -aggregations run on the full data set. -Querying many indices at once without any filters can cause an error in -kibana which looks like `[esql] > Unexpected error from Elasticsearch: The -content length (536885793) is bigger than the maximum allowed string -(536870888)`. The response from ES|QL is too long. Use `DROP` or -`KEEP` to limit the number of fields returned. diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-locate.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-locate.txt index 0c47550b219dc..605a287841440 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-locate.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-locate.txt @@ -1,14 +1,35 @@ -LOCATE - -Syntax -Parameters -string -An input string -substring -A substring to locate in the input string -start -The start index -DescriptionReturns an integer that indicates the position of a keyword substring within another stringSupported types -Example -row a = "hello" -| eval a_ll = locate(a, "ll") +## LOCATE + +LOCATE function in ES|QL returns an integer that indicates the position of a keyword substring within another string. + +### Syntax + +`LOCATE(string, substring, start)` + +#### Parameters + +- `string`: An input string +- `substring`: A substring to locate in the input string +- `start`: The start index + +### Examples + +Here are a couple of examples of how you can use the LOCATE function in ES|QL: + +Example 1: + +```esql +ROW a = "hello" +| EVAL a_ll = LOCATE(a, "ll") +``` + +In this example, the LOCATE function is used to find the position of the substring "ll" in the string "hello". The result would be `3` as "ll" starts at the third position in the string "hello". + +Example 2: + +```esql +ROW a = "Elasticsearch Query Language" +| EVAL a_ll = LOCATE(a, "Query", 5) +``` + +In this example, the LOCATE function is used to find the position of the substring "Query" in the string "Elasticsearch Query Language", starting from the fifth position. The result would be `14` as "Query" starts at the fourteenth position in the string "Elasticsearch Query Language". \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-log.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-log.txt index c3e97b9fe5fcf..69a19c5578f14 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-log.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-log.txt @@ -1,17 +1,30 @@ -LOG - -Syntax -Parameters -base -Base of logarithm. If null, the function returns null. If not provided, this function returns the natural logarithm (base e) of a value. -number -Numeric expression. If null, the function returns null. -DescriptionReturns the logarithm of a value to a base. The input can be any numeric value, the return value is always a double. Logs of zero, negative numbers, and base of one return null as well as a warning.Supported types -Examples +## LOG + +The `LOG` function in ES|QL returns the logarithm of a value to a base. The input can be any numeric value, and the return value is always a double. Logs of zero, negative numbers, and base of one return null as well as a warning. + +### Syntax + +`LOG(base, number)` + +#### Parameters + +- `base`: Base of logarithm. If null, the function returns null. If not provided, this function returns the natural logarithm (base e) of a value. +- `number`: Numeric expression. If null, the function returns null. + +### Examples + +Here are a couple of examples of full ES|QL queries using the `LOG` function: + ```esql ROW base = 2.0, value = 8.0 | EVAL s = LOG(base, value) ``` -row value = 100 -| EVAL s = LOG(value); +In this example, the `LOG` function is used to calculate the logarithm of `8.0` to the base `2.0`. + +```esql +ROW value = 100 +| EVAL s = LOG(value) +``` + +In this example, the `LOG` function is used to calculate the natural logarithm (base e) of `100` as no base is provided. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-log10.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-log10.txt index 5fbe4a94cd683..78a0b43a087a8 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-log10.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-log10.txt @@ -1,12 +1,21 @@ -LOG10 - -Syntax -Parameters -number -Numeric expression. If null, the function returns null. -DescriptionReturns the logarithm of a value to base 10. The input can be any numeric value, the return value is always a double. Logs of 0 and negative numbers return null as well as a warning.Supported types -Example +## LOG10 + +The `LOG10` function in ES|QL is used to calculate the logarithm of a value to the base 10. The input can be any numeric value and the return value is always a double. If the input is 0 or a negative number, the function returns null and a warning. + +### Examples + +Here are a couple of examples of how you can use the `LOG10` function in ES|QL queries: + ```esql ROW d = 1000.0 | EVAL s = LOG10(d) ``` + +In this example, the `LOG10` function is used to calculate the base 10 logarithm of the value 1000. The result is stored in the variable `s`. + +```esql +ROW d = 100.0 +| EVAL s = LOG10(d) +``` + +In this example, the `LOG10` function is used to calculate the base 10 logarithm of the value 100. The result is stored in the variable `s`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-lookup.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-lookup.txt new file mode 100644 index 0000000000000..46dc960ac1332 --- /dev/null +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-lookup.txt @@ -0,0 +1,82 @@ +## LOOKUP + +The `LOOKUP` command in ES|QL is a highly experimental feature that is currently only available in SNAPSHOT versions. This command is used to match values from the input against a table provided in the request, adding the other fields from the table to the output. + +### Use Cases and Limitations + +The `LOOKUP` command is particularly useful when you need to match and compare data from different sources or tables. It allows you to enrich your query results with additional data from a separate table based on matching fields. + +However, it's important to note that this command is still in the experimental stage and may not be fully stable or support all use cases. It's recommended to use this command in testing environments and not in production. + +### Examples + +Here are some examples of how to use the `LOOKUP` command in ES|QL: + +**Example 1:** + +``` +POST /_query?format=txt +{ + "query": """ + FROM library + | SORT page_count DESC + | KEEP name, author + | LOOKUP era ON author + | LIMIT 5 + """ + "tables": { + "era": { + "author:keyword": ["Frank Herbert", "Peter F. Hamilton", "Vernor Vinge", "Alastair Reynolds", "James S.A. Corey"], + "era:keyword" : [ "The New Wave", "Diamond", "Diamond", "Diamond", "Hadron"] + } + } +} +``` + +In this example, the `LOOKUP` command is used to match the `author` field from the `library` index with the `author` field in the `era` table. The matched data is then added to the output. + +**Example 2:** + +``` +POST /_query?format=txt +{ + "query": """ + FROM employees + | SORT salary DESC + | KEEP name, department + | LOOKUP departments ON department + | LIMIT 10 + """ + "tables": { + "departments": { + "department:keyword": ["Sales", "Marketing", "HR", "Engineering"], + "location:keyword" : [ "New York", "San Francisco", "London", "Berlin"] + } + } +} +``` + +In this example, the `LOOKUP` command is used to match the `department` field from the `employees` index with the `department` field in the `departments` table. The matched data is then added to the output. + +**Example 3:** + +``` +POST /_query?format=txt +{ + "query": """ + FROM orders + | SORT order_date DESC + | KEEP order_id, product_id + | LOOKUP products ON product_id + | LIMIT 20 + """ + "tables": { + "products": { + "product_id:keyword": ["P001", "P002", "P003", "P004"], + "product_name:keyword" : [ "Product 1", "Product 2", "Product 3", "Product 4"] + } + } +} +``` + +In this example, the `LOOKUP` command is used to match the `product_id` field from the `orders` index with the `product_id` field in the `products` table. The matched data is then added to the output. diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-ltrim.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-ltrim.txt index e98ccd0ce65d1..9a6b50d702a98 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-ltrim.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-ltrim.txt @@ -1,15 +1,29 @@ -LTRIM - -Syntax -Parameters -string -String expression. If null, the function returns null. -DescriptionRemoves leading whitespaces from a string.Supported types -Example +## LTRIM + +The `LTRIM` function is used to remove leading whitespaces from a string. + +### Syntax + +`LTRIM(string)` + +#### Parameters + +- `string`: String expression. If null, the function returns null. + +### Examples + +Here are a couple of examples of how you can use the `LTRIM` function in ES|QL queries: + +```esql +ROW message = " some text " +| EVAL trimmed_message = LTRIM(message) +``` + +In this example, the `LTRIM` function is used to remove the leading whitespaces from the `message` string. + ```esql -ROW message = " some text ", color = " red " -| EVAL message = LTRIM(message) -| EVAL color = LTRIM(color) -| EVAL message = CONCAT("'", message, "'") -| EVAL color = CONCAT("'", color, "'") +ROW color = " red " +| EVAL trimmed_color = LTRIM(color) ``` + +In this example, the `LTRIM` function is used to remove the leading whitespace from the `color` string. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-max.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-max.txt index fe4522d77d692..32dad967274d8 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-max.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-max.txt @@ -1,20 +1,29 @@ -MAX - -Syntax -MAX(expression) -Parameters -expression -Expression from which to return the maximum value. -DescriptionReturns the maximum value of a numeric expression.Example +## MAX + +The `MAX` function in ES|QL is used to return the maximum value of a numeric expression. + +### Syntax + +`MAX(expression)` + +#### Parameters + +`expression`: The expression from which to return the maximum value. + +### Examples + +Here are a couple of examples of how the `MAX` function can be used in ES|QL queries: + +1. To find the maximum value in the `languages` field from the `employees` index, you can use the following query: + ```esql FROM employees | STATS MAX(languages) ``` -The expression can use inline functions. For example, to calculate the maximum -over an average of a multivalued column, use MV_AVG to first average the -multiple values per row, and use the result with the MAX function: +2. The `MAX` function can also be used with inline functions. For instance, to calculate the maximum over an average of a multivalued column, you can first use the `MV_AVG` function to average the multiple values per row, and then use the result with the `MAX` function: + ```esql FROM employees | STATS max_avg_salary_change = MAX(MV_AVG(salary_change)) -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-median.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-median.txt index 6f365afd34aec..b4a8810047d41 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-median.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-median.txt @@ -1,25 +1,21 @@ -MEDIAN +## MEDIAN + +The `MEDIAN` function in ES|QL returns the value that is greater than half of all values and less than half of all values, also known as the 50% PERCENTILE. Like `PERCENTILE`, `MEDIAN` is usually approximate and is also non-deterministic. This means you can get slightly different results using the same data. + +### Examples + +Here are a couple of examples of how to use the `MEDIAN` function in ES|QL: -Syntax -MEDIAN(expression) -Parameters -expression -Expression from which to return the median value. -DescriptionReturns the value that is greater than half of all values and less than half of -all values, also known as the 50% PERCENTILE. -Like PERCENTILE, MEDIAN is usually approximate. -MEDIAN is also non-deterministic. -This means you can get slightly different results using the same data. -Example ```esql FROM employees | STATS MEDIAN(salary), PERCENTILE(salary, 50) ``` -The expression can use inline functions. For example, to calculate the median of -the maximum values of a multivalued column, first use MV_MAX to get the -maximum value per row, and use the result with the MEDIAN function: +In this example, the `MEDIAN` function is used to calculate the median salary from the `employees` data stream or index. + ```esql FROM employees | STATS median_max_salary_change = MEDIAN(MV_MAX(salary_change)) ``` + +In this example, the `MEDIAN` function is used in conjunction with the `MV_MAX` function to calculate the median of the maximum values of a multivalued column `salary_change`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-median_absolute_deviation.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-median_absolute_deviation.txt index 0098c9ca8f3eb..1ef1732218e11 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-median_absolute_deviation.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-median_absolute_deviation.txt @@ -1,31 +1,33 @@ -MEDIAN_ABSOLUTE_DEVIATION - -Syntax -MEDIAN_ABSOLUTE_DEVIATION(expression) -Parameters -expression -Expression from which to return the median absolute deviation. -DescriptionReturns the median absolute deviation, a measure of variability. It is a robust -statistic, meaning that it is useful for describing data that may have outliers, -or may not be normally distributed. For such data it can be more descriptive -than standard deviation.It is calculated as the median of each data point’s deviation from the median of -the entire sample. That is, for a random variable X, the median absolute -deviation is median(|median(X) - X|). -Like PERCENTILE, MEDIAN_ABSOLUTE_DEVIATION is - usually approximate. -MEDIAN_ABSOLUTE_DEVIATION is also non-deterministic. -This means you can get slightly different results using the same data. -Example +## MEDIAN_ABSOLUTE_DEVIATION + +The `MEDIAN_ABSOLUTE_DEVIATION` function is a robust statistic that is useful for describing data that may have outliers or may not be normally distributed. It provides a measure of variability by calculating the median of each data point’s deviation from the median of the entire sample. + +This function is usually approximate and non-deterministic, meaning that you can get slightly different results using the same data. + +### Syntax: + +`MEDIAN_ABSOLUTE_DEVIATION(expression)` + +#### Parameters: + +- `expression`: Expression from which to return the median absolute deviation. + +### Examples: + +Here is an example of a complete ES|QL query using the `MEDIAN_ABSOLUTE_DEVIATION` function: + ```esql FROM employees | STATS MEDIAN(salary), MEDIAN_ABSOLUTE_DEVIATION(salary) ``` -The expression can use inline functions. For example, to calculate the the -median absolute deviation of the maximum values of a multivalued column, first -use MV_MAX to get the maximum value per row, and use the result with the -MEDIAN_ABSOLUTE_DEVIATION function: +In this query, the `MEDIAN_ABSOLUTE_DEVIATION` function is used to calculate the median absolute deviation of the `salary` field for the `employees` index. + +The `MEDIAN_ABSOLUTE_DEVIATION` function can also be used with inline functions. Here is an example where it is used with the `MV_MAX` function to calculate the median absolute deviation of the maximum values of a multivalued column: + ```esql FROM employees | STATS m_a_d_max_salary_change = MEDIAN_ABSOLUTE_DEVIATION(MV_MAX(salary_change)) ``` + +In this query, the `MV_MAX` function is first used to get the maximum value per row of the `salary_change` field. The result is then used with the `MEDIAN_ABSOLUTE_DEVIATION` function to calculate the median absolute deviation. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-min.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-min.txt index 7b205f00e0784..737a21bb6cd99 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-min.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-min.txt @@ -1,20 +1,29 @@ -MIN - -Syntax -MIN(expression) -Parameters -expression -Expression from which to return the minimum value. -DescriptionReturns the minimum value of a numeric expression.Example +## MIN + +The `MIN` function in ES|QL is used to return the minimum value of a numeric expression. + +### Syntax: + +`MIN(expression)` + +#### Parameters: + +`expression`: The expression from which to return the minimum value. + +### Examples: + +Here are a couple of examples of how you can use the `MIN` function in ES|QL: + +1. To find the minimum value of a field, you can use the `MIN` function directly. For example, the following query returns the minimum value of the `languages` field from the `employees` index: + ```esql FROM employees | STATS MIN(languages) ``` -The expression can use inline functions. For example, to calculate the minimum -over an average of a multivalued column, use MV_AVG to first average the -multiple values per row, and use the result with the MIN function: +2. You can also use the `MIN` function with other functions like `MV_AVG` to perform more complex calculations. For example, the following query calculates the average of a multivalued column `salary_change` for each row, and then finds the minimum of these averages: + ```esql FROM employees | STATS min_avg_salary_change = MIN(MV_AVG(salary_change)) -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_avg.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_avg.txt index 7959297c1cb23..1dcdf012ef0db 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_avg.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_avg.txt @@ -1,12 +1,29 @@ -MV_AVG - -Syntax -Parameters -number -Multivalue expression. -DescriptionConverts a multivalued field into a single valued field containing the average of all of the values.Supported types -Example +## MV_AVG + +The `MV_AVG` function in ES|QL converts a multivalued field into a single valued field containing the average of all of the values. + +### Syntax + +`MV_AVG(number)` + +#### Parameters + +`number`: Multivalue expression. + +### Examples + +Here are a couple of examples of how you can use the `MV_AVG` function in your ES|QL queries: + ```esql ROW a=[3, 5, 1, 6] | EVAL avg_a = MV_AVG(a) ``` + +In this example, the `MV_AVG` function is used to calculate the average of the values in the multivalued field `a`. + +```esql +ROW b=[10, 20, 30, 40] +| EVAL avg_b = MV_AVG(b) +``` + +In this second example, the `MV_AVG` function is used to calculate the average of the values in the multivalued field `b`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_concat.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_concat.txt index d8768bc34bdef..f2699a0ac7a87 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_concat.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_concat.txt @@ -1,20 +1,23 @@ -MV_CONCAT - -Syntax -Parameters -string -Multivalue expression. -delim -Delimiter. -DescriptionConverts a multivalued string expression into a single valued column containing the concatenation of all values separated by a delimiter.Supported types -Examples +## MV_CONCAT + +The `MV_CONCAT` function in ES|QL converts a multivalued string expression into a single valued column. It does this by concatenating all values separated by a specified delimiter. + +### Examples + +Here are a couple of examples of how you can use the `MV_CONCAT` function in your ES|QL queries: + ```esql ROW a=["foo", "zoo", "bar"] | EVAL j = MV_CONCAT(a, ", ") ``` -To concat non-string columns, call TO_STRING first: +In this example, the `MV_CONCAT` function is used to concatenate the values in the array `a` with a comma separator. The result is a single string `"foo, zoo, bar"`. + +If you need to concatenate non-string columns, you can use the `TO_STRING` function first: + ```esql ROW a=[10, 9, 8] | EVAL j = MV_CONCAT(TO_STRING(a), ", ") ``` + +In this case, the numeric values in the array `a` are first converted to strings using the `TO_STRING` function. Then, the `MV_CONCAT` function concatenates these string values with a comma separator. The result is a single string `"10, 9, 8"`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_count.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_count.txt index 2cc68fafc5b4d..1ba65c3d81fbf 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_count.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_count.txt @@ -1,12 +1,29 @@ -MV_COUNT - -Syntax -Parameters -field -Multivalue expression. -DescriptionConverts a multivalued expression into a single valued column containing a count of the number of values.Supported types -Example +## MV_COUNT + +The `MV_COUNT` function in ES|QL is used to convert a multivalued expression into a single valued column containing a count of the number of values. + +### Syntax + +The syntax for using the `MV_COUNT` function is as follows: + +`MV_COUNT(field)` + +Here, `field` is a multivalue expression. + +### Examples + +Here are a couple of examples demonstrating the use of the `MV_COUNT` function: + ```esql ROW a=["foo", "zoo", "bar"] | EVAL count_a = MV_COUNT(a) ``` + +In this example, the `MV_COUNT` function is used to count the number of values in the array `["foo", "zoo", "bar"]`, and the result is stored in the `count_a` column. + +```esql +ROW b=[1, 2, 3, 4, 5] +| EVAL count_b = MV_COUNT(b) +``` + +In this second example, the `MV_COUNT` function is used to count the number of values in the array `[1, 2, 3, 4, 5]`, and the result is stored in the `count_b` column. diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_dedupe.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_dedupe.txt index d9bd25a64e6e1..32726e09767dd 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_dedupe.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_dedupe.txt @@ -1,14 +1,29 @@ -MV_DEDUPE - -Syntax -Parameters -field -Multivalue expression. -DescriptionRemove duplicate values from a multivalued field. -MV_DEDUPE may, but won’t always, sort the values in the column. -Supported types -Example +## MV_DEDUPE + +The `MV_DEDUPE` function is used to remove duplicate values from a multivalued field. It's important to note that while `MV_DEDUPE` may sort the values in the column, it's not guaranteed to always do so. + +### Syntax + +`MV_DEDUPE(field)` + +#### Parameters + +- `field`: Multivalue expression. + +### Examples + +Here are a couple of examples of how you can use the `MV_DEDUPE` function in your ES|QL queries: + ```esql ROW a=["foo", "foo", "bar", "foo"] | EVAL dedupe_a = MV_DEDUPE(a) ``` + +In this example, the `MV_DEDUPE` function is used to remove duplicate values from the multivalued field `a`. The resulting `dedupe_a` field will contain the values `["foo", "bar"]`. + +```esql +ROW b=["apple", "banana", "apple", "orange", "banana"] +| EVAL dedupe_b = MV_DEDUPE(b) +``` + +In this second example, the `MV_DEDUPE` function is used to remove duplicate values from the multivalued field `b`. The resulting `dedupe_b` field will contain the values `["apple", "banana", "orange"]`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_expand.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_expand.txt index a50b54d5940fa..9a3195a115713 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_expand.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_expand.txt @@ -1,15 +1,41 @@ -MV_EXPAND +## MV_EXPAND +The `MV_EXPAND` command in ES|QL is a processing command that expands multivalued columns into one row per value, duplicating other columns. This command is particularly useful when dealing with data that contains multivalued fields and you want to create a separate row for each value in the multivalued field. -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -Syntax -MV_EXPAND column -Parameters -column +This functionality is currently in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + +### Syntax + +`MV_EXPAND column` + +#### Parameters + +`column` The multivalued column to expand. -DescriptionThe MV_EXPAND processing command expands multivalued columns into one row per -value, duplicating other columns.Example + +### Examples + +Here are some examples of how you can use the `MV_EXPAND` command in ES|QL: + +1. Expanding a multivalued column 'a': + ```esql -ROW a=[1,2,3], b="b", j=["a","b"] +ROW a=[1,2,3], b="b" | MV_EXPAND a ``` + +2. Expanding a multivalued column 'languages': + +```esql +FROM employees +| MV_EXPAND languages +``` + +3. Expanding a multivalued column 'tags': + +```esql +FROM blog_posts +| MV_EXPAND tags +``` + +In each of these examples, the `MV_EXPAND` command creates a new row for each value in the specified multivalued column. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_first.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_first.txt index bcae6e967243c..fc901d41319e8 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_first.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_first.txt @@ -1,12 +1,31 @@ -MV_FIRST - -Syntax -Parameters -field -Multivalue expression. -DescriptionConverts a multivalued expression into a single valued column containing the first value. This is most useful when reading from a function that emits multivalued columns in a known order like SPLIT. The order that multivalued fields are read from underlying storage is not guaranteed. It is frequently ascending, but don’t rely on that. If you need the minimum value use MV_MIN instead of MV_FIRST. MV_MIN has optimizations for sorted values so there isn’t a performance benefit to MV_FIRST.Supported types -Example +## MV_FIRST + +The `MV_FIRST` function in ES|QL is used to convert a multivalued expression into a single valued column containing the first value. This function is most useful when reading from a function that emits multivalued columns in a known order like `SPLIT`. + +It's important to note that the order that multivalued fields are read from underlying storage is not guaranteed. It is frequently ascending, but this should not be relied upon. If you need the minimum value, use `MV_MIN` instead of `MV_FIRST`. `MV_MIN` has optimizations for sorted values so there isn’t a performance benefit to `MV_FIRST`. + +### Syntax: + +`MV_FIRST(field)` + +#### Parameters: + +- `field`: Multivalue expression. + +### Examples: + +Here are a couple of examples of how you can use the `MV_FIRST` function in your ES|QL queries: + ```esql ROW a="foo;bar;baz" | EVAL first_a = MV_FIRST(SPLIT(a, ";")) ``` + +In this example, the `SPLIT` function is used to split the string "foo;bar;baz" into a multivalued field. The `MV_FIRST` function is then used to select the first value from this multivalued field. + +```esql +ROW numbers=[10, 20, 30, 40, 50] +| EVAL first_num = MV_FIRST(numbers) +``` + +In this second example, the `MV_FIRST` function is used to select the first value from the multivalued field "numbers". \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_last.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_last.txt index f75c9c429f802..2abfbb5a65ee1 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_last.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_last.txt @@ -1,12 +1,23 @@ -MV_LAST - -Syntax -Parameters -field -Multivalue expression. -DescriptionConverts a multivalue expression into a single valued column containing the last value. This is most useful when reading from a function that emits multivalued columns in a known order like SPLIT. The order that multivalued fields are read from underlying storage is not guaranteed. It is frequently ascending, but don’t rely on that. If you need the maximum value use MV_MAX instead of MV_LAST. MV_MAX has optimizations for sorted values so there isn’t a performance benefit to MV_LAST.Supported types -Example +## MV_LAST + +The `MV_LAST` function in ES|QL is used to convert a multivalue expression into a single valued column containing the last value. This function is most useful when reading from a function that emits multivalued columns in a known order like `SPLIT`. + +It's important to note that the order that multivalued fields are read from underlying storage is not guaranteed. It is frequently ascending, but this should not be relied upon. If you need the maximum value, it is recommended to use `MV_MAX` instead of `MV_LAST`. `MV_MAX` has optimizations for sorted values so there isn’t a performance benefit to `MV_LAST`. + +### Examples + +Here are a couple of examples of how you can use the `MV_LAST` function in your ES|QL queries: + ```esql ROW a="foo;bar;baz" | EVAL last_a = MV_LAST(SPLIT(a, ";")) ``` + +In this example, the `SPLIT` function is used to split the string "foo;bar;baz" into a multivalue expression. The `MV_LAST` function is then used to select the last value from this multivalue expression. + +```esql +ROW numbers="1;2;3;4;5" +| EVAL last_number = MV_LAST(SPLIT(numbers, ";")) +``` + +In this second example, the `SPLIT` function is used to split the string "1;2;3;4;5" into a multivalue expression. The `MV_LAST` function is then used to select the last value from this multivalue expression. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_max.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_max.txt index cdcf2ee986d3d..709a1e1b747c5 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_max.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_max.txt @@ -1,18 +1,23 @@ -MV_MAX - -Syntax -Parameters -field -Multivalue expression. -DescriptionConverts a multivalued expression into a single valued column containing the maximum value.Supported types -Examples +## MV_MAX + +The `MV_MAX` function in ES|QL is used to convert a multivalued expression into a single valued column containing the maximum value. This function can be used with any column type, including keyword columns. In the case of keyword columns, it picks the last string, comparing their utf-8 representation byte by byte. + +### Examples + +Here are a couple of examples of how you can use the `MV_MAX` function in ES|QL: + +1. To find the maximum value in a multivalued numeric field: + ```esql ROW a=[3, 5, 1] | EVAL max_a = MV_MAX(a) ``` -It can be used by any column type, including keyword columns. In that case it picks the last string, comparing their utf-8 representation byte by byte: +2. To find the last string in a multivalued keyword field: + ```esql ROW a=["foo", "zoo", "bar"] | EVAL max_a = MV_MAX(a) ``` + +In both examples, the `MV_MAX` function is used to find the maximum value in the multivalued field `a`. The result is stored in the new field `max_a`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_median.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_median.txt index fa4c9ba343753..5b66fa243c009 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_median.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_median.txt @@ -1,18 +1,29 @@ -MV_MEDIAN - -Syntax -Parameters -number -Multivalue expression. -DescriptionConverts a multivalued field into a single valued field containing the median value.Supported types -Examples +## MV_MEDIAN + +The `MV_MEDIAN` function in ES|QL converts a multivalued field into a single valued field containing the median value. If the row has an even number of values for a column, the result will be the average of the middle two entries. If the column is not floating point, the average rounds down. + +### Syntax + +`MV_MEDIAN(number)` + +#### Parameters + +`number`: Multivalue expression. + +### Examples + +Here are a couple of examples of how you can use the `MV_MEDIAN` function in ES|QL queries: + ```esql ROW a=[3, 5, 1] | EVAL median_a = MV_MEDIAN(a) ``` -If the row has an even number of values for a column, the result will be the average of the middle two entries. If the column is not floating point, the average rounds down: +In this example, the `MV_MEDIAN` function calculates the median of the values in the `a` array, which are `[3, 5, 1]`. The median value is `3`. + ```esql ROW a=[3, 7, 1, 6] | EVAL median_a = MV_MEDIAN(a) ``` + +In this example, the `MV_MEDIAN` function calculates the median of the values in the `a` array, which are `[3, 7, 1, 6]`. Since there is an even number of values, the function calculates the average of the middle two entries, which results in `4`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_min.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_min.txt index c4c18f40fe494..aff39c9ddbba7 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_min.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_min.txt @@ -1,18 +1,21 @@ -MV_MIN +## MV_MIN + +The `MV_MIN` function in ES|QL is used to convert a multivalued expression into a single valued column containing the minimum value. This function can be used with any column type, including keyword columns. In the case of keyword columns, it picks the first string, comparing their utf-8 representation byte by byte. + +### Examples + +Here are a couple of examples of how to use the `MV_MIN` function in ES|QL: -Syntax -Parameters -field -Multivalue expression. -DescriptionConverts a multivalued expression into a single valued column containing the minimum value.Supported types -Examples ```esql ROW a=[2, 1] | EVAL min_a = MV_MIN(a) ``` -It can be used by any column type, including keyword columns. In that case, it picks the first string, comparing their utf-8 representation byte by byte: +In this example, the `MV_MIN` function is used to find the minimum value in the array `[2, 1]`. The result is stored in the `min_a` column. + ```esql ROW a=["foo", "bar"] | EVAL min_a = MV_MIN(a) ``` + +In this example, the `MV_MIN` function is used to find the minimum value in the array `["foo", "bar"]`. Since these are string values, the function compares their utf-8 representation byte by byte. The result is stored in the `min_a` column. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_slice.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_slice.txt index 9443842f6405c..12e98a93550c1 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_slice.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_slice.txt @@ -1,16 +1,31 @@ -MV_SLICE - -Syntax -Parameters -field -Multivalue expression. If null, the function returns null. -start -Start position. If null, the function returns null. The start argument can be negative. An index of -1 is used to specify the last value in the list. -end -End position(included). Optional; if omitted, the position at start is returned. The end argument can be negative. An index of -1 is used to specify the last value in the list. -DescriptionReturns a subset of the multivalued field using the start and end index values.Supported types -Examples +## MV_SLICE + +MV_SLICE is a function in ES|QL that returns a subset of a multivalued field using the start and end index values. + +### Syntax + +`MV_SLICE(field, start, end)` + +#### Parameters + +- `field`: Multivalue expression. If null, the function returns null. +- `start`: Start position. If null, the function returns null. The start argument can be negative. An index of -1 is used to specify the last value in the list. +- `end`: End position(included). Optional; if omitted, the position at start is returned. The end argument can be negative. An index of -1 is used to specify the last value in the list. + +### Examples + +Here are a couple of examples of how to use the MV_SLICE function in ES|QL: + +```esql row a = [1, 2, 2, 3] | eval a1 = mv_slice(a, 1), a2 = mv_slice(a, 2, 3) +``` + +In this example, the MV_SLICE function is used to get subsets of the multivalued field `a`. The subsets are stored in the new fields `a1` and `a2`. + +```esql row a = [1, 2, 2, 3] | eval a1 = mv_slice(a, -2), a2 = mv_slice(a, -3, -1) +``` + +In this example, the MV_SLICE function is used with negative start and end positions to get subsets of the multivalued field `a` from the end of the list. The subsets are stored in the new fields `a1` and `a2`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_sort.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_sort.txt index a49382a25c9c9..41480eb81afa1 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_sort.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_sort.txt @@ -1,14 +1,30 @@ -MV_SORT - -Syntax -Parameters -field -Multivalue expression. If null, the function returns null. -order -Sort order. The valid options are ASC and DESC, the default is ASC. -DescriptionSorts a multivalued field in lexicographical order.Supported types -Example +## MV_SORT + +The `MV_SORT` function is used to sort a multivalued field in lexicographical order. + +### Syntax + +`MV_SORT(field, order)` + +#### Parameters + +- `field`: A multivalue expression. If null, the function returns null. +- `order`: Sort order. The valid options are `ASC` and `DESC`, the default is `ASC`. + +### Examples + +Here are a couple of examples of how you can use the `MV_SORT` function in ES|QL queries: + ```esql ROW a = [4, 2, -3, 2] -| EVAL sa = mv_sort(a), sd = mv_sort(a, "DESC") +| EVAL sa = MV_SORT(a) ``` + +In this example, the `MV_SORT` function is used to sort the values in the `a` field in ascending order. + +```esql +ROW a = [4, 2, -3, 2] +| EVAL sd = MV_SORT(a, "DESC") +``` + +In this example, the `MV_SORT` function is used to sort the values in the `a` field in descending order. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_sum.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_sum.txt index 92bbcfebd66cd..d5476aedffa4a 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_sum.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_sum.txt @@ -1,12 +1,29 @@ -MV_SUM - -Syntax -Parameters -number -Multivalue expression. -DescriptionConverts a multivalued field into a single valued field containing the sum of all of the values.Supported types -Example +## MV_SUM + +The `MV_SUM` function in ES|QL is used to convert a multivalued field into a single valued field containing the sum of all the values. + +### Syntax + +`MV_SUM(number)` + +#### Parameters + +- `number`: A multivalued expression. + +### Examples + +Here are a couple of examples of how you can use the `MV_SUM` function in ES|QL: + ```esql ROW a=[3, 5, 6] | EVAL sum_a = MV_SUM(a) ``` + +In this example, the `MV_SUM` function is used to calculate the sum of the values in the multivalued field `a`. + +```esql +ROW b=[10, 20, 30, 40] +| EVAL sum_b = MV_SUM(b) +``` + +In this second example, the `MV_SUM` function is used to calculate the sum of the values in the multivalued field `b`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_zip.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_zip.txt index ea21096428b19..f5028c4207da9 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_zip.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-mv_zip.txt @@ -1,17 +1,33 @@ -MV_ZIP - -Syntax -Parameters -string1 -Multivalue expression. -string2 -Multivalue expression. -delim -Delimiter. Optional; if omitted, , is used as a default delimiter. -DescriptionCombines the values from two multivalued fields with a delimiter that joins them together.Supported types -Example +## MV_ZIP + +The `MV_ZIP` function in ES|QL combines the values from two multivalued fields with a delimiter that joins them together. + +### Syntax + +`MV_ZIP(string1, string2, delim)` + +#### Parameters + +- `string1`: Multivalue expression. +- `string2`: Multivalue expression. +- `delim`: Delimiter. Optional; if omitted, `,` is used as a default delimiter. + +### Examples + +Here are a couple of examples of how you can use the `MV_ZIP` function in your ES|QL queries: + ```esql ROW a = ["x", "y", "z"], b = ["1", "2"] -| EVAL c = mv_zip(a, b, "-") +| EVAL c = MV_ZIP(a, b, "-") | KEEP a, b, c ``` + +In this example, the `MV_ZIP` function is used to combine the values from the `a` and `b` fields with a `-` delimiter. The result is stored in the `c` field. + +```esql +ROW a = ["apple", "banana", "cherry"], b = ["red", "yellow", "red"] +| EVAL fruit_color = MV_ZIP(a, b, " is ") +| KEEP a, b, fruit_color +``` + +In this second example, the `MV_ZIP` function is used to combine the values from the `a` and `b` fields with ` is ` as the delimiter. The result is stored in the `fruit_color` field. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-now.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-now.txt index e6b885f2907f2..632e698e7008a 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-now.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-now.txt @@ -1,14 +1,20 @@ -NOW +## NOW + +The `NOW` function in ES|QL returns the current date and time. + +### Examples + +Here are a couple of examples of how you can use the `NOW` function in ES|QL queries: + +1. To get the current date and time, you can use the `NOW` function in a `ROW` command: -Syntax -NOW() -DescriptionReturns current date and time.Example ```esql ROW current_date = NOW() ``` -To retrieve logs from the last hour: +2. To retrieve logs from the last hour, you can use the `NOW` function in a `WHERE` clause: + ```esql FROM sample_data | WHERE @timestamp > NOW() - 1 hour -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-operators-overview.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-operators-overview.txt deleted file mode 100644 index bfaaac6b16597..0000000000000 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-operators-overview.txt +++ /dev/null @@ -1,12 +0,0 @@ -Operators overview - - -Operators -Binary operators -Unary operators -Logical operators -IS NULL and IS NOT NULL predicates -Cast (::) -IN -LIKE -RLIKE diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-operators.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-operators.txt index a54a212800d4b..e6d88e78993b4 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-operators.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-operators.txt @@ -1,191 +1,170 @@ -CIDR_MATCH -CIDR_MATCH +# ES|QL Operators -Syntax -Parameters -ip -IP address of type ip (both IPv4 and IPv6 are supported). -blockX -CIDR block to test the IP against. -DescriptionReturns true if the provided IP is contained in one of the provided CIDR blocks.Supported types -Example -```esql -FROM hosts -| WHERE CIDR_MATCH(ip1, "127.0.0.2/32", "127.0.0.3/32") -| KEEP card, host, ip0, ip1 -``` +ES|QL supports a variety of operators that can be used in queries. These operators can be categorized into binary operators, unary operators, logical operators, and others. -ENDS_WITH -ENDS_WITH +## Binary Operators -Syntax -Parameters -str -String expression. If null, the function returns null. -suffix -String expression. If null, the function returns null. -DescriptionReturns a boolean that indicates whether a keyword string ends with another string.Supported types -Example -```esql -FROM employees -| KEEP last_name -| EVAL ln_E = ENDS_WITH(last_name, "d") -``` +Binary operators in ES|QL include equality, inequality, less than, less than or equal to, greater than, greater than or equal to, add, subtract, multiply, divide, and modulus. + +### Equality -STARTS_WITH -STARTS_WITH +The equality operator (`==`) checks if two values are equal. -Syntax -Parameters -str -String expression. If null, the function returns null. -prefix -String expression. If null, the function returns null. -DescriptionReturns a boolean that indicates whether a keyword string starts with another string.Supported types -Example ```esql FROM employees -| KEEP last_name -| EVAL ln_S = STARTS_WITH(last_name, "B") +| WHERE first_name == "John" ``` -Binary operators -Binary operators - +### Inequality -Equality -Equality +The inequality operator (`!=`) checks if two values are not equal. +```esql +FROM employees +| WHERE salary != 50000 +``` -Supported types:Supported types +### Less Than -Inequality != -Inequality != +The less than operator (`<`) checks if one value is less than another. +```esql +FROM employees +| WHERE age < 30 +``` -Supported types:Supported types +### Less Than or Equal To -Less than < -Less than < +The less than or equal to operator (`<=`) checks if one value is less than or equal to another. +```esql +FROM employees +| WHERE years_of_experience <= 5 +``` -Supported types +### Greater Than -Less than or equal to <= -Less than or equal to <= +The greater than operator (`>`) checks if one value is greater than another. +```esql +FROM employees +| WHERE salary > 50000 +``` -Supported types +### Greater Than or Equal To -Greater than > -Greater than > +The greater than or equal to operator (`>=`) checks if one value is greater than or equal to another. +```esql +FROM employees +| WHERE age >= 30 +``` -Supported types +### Add -Greater than or equal to >= -Greater than or equal to >= +The add operator (`+`) adds two values together. +```esql +FROM employees +| EVAL total_compensation = salary + bonus +``` -Supported types +### Subtract -Add + -Add + +The subtract operator (`-`) subtracts one value from another. +```esql +FROM employees +| EVAL years_until_retirement = 65 - age +``` -Supported types +### Multiply -Subtract - -Subtract - +The multiply operator (`*`) multiplies two values. +```esql +FROM employees +| EVAL yearly_bonus = monthly_bonus * 12 +``` -Supported types +### Divide -Multiply * -Multiply * +The divide operator (`/`) divides one value by another. +```esql +FROM employees +| EVAL hourly_wage = salary / 2080 +``` -Supported types +### Modulus -Divide / -Divide / +The modulus operator (`%`) returns the remainder of a division operation. +```esql +FROM employees +| EVAL odd_or_even = employee_id % 2 +``` -Supported types +## Unary Operators -Modulus % -Modulus % +ES|QL supports one unary operator, negation (`-`), which negates a value. +```esql +FROM employees +| EVAL negative_salary = -salary +``` -Supported types +## Logical Operators -Unary operators -Unary operators +ES|QL supports the logical operators `AND`, `OR`, and `NOT`. -The only unary operators is negation (-): -Supported types:Supported types +```esql +FROM employees +| WHERE salary > 50000 AND years_of_experience <= 5 +``` -Logical operators -Logical operators +## Other Operators -The following logical operators are supported: -AND -OR -NOT +### IS NULL and IS NOT NULL -IS NULL and IS NOT NULL predicates -IS NULL and IS NOT NULL predicates +The `IS NULL` and `IS NOT NULL` predicates check if a value is null or not null, respectively. -For NULL comparison, use the IS NULL and IS NOT NULL predicates: ```esql FROM employees | WHERE birth_date IS NULL -| KEEP first_name, last_name -| SORT first_name -| LIMIT 3 ``` +### Cast (::) + +The `::` operator provides a convenient alternative syntax to the `TO_` conversion functions. + ```esql -FROM employees -| WHERE is_rehired IS NOT NULL -| STATS COUNT(emp_no) +ROW ver = CONCAT(("0"::INT + 1)::STRING, ".2.3")::VERSION ``` -IN -IN +### IN + +The `IN` operator checks if a field or expression equals an element in a list of literals, fields, or expressions. -The IN operator allows testing whether a field or expression equals -an element in a list of literals, fields or expressions: ```esql ROW a = 1, b = 4, c = 3 | WHERE c-a IN (3, b / 2, a) ``` -LIKE -LIKE +### LIKE + +The `LIKE` operator filters data based on string patterns using wildcards. -Use LIKE to filter data based on string patterns using wildcards. LIKE -usually acts on a field placed on the left-hand side of the operator, but it can -also act on a constant (literal) expression. The right-hand side of the operator -represents the pattern.The following wildcard characters are supported: -* matches zero or more characters. -? matches one character. -Supported types ```esql FROM employees | WHERE first_name LIKE "?b*" -| KEEP first_name, last_name ``` -RLIKE -RLIKE +### RLIKE + +The `RLIKE` operator filters data based on string patterns using regular expressions. -Use RLIKE to filter data based on string patterns using using -regular expressions. RLIKE usually acts on a field placed on -the left-hand side of the operator, but it can also act on a constant (literal) -expression. The right-hand side of the operator represents the pattern.Supported types ```esql FROM employees | WHERE first_name RLIKE ".leja.*" -| KEEP first_name, last_name -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-overview.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-overview.txt index f72514ae5ea81..36036e92ea093 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-overview.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-overview.txt @@ -1,44 +1,52 @@ +# Elasticsearch Query Language (ES|QL) -ES|QLedit -The Elasticsearch Query Language (ES|QL) provides a powerful way to filter, transform, -and analyze data stored in Elasticsearch, and in the future in other runtimes. It is -designed to be easy to learn and use, by end users, SRE teams, application -developers, and administrators. -Users can author ES|QL queries to find specific events, perform statistical -analysis, and generate visualizations. It supports a wide range of commands and -functions that enable users to perform various data operations, such as -filtering, aggregation, time-series analysis, and more. -The Elasticsearch Query Language (ES|QL) makes use of "pipes" (|) to manipulate and -transform data in a step-by-step fashion. This approach allows users to compose -a series of operations, where the output of one operation becomes the input for -the next, enabling complex data transformations and analysis. -The ES|QL Compute Engineedit -ES|QL is more than a language: it represents a significant investment in new -compute capabilities within Elasticsearch. To achieve both the functional and performance -requirements for ES|QL, it was necessary to build an entirely new compute -architecture. ES|QL search, aggregation, and transformation functions are -directly executed within Elasticsearch itself. Query expressions are not -transpiled to Query DSL for execution. This approach allows ES|QL to be -extremely performant and versatile. -The new ES|QL execution engine was designed with performance in mind — it -operates on blocks at a time instead of per row, targets vectorization and cache -locality, and embraces specialization and multi-threading. It is a separate -component from the existing Elasticsearch aggregation framework with different -performance characteristics. -The ES|QL documentation is organized in these sections: -Getting started -A tutorial to help you get started with ES|QL. -ES|QL reference -Reference documentation for the ES|QL syntax, -commands, and functions and -operators. Information about working with metadata -fields and multivalued fields. And guidance for -data processing with DISSECT and -GROK and data enrichment with ENRICH. -Using ES|QL -An overview of using the REST API, Using ES|QL in Kibana, -Using ES|QL in Elastic Security, Using ES|QL across clusters, and Task management. -Limitations -The current limitations of ES|QL. -Examples -A few examples of what you can do with ES|QL. +The Elasticsearch Query Language (ES|QL) is a powerful language designed to filter, transform, and analyze data stored in Elasticsearch. It is designed to be user-friendly and can be used by end users, SRE teams, application developers, and administrators. + +Users can author ES|QL queries to find specific events, perform statistical analysis, and generate visualizations. It supports a wide range of commands and functions that enable users to perform various data operations, such as filtering, aggregation, time-series analysis, and more. + +ES|QL uses "pipes" (|) to manipulate and transform data in a step-by-step fashion. This approach allows users to compose a series of operations, where the output of one operation becomes the input for the next, enabling complex data transformations and analysis. + +## ES|QL Compute Engine + +ES|QL is more than just a language. It represents a significant investment in new compute capabilities within Elasticsearch. To achieve both the functional and performance requirements for ES|QL, a new compute architecture was built. ES|QL search, aggregation, and transformation functions are directly executed within Elasticsearch itself. Query expressions are not transpiled to Query DSL for execution. This approach allows ES|QL to be extremely performant and versatile. + +The new ES|QL execution engine was designed with performance in mind. It operates on blocks at a time instead of per row, targets vectorization and cache locality, and embraces specialization and multi-threading. It is a separate component from the existing Elasticsearch aggregation framework with different performance characteristics. + +## Limitations + +There are some known limitations to ES|QL: + +- ES|QL only supports the UTC timezone. +- Full-text search is not yet supported. +- ES|QL does not support querying time series data streams (TSDS). +- Date math expressions work well when the leftmost expression is a datetime, but using parentheses or putting the datetime to the right is not always supported yet. +- ES|QL does not support configurations where the _source field is disabled. + +## Using ES|QL + +ES|QL can be used through the REST API, in Kibana, in Elastic Security, and across clusters. + +### REST API + +You can use the REST API to execute ES|QL queries. Here's an example of how to use the REST API: + +``` +POST /_query +{ + "query": """ + FROM library + | EVAL year = DATE_TRUNC(1 YEARS, release_date) + | STATS MAX(page_count) BY year + | SORT year + | LIMIT 5 + """ +} +``` + +### Kibana + +In Kibana, ES|QL can be used to query and aggregate your data, create visualizations, and set up alerts. However, there are some limitations when using ES|QL in Kibana. For example, the user interface to filter data is not enabled when Discover is in ES|QL mode. To filter data, you need to write a query that uses the `WHERE` command instead. + +### Cross Cluster + +ES|QL also supports executing a single query across multiple clusters. This can be useful for querying data from different geographical locations or separate Elasticsearch clusters. diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-percentile.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-percentile.txt index cc2b5e01297a0..0057bd045ffac 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-percentile.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-percentile.txt @@ -1,50 +1,34 @@ -PERCENTILE - -Syntax -PERCENTILE(expression, percentile) -Parameters -expression -Expression from which to return a percentile. -percentile -A constant numeric expression. -DescriptionReturns the value at which a certain percentage of observed values occur. For -example, the 95th percentile is the value which is greater than 95% of the -observed values and the 50th percentile is the MEDIAN.Example +## PERCENTILE + +The `PERCENTILE` function in ES|QL returns the value at which a certain percentage of observed values occur. For example, the 95th percentile is the value which is greater than 95% of the observed values and the 50th percentile is the median. + +### Syntax + +`PERCENTILE(expression, percentile)` + +#### Parameters + +- `expression`: Expression from which to return a percentile. +- `percentile`: A constant numeric expression. + +### Examples + +Here are a couple of examples of how to use the `PERCENTILE` function in ES|QL: + ```esql FROM employees -| STATS p0 = PERCENTILE(salary, 0) - , p50 = PERCENTILE(salary, 50) - , p99 = PERCENTILE(salary, 99) +| STATS p0 = PERCENTILE(salary, 0), p50 = PERCENTILE(salary, 50), p99 = PERCENTILE(salary, 99) ``` -The expression can use inline functions. For example, to calculate a percentile -of the maximum values of a multivalued column, first use MV_MAX to get the -maximum value per row, and use the result with the PERCENTILE function: +In this example, the `PERCENTILE` function is used to calculate the 0th, 50th, and 99th percentiles of the `salary` field in the `employees` index. + ```esql FROM employees | STATS p80_max_salary_change = PERCENTILE(MV_MAX(salary_change), 80) ``` -PERCENTILE is (usually) approximateeditThere are many different algorithms to calculate percentiles. The naive -implementation simply stores all the values in a sorted array. To find the 50th -percentile, you simply find the value that is at my_array[count(my_array) * 0.5].Clearly, the naive implementation does not scale — the sorted array grows -linearly with the number of values in your dataset. To calculate percentiles -across potentially billions of values in an Elasticsearch cluster, approximate -percentiles are calculated.The algorithm used by the percentile metric is called TDigest (introduced by -Ted Dunning in -Computing Accurate Quantiles using T-Digests).When using this metric, there are a few guidelines to keep in mind: -Accuracy is proportional to q(1-q). This means that extreme percentiles (e.g. 99%) -are more accurate than less extreme percentiles, such as the median -For small sets of values, percentiles are highly accurate (and potentially -100% accurate if the data is small enough). -As the quantity of values in a bucket grows, the algorithm begins to approximate -the percentiles. It is effectively trading accuracy for memory savings. The -exact level of inaccuracy is difficult to generalize, since it depends on your -data distribution and volume of data being aggregated -The following chart shows the relative error on a uniform distribution depending -on the number of collected values and the requested percentile:It shows how precision is better for extreme percentiles. The reason why error diminishes -for large number of values is that the law of large numbers makes the distribution of -values more and more uniform and the t-digest tree can do a better job at summarizing -it. It would not be the case on more skewed distributions. -PERCENTILE is also non-deterministic. -This means you can get slightly different results using the same data. +In this example, the `PERCENTILE` function is used in conjunction with the `MV_MAX` function to calculate the 80th percentile of the maximum values of the `salary_change` field in the `employees` index. + +### Note + +The `PERCENTILE` function is usually approximate. There are many different algorithms to calculate percentiles and the naive implementation does not scale. To calculate percentiles across potentially billions of values in an Elasticsearch cluster, approximate percentiles are calculated using the TDigest algorithm. This means you can get slightly different results using the same data. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-pi.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-pi.txt index ce7d06fa069ae..b62f6e50831c0 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-pi.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-pi.txt @@ -1,8 +1,20 @@ -PI +## PI + +The `PI` function in ES|QL returns the mathematical constant Pi, which is the ratio of a circle's circumference to its diameter. + +### Examples + +Here are a couple of examples of how you can use the `PI` function in ES|QL queries: -Syntax -ParametersDescriptionReturns Pi, the ratio of a circle’s circumference to its diameter.Supported types -Example ```esql ROW PI() ``` + +In this example, the `PI` function is used to simply return the value of Pi. + +```esql +FROM employees +| EVAL circle_area = PI() * POW(radius, 2) +``` + +In this second example, the `PI` function is used in a calculation to determine the area of a circle, given the radius stored in the `radius` field of the `employees` index. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-pow.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-pow.txt index add982840c5ec..7107b2f715aa3 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-pow.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-pow.txt @@ -1,23 +1,21 @@ -POW +## POW + +The `POW` function in ES|QL returns the value of a base raised to the power of an exponent. It takes two numeric expressions as parameters: the base and the exponent. If either of these parameters is null, the function will return null. It's important to note that it is still possible to overflow a double result here; in that case, null will be returned. + +### Examples + +Here are a couple of examples of full ES|QL queries using the `POW` function: + +1. This query calculates the result of 2.0 raised to the power of 2: -Syntax -Parameters -base -Numeric expression for the base. If null, the function returns null. -exponent -Numeric expression for the exponent. If null, the function returns null. -DescriptionReturns the value of base raised to the power of exponent. -It is still possible to overflow a double result here; in that case, null will be returned. -Supported types -Examples ```esql ROW base = 2.0, exponent = 2 | EVAL result = POW(base, exponent) ``` -The exponent can be a fraction, which is similar to performing a root. -For example, the exponent of 0.5 will give the square root of the base: +2. This query calculates the square root of 4 by raising 4 to the power of 0.5: + ```esql ROW base = 4, exponent = 0.5 | EVAL s = POW(base, exponent) -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-processing-commands.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-processing-commands.txt deleted file mode 100644 index c55ef6a7f29ed..0000000000000 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-processing-commands.txt +++ /dev/null @@ -1,19 +0,0 @@ -Processing commands - -ES|QL processing commands change an input table by adding, removing, or changing -rows and columns. -ES|QL supports these processing commands: -DISSECT -DROP -ENRICH -EVAL -GROK -KEEP -LIMIT -[preview] -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -MV_EXPAND -RENAME -SORT -STATS ... BY -WHERE diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-rename.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-rename.txt index 496db07019b7c..5275d2f2c846c 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-rename.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-rename.txt @@ -1,23 +1,46 @@ -RENAME +## RENAME -Syntax +The `RENAME` command in ES|QL is used to rename one or more columns in a table. If a column with the new name already exists, it will be replaced by the new column. This command can be useful in scenarios where you want to make column names more descriptive or to conform to a certain naming convention. + +However, it's important to note that if a column with the new name already exists, it will be replaced by the new column. Therefore, caution should be exercised to avoid unintentionally overwriting existing columns. + +### Syntax + +``` RENAME old_name1 AS new_name1[, ..., old_nameN AS new_nameN] -Parameters -old_nameX -The name of a column you want to rename. -new_nameX -The new name of the column. -DescriptionThe RENAME processing command renames one or more columns. If a column with -the new name already exists, it will be replaced by the new column.Examples -```esql +``` + +#### Parameters + +- `old_nameX`: The name of a column you want to rename. +- `new_nameX`: The new name of the column. + +### Examples + +Here are some examples of how the `RENAME` command can be used in ES|QL queries: + +1. Renaming a single column: + + ```esql FROM employees | KEEP first_name, last_name, still_hired -| RENAME still_hired AS employed +| RENAME still_hired AS employed ``` -Multiple columns can be renamed with a single RENAME command: -```esql +2. Renaming multiple columns with a single `RENAME` command: + + ```esql FROM employees | KEEP first_name, last_name | RENAME first_name AS fn, last_name AS ln ``` + +3. Renaming a column and using the new name in a subsequent command: + + ```esql +FROM employees +| RENAME salary AS annual_income +| WHERE annual_income > 50000 +``` + +In the third example, after renaming the `salary` column to `annual_income`, we can use the new column name in subsequent commands in the query. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-repeat.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-repeat.txt new file mode 100644 index 0000000000000..8face87f51dff --- /dev/null +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-repeat.txt @@ -0,0 +1,30 @@ +## REPEAT + +The `REPEAT` function in ES|QL is used to construct a string by concatenating a given string with itself a specified number of times. + +### Syntax + +`REPEAT(string, number)` + +#### Parameters + +- `string`: The string expression that you want to repeat. +- `number`: The number of times you want to repeat the string. + +### Examples + +Here are a couple of examples of how you can use the `REPEAT` function in ES|QL: + +```esql +ROW a = "Hello!" +| EVAL triple_a = REPEAT(a, 3) +``` + +In this example, the string "Hello!" is repeated 3 times, resulting in "Hello!Hello!Hello!". + +```esql +ROW b = "ES|QL " +| EVAL five_b = REPEAT(b, 5) +``` + +In this example, the string "ES|QL " is repeated 5 times, resulting in "ES|QL ES|QL ES|QL ES|QL ES|QL ". diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-replace.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-replace.txt index fc1ef7656ed75..b2abc79c2d76b 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-replace.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-replace.txt @@ -1,17 +1,33 @@ -REPLACE - -Syntax -Parameters -string -String expression. -regex -Regular expression. -newString -Replacement string. -DescriptionThe function substitutes in the string str any match of the regular expression regex with the replacement string newStr.Supported types -ExampleThis example replaces any occurrence of the word "World" with the word "Universe": +## REPLACE + +The `REPLACE` function substitutes any match of a regular expression within a string with a replacement string. + +### Syntax + +`REPLACE(string, regex, newString)` + +#### Parameters + +- `string`: String expression. +- `regex`: Regular expression. +- `newString`: Replacement string. + +### Examples + +Here are a couple of examples of how to use the `REPLACE` function in ES|QL queries: + ```esql ROW str = "Hello World" | EVAL str = REPLACE(str, "World", "Universe") | KEEP str ``` + +In this example, the `REPLACE` function is used to replace any occurrence of the word "World" with the word "Universe" in the string "Hello World". + +```esql +ROW str = "Elasticsearch is awesome" +| EVAL str = REPLACE(str, "awesome", "fantastic") +| KEEP str +``` + +In this example, the `REPLACE` function is used to replace the word "awesome" with "fantastic" in the string "Elasticsearch is awesome". \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-right.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-right.txt index f7e7e7f0c0c60..c3e2fd9303e68 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-right.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-right.txt @@ -1,13 +1,20 @@ -RIGHT - -Syntax -Parameters -string -The string from which to returns a substring. -length -The number of characters to return. -DescriptionReturn the substring that extracts length chars from str starting from the right.Supported types -Example +## RIGHT + +The `RIGHT` function in ES|QL is used to extract a substring from a string, starting from the right. The number of characters to return is specified by the `length` parameter. + +### Syntax + +`RIGHT(string, length)` + +#### Parameters + +- `string`: The string from which to return a substring. +- `length`: The number of characters to return. + +### Examples + +Here are a couple of examples of how to use the `RIGHT` function in ES|QL: + ```esql FROM employees | KEEP last_name @@ -15,3 +22,12 @@ FROM employees | SORT last_name ASC | LIMIT 5 ``` + +In this example, the `RIGHT` function is used to extract the last three characters from the `last_name` field of each record in the `employees` index. The resulting substring is then stored in a new field called `right`. The query then sorts the results in ascending order by `last_name` and limits the output to the first 5 records. + +```esql +FROM logs-* +| EVAL file_extension = RIGHT(file_name, 3) +``` + +In this second example, the `RIGHT` function is used to extract the file extension from a `file_name` field in a `logs-*` index. The resulting substring is stored in a new field called `file_extension`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-round.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-round.txt index 5f0e72b8cdfd2..aaef24b83a673 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-round.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-round.txt @@ -1,15 +1,31 @@ -ROUND - -Syntax -Parameters -number -The numeric value to round. If null, the function returns null. -decimals -The number of decimal places to round to. Defaults to 0. If null, the function returns null. -DescriptionRounds a number to the specified number of decimal places. Defaults to 0, which returns the nearest integer. If the precision is a negative number, rounds to the number of digits left of the decimal point.Supported types -Example +## ROUND + +The `ROUND` function in ES|QL is used to round a number to a specified number of decimal places. By default, it rounds to 0 decimal places, returning the nearest integer. If the precision is a negative number, it rounds to the number of digits left of the decimal point. + +### Syntax: + +`ROUND(number, decimals)` + +#### Parameters: + +- `number`: The numeric value to round. If null, the function returns null. +- `decimals`: The number of decimal places to round to. Defaults to 0. If null, the function returns null. + +### Examples: + +Here are a couple of examples of how to use the `ROUND` function in ES|QL queries: + ```esql FROM employees | KEEP first_name, last_name, height | EVAL height_ft = ROUND(height * 3.281, 1) ``` + +In this example, the `ROUND` function is used to round the result of the multiplication of the `height` field and `3.281` to `1` decimal place. The result is stored in the `height_ft` field. + +```esql +FROM sales_data +| EVAL rounded_sales = ROUND(sales * 1.2) +``` + +In this second example, the `ROUND` function is used to round the result of the multiplication of the `sales` field and `1.2` to the nearest integer (since no decimal places are specified). The result is stored in the `rounded_sales` field. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-row.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-row.txt index 8f60bd96b6bea..48aaa65963786 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-row.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-row.txt @@ -1,35 +1,42 @@ -ROW +## ROW -Syntax -```esql +The `ROW` command in ES|QL is used to produce a row with one or more columns with specified values. This can be particularly useful for testing purposes. + +### Syntax + +The syntax for the `ROW` command is as follows: + +``` ROW column1 = value1[, ..., columnN = valueN] ``` -Parameters -columnX -The column name. -valueX -The value for the column. Can be a literal, an expression, or a -function. -DescriptionThe -```esql -ROW source command produces a row with one or more columns with values -``` +#### Parameters + +- `columnX`: The name of the column. +- `valueX`: The value for the column. This can be a literal, an expression, or a function. + +### Examples -that you specify. This can be useful for testing.Examples -```esql +Here are some examples of how the `ROW` command can be used in ES|QL: + +1. Creating a row with specified values: + + ```esql ROW a = 1, b = "two", c = null ``` -Use square brackets to create multi-value columns: -```esql +2. Using square brackets to create multi-value columns: + + ```esql ROW a = [2, 1] ``` -```esql -ROW supports the use of functions: -``` +3. Using functions within the `ROW` command: -```esql + ```esql ROW a = ROUND(1.23, 0) ``` + +### Limitations + +There are no known limitations for the `ROW` command in ES|QL. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-rtrim.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-rtrim.txt index 0e1650ba21092..9e92e45629f70 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-rtrim.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-rtrim.txt @@ -1,15 +1,23 @@ -RTRIM - -Syntax -Parameters -string -String expression. If null, the function returns null. -DescriptionRemoves trailing whitespaces from a string.Supported types -Example +## RTRIM + +The `RTRIM` function in ES|QL is used to remove trailing whitespaces from a string. If the string expression is null, the function will return null. + +### Examples + +Here are a couple of examples of how you can use the `RTRIM` function in ES|QL queries: + ```esql -ROW message = " some text ", color = " red " +ROW message = " some text " | EVAL message = RTRIM(message) -| EVAL color = RTRIM(color) | EVAL message = CONCAT("'", message, "'") +``` + +In this example, the `RTRIM` function is used to remove trailing whitespaces from the `message` string. The `CONCAT` function is then used to concatenate the modified `message` string with single quotes. + +```esql +ROW color = " red " +| EVAL color = RTRIM(color) | EVAL color = CONCAT("'", color, "'") ``` + +In this second example, the `RTRIM` function is used to remove trailing whitespaces from the `color` string. The `CONCAT` function is then used to concatenate the modified `color` string with single quotes. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-show.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-show.txt index 4941c1364a95b..80f92061f141f 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-show.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-show.txt @@ -1,25 +1,19 @@ -SHOW +## SHOW -Syntax -```esql -SHOW item -``` +The `SHOW` command in ES|QL is used to return information about the deployment and its capabilities. Currently, the only supported item for this command is `INFO`, which returns the deployment’s version, build date, and hash. -Parameters -item -Can only be INFO. -DescriptionThe -```esql -SHOW source command returns information about the deployment and -``` +### Examples -its capabilities: -Use -```esql -SHOW INFO to return the deployment’s version, build date and hash. -``` +Here are some examples of how to use the `SHOW` command in ES|QL: + +1. To get the deployment's version, build date, and hash: -Examples ```esql SHOW INFO ``` + +Please note that the `SHOW` command can only be used with `INFO` as its parameter. Any other parameters will not be recognized by the command. + +### Limitations + +Currently, the `SHOW` command only supports `INFO` as its parameter. It does not support any other parameters or options. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-signum.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-signum.txt index 5cc3dd25c95c8..bab747ef9b185 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-signum.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-signum.txt @@ -1,12 +1,29 @@ -SIGNUM - -Syntax -Parameters -number -Numeric expression. If null, the function returns null. -DescriptionReturns the sign of the given number. It returns -1 for negative numbers, 0 for 0 and 1 for positive numbers.Supported types -Example +## SIGNUM + +The `SIGNUM` function in ES|QL returns the sign of a given number. It returns `-1` for negative numbers, `0` for `0`, and `1` for positive numbers. + +### Syntax + +The syntax for the `SIGNUM` function is as follows: + +`SIGNUM(number)` + +Here, `number` is a numeric expression. If `null`, the function returns `null`. + +### Examples + +Here are a couple of examples of how you can use the `SIGNUM` function in ES|QL: + ```esql ROW d = 100.0 | EVAL s = SIGNUM(d) ``` + +In this example, the `SIGNUM` function is used to determine the sign of the number `100.0`. Since `100.0` is a positive number, the function returns `1`. + +```esql +ROW d = -50.0 +| EVAL s = SIGNUM(d) +``` + +In this example, the `SIGNUM` function is used to determine the sign of the number `-50.0`. Since `-50.0` is a negative number, the function returns `-1`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sin.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sin.txt index 97f21c4066cde..730df58969234 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sin.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sin.txt @@ -1,12 +1,21 @@ -SIN - -Syntax -Parameters -angle -An angle, in radians. If null, the function returns null. -DescriptionReturns ths Sine trigonometric function of an angle.Supported types -Example +## SIN + +The `SIN` function in ES|QL is used to calculate the sine of an angle. The angle should be provided in radians. If the provided angle is null, the function will return null. + +### Examples + +Here are a couple of examples of how you can use the `SIN` function in ES|QL: + ```esql ROW a=1.8 -| EVAL sin=SIN(a) +| EVAL sin = SIN(a) ``` + +In this example, the `SIN` function is used to calculate the sine of the angle `1.8` radians. The result is stored in the `sin` variable. + +```esql +ROW a=3.14 +| EVAL sin_value = SIN(a) +``` + +In this second example, the `SIN` function is used to calculate the sine of the angle `3.14` radians (approximately equal to π, the angle for a half circle in the unit circle). The result is stored in the `sin_value` variable. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sinh.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sinh.txt index 71f1e7224ec98..62a1d8e089b06 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sinh.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sinh.txt @@ -1,12 +1,21 @@ -SINH - -Syntax -Parameters -angle -An angle, in radians. If null, the function returns null. -DescriptionReturns the hyperbolic sine of an angle.Supported types -Example +## SINH + +The `SINH` function in ES|QL returns the hyperbolic sine of an angle. The angle should be provided in radians. If the provided angle is null, the function will return null. + +### Examples + +Here are a couple of examples of how you can use the `SINH` function in ES|QL: + ```esql ROW a=1.8 -| EVAL sinh=SINH(a) +| EVAL sinh = SINH(a) ``` + +In this example, the `SINH` function is used to calculate the hyperbolic sine of the angle `1.8` radians. + +```esql +ROW a=3.14 +| EVAL sinh_value = SINH(a) +``` + +In this second example, the `SINH` function is used to calculate the hyperbolic sine of the angle `3.14` radians. The result is stored in the `sinh_value` variable. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sort.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sort.txt index 1f9d4c2527cd8..68bc7790a033c 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sort.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sort.txt @@ -1,40 +1,45 @@ -SORT - -Syntax -SORT column1 [ASC/DESC][NULLS FIRST/NULLS LAST][, ..., columnN [ASC/DESC][NULLS FIRST/NULLS LAST]] -Parameters -columnX -The column to sort on. -DescriptionThe SORT processing command sorts a table on one or more columns.The default sort order is ascending. Use ASC or DESC to specify an explicit -sort order.Two rows with the same sort key are considered equal. You can provide additional -sort expressions to act as tie breakers.Sorting on multivalued columns uses the lowest value when sorting ascending and -the highest value when sorting descending.By default, null values are treated as being larger than any other value. With -an ascending sort order, null values are sorted last, and with a descending -sort order, null values are sorted first. You can change that by providing -NULLS FIRST or NULLS LAST.Examples -```esql +## SORT + +The `SORT` command in ES|QL is a processing command that sorts a table based on one or more columns. The default sort order is ascending, but you can specify an explicit sort order using `ASC` or `DESC`. + +In cases where two rows have the same sort key, they are considered equal. However, you can provide additional sort expressions to act as tie breakers. When sorting on multivalued columns, the lowest value is used when sorting in ascending order and the highest value when sorting in descending order. + +By default, null values are treated as being larger than any other value. This means that with an ascending sort order, null values are sorted last, and with a descending sort order, null values are sorted first. You can change this by providing `NULLS FIRST` or `NULLS LAST`. + +### Examples + +Here are some examples of how to use the `SORT` command in ES|QL: + +1. Sorting by height in ascending order (default): + + ```esql FROM employees | KEEP first_name, last_name, height | SORT height ``` -Explicitly sorting in ascending order with ASC: -```esql +2. Explicitly sorting in descending order with `DESC`: + + ```esql FROM employees | KEEP first_name, last_name, height | SORT height DESC ``` -Providing additional sort expressions to act as tie breakers: -```esql +3. Providing additional sort expressions to act as tie breakers: + + ```esql FROM employees | KEEP first_name, last_name, height | SORT height DESC, first_name ASC ``` -Sorting null values first using NULLS FIRST: -```esql +4. Sorting null values first using `NULLS FIRST`: + + ```esql FROM employees | KEEP first_name, last_name, height | SORT first_name ASC NULLS FIRST ``` + +Please note that the `SORT` command does not support sorting on spatial types (`geo_point`, `geo_shape`, `cartesian_point`, `cartesian_shape`). \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-source-commands.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-source-commands.txt deleted file mode 100644 index 8065c0e0bbfb0..0000000000000 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-source-commands.txt +++ /dev/null @@ -1,7 +0,0 @@ -Source commands - -An ES|QL source command produces a table, typically with data from Elasticsearch. An ES|QL query must start with a source command. -ES|QL supports these source commands: -FROM -ROW -SHOW diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-split.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-split.txt index 2b65db150c4ff..658c161292b64 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-split.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-split.txt @@ -1,14 +1,30 @@ -SPLIT - -Syntax -Parameters -string -String expression. If null, the function returns null. -delim -Delimiter. Only single byte delimiters are currently supported. -DescriptionSplit a single valued string into multiple strings.Supported types -Example +## SPLIT + +The `SPLIT` function in ES|QL is used to split a single valued string into multiple strings based on a specified delimiter. + +### Syntax + +`SPLIT(string, delim)` + +#### Parameters + +- `string`: This is the string expression that you want to split. If null, the function returns null. +- `delim`: This is the delimiter that will be used to split the string. Only single byte delimiters are currently supported. + +### Examples + +Here are a couple of examples of how you can use the `SPLIT` function in ES|QL: + ```esql ROW words="foo;bar;baz;qux;quux;corge" | EVAL word = SPLIT(words, ";") ``` + +In this example, the string "foo;bar;baz;qux;quux;corge" is split into multiple strings using the semicolon (;) as the delimiter. + +```esql +ROW data="John,Doe,30" +| EVAL details = SPLIT(data, ",") +``` + +In this second example, the string "John,Doe,30" is split into multiple strings using the comma (,) as the delimiter. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sqrt.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sqrt.txt index 9b2fc2ccbab80..6e1820242b468 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sqrt.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sqrt.txt @@ -1,12 +1,29 @@ -SQRT - -Syntax -Parameters -number -Numeric expression. If null, the function returns null. -DescriptionReturns the square root of a number. The input can be any numeric value, the return value is always a double. Square roots of negative numbers and infinites are null.Supported types -Example +## SQRT + +The `SQRT` function in ES|QL is used to calculate the square root of a number. The input can be any numeric value and the return value is always a double. If the input is a negative number or infinity, the function returns null. + +### Syntax + +`SQRT(number)` + +#### Parameters + +`number`: Numeric expression. If null, the function returns null. + +### Examples + +Here are a couple of examples of how to use the `SQRT` function in ES|QL: + ```esql ROW d = 100.0 | EVAL s = SQRT(d) ``` + +In this example, the `SQRT` function is used to calculate the square root of 100. The result is stored in the variable `s`. + +```esql +ROW d = 16.0 +| EVAL s = SQRT(d) +``` + +In this example, the `SQRT` function is used to calculate the square root of 16. The result is stored in the variable `s`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_centroid_agg.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_centroid_agg.txt index 3cba219549177..f76bbdbf54e8f 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_centroid_agg.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_centroid_agg.txt @@ -1,11 +1,21 @@ -ST_CENTROID_AGG +## ST_CENTROID_AGG +ST_CENTROID_AGG is a function that calculates the spatial centroid over a field with spatial point geometry type. This functionality is currently in technical preview and may be changed or removed in a future release. + +### Examples + +Here are a couple of examples of full ES|QL queries using the ST_CENTROID_AGG function: -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -Calculate the spatial centroid over a field with spatial point geometry type. ```esql FROM airports -| STATS centroid=ST_CENTROID_AGG(location) +| STATS centroid = ST_CENTROID_AGG(location) +``` + +In this example, the ST_CENTROID_AGG function is used to calculate the spatial centroid over the 'location' field from the 'airports' index. + +```esql +FROM geo_data +| STATS geo_centroid = ST_CENTROID_AGG(geo_point) ``` -Supported types: +In this second example, the ST_CENTROID_AGG function is used to calculate the spatial centroid over the 'geo_point' field from the 'geo_data' index. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_contains.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_contains.txt index 5c271d6d40de0..da7c244d57d76 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_contains.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_contains.txt @@ -1,19 +1,34 @@ -ST_CONTAINS - - -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -Syntax -Parameters -geomA -Expression of type geo_point, cartesian_point, geo_shape or cartesian_shape. If null, the function returns null. -geomB -Expression of type geo_point, cartesian_point, geo_shape or cartesian_shape. If null, the function returns null. -The second parameter must also have the same coordinate system as the first. -This means it is not possible to combine geo_* and cartesian_* parameters. -DescriptionReturns whether the first geometry contains the second geometry.This is the inverse of the ST_WITHIN function.Supported types -Example +## ST_CONTAINS + +ST_CONTAINS is a function in ES|QL that checks whether the first geometry contains the second geometry. This function is the inverse of the ST_WITHIN function. + +### Syntax + +The syntax for the ST_CONTAINS function is as follows: + +`ST_CONTAINS(geomA, geomB)` + +#### Parameters + +- `geomA`: An expression of type geo_point, cartesian_point, geo_shape or cartesian_shape. If null, the function returns null. +- `geomB`: An expression of type geo_point, cartesian_point, geo_shape or cartesian_shape. If null, the function returns null. The second parameter must also have the same coordinate system as the first. This means it is not possible to combine geo_* and cartesian_* parameters. + +### Examples + +Here are a couple of examples of how to use the ST_CONTAINS function in ES|QL queries: + ```esql FROM airport_city_boundaries | WHERE ST_CONTAINS(city_boundary, TO_GEOSHAPE("POLYGON((109.35 18.3, 109.45 18.3, 109.45 18.4, 109.35 18.4, 109.35 18.3))")) | KEEP abbrev, airport, region, city, city_location ``` + +In this example, the ST_CONTAINS function is used to check if the `city_boundary` contains the specified polygon. The query then keeps the `abbrev`, `airport`, `region`, `city`, and `city_location` fields. + +```esql +FROM geo_shapes +| WHERE ST_CONTAINS(shape_field, TO_GEOSHAPE("POINT(10 20)")) +| KEEP id, name, shape_field +``` + +In this second example, the ST_CONTAINS function is used to check if the `shape_field` contains the specified point. The query then keeps the `id`, `name`, and `shape_field` fields. diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_disjoint.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_disjoint.txt index 401f94c2bf861..c1b8cc165ac7d 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_disjoint.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_disjoint.txt @@ -1,20 +1,31 @@ -ST_DISJOINT - - -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -Syntax -Parameters -geomA -Expression of type geo_point, cartesian_point, geo_shape or cartesian_shape. If null, the function returns null. -geomB -Expression of type geo_point, cartesian_point, geo_shape or cartesian_shape. If null, the function returns null. -The second parameter must also have the same coordinate system as the first. -This means it is not possible to combine geo_* and cartesian_* parameters. -DescriptionReturns whether the two geometries or geometry columns are disjoint.This is the inverse of the ST_INTERSECTS function. -In mathematical terms: ST_Disjoint(A, B) ⇔ A ⋂ B = ∅Supported types -Example +## ST_DISJOINT + +ST_DISJOINT is a function in ES|QL that checks whether two geometries or geometry columns are disjoint. In other words, it verifies if the two geometries do not intersect at any point. This function is the inverse of the ST_INTERSECTS function. In mathematical terms, if A and B are two geometries, they are disjoint if their intersection is an empty set (A ⋂ B = ∅). + +### Syntax + +`ST_DISJOINT(geomA, geomB)` + +#### Parameters + +- `geomA`: An expression of type geo_point, cartesian_point, geo_shape, or cartesian_shape. If null, the function returns null. +- `geomB`: An expression of type geo_point, cartesian_point, geo_shape, or cartesian_shape. If null, the function returns null. The second parameter must also have the same coordinate system as the first. This means it is not possible to combine geo_* and cartesian_* parameters. + +### Examples + +Here are a couple of examples of how to use the ST_DISJOINT function in ES|QL queries: + ```esql FROM airport_city_boundaries | WHERE ST_DISJOINT(city_boundary, TO_GEOSHAPE("POLYGON((-10 -60, 120 -60, 120 60, -10 60, -10 -60))")) | KEEP abbrev, airport, region, city, city_location ``` + +In this example, the query checks if the city_boundary is disjoint from the specified polygon. If they are disjoint, the query returns the abbrev, airport, region, city, and city_location fields. + +```esql +FROM geo_shapes +| WHERE ST_DISJOINT(shape1, shape2) +``` + +In this example, the query checks if shape1 and shape2 are disjoint. If they are, the query returns all the fields of the matching documents. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_intersects.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_intersects.txt index 1dbb4a50122d6..1682fcaccc014 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_intersects.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_intersects.txt @@ -1,22 +1,30 @@ -ST_INTERSECTS - - -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -Syntax -Parameters -geomA -Expression of type geo_point, cartesian_point, geo_shape or cartesian_shape. If null, the function returns null. -geomB -Expression of type geo_point, cartesian_point, geo_shape or cartesian_shape. If null, the function returns null. -The second parameter must also have the same coordinate system as the first. -This means it is not possible to combine geo_* and cartesian_* parameters. -DescriptionReturns true if two geometries intersect. -They intersect if they have any point in common, including their interior points -(points along lines or within polygons). -This is the inverse of the ST_DISJOINT function. -In mathematical terms: ST_Intersects(A, B) ⇔ A ⋂ B ≠ ∅Supported types -Example +## ST_INTERSECTS + +The `ST_INTERSECTS` function returns `true` if two geometries intersect. They intersect if they have any point in common, including their interior points (points along lines or within polygons). This is the inverse of the `ST_DISJOINT` function. In mathematical terms: `ST_Intersects(A, B) ⇔ A ⋂ B ≠ ∅`. + +### Syntax + +`ST_INTERSECTS(geomA, geomB)` + +#### Parameters + +- `geomA`: Expression of type `geo_point`, `cartesian_point`, `geo_shape` or `cartesian_shape`. If `null`, the function returns `null`. +- `geomB`: Expression of type `geo_point`, `cartesian_point`, `geo_shape` or `cartesian_shape`. If `null`, the function returns `null`. The second parameter must also have the same coordinate system as the first. This means it is not possible to combine `geo_*` and `cartesian_*` parameters. + +### Examples + +Here are a couple of examples of how to use the `ST_INTERSECTS` function in ES|QL queries: + ```esql FROM airports | WHERE ST_INTERSECTS(location, TO_GEOSHAPE("POLYGON((42 14, 43 14, 43 15, 42 15, 42 14))")) ``` + +In this example, the `ST_INTERSECTS` function is used to find airports that are located within a specific polygon. + +```esql +FROM geo_shapes +| WHERE ST_INTERSECTS(shape_field, TO_GEOSHAPE("POINT(42 14)")) +``` + +In this second example, the `ST_INTERSECTS` function is used to find geo shapes that intersect with a specific point. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_within.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_within.txt index 0224b921d274c..027f5b1eae393 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_within.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_within.txt @@ -1,19 +1,34 @@ -ST_WITHIN - - -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -Syntax -Parameters -geomA -Expression of type geo_point, cartesian_point, geo_shape or cartesian_shape. If null, the function returns null. -geomB -Expression of type geo_point, cartesian_point, geo_shape or cartesian_shape. If null, the function returns null. -The second parameter must also have the same coordinate system as the first. -This means it is not possible to combine geo_* and cartesian_* parameters. -DescriptionReturns whether the first geometry is within the second geometry.This is the inverse of the ST_CONTAINS function.Supported types -Example +## ST_WITHIN + +ST_WITHIN is a function in ES|QL that checks whether the first geometry is within the second geometry. This function is the inverse of the ST_CONTAINS function. + +### Syntax + +The syntax for the ST_WITHIN function is as follows: + +`ST_WITHIN(geomA, geomB)` + +#### Parameters + +- `geomA`: This is an expression of type geo_point, cartesian_point, geo_shape, or cartesian_shape. If null, the function returns null. +- `geomB`: This is an expression of type geo_point, cartesian_point, geo_shape, or cartesian_shape. If null, the function returns null. The second parameter must also have the same coordinate system as the first. This means it is not possible to combine geo_* and cartesian_* parameters. + +### Examples + +Here are a couple of examples of how to use the ST_WITHIN function in ES|QL: + ```esql FROM airport_city_boundaries | WHERE ST_WITHIN(city_boundary, TO_GEOSHAPE("POLYGON((109.1 18.15, 109.6 18.15, 109.6 18.65, 109.1 18.65, 109.1 18.15))")) | KEEP abbrev, airport, region, city, city_location ``` + +In this example, the ST_WITHIN function is used to check if the `city_boundary` is within the specified polygon. The query then keeps the `abbrev`, `airport`, `region`, `city`, and `city_location` fields from the `airport_city_boundaries` index. + +```esql +FROM my_index +| WHERE ST_WITHIN(my_geo_point, TO_GEOSHAPE("POLYGON((10 10, 20 20, 30 30, 10 10))")) +| KEEP field1, field2 +``` + +In this second example, the ST_WITHIN function is used to check if the `my_geo_point` field is within the specified polygon. The query then keeps the `field1` and `field2` fields from the `my_index` index. diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_x.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_x.txt index 286c9471b71d8..820ec0176ad9d 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_x.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_x.txt @@ -1,15 +1,21 @@ -ST_X +## ST_X +The `ST_X` function is used to extract the x coordinate from a provided point. If the point is of type `geo_point`, this is equivalent to extracting the longitude value. + +### Examples + +Here are a couple of examples of how you can use the `ST_X` function in ES|QL queries: -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -Syntax -Parameters -point -Expression of type geo_point or cartesian_point. If null, the function returns null. -DescriptionExtracts the x coordinate from the supplied point. -If the points is of type geo_point this is equivalent to extracting the longitude value.Supported types -Example ```esql ROW point = TO_GEOPOINT("POINT(42.97109629958868 14.7552534006536)") -| EVAL x = ST_X(point), y = ST_Y(point) +| EVAL x = ST_X(point) ``` + +In this example, the `ST_X` function is used to extract the x coordinate (or longitude) from a `geo_point` that is created using the `TO_GEOPOINT` function. + +```esql +ROW point = TO_GEOPOINT("POINT(50.8503 4.3517)") +| EVAL x = ST_X(point) +``` + +In this second example, the `ST_X` function is used to extract the x coordinate (or longitude) from a different `geo_point`. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_y.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_y.txt index dd0262318d862..4e7daf35db08d 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_y.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-st_y.txt @@ -1,15 +1,26 @@ -ST_Y +## ST_Y +The `ST_Y` function extracts the y coordinate from the supplied point. If the points is of type `geo_point` this is equivalent to extracting the latitude value. + +### Syntax + +`ST_Y(point)` + +### Parameters + +- `point`: Expression of type `geo_point` or `cartesian_point`. If null, the function returns null. + +### Examples + +Here are a couple of examples of how you can use the `ST_Y` function in ES|QL queries: -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -Syntax -Parameters -point -Expression of type geo_point or cartesian_point. If null, the function returns null. -DescriptionExtracts the y coordinate from the supplied point. -If the points is of type geo_point this is equivalent to extracting the latitude value.Supported types -Example ```esql ROW point = TO_GEOPOINT("POINT(42.97109629958868 14.7552534006536)") -| EVAL x = ST_X(point), y = ST_Y(point) +| EVAL y = ST_Y(point) ``` + +```esql +FROM geo_data +| EVAL latitude = ST_Y(location) +| WHERE latitude > 50 +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-starts_with.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-starts_with.txt new file mode 100644 index 0000000000000..bee2a57300a25 --- /dev/null +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-starts_with.txt @@ -0,0 +1,33 @@ +## STARTS_WITH + +The `STARTS_WITH` function in ES|QL is used to check if a keyword string starts with another string. It returns a boolean value indicating the result of this comparison. + +### Syntax + +The syntax for using the `STARTS_WITH` function is as follows: + +`STARTS_WITH(str, prefix)` + +#### Parameters + +- `str`: This is a string expression. If null, the function returns null. +- `prefix`: This is another string expression. If null, the function returns null. + +### Examples + +Here are a couple of examples showing how to use the `STARTS_WITH` function in ES|QL queries: + +```esql +FROM employees +| KEEP last_name +| EVAL ln_S = STARTS_WITH(last_name, "B") +``` + +In this example, the `STARTS_WITH` function is used to check if the `last_name` of employees starts with the letter "B". The result is stored in the `ln_S` field. + +```esql +FROM logs-* +| WHERE STARTS_WITH(log_message, "ERROR") +``` + +In this second example, the `STARTS_WITH` function is used in a `WHERE` clause to filter out log messages that start with the word "ERROR". \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-stats.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-stats.txt index ed6dbbd283b6b..4369353daa3cb 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-stats.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-stats.txt @@ -1,64 +1,52 @@ -STATS ... BY - -Syntax -STATS [column1 =] expression1[, ..., [columnN =] expressionN] -[BY grouping_expression1[, ..., grouping_expressionN]] -Parameters -columnX -The name by which the aggregated value is returned. If omitted, the name is -equal to the corresponding expression (expressionX). -expressionX -An expression that computes an aggregated value. -grouping_expressionX -An expression that outputs the values to group by. -Individual null values are skipped when computing aggregations. -DescriptionThe STATS ... BY processing command groups rows according to a common value -and calculate one or more aggregated values over the grouped rows. If BY is -omitted, the output table contains exactly one row with the aggregations applied -over the entire dataset.The following aggregation functions are supported: -AVG -COUNT -COUNT_DISTINCT -MAX -MEDIAN -MEDIAN_ABSOLUTE_DEVIATION -MIN -PERCENTILE -[preview] -This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -ST_CENTROID_AGG -SUM -VALUES -STATS without any groups is much much faster than adding a group. -Grouping on a single expression is currently much more optimized than grouping - on many expressions. In some tests we have seen grouping on a single keyword - column to be five times faster than grouping on two keyword columns. Do - not try to work around this by combining the two columns together with - something like CONCAT and then grouping - that is not going to be - faster. -ExamplesCalculating a statistic and grouping by the values of another column: -```esql +# STATS + +The `STATS` command in ES|QL is a processing command that groups rows according to a common value and calculates one or more aggregated values over the grouped rows. If `BY` is omitted, the output table contains exactly one row with the aggregations applied over the entire dataset. + +The following aggregation functions are supported: + +- `AVG` +- `COUNT` +- `COUNT_DISTINCT` +- `MAX` +- `MEDIAN` +- `MEDIAN_ABSOLUTE_DEVIATION` +- `MIN` +- `PERCENTILE` +- `ST_CENTROID_AGG` (This functionality is in technical preview and may be changed or removed in a future release) +- `SUM` +- `VALUES` + +It's important to note that `STATS` without any groups is much faster than adding a group. Grouping on a single expression is currently much more optimized than grouping on many expressions. + +## Examples + +Here are some examples of how you can use the `STATS` command in ES|QL: + +1. Calculating a statistic and grouping by the values of another column: + + ```esql FROM employees | STATS count = COUNT(emp_no) BY languages | SORT languages ``` -Omitting BY returns one row with the aggregations applied over the entire -dataset: -```esql +2. Omitting `BY` returns one row with the aggregations applied over the entire dataset: + + ```esql FROM employees | STATS avg_lang = AVG(languages) ``` -It’s possible to calculate multiple values: -```esql +3. It’s possible to calculate multiple values: + + ```esql FROM employees | STATS avg_lang = AVG(languages), max_lang = MAX(languages) ``` -It’s also possible to group by multiple values (only supported for long and -keyword family fields): -```esql +4. It’s also possible to group by multiple values (only supported for long and keyword family fields): + + ```esql FROM employees | EVAL hired = DATE_FORMAT("YYYY", hire_date) | STATS avg_salary = AVG(salary) BY hired, languages.long @@ -66,36 +54,39 @@ FROM employees | SORT hired, languages.long ``` -Both the aggregating functions and the grouping expressions accept other -functions. This is useful for using STATS...BY on multivalue columns. -For example, to calculate the average salary change, you can use MV_AVG to -first average the multiple values per employee, and use the result with the -AVG function: -```esql +5. Both the aggregating functions and the grouping expressions accept other functions. This is useful for using `STATS...BY` on multivalue columns. For example, to calculate the average salary change, you can use `MV_AVG` to first average the multiple values per employee, and use the result with the `AVG` function: + + ```esql FROM employees | STATS avg_salary_change = ROUND(AVG(MV_AVG(salary_change)), 10) ``` -An example of grouping by an expression is grouping employees on the first -letter of their last name: -```esql +6. An example of grouping by an expression is grouping employees on the first letter of their last name: + + ```esql FROM employees | STATS my_count = COUNT() BY LEFT(last_name, 1) | SORT `LEFT(last_name, 1)` ``` -Specifying the output column name is optional. If not specified, the new column -name is equal to the expression. The following query returns a column named -AVG(salary): -```esql -FROM employees -| STATS AVG(salary) -``` +7. Specifying the output column name is optional. If not specified, the new column name is equal to the expression. The following query returns a column named `AVG(salary)`: -Because this name contains special characters, it needs to be -quoted with backticks (`) when using it in subsequent commands: -```esql + ```esql FROM employees | STATS AVG(salary) | EVAL avg_salary_rounded = ROUND(`AVG(salary)`) ``` + +## Limitations + +- `STATS` does not support configurations where the `_source` field is disabled. +- Full-text search is not supported. +- `text` fields behave like `keyword` fields. +- Time series data streams are not supported. +- Date math expressions work well when the leftmost expression is a datetime. +- Enrich limitations: The ES|QL `ENRICH` command only supports enrich policies of type `match`. Furthermore, `ENRICH` only supports enriching on a column of type `keyword`. +- Dissect limitations: The `DISSECT` command does not support reference keys. +- Grok limitations: The `GROK` command does not support configuring custom patterns, or multiple patterns. The `GROK` command is not subject to Grok watchdog settings. +- Multivalue limitations: ES|QL supports multivalued fields, but functions return `null` when applied to a multivalued field, unless documented otherwise. +- Timezone support: ES|QL only supports the UTC timezone. +- Kibana limitations: The user interface to filter data is not enabled when Discover is in ES|QL mode. To filter data, write a query that uses the `WHERE` command instead. Discover shows no more than 10,000 rows. This limit only applies to the number of rows that are retrieved by the query and displayed in Discover. Queries and aggregations run on the full data set. Discover shows no more than 50 columns. If a query returns more than 50 columns, Discover only shows the first 50. CSV export from Discover shows no more than 10,000 rows. This limit only applies to the number of rows that are retrieved by the query and displayed in Discover. Queries and aggregations run on the full data set. Querying many indices at once without any filters can cause an error in kibana which looks like `[esql] > Unexpected error from Elasticsearch: The content length (536885793) is bigger than the maximum allowed string (536870888)`. The response from ES|QL is too long. Use `DROP` or `KEEP` to limit the number of fields returned. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-substring.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-substring.txt index d49f1ca92f2ac..53aedd96c3466 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-substring.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-substring.txt @@ -1,33 +1,41 @@ -SUBSTRING - -Syntax -Parameters -string -String expression. If null, the function returns null. -start -Start position. -length -Length of the substring from the start position. Optional; if omitted, all positions after start are returned. -DescriptionReturns a substring of a string, specified by a start position and an optional lengthSupported types -ExamplesThis example returns the first three characters of every last name: -```esql +## SUBSTRING + +The `SUBSTRING` function in ES|QL is used to extract a specific portion of a string. It is specified by a start position and an optional length. If the length is not provided, the function returns all positions after the start. + +### Syntax: + +`SUBSTRING(string, start, [length])` + +#### Parameters: + +- `string`: The string expression from which to extract the substring. If null, the function returns null. +- `start`: The starting position for the substring. +- `length`: The length of the substring from the start position. This is optional; if omitted, all positions after start are returned. + +### Examples: + +Here are a couple of examples of how to use the `SUBSTRING` function in ES|QL: + +1. Extracting the first three characters of every last name: + + ```esql FROM employees | KEEP last_name | EVAL ln_sub = SUBSTRING(last_name, 1, 3) ``` -A negative start position is interpreted as being relative to the end of the string. -This example returns the last three characters of of every last name: -```esql +2. Extracting the last three characters of every last name: + + ```esql FROM employees | KEEP last_name | EVAL ln_sub = SUBSTRING(last_name, -3, 3) ``` -If length is omitted, substring returns the remainder of the string. -This example returns all characters except for the first: -```esql +3. Extracting all characters except for the first: + + ```esql FROM employees | KEEP last_name | EVAL ln_sub = SUBSTRING(last_name, 2) -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sum.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sum.txt index c2cdff2787d54..2e555961c553f 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sum.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-sum.txt @@ -1,19 +1,21 @@ -SUM +## SUM + +The `SUM` function in ES|QL is used to calculate the sum of a numeric expression. + +### Examples + +Here are a couple of examples of how you can use the `SUM` function in ES|QL: + +1. To calculate the sum of a field named `languages` in an index named `employees`, you can use the following query: -Syntax -SUM(expression) -expression -Numeric expression. -DescriptionReturns the sum of a numeric expression.Example ```esql FROM employees | STATS SUM(languages) ``` -The expression can use inline functions. For example, to calculate -the sum of each employee’s maximum salary changes, apply the -MV_MAX function to each row and then sum the results: +2. You can also use the `SUM` function with other functions like `MV_MAX`. In the following example, the `MV_MAX` function is applied to each row of the `salary_change` field to get the maximum salary change for each employee. The `SUM` function then calculates the total of these maximum salary changes: + ```esql FROM employees | STATS total_salary_changes = SUM(MV_MAX(salary_change)) -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-syntax.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-syntax.txt index 04b7ed975e8d9..e76b78c7e1cb4 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-syntax.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-syntax.txt @@ -1,108 +1,121 @@ +# ES|QL Syntax + +ES|QL (Elasticsearch Query Language) uses a simple yet powerful syntax that allows you to filter, transform, and analyze data stored in Elasticsearch. The syntax is composed of a source command followed by an optional series of processing commands, separated by a pipe character (`|`). + +## Basic Syntax + +An ES|QL query typically looks like this: + +source-command +| processing-command1 +| processing-command2 + +The result of a query is the table produced by the final processing command. For an overview of all supported commands, functions, and operators, refer to Commands and Functions and operators. + +You can also write an ES|QL query as a single line. For example: -ES|QL syntax referenceedit -Basic syntaxedit -An ES|QL query is composed of a source command followed -by an optional series of processing commands, -separated by a pipe character: `|`. For example: source-command | processing-command1 | processing-command2 -The result of a query is the table produced by the final processing command. -For an overview of all supported commands, functions, and operators, refer to Commands and Functions and operators. -For readability, this documentation puts each processing command on a new -line. However, you can write an ES|QL query as a single line. The following -query is identical to the previous one: -source-command | processing-command1 | processing-command2 -Identifiersedit -Identifiers need to be quoted with backticks (```) if: -they don’t start with a letter, `_` or `@` -any of the other characters is not a letter, number, or `_` -For example: + +## Identifiers + +Identifiers in ES|QL need to be quoted with backticks (```) if they don’t start with a letter, `_` or `@` or if any of the other characters is not a letter, number, or `_`. For example: + ```esql FROM index | KEEP `1.field` ``` -When referencing a function alias that itself uses a quoted identifier, the -backticks of the quoted identifier need to be escaped with another backtick. For -example: +When referencing a function alias that itself uses a quoted identifier, the backticks of the quoted identifier need to be escaped with another backtick. For example: + ```esql FROM index | STATS COUNT(`1.field`) | EVAL my_count = `COUNT(``1.field``)` ``` -Literalsedit +## Literals + ES|QL currently supports numeric and string literals. -String literalsedit -A string literal is a sequence of unicode characters delimited by double -quotes (`"`). -// Filter by a string value + +### String Literals + +A string literal is a sequence of unicode characters delimited by double quotes (`"`). If the literal string itself contains quotes, these need to be escaped (`\\"`). ES|QL also supports the triple-quotes (`"""`) delimiter, for convenience. Special characters CR, LF and TAB can be provided with the usual escaping: `\r`, `\n`, `\t`, respectively. + ```esql FROM index | WHERE first_name == "Georgi" ``` -If the literal string itself contains quotes, these need to be escaped (`\\"`). -ES|QL also supports the triple-quotes (`"""`) delimiter, for convenience: -```esql -ROW name = """Indiana "Indy" Jones""" -``` +### Numerical Literals + +The numeric literals are accepted in decimal and in the scientific notation with the exponent marker (`e` or `E`), starting either with a digit, decimal point `.` or the negative sign `-`. The integer numeric literals are implicitly converted to the `integer`, `long` or the `double` type, whichever can first accommodate the literal’s value. The floating point literals are implicitly converted the `double` type. -The special characters CR, LF and TAB can be provided with the usual escaping: -`\r`, `\n`, `\t`, respectively. -Numerical literalsedit -The numeric literals are accepted in decimal and in the scientific notation -with the exponent marker (`e` or `E`), starting either with a digit, decimal -point `.` or the negative sign `-`: 1969 -- integer notation 3.14 -- decimal notation .1234 -- decimal notation starting with decimal point 4E5 -- scientific notation (with exponent marker) 1.2e-3 -- scientific notation with decimal point -.1e2 -- scientific notation starting with the negative sign -The integer numeric literals are implicitly converted to the `integer`, `long` -or the `double` type, whichever can first accommodate the literal’s value. -The floating point literals are implicitly converted the `double` type. -To obtain constant values of different types, use one of the numeric -conversion functions. -Commentsedit -ES|QL uses C++ style comments: -double slash `//` for single line comments -`/*` and `*/` for block comments -// Query the employees index + +## Comments + +ES|QL uses C++ style comments: double slash `//` for single line comments and `/*` and `*/` for block comments. + ```esql +// Query the employees index FROM employees | WHERE height > 2 ``` +## Timespan Literals + +Datetime intervals and timespans can be expressed using timespan literals. Timespan literals are a combination of a number and a qualifier. These qualifiers are supported: `millisecond`/`milliseconds`/`ms`, `second`/`seconds`/`sec`/`s`, `minute`/`minutes`/`min`, `hour`/`hours`/`h`, `day`/`days`/`d`, `week`/`weeks`/`w`, `month`/`months`/`mo`, `quarter`/`quarters`/`q`, `year`/`years`/`yr`/`y`. Timespan literals are not whitespace sensitive. + +1day +1 day +1 day + +## Example Queries with Timespan Literals + +Here are some example queries using timespan literals: + +1. Querying data from the last 7 days: + ```esql -FROM /* Query the employees index */ employees -| WHERE height > 2 +FROM logs +| WHERE @timestamp >= NOW() - 7d ``` +2. Aggregating data on an hourly basis for the past 24 hours: + ```esql -FROM employees +FROM logs +| STATS COUNT(*) BY timestamp = DATE_TRUNC(1h, @timestamp) +| WHERE timestamp >= NOW() - 24h ``` -/* Query the - * employees - * index */ -| WHERE height > 2 -Timespan literalsedit -Datetime intervals and timespans can be expressed using timespan literals. -Timespan literals are a combination of a number and a qualifier. These -qualifiers are supported: -`millisecond`/`milliseconds`/`ms` -`second`/`seconds`/`sec`/`s` -`minute`/`minutes`/`min` -`hour`/`hours`/`h` -`day`/`days`/`d` -`week`/`weeks`/`w` -`month`/`months`/`mo` -`quarter`/`quarters`/`q` -`year`/`years`/`yr`/`y` -Timespan literals are not whitespace sensitive. These expressions are all valid: -`1day` -`1 day` -`1 day` +3. Finding the average response time per minute for the last hour: + +```esql +FROM logs +| STATS AVG(response_time) BY minute = DATE_TRUNC(1m, @timestamp) +| WHERE @timestamp >= NOW() - 1h +``` + +4. Aggregating data on a weekly basis for the past year: + +```esql +FROM logs +| STATS COUNT(*) BY week = DATE_TRUNC(1w, @timestamp) +| WHERE @timestamp >= NOW() - 1y +``` + +5. Finding the maximum response time per second for the last minute: + +```esql +FROM logs +| STATS MAX(response_time) BY second = DATE_TRUNC(1s, @timestamp) +| WHERE @timestamp >= NOW() - 1m +``` diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-tan.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-tan.txt index 4d939401e3035..7f1280c10f536 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-tan.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-tan.txt @@ -1,12 +1,29 @@ -TAN - -Syntax -Parameters -angle -An angle, in radians. If null, the function returns null. -DescriptionReturns the Tangent trigonometric function of an angle.Supported types -Example +## TAN + +The `TAN` function in ES|QL is used to calculate the Tangent of an angle. The angle should be provided in radians. + +### Syntax + +The syntax for using the `TAN` function is as follows: + +`TAN(angle)` + +Here, `angle` is the angle in radians for which you want to calculate the Tangent. If `angle` is null, the function will return null. + +### Examples + +Here are a couple of examples showing how to use the `TAN` function in ES|QL: + ```esql ROW a=1.8 -| EVAL tan=TAN(a) +| EVAL tan = TAN(a) +``` + +In this example, the `TAN` function is used to calculate the Tangent of the angle `1.8` radians. + +```esql +ROW a=3.14 +| EVAL tan = TAN(a) ``` + +In this example, the `TAN` function is used to calculate the Tangent of the angle `3.14` radians. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-tanh.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-tanh.txt index ffafd176e8c49..d1412a7016bd6 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-tanh.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-tanh.txt @@ -1,12 +1,29 @@ -TANH - -Syntax -Parameters -angle -An angle, in radians. If null, the function returns null. -DescriptionReturns the Tangent hyperbolic function of an angle.Supported types -Example +## TANH + +The `TANH` function in ES|QL returns the Tangent hyperbolic function of an angle. The angle should be provided in radians. If the angle is null, the function will return null. + +### Syntax + +`TANH(angle)` + +#### Parameters + +- `angle`: An angle, in radians. If null, the function returns null. + +### Examples + +Here are a couple of examples of how to use the `TANH` function in ES|QL: + ```esql ROW a=1.8 -| EVAL tanh=TANH(a) +| EVAL tanh = TANH(a) +``` + +In this example, the `TANH` function is used to calculate the Tangent hyperbolic function of the angle `1.8` radians. + +```esql +ROW a=3.14 +| EVAL tanh_result = TANH(a) ``` + +In this second example, the `TANH` function is used to calculate the Tangent hyperbolic function of the angle `3.14` radians. The result is stored in the `tanh_result` variable. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-tau.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-tau.txt index e5a9a5813d89c..c7e0a5211d48f 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-tau.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-tau.txt @@ -1,8 +1,20 @@ -TAU +## TAU + +TAU function in ES|QL returns the ratio of a circle’s circumference to its radius. + +### Examples + +Here are a couple of examples of how to use the TAU function in ES|QL: -Syntax -ParametersDescriptionReturns the ratio of a circle’s circumference to its radius.Supported types -Example ```esql ROW TAU() ``` + +In this example, the TAU function is used to return the ratio of a circle’s circumference to its radius. + +```esql +FROM my-index +| EVAL tau_ratio = TAU() +``` + +In this example, the TAU function is used within an EVAL function to create a new column `tau_ratio` in the result set, which contains the ratio of a circle’s circumference to its radius. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_base64.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_base64.txt index 86d60d94a70b9..4069711b9524f 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_base64.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_base64.txt @@ -1,10 +1,29 @@ -TO_BASE64 - -Syntax -Parameters -string -A string. -DescriptionEncode a string to a base64 string.Supported types -Example -row a = "elastic" -| eval e = to_base64(a) +## TO_BASE64 + +The `TO_BASE64` function in ES|QL is used to encode a string to a base64 string. + +### Syntax + +`TO_BASE64(string)` + +#### Parameters + +- `string`: The string you want to encode. + +### Examples + +Here are a couple of examples of how you can use the `TO_BASE64` function in ES|QL: + +```esql +ROW a = "elastic" +| EVAL e = TO_BASE64(a) +``` + +In this example, the string "elastic" is encoded to a base64 string. + +```esql +ROW b = "Elasticsearch Query Language" +| EVAL encoded = TO_BASE64(b) +``` + +In this example, the string "Elasticsearch Query Language" is encoded to a base64 string. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_boolean.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_boolean.txt index e32191d2e2d02..34868efa9ccab 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_boolean.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_boolean.txt @@ -1,12 +1,29 @@ -TO_BOOLEAN - -Syntax -Parameters -field -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts an input value to a boolean value. A string value of true will be case-insensitive converted to the Boolean true. For anything else, including the empty string, the function will return false. The numerical value of 0 will be converted to false, anything else will be converted to true.Supported types -Example +## TO_BOOLEAN + +The `TO_BOOLEAN` function converts an input value to a boolean value. A string value of true will be case-insensitive converted to the Boolean true. For anything else, including the empty string, the function will return false. The numerical value of 0 will be converted to false, anything else will be converted to true. + +### Syntax + +`TO_BOOLEAN(field)` + +#### Parameters + +- `field`: Input value. The input can be a single- or multi-valued column or an expression. + +### Examples + +Here are a couple of examples of full ES|QL queries using the `TO_BOOLEAN` function: + ```esql ROW str = ["true", "TRuE", "false", "", "yes", "1"] | EVAL bool = TO_BOOLEAN(str) ``` + +In this example, the `TO_BOOLEAN` function is used to convert a list of string values to boolean. The resulting `bool` column will contain boolean values corresponding to the input strings. + +```esql +ROW str = ["0", "1", "2", "-1", "0.5"] +| EVAL bool = TO_BOOLEAN(str) +``` + +In this second example, the `TO_BOOLEAN` function is used to convert a list of numeric strings to boolean. The resulting `bool` column will contain boolean values corresponding to the input strings. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_cartesianpoint.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_cartesianpoint.txt index 4141d9c43bb9e..35310b547f32d 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_cartesianpoint.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_cartesianpoint.txt @@ -1,13 +1,22 @@ -TO_CARTESIANPOINT - -Syntax -Parameters -field -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts an input value to a cartesian_point value. A string will only be successfully converted if it respects the WKT Point format.Supported types -Example +## TO_CARTESIANPOINT + +The `TO_CARTESIANPOINT` function converts an input value to a `cartesian_point` value. This conversion will only be successful if the input string respects the WKT Point format. + +### Examples + +Here are a couple of examples of how you can use the `TO_CARTESIANPOINT` function in ES|QL queries: + ```esql ROW wkt = ["POINT(4297.11 -1475.53)", "POINT(7580.93 2272.77)"] | MV_EXPAND wkt | EVAL pt = TO_CARTESIANPOINT(wkt) ``` + +In this example, the `TO_CARTESIANPOINT` function is used to convert the values in the `wkt` field (which are in WKT Point format) to `cartesian_point` values. The `MV_EXPAND` function is used to expand the multi-valued `wkt` field into individual rows, and then the `TO_CARTESIANPOINT` function is applied to each row. + +```esql +ROW wkt = "POINT(4297.11 -1475.53)" +| EVAL pt = TO_CARTESIANPOINT(wkt) +``` + +In this second example, the `TO_CARTESIANPOINT` function is used to convert a single WKT Point string to a `cartesian_point` value. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_cartesianshape.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_cartesianshape.txt index d7d7e3ebe94bd..8e16ba92a8e7b 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_cartesianshape.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_cartesianshape.txt @@ -1,13 +1,18 @@ -TO_CARTESIANSHAPE - -Syntax -Parameters -field -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts an input value to a cartesian_shape value. A string will only be successfully converted if it respects the WKT format.Supported types -Example +## TO_CARTESIANSHAPE + +The `TO_CARTESIANSHAPE` function converts an input value to a `cartesian_shape` value. A string will only be successfully converted if it respects the WKT format. + +### Examples + +Here are a couple of examples of full ES|QL queries using the `TO_CARTESIANSHAPE` function: + +```esql +ROW wkt = "POINT(4297.11 -1475.53)" +| EVAL geom = TO_CARTESIANSHAPE(wkt) +``` + ```esql ROW wkt = ["POINT(4297.11 -1475.53)", "POLYGON ((3339584.72 1118889.97, 4452779.63 4865942.27, 2226389.81 4865942.27, 1113194.90 2273030.92, 3339584.72 1118889.97))"] | MV_EXPAND wkt | EVAL geom = TO_CARTESIANSHAPE(wkt) -``` +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_datetime.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_datetime.txt index 89e6d80b0186b..b23b9cb6934bd 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_datetime.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_datetime.txt @@ -1,23 +1,21 @@ -TO_DATETIME +## TO_DATETIME + +The `TO_DATETIME` function converts an input value to a date value. A string will only be successfully converted if it’s respecting the format `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`. To convert dates in other formats, use `DATE_PARSE`. + +### Examples + +Here are a couple of examples of how to use the `TO_DATETIME` function in ES|QL queries: -Syntax -Parameters -field -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts an input value to a date value. A string will only be successfully converted if it’s respecting the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. To convert dates in other formats, use DATE_PARSE.Supported types -Examples ```esql ROW string = ["1953-09-02T00:00:00.000Z", "1964-06-02T00:00:00.000Z", "1964-06-02 00:00:00"] | EVAL datetime = TO_DATETIME(string) ``` -Note that in this example, the last value in the source multi-valued field has not been converted. -The reason being that if the date format is not respected, the conversion will result in a null value. -When this happens a Warning header is added to the response. -The header will provide information on the source of the failure:"Line 1:112: evaluation of [TO_DATETIME(string)] failed, treating result as null. "Only first 20 failures recorded."A following header will contain the failure reason and the offending value:"java.lang.IllegalArgumentException: failed to parse date field [1964-06-02 00:00:00] -with format [yyyy-MM-dd'T'HH:mm:ss.SSS'Z']"If the input parameter is of a numeric type, -its value will be interpreted as milliseconds since the Unix epoch. For example: +In this example, the last value in the source multi-valued field has not been converted. This is because if the date format is not respected, the conversion will result in a null value. When this happens a Warning header is added to the response. The header will provide information on the source of the failure. + ```esql ROW int = [0, 1] | EVAL dt = TO_DATETIME(int) ``` + +In this example, if the input parameter is of a numeric type, its value will be interpreted as milliseconds since the Unix epoch. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_degrees.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_degrees.txt index 31e60bc68ac1a..d82a65148947f 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_degrees.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_degrees.txt @@ -1,12 +1,29 @@ -TO_DEGREES - -Syntax -Parameters -number -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts a number in radians to degrees.Supported types -Example +## TO_DEGREES + +The `TO_DEGREES` function in ES|QL is used to convert a number in radians to degrees. + +### Syntax + +`TO_DEGREES(number)` + +#### Parameters + +- `number`: This is the input value. It can be a single or multi-valued column or an expression. + +### Examples + +Here are a couple of examples of how you can use the `TO_DEGREES` function in ES|QL: + ```esql ROW rad = [1.57, 3.14, 4.71] | EVAL deg = TO_DEGREES(rad) ``` + +In this example, the `TO_DEGREES` function is used to convert the values in the `rad` array from radians to degrees. + +```esql +FROM my_index +| EVAL angle_deg = TO_DEGREES(angle_rad) +``` + +In this example, the `TO_DEGREES` function is used to convert the values in the `angle_rad` field from radians to degrees and the result is stored in the `angle_deg` field. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_double.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_double.txt index 5e942690efd08..22567ab279190 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_double.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_double.txt @@ -1,17 +1,21 @@ -TO_DOUBLE +## TO_DOUBLE + +TO_DOUBLE function converts an input value to a double value. If the input parameter is of a date type, its value will be interpreted as milliseconds since the Unix epoch, converted to double. Boolean true will be converted to double 1.0, false to 0.0. + +### Examples + +Here are a couple of examples of how to use the `TO_DOUBLE` function in ES|QL: + +```esql +ROW str1 = "5.20128E11" +| EVAL dbl = TO_DOUBLE("520128000000"), dbl1 = TO_DOUBLE(str1) +``` + +In this example, the string "5.20128E11" is converted to a double value. -Syntax -Parameters -field -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts an input value to a double value. If the input parameter is of a date type, its value will be interpreted as milliseconds since the Unix epoch, converted to double. Boolean true will be converted to double 1.0, false to 0.0.Supported types -Example ```esql -ROW str1 = "5.20128E11", str2 = "foo" -| EVAL dbl = TO_DOUBLE("520128000000"), dbl1 = TO_DOUBLE(str1), dbl2 = TO_DOUBLE(str2) +ROW str2 = "foo" +| EVAL dbl2 = TO_DOUBLE(str2) ``` -Note that in this example, the last conversion of the string isn’t possible. -When this happens, the result is a null value. In this case a Warning header is added to the response. -The header will provide information on the source of the failure:"Line 1:115: evaluation of [TO_DOUBLE(str2)] failed, treating result as null. Only first 20 failures recorded."A following header will contain the failure reason and the offending value: -"java.lang.NumberFormatException: For input string: "foo"" \ No newline at end of file +In this example, the string "foo" cannot be converted to a double value, resulting in a null value. A warning header is added to the response indicating the source of the failure. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_geopoint.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_geopoint.txt index 9880e88c27dd2..e3db60a8fcf5d 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_geopoint.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_geopoint.txt @@ -1,12 +1,21 @@ -TO_GEOPOINT - -Syntax -Parameters -field -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts an input value to a geo_point value. A string will only be successfully converted if it respects the WKT Point format.Supported types -Example +## TO_GEOPOINT + +The `TO_GEOPOINT` function in ES|QL is used to convert an input value to a `geo_point` value. This function is successful in conversion only if the input string respects the WKT (Well-Known Text) Point format. + +### Examples + +Here are a couple of examples of how you can use the `TO_GEOPOINT` function in your ES|QL queries: + ```esql ROW wkt = "POINT(42.97109630194 14.7552534413725)" | EVAL pt = TO_GEOPOINT(wkt) ``` + +In this example, the `TO_GEOPOINT` function is used to convert the WKT representation of a point to a `geo_point` value. + +```esql +ROW wkt = "POINT(34.052235 -118.243683)" +| EVAL location = TO_GEOPOINT(wkt) +``` + +In this second example, the `TO_GEOPOINT` function is used to convert the WKT representation of a different point to a `geo_point` value. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_geoshape.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_geoshape.txt index e75a292fa2767..d3b6bb198040f 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_geoshape.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_geoshape.txt @@ -1,12 +1,21 @@ -TO_GEOSHAPE - -Syntax -Parameters -field -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts an input value to a geo_shape value. A string will only be successfully converted if it respects the WKT format.Supported types -Example +## TO_GEOSHAPE + +The `TO_GEOSHAPE` function in ES|QL is used to convert an input value to a `geo_shape` value. The conversion will be successful only if the input string respects the Well-Known Text (WKT) format. + +### Examples + +Here are a couple of examples of how you can use the `TO_GEOSHAPE` function in your ES|QL queries: + ```esql ROW wkt = "POLYGON ((30 10, 40 40, 20 40, 10 20, 30 10))" | EVAL geom = TO_GEOSHAPE(wkt) ``` + +In this example, the `TO_GEOSHAPE` function is used to convert a WKT representation of a polygon into a `geo_shape` value. + +```esql +ROW wkt = "POINT (30 10)" +| EVAL geom = TO_GEOSHAPE(wkt) +``` + +In this second example, the `TO_GEOSHAPE` function is used to convert a WKT representation of a point into a `geo_shape` value. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_integer.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_integer.txt index ff8ba3c52d410..f0881133c7d8a 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_integer.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_integer.txt @@ -1,16 +1,24 @@ -TO_INTEGER - -Syntax -Parameters -field -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts an input value to an integer value. If the input parameter is of a date type, its value will be interpreted as milliseconds since the Unix epoch, converted to integer. Boolean true will be converted to integer 1, false to 0.Supported types -Example +## TO_INTEGER + +The `TO_INTEGER` function converts an input value to an integer value. If the input parameter is of a date type, its value will be interpreted as milliseconds since the Unix epoch, converted to integer. Boolean `true` will be converted to integer `1`, `false` to `0`. + +### Examples + +Here are a couple of examples of full ES|QL queries using the `TO_INTEGER` function: + ```esql ROW long = [5013792, 2147483647, 501379200000] | EVAL int = TO_INTEGER(long) ``` -Note that in this example, the last value of the multi-valued field cannot be converted as an integer. -When this happens, the result is a null value. In this case a Warning header is added to the response. -The header will provide information on the source of the failure:"Line 1:61: evaluation of [TO_INTEGER(long)] failed, treating result as null. Only first 20 failures recorded."A following header will contain the failure reason and the offending value:"org.elasticsearch.xpack.ql.InvalidArgumentException: [501379200000] out of [integer] range" \ No newline at end of file +In this example, the last value of the multi-valued field cannot be converted as an integer. When this happens, the result is a null value. A Warning header is added to the response providing information on the source of the failure: + +```esql +"Line 1:61: evaluation of [TO_INTEGER(long)] failed, treating result as null. Only first 20 failures recorded." +``` + +A following header will contain the failure reason and the offending value: + +``` +"org.elasticsearch.xpack.esql.core.InvalidArgumentException: [501379200000] out of [integer] range" +``` diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_ip.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_ip.txt index 3ec377bea6598..ddd8e0eeaee39 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_ip.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_ip.txt @@ -1,17 +1,22 @@ -TO_IP +## TO_IP + +The `TO_IP` function in ES|QL is used to convert an input string to an IP value. + +### Examples + +Here are a couple of examples of how you can use the `TO_IP` function in your ES|QL queries: -Syntax -Parameters -field -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts an input string to an IP value.Supported types -Example ```esql -ROW str1 = "1.1.1.1", str2 = "foo" -| EVAL ip1 = TO_IP(str1), ip2 = TO_IP(str2) +ROW str1 = "1.1.1.1" +| EVAL ip1 = TO_IP(str1) | WHERE CIDR_MATCH(ip1, "1.0.0.0/8") ``` -Note that in this example, the last conversion of the string isn’t possible. -When this happens, the result is a null value. In this case a Warning header is added to the response. -The header will provide information on the source of the failure:"Line 1:68: evaluation of [TO_IP(str2)] failed, treating result as null. Only first 20 failures recorded."A following header will contain the failure reason and the offending value:"java.lang.IllegalArgumentException: 'foo' is not an IP string literal." \ No newline at end of file +In this example, the `TO_IP` function is used to convert the string "1.1.1.1" to an IP value. The `WHERE` clause then uses the `CIDR_MATCH` function to check if the IP value falls within the specified CIDR range. + +```esql +ROW str2 = "foo" +| EVAL ip2 = TO_IP(str2) +``` + +In this second example, the `TO_IP` function attempts to convert the string "foo" to an IP value. However, since "foo" is not a valid IP string literal, the function returns a null value and a warning is added to the response header. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_long.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_long.txt index dd6eebc129e02..4e23ae659f17a 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_long.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_long.txt @@ -1,16 +1,21 @@ -TO_LONG +## TO_LONG + +The `TO_LONG` function converts an input value to a long value. If the input parameter is of a date type, its value will be interpreted as milliseconds since the Unix epoch, converted to long. Boolean true will be converted to long 1, false to 0. + +### Examples + +Here are a couple of examples of how you can use the `TO_LONG` function in ES|QL queries: + +```esql +ROW str1 = "2147483648" +| EVAL long1 = TO_LONG(str1) +``` + +In this example, the string "2147483648" is converted to a long value. -Syntax -Parameters -field -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts an input value to a long value. If the input parameter is of a date type, its value will be interpreted as milliseconds since the Unix epoch, converted to long. Boolean true will be converted to long 1, false to 0.Supported types -Example ```esql -ROW str1 = "2147483648", str2 = "2147483648.2", str3 = "foo" -| EVAL long1 = TO_LONG(str1), long2 = TO_LONG(str2), long3 = TO_LONG(str3) +ROW str2 = "2147483648.2", str3 = "foo" +| EVAL long2 = TO_LONG(str2), long3 = TO_LONG(str3) ``` -Note that in this example, the last conversion of the string isn’t possible. -When this happens, the result is a null value. In this case a Warning header is added to the response. -The header will provide information on the source of the failure:"Line 1:113: evaluation of [TO_LONG(str3)] failed, treating result as null. Only first 20 failures recorded."A following header will contain the failure reason and the offending value:"java.lang.NumberFormatException: For input string: "foo"" \ No newline at end of file +In this example, the string "2147483648.2" is converted to a long value. However, the string "foo" cannot be converted to a long value, resulting in a null value and a warning header added to the response. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_lower.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_lower.txt index 34c99788884b3..ccfdf623a83bf 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_lower.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_lower.txt @@ -1,12 +1,29 @@ -TO_LOWER - -Syntax -Parameters -str -String expression. If null, the function returns null. -DescriptionReturns a new string representing the input string converted to lower case.Supported types -Example +## TO_LOWER + +The `TO_LOWER` function in ES|QL is used to convert an input string to lower case. + +### Syntax + +`TO_LOWER(str)` + +#### Parameters + +- `str`: String expression. If null, the function returns null. + +### Examples + +Here are a couple of examples of how you can use the `TO_LOWER` function in ES|QL queries: + +```esql +ROW message = "HELLO WORLD" +| EVAL lower_message = TO_LOWER(message) +``` + +In this example, the `TO_LOWER` function is used to convert the string "HELLO WORLD" to lower case. The result would be "hello world". + ```esql -ROW message = "Some Text" -| EVAL message_lower = TO_LOWER(message) +ROW name = "John Doe" +| EVAL lower_name = TO_LOWER(name) ``` + +In this example, the `TO_LOWER` function is used to convert the string "John Doe" to lower case. The result would be "john doe". \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_radians.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_radians.txt index 3fec9e2079191..dbf3ef1e2aa62 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_radians.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_radians.txt @@ -1,12 +1,29 @@ -TO_RADIANS - -Syntax -Parameters -number -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts a number in degrees to radians.Supported types -Example +## TO_RADIANS + +The `TO_RADIANS` function in ES|QL is used to convert a number in degrees to radians. + +### Syntax + +`TO_RADIANS(number)` + +#### Parameters + +- `number`: This is the input value. It can be a single or multi-valued column or an expression. + +### Examples + +Here are a couple of examples of how you can use the `TO_RADIANS` function in ES|QL: + ```esql ROW deg = [90.0, 180.0, 270.0] | EVAL rad = TO_RADIANS(deg) ``` + +In this example, the `TO_RADIANS` function is used to convert an array of degree values into radians. + +```esql +ROW deg = 45 +| EVAL rad = TO_RADIANS(deg) +``` + +In this example, the `TO_RADIANS` function is used to convert a single degree value into radians. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_string.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_string.txt index 2d3435e026df4..ed7aad31edd8b 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_string.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_string.txt @@ -1,18 +1,21 @@ -TO_STRING +## TO_STRING + +The `TO_STRING` function in ES|QL is used to convert an input value into a string. The input can be a single or multi-valued column or an expression. + +### Examples + +Here are a couple of examples of how you can use the `TO_STRING` function in your ES|QL queries: -Syntax -Parameters -field -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts an input value into a string.Supported types -Examples ```esql ROW a=10 | EVAL j = TO_STRING(a) ``` -It also works fine on multivalued fields: +In this example, the function is used to convert the numeric value `10` into a string. + ```esql ROW a=[10, 9, 8] | EVAL j = TO_STRING(a) ``` + +In this example, the function is used to convert the values in a multi-valued field into strings. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_unsigned_long.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_unsigned_long.txt index 8e0fa649d427e..afba5be08f5cd 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_unsigned_long.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_unsigned_long.txt @@ -1,17 +1,21 @@ -TO_UNSIGNED_LONG +## TO_UNSIGNED_LONG + +The `TO_UNSIGNED_LONG` function converts an input value to an unsigned long value. If the input parameter is of a date type, its value will be interpreted as milliseconds since the Unix epoch, converted to unsigned long. Boolean true will be converted to unsigned long 1, false to 0. + +### Examples + +Here are a couple of examples of full ES|QL queries using the `TO_UNSIGNED_LONG` function: -Syntax -Parameters -field -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts an input value to an unsigned long value. If the input parameter is of a date type, its value will be interpreted as milliseconds since the Unix epoch, converted to unsigned long. Boolean true will be converted to unsigned long 1, false to 0.Supported types -Example ```esql ROW str1 = "2147483648", str2 = "2147483648.2", str3 = "foo" | EVAL long1 = TO_UNSIGNED_LONG(str1), long2 = TO_ULONG(str2), long3 = TO_UL(str3) ``` -Note that in this example, the last conversion of the string isn’t possible. -When this happens, the result is a null value. In this case a Warning header is added to the response. -The header will provide information on the source of the failure:"Line 1:133: evaluation of [TO_UL(str3)] failed, treating result as null. Only first 20 failures recorded."A following header will contain the failure reason and the offending value:"java.lang.NumberFormatException: Character f is neither a decimal digit number, decimal point, -+ "nor "e" notation exponential mark." \ No newline at end of file +In this example, the `TO_UNSIGNED_LONG` function is used to convert string values to unsigned long. Note that the last conversion of the string isn’t possible. When this happens, the result is a null value. + +```esql +ROW date = "2022-01-01T00:00:00Z" +| EVAL timestamp = TO_UNSIGNED_LONG(date) +``` + +In this example, the `TO_UNSIGNED_LONG` function is used to convert a date string to an unsigned long value, representing the milliseconds since the Unix epoch. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_upper.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_upper.txt index c1ad388758dae..9f703c69c167e 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_upper.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_upper.txt @@ -1,12 +1,34 @@ -TO_UPPER - -Syntax -Parameters -str -String expression. If null, the function returns null. -DescriptionReturns a new string representing the input string converted to upper case.Supported types -Example +## TO_UPPER + +The `TO_UPPER` function in ES|QL is used to convert an input string to upper case. + +### Syntax + +`TO_UPPER(str)` + +#### Parameters + +- `str`: This is a string expression. If null, the function returns null. + +### Description + +The function returns a new string representing the input string converted to upper case. + +### Examples + +Here are a couple of examples of full ES|QL queries using the `TO_UPPER` function: + ```esql -ROW message = "Some Text" -| EVAL message_upper = TO_UPPER(message) +ROW message = "Hello World" +| EVAL upper_message = TO_UPPER(message) ``` + +In this example, the `TO_UPPER` function is used to convert the string "Hello World" to upper case. + +```esql +FROM employees +| EVAL upper_last_name = TO_UPPER(last_name) +| KEEP emp_no, upper_last_name +``` + +In this example, the `TO_UPPER` function is used to convert the `last_name` field of each record in the `employees` index to upper case. The query then keeps the `emp_no` and the upper case `last_name` for each record. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_version.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_version.txt index 07d6c6f9d510b..b560d15edc942 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_version.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-to_version.txt @@ -1,11 +1,19 @@ -TO_VERSION - -Syntax -Parameters -field -Input value. The input can be a single- or multi-valued column or an expression. -DescriptionConverts an input string to a version value.Supported types -Example +## TO_VERSION + +TO_VERSION function converts an input string to a version value. + +### Examples + +Here are a couple of examples of how you can use the TO_VERSION function in ES|QL queries: + ```esql ROW v = TO_VERSION("1.2.3") ``` + +In this example, the TO_VERSION function is used to convert the string "1.2.3" to a version value. + +```esql +ROW v = TO_VERSION("2.3.4") +``` + +In this example, the TO_VERSION function is used to convert the string "2.3.4" to a version value. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-trim.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-trim.txt index bed7bebc2dd60..faaad56be6f8b 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-trim.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-trim.txt @@ -1,13 +1,30 @@ -TRIM - -Syntax -Parameters -string -String expression. If null, the function returns null. -DescriptionRemoves leading and trailing whitespaces from a string.Supported types -Example +## TRIM + +The `TRIM` function in ES|QL is used to remove leading and trailing whitespaces from a string. If the string expression is null, the function will return null. + +### Syntax + +`TRIM(string)` + +#### Parameters + +`string`: A string expression. If null, the function returns null. + +### Examples + +Here are a couple of examples of how you can use the `TRIM` function in ES|QL: + ```esql ROW message = " some text ", color = " red " | EVAL message = TRIM(message) | EVAL color = TRIM(color) ``` + +In this example, the `TRIM` function is used to remove the leading and trailing whitespaces from the `message` and `color` strings. + +```esql +ROW name = " John Doe " +| EVAL trimmed_name = TRIM(name) +``` + +In this second example, the `TRIM` function is used to remove the leading and trailing whitespaces from the `name` string. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-values.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-values.txt index 0b3a1ec5db2a9..edc92663a03b8 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-values.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-values.txt @@ -1,22 +1,24 @@ -VALUES - - -Do not use VALUES on production environments. This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -Syntax -VALUES(expression) -expression -Expression of any type except geo_point, cartesian_point, geo_shape, or cartesian_shape. -DescriptionReturns all values in a group as a multivalued field. The order of the returned values isn’t guaranteed. -If you need the values returned in order use MV_SORT. -This can use a significant amount of memory and ES|QL doesn’t yet - grow aggregations beyond memory. So this aggregation will work until - it is used to collect more values than can fit into memory. Once it - collects too many values it will fail the query with - a Circuit Breaker Error. -Example +## VALUES + +The `VALUES` function in ES|QL is used to return all values in a group as a multivalued field. The order of the returned values isn’t guaranteed. If you need the values returned in order, you can use `MV_SORT`. This function can use a significant amount of memory and ES|QL doesn’t yet grow aggregations beyond memory. So this aggregation will work until it is used to collect more values than can fit into memory. Once it collects too many values it will fail the query with a Circuit Breaker Error. + +### Syntax + +`VALUES(expression)` + +Where `expression` is an expression of any type except `geo_point`, `cartesian_point`, `geo_shape`, or `cartesian_shape`. + +### Examples + +Here are a couple of examples of how you can use the `VALUES` function in ES|QL queries: + ```esql FROM employees | EVAL first_letter = SUBSTRING(first_name, 0, 1) -| STATS first_name=MV_SORT(VALUES(first_name)) BY first_letter +| STATS first_name = MV_SORT(VALUES(first_name)) BY first_letter | SORT first_letter ``` + +In this example, the `VALUES` function is used to return all values of the `first_name` field in a group as a multivalued field. The `MV_SORT` function is then used to sort these values. + +Please note that this function is in technical preview and may be changed or removed in a future release. It is not recommended to use `VALUES` on production environments. \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-where.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-where.txt index ef9816b81c3fd..3c8e9ab1bd14b 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-where.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/esql_docs/esql-where.txt @@ -1,83 +1,65 @@ -WHERE - -Syntax -WHERE expression -Parameters -expression -A boolean expression. -DescriptionThe WHERE processing command produces a table that contains all the rows from -the input table for which the provided condition evaluates to true.Examples -```esql +## WHERE + +The `WHERE` command in ES|QL is a processing command that produces a table containing all the rows from the input table for which the provided condition evaluates to true. This command is particularly useful in filtering data based on specific conditions. + +The `WHERE` command supports various functions and operators, including date math for retrieving data from a specific time range, `LIKE` and `RLIKE` for filtering data based on string patterns, and the `IN` operator for testing whether a field or expression equals an element in a list of literals, fields, or expressions. + +However, it's important to note that the `WHERE` command has certain limitations. For instance, it does not support configurations where the `_source` field is disabled. Also, full-text search is not yet supported because of the way ES|QL treats `text` values. + +### Syntax: + +`WHERE expression` + +#### Parameters: + +- `expression`: A boolean expression. + +### Examples: + +Here are some examples of how the `WHERE` command can be used in different scenarios: + +1. Filtering employees who are still hired: + + ```esql FROM employees | KEEP first_name, last_name, still_hired | WHERE still_hired == true ``` -Which, if still_hired is a boolean field, can be simplified to: -```esql -FROM employees -| KEEP first_name, last_name, still_hired -| WHERE still_hired -``` +2. Retrieving the last hour of logs: -Use date math to retrieve data from a specific time range. For example, to -retrieve the last hour of logs: -```esql + ```esql FROM sample_data | WHERE @timestamp > NOW() - 1 hour ``` -WHERE supports various functions. For example the -LENGTH function: -```esql +3. Filtering employees based on the length of their first name: + + ```esql FROM employees | KEEP first_name, last_name, height | WHERE LENGTH(first_name) < 4 ``` -For a complete list of all functions, refer to Functions overview.For NULL comparison, use the IS NULL and IS NOT NULL predicates: -```esql -FROM employees -| WHERE birth_date IS NULL -| KEEP first_name, last_name -| SORT first_name -| LIMIT 3 -``` - -```esql -FROM employees -| WHERE is_rehired IS NOT NULL -| STATS COUNT(emp_no) -``` +4. Filtering data based on string patterns using `LIKE`: -Use LIKE to filter data based on string patterns using wildcards. LIKE -usually acts on a field placed on the left-hand side of the operator, but it can -also act on a constant (literal) expression. The right-hand side of the operator -represents the pattern.The following wildcard characters are supported: -* matches zero or more characters. -? matches one character. -Supported types -```esql + ```esql FROM employees | WHERE first_name LIKE "?b*" | KEEP first_name, last_name ``` -Use RLIKE to filter data based on string patterns using using -regular expressions. RLIKE usually acts on a field placed on -the left-hand side of the operator, but it can also act on a constant (literal) -expression. The right-hand side of the operator represents the pattern.Supported types -```esql +5. Filtering data based on string patterns using `RLIKE`: + + ```esql FROM employees | WHERE first_name RLIKE ".leja.*" | KEEP first_name, last_name ``` -The IN operator allows testing whether a field or expression equals -an element in a list of literals, fields or expressions: -```esql +6. Using the `IN` operator to test whether a field or expression equals an element in a list: + + ```esql ROW a = 1, b = 4, c = 3 | WHERE c-a IN (3, b / 2, a) -``` - -For a complete list of all operators, refer to Operators. \ No newline at end of file +``` \ No newline at end of file diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/index.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/index.ts index 8a81d9ae32123..69a6e5967f746 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/index.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/index.ts @@ -25,6 +25,7 @@ import { createFunctionResponseMessage } from '@kbn/observability-ai-assistant-p import type { FunctionRegistrationParameters } from '..'; import { correctCommonEsqlMistakes } from './correct_common_esql_mistakes'; import { runAndValidateEsqlQuery } from './validate_esql_query'; +import { INLINE_ESQL_QUERY_REGEX } from './constants'; export const QUERY_FUNCTION_NAME = 'query'; @@ -240,14 +241,6 @@ export function registerQueryFunction({ functions, resources }: FunctionRegistra parameters: { type: 'object', properties: { - guides: { - type: 'array', - items: { - type: 'string', - enum: ['API', 'KIBANA', 'CROSS_CLUSTER'], - }, - description: 'A list of guides', - }, commands: { type: 'array', items: { @@ -292,7 +285,6 @@ export function registerQueryFunction({ functions, resources }: FunctionRegistra } const args = JSON.parse(response.message.function_call.arguments) as { - guides?: string[]; commands?: string[]; functions?: string[]; intention: VisualizeESQLUserIntention; @@ -301,9 +293,9 @@ export function registerQueryFunction({ functions, resources }: FunctionRegistra const keywords = [ ...(args.commands ?? []), ...(args.functions ?? []), - ...(args.guides ?? []), 'SYNTAX', 'OVERVIEW', + 'OPERATORS', ].map((keyword) => keyword.toUpperCase()); const messagesToInclude = mapValues(pick(esqlDocs, keywords), ({ data }) => data); @@ -426,12 +418,26 @@ export function registerQueryFunction({ functions, resources }: FunctionRegistra return esqlResponse$.pipe( emitWithConcatenatedMessage(async (msg) => { + msg.message.content = msg.message.content.replaceAll( + INLINE_ESQL_QUERY_REGEX, + (_match, query) => { + const correction = correctCommonEsqlMistakes(query); + if (correction.isCorrection) { + resources.logger.debug( + `Corrected query, from: \n${correction.input}\nto:\n${correction.output}` + ); + } + return '```esql\n' + correction.output + '\n```'; + } + ); + if (msg.message.function_call.name) { return msg; } - const esqlQuery = correctCommonEsqlMistakes(msg.message.content, resources.logger) - .match(/```esql([\s\S]*?)```/)?.[1] - ?.trim(); + + const esqlQuery = msg.message.content.match( + new RegExp(INLINE_ESQL_QUERY_REGEX, 'ms') + )?.[1]; let functionCall: ConcatenatedMessage['message']['function_call'] | undefined; @@ -459,7 +465,6 @@ export function registerQueryFunction({ functions, resources }: FunctionRegistra ...msg, message: { ...msg.message, - content: correctCommonEsqlMistakes(msg.message.content, resources.logger), ...(functionCall ? { function_call: functionCall, diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/system_message.txt b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/system_message.txt index 0b85e491cdcca..8fc2243480218 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/system_message.txt +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/system_message.txt @@ -1,3 +1,5 @@ +# System instructions + You are a helpful assistant for generating and executing ES|QL queries. Your goal is to help the user construct and possibly execute an ES|QL query for the Observability use cases, which often involve metrics, logs diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/validate_esql_query.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/validate_esql_query.ts index 598feaacf8d51..0b72dfd1de32d 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/validate_esql_query.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/query/validate_esql_query.ts @@ -9,7 +9,8 @@ import { validateQuery } from '@kbn/esql-validation-autocomplete'; import { getAstAndSyntaxErrors } from '@kbn/esql-ast'; import type { ElasticsearchClient } from '@kbn/core/server'; import { ESQLSearchResponse, ESQLRow } from '@kbn/es-types'; -import { esFieldTypeToKibanaFieldType, type KBN_FIELD_TYPES } from '@kbn/field-types'; +import { esFieldTypeToKibanaFieldType } from '@kbn/field-types'; +import { DatatableColumn, DatatableColumnType } from '@kbn/expressions-plugin/common'; import { splitIntoCommands } from './correct_common_esql_mistakes'; export async function runAndValidateEsqlQuery({ @@ -19,13 +20,7 @@ export async function runAndValidateEsqlQuery({ query: string; client: ElasticsearchClient; }): Promise<{ - columns?: Array<{ - id: string; - name: string; - meta: { - type: KBN_FIELD_TYPES; - }; - }>; + columns?: DatatableColumn[]; rows?: ESQLRow[]; error?: Error; errorMessages?: string[]; @@ -63,7 +58,7 @@ export async function runAndValidateEsqlQuery({ esqlResponse.columns?.map(({ name, type }) => ({ id: name, name, - meta: { type: esFieldTypeToKibanaFieldType(type) }, + meta: { type: esFieldTypeToKibanaFieldType(type) as DatatableColumnType }, })) ?? []; return { columns, rows: esqlResponse.values }; diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/visualize_esql.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/visualize_esql.ts index 1979a0535083a..bca5b04e2da06 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/visualize_esql.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/functions/visualize_esql.ts @@ -5,8 +5,11 @@ * 2.0. */ import { VisualizeESQLUserIntention } from '@kbn/observability-ai-assistant-plugin/common/functions/visualize_esql'; -import { visualizeESQLFunction } from '../../common/functions/visualize_esql'; -import { FunctionRegistrationParameters } from '.'; +import { + visualizeESQLFunction, + type VisualizeQueryResponsev1, +} from '../../common/functions/visualize_esql'; +import type { FunctionRegistrationParameters } from '.'; import { runAndValidateEsqlQuery } from './query/validate_esql_query'; const getMessageForLLM = ( @@ -27,23 +30,32 @@ export function registerVisualizeESQLFunction({ functions, resources, }: FunctionRegistrationParameters) { - functions.registerFunction(visualizeESQLFunction, async ({ arguments: { query, intention } }) => { - const { columns, errorMessages, rows } = await runAndValidateEsqlQuery({ - query, - client: (await resources.context.core).elasticsearch.client.asCurrentUser, - }); + functions.registerFunction( + visualizeESQLFunction, + async ({ arguments: { query, intention } }): Promise => { + // errorMessages contains the syntax errors from the client side valdation + // error contains the error from the server side validation, it is always one error + // and help us identify errors like index not found, field not found etc. + const { columns, errorMessages, rows, error } = await runAndValidateEsqlQuery({ + query, + client: (await resources.context.core).elasticsearch.client.asCurrentUser, + }); - const message = getMessageForLLM(intention, query, Boolean(errorMessages?.length)); + const message = getMessageForLLM(intention, query, Boolean(errorMessages?.length)); - return { - data: { - columns, - rows, - }, - content: { - message, - errorMessages, - }, - }; - }); + return { + data: { + columns: columns ?? [], + rows: rows ?? [], + }, + content: { + message, + errorMessages: [ + ...(errorMessages ? errorMessages : []), + ...(error ? [error.message] : []), + ], + }, + }; + } + ); } diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/rule_connector/index.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/rule_connector/index.ts index c6b8b56b45a87..aac5637e7d5bb 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/rule_connector/index.ts +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/server/rule_connector/index.ts @@ -224,7 +224,7 @@ async function executor( content: getSystemMessageFromInstructions({ availableFunctionNames: functionClient.getFunctions().map((fn) => fn.definition.name), registeredInstructions: functionClient.getInstructions(), - knowledgeBaseInstructions: [], + userInstructions: [], requestInstructions: [], }), }, diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_management/public/routes/components/settings_tab/settings_tab.tsx b/x-pack/plugins/observability_solution/observability_ai_assistant_management/public/routes/components/settings_tab/settings_tab.tsx index b455d4a13ca8b..4ec17f34610e2 100644 --- a/x-pack/plugins/observability_solution/observability_ai_assistant_management/public/routes/components/settings_tab/settings_tab.tsx +++ b/x-pack/plugins/observability_solution/observability_ai_assistant_management/public/routes/components/settings_tab/settings_tab.tsx @@ -50,6 +50,7 @@ export function SettingsTab() { { defaultMessage: 'Toggle the AI Assistant button and Contextual Insights on or off in Observability apps by checking or unchecking the AI Assistant feature in Spaces > > Features.', + ignoreTag: true, } )}

    diff --git a/x-pack/plugins/observability_solution/observability_onboarding/public/application/quickstart_flows/custom_logs/install_elastic_agent.tsx b/x-pack/plugins/observability_solution/observability_onboarding/public/application/quickstart_flows/custom_logs/install_elastic_agent.tsx index 2b209d8e98709..18fdc833483fe 100644 --- a/x-pack/plugins/observability_solution/observability_onboarding/public/application/quickstart_flows/custom_logs/install_elastic_agent.tsx +++ b/x-pack/plugins/observability_solution/observability_onboarding/public/application/quickstart_flows/custom_logs/install_elastic_agent.tsx @@ -70,6 +70,8 @@ export function InstallElasticAgent() { if (!hasAlreadySavedFlow(getState())) { return callApi('GET /internal/observability_onboarding/logs/setup/privileges'); } + // FIXME: Dario could not find a reasonable fix for getState() + // eslint-disable-next-line react-hooks/exhaustive-deps }, []); const { data: setup } = useFetcher((callApi) => { @@ -102,6 +104,8 @@ export function InstallElasticAgent() { }); } }, + // FIXME: Dario could not find a reasonable fix for getState() + // eslint-disable-next-line react-hooks/exhaustive-deps [monitoringRole?.hasPrivileges] ); @@ -130,10 +134,14 @@ export function InstallElasticAgent() { }, }); } + // FIXME: Dario could not find a reasonable fix for getState() + // eslint-disable-next-line react-hooks/exhaustive-deps }, []); const { apiKeyEncoded, onboardingId } = installShipperSetup ?? getState(); + const succesfullySavedOnboardingState = saveOnboardingStateDataStatus === FETCH_STATUS.SUCCESS; + const { data: yamlConfig = '', status: yamlConfigStatus } = useFetcher( (callApi) => { if (apiKeyEncoded && onboardingId) { @@ -143,7 +151,9 @@ export function InstallElasticAgent() { }); } }, - [apiKeyEncoded, onboardingId, saveOnboardingStateDataStatus === FETCH_STATUS.SUCCESS] + // FIXME: Dario could not find a reasonable fix for succesfullySavedOnboardingState + // eslint-disable-next-line react-hooks/exhaustive-deps + [apiKeyEncoded, onboardingId, succesfullySavedOnboardingState] ); useEffect(() => { diff --git a/x-pack/plugins/observability_solution/observability_onboarding/public/application/quickstart_flows/system_logs/install_elastic_agent.tsx b/x-pack/plugins/observability_solution/observability_onboarding/public/application/quickstart_flows/system_logs/install_elastic_agent.tsx index a46a7c6627662..ea25181243571 100644 --- a/x-pack/plugins/observability_solution/observability_onboarding/public/application/quickstart_flows/system_logs/install_elastic_agent.tsx +++ b/x-pack/plugins/observability_solution/observability_onboarding/public/application/quickstart_flows/system_logs/install_elastic_agent.tsx @@ -109,6 +109,8 @@ export function InstallElasticAgent() { const { apiKeyEncoded, onboardingId } = installShipperSetup ?? getState(); + const successfullyInstalledShipperSetup = installShipperSetupStatus === FETCH_STATUS.SUCCESS; + const { data: yamlConfig = '', status: yamlConfigStatus } = useFetcher( (callApi) => { if (apiKeyEncoded && onboardingId) { @@ -118,7 +120,9 @@ export function InstallElasticAgent() { }); } }, - [apiKeyEncoded, onboardingId, installShipperSetupStatus === FETCH_STATUS.SUCCESS] + // FIXME: Dario could not find a reasonable fix for successfullyInstalledShipperSetup + // eslint-disable-next-line react-hooks/exhaustive-deps + [apiKeyEncoded, onboardingId, successfullyInstalledShipperSetup] ); useEffect(() => { diff --git a/x-pack/plugins/observability_solution/observability_shared/public/hooks/use_es_search.ts b/x-pack/plugins/observability_solution/observability_shared/public/hooks/use_es_search.ts index e51fdb8964bf5..ef38cf13a8c2a 100644 --- a/x-pack/plugins/observability_solution/observability_shared/public/hooks/use_es_search.ts +++ b/x-pack/plugins/observability_solution/observability_shared/public/hooks/use_es_search.ts @@ -110,6 +110,7 @@ export const useEsSearch = (); - const [isLoading, setIsLoading] = useState(false); - - useEffect(() => { - const createDataView = () => - dataViews.create({ + const { data: dataView, loading } = useFetcher(async () => { + if (dataViewId) { + try { + return await dataViews.get(dataViewId); + } catch (e) { + return dataViews.create({ + id: `${indexPatternString}-id`, + title: indexPatternString, + allowNoIndex: true, + }); + } + } else if (indexPatternString) { + return dataViews.create({ id: `${indexPatternString}-id`, title: indexPatternString, allowNoIndex: true, }); - - if (indexPatternString) { - setIsLoading(true); - createDataView() - .then((value) => { - setStateDataView(value); - }) - .finally(() => { - setIsLoading(false); - }); } - }, [indexPatternString, dataViews]); + }, [dataViewId, dataViews, indexPatternString]); - return { dataView: stateDataView, loading: isLoading }; + return { dataView, loading: Boolean(loading) }; } diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_details/slo_details.test.tsx b/x-pack/plugins/observability_solution/slo/public/pages/slo_details/slo_details.test.tsx index 842c30073ecb1..508f8295121d2 100644 --- a/x-pack/plugins/observability_solution/slo/public/pages/slo_details/slo_details.test.tsx +++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_details/slo_details.test.tsx @@ -32,6 +32,7 @@ import { useKibana } from '../../utils/kibana_react'; import { render } from '../../utils/test_helper'; import { SloDetailsPage } from './slo_details'; import { TagsList, HeaderMenuPortal } from '@kbn/observability-shared-plugin/public'; +import { useCreateDataView } from '../../hooks/use_create_data_view'; jest.mock('react-router-dom', () => ({ ...jest.requireActual('react-router-dom'), @@ -46,6 +47,7 @@ jest.mock('../../hooks/use_fetch_active_alerts'); jest.mock('../../hooks/use_fetch_slo_details'); jest.mock('../../hooks/use_fetch_historical_summary'); jest.mock('../../hooks/use_delete_slo'); +jest.mock('../../hooks/use_create_data_view'); jest.mock('../../hooks/use_delete_slo_instance'); const useKibanaMock = useKibana as jest.Mock; @@ -56,6 +58,7 @@ const useFetchActiveAlertsMock = useFetchActiveAlerts as jest.Mock; const useFetchSloDetailsMock = useFetchSloDetails as jest.Mock; const useFetchHistoricalSummaryMock = useFetchHistoricalSummary as jest.Mock; const useDeleteSloMock = useDeleteSlo as jest.Mock; +const useCreateDataViewsMock = useCreateDataView as jest.Mock; const useDeleteSloInstanceMock = useDeleteSloInstance as jest.Mock; const TagsListMock = TagsList as jest.Mock; TagsListMock.mockReturnValue(
    Tags list
    ); @@ -132,6 +135,9 @@ describe('SLO Details Page', () => { jest.clearAllMocks(); mockKibana(); useCapabilitiesMock.mockReturnValue({ hasWriteCapabilities: true, hasReadCapabilities: true }); + useCreateDataViewsMock.mockReturnValue({ + dataView: { getName: () => 'dataview', getIndexPattern: () => '.dataview-index' }, + }); useFetchHistoricalSummaryMock.mockReturnValue({ isLoading: false, data: historicalSummaryData, diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/apm_availability/apm_availability_indicator_type_form.tsx b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/apm_availability/apm_availability_indicator_type_form.tsx index ee08e073bcac9..7424db8a448e6 100644 --- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/apm_availability/apm_availability_indicator_type_form.tsx +++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/apm_availability/apm_availability_indicator_type_form.tsx @@ -10,6 +10,7 @@ import { APMTransactionErrorRateIndicator } from '@kbn/slo-schema'; import { i18n } from '@kbn/i18n'; import React, { useEffect } from 'react'; import { useFormContext } from 'react-hook-form'; +import { DATA_VIEW_FIELD } from '../custom_common/index_selection'; import { useCreateDataView } from '../../../../hooks/use_create_data_view'; import { GroupByField } from '../common/group_by_field'; import { useFetchApmIndex } from '../../../../hooks/use_fetch_apm_indices'; @@ -23,6 +24,7 @@ import { getGroupByCardinalityFilters } from '../apm_common/get_group_by_cardina export function ApmAvailabilityIndicatorTypeForm() { const { watch, setValue } = useFormContext>(); const { data: apmIndex } = useFetchApmIndex(); + const dataViewId = watch(DATA_VIEW_FIELD); const [ serviceName = '', @@ -53,6 +55,7 @@ export function ApmAvailabilityIndicatorTypeForm() { const { dataView, loading: isIndexFieldsLoading } = useCreateDataView({ indexPatternString: apmIndex, + dataViewId, }); return ( @@ -129,7 +132,7 @@ export function ApmAvailabilityIndicatorTypeForm() { ; placeholder: string; @@ -25,10 +26,7 @@ export interface SearchBarProps { } export function QueryBuilder(props: SearchBarProps) { - const { indexPatternString, name } = props; - const { dataView } = useCreateDataView({ - indexPatternString, - }); + const { dataView, name } = props; const [isFlyoutOpen, setIsFlyoutOpen] = useState(false); const [range, setRange] = useState({ from: 'now-15m', to: 'now' }); @@ -67,6 +65,7 @@ export function QueryBuilder(props: SearchBarProps) { searchBarProps={props} /> )} + ); } diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/common/query_search_bar.tsx b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/common/query_search_bar.tsx index 49ddd17e65a4e..d238aacf1df60 100644 --- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/common/query_search_bar.tsx +++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/common/query_search_bar.tsx @@ -12,7 +12,6 @@ import { kqlQuerySchema, kqlWithFiltersSchema } from '@kbn/slo-schema'; import React, { memo } from 'react'; import styled from 'styled-components'; import { observabilityAppId } from '@kbn/observability-shared-plugin/common'; -import { useCreateDataView } from '../../../../hooks/use_create_data_view'; import { SearchBarProps } from './query_builder'; import { useKibana } from '../../../../utils/kibana_react'; import { CreateSLOForm } from '../../types'; @@ -23,7 +22,7 @@ export const QuerySearchBar = memo( isFlyoutOpen, name, label, - indexPatternString, + dataView, required, tooltip, dataTestSubj, @@ -36,9 +35,6 @@ export const QuerySearchBar = memo( setRange: (range: TimeRange) => void; }) => { const { SearchBar } = useKibana().services.unifiedSearch.ui; - const { dataView } = useCreateDataView({ - indexPatternString, - }); const { control } = useFormContext(); diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/common/runtime_field_used.tsx b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/common/runtime_field_used.tsx new file mode 100644 index 0000000000000..a937a1577e0df --- /dev/null +++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/common/runtime_field_used.tsx @@ -0,0 +1,52 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; +import React from 'react'; + +import { FieldPath } from 'react-hook-form'; +import { EuiCallOut, EuiSpacer } from '@elastic/eui'; +import { DataView } from '@kbn/data-views-plugin/common'; +import { useRunTimeFieldBeingUsed } from '../../hooks/use_find_runtime_usage'; +import { CreateSLOForm } from '../../types'; + +export function RunTimeFieldUsed({ + dataView, + name, +}: { + dataView?: DataView; + name: FieldPath; +}) { + const fieldNames = useRunTimeFieldBeingUsed(name, dataView); + + if (fieldNames.length === 0) { + return null; + } + + return ( + <> + + +

    + {fieldNames.join(', ')}, + }} + /> +

    +     + + ); +} diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_common/index_selection.tsx b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_common/index_selection.tsx index fe023cd859549..526c955f2c6d8 100644 --- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_common/index_selection.tsx +++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_common/index_selection.tsx @@ -8,103 +8,114 @@ import { EuiFormRow } from '@elastic/eui'; import { DataView } from '@kbn/data-views-plugin/public'; import { i18n } from '@kbn/i18n'; -import React, { useEffect, useState } from 'react'; +import React, { useEffect } from 'react'; import { Controller, useFormContext } from 'react-hook-form'; import { DataViewPicker } from '@kbn/unified-search-plugin/public'; -import { useFetchDataViews } from '@kbn/observability-plugin/public'; +import { getDataViewPattern, useAdhocDataViews } from './use_adhoc_data_views'; +import { SloPublicPluginsStart } from '../../../..'; import { useKibana } from '../../../../utils/kibana_react'; import { CreateSLOForm } from '../../types'; -export function IndexSelection() { - const { control, getFieldState, setValue, watch } = useFormContext(); - const { dataViews: dataViewsService } = useKibana().services; +export const DATA_VIEW_FIELD = 'indicator.params.dataViewId'; +const INDEX_FIELD = 'indicator.params.index'; +const TIMESTAMP_FIELD = 'indicator.params.timestampField'; - const { isLoading: isDataViewsLoading, data: dataViews = [], refetch } = useFetchDataViews(); +export function IndexSelection({ selectedDataView }: { selectedDataView?: DataView }) { + const { control, getFieldState, setValue, watch } = useFormContext(); + const { dataViews: dataViewsService, dataViewFieldEditor } = useKibana().services; - const { dataViewEditor } = useKibana().services; + const { dataViewEditor } = useKibana().services; - const [adHocDataViews, setAdHocDataViews] = useState([]); + const currentIndexPattern = watch(INDEX_FIELD); + const currentDataViewId = watch(DATA_VIEW_FIELD); - const currentIndexPattern = watch('indicator.params.index'); + const { dataViewsList, isDataViewsLoading, adHocDataViews, setAdHocDataViews, refetch } = + useAdhocDataViews({ + currentIndexPattern, + }); useEffect(() => { - if (!isDataViewsLoading) { - const missingAdHocDataView = - dataViews.find((dataView) => dataView.title === currentIndexPattern) || - adHocDataViews.find((dataView) => dataView.getIndexPattern() === currentIndexPattern); - - if (!missingAdHocDataView && currentIndexPattern) { - async function loadMissingDataView() { - const dataView = await dataViewsService.create( - { - title: currentIndexPattern, - allowNoIndex: true, - }, - true - ); - if (dataView.getIndexPattern() === currentIndexPattern) { - setAdHocDataViews((prev) => [...prev, dataView]); - } - } - - loadMissingDataView(); - } + const indPatternId = getDataViewPattern({ + byPatten: currentIndexPattern, + dataViewsList, + adHocDataViews, + }); + if (!currentDataViewId && currentIndexPattern && !isDataViewsLoading && indPatternId) { + setValue(DATA_VIEW_FIELD, indPatternId); } - }, [adHocDataViews, currentIndexPattern, dataViews, dataViewsService, isDataViewsLoading]); - - const getDataViewPatternById = (id?: string) => { - return ( - dataViews.find((dataView) => dataView.id === id)?.title || - adHocDataViews.find((dataView) => dataView.id === id)?.getIndexPattern() - ); - }; - - const getDataViewIdByIndexPattern = (indexPattern: string) => { - return ( - dataViews.find((dataView) => dataView.title === indexPattern) || - adHocDataViews.find((dataView) => dataView.getIndexPattern() === indexPattern) - ); - }; + }, [ + adHocDataViews, + currentDataViewId, + currentIndexPattern, + dataViewsList, + isDataViewsLoading, + setValue, + ]); return ( - + ( { - field.onChange(getDataViewPatternById(newId)); + setValue( + INDEX_FIELD, + getDataViewPattern({ byId: newId, adHocDataViews, dataViewsList })! + ); + field.onChange(newId); dataViewsService.get(newId).then((dataView) => { if (dataView.timeFieldName) { - setValue('indicator.params.timestampField', dataView.timeFieldName); + setValue(TIMESTAMP_FIELD, dataView.timeFieldName); } }); }} - currentDataViewId={getDataViewIdByIndexPattern(field.value)?.id} + onAddField={ + currentDataViewId && selectedDataView + ? () => { + dataViewFieldEditor.openEditor({ + ctx: { + dataView: selectedDataView, + }, + onSave: () => {}, + }); + } + : undefined + } + currentDataViewId={ + field.value ?? + getDataViewPattern({ + byPatten: currentIndexPattern, + dataViewsList, + adHocDataViews, + }) + } onDataViewCreated={() => { dataViewEditor.openEditor({ allowAdHocDataView: true, onSave: (dataView: DataView) => { if (!dataView.isPersisted()) { setAdHocDataViews([...adHocDataViews, dataView]); - field.onChange(dataView.getIndexPattern()); + field.onChange(dataView.id); + setValue(INDEX_FIELD, dataView.getIndexPattern()); } else { refetch(); - field.onChange(dataView.getIndexPattern()); + field.onChange(dataView.id); + setValue(INDEX_FIELD, dataView.getIndexPattern()); } if (dataView.timeFieldName) { - setValue('indicator.params.timestampField', dataView.timeFieldName); + setValue(TIMESTAMP_FIELD, dataView.timeFieldName); } }, }); diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_common/use_adhoc_data_views.ts b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_common/use_adhoc_data_views.ts new file mode 100644 index 0000000000000..6c8288df6b9d9 --- /dev/null +++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_common/use_adhoc_data_views.ts @@ -0,0 +1,75 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { useEffect, useState } from 'react'; +import { DataView, DataViewListItem } from '@kbn/data-views-plugin/common'; +import { useFetchDataViews } from '@kbn/observability-plugin/public'; +import { useKibana } from '../../../../utils/kibana_react'; + +export const getDataViewPattern = ({ + byId, + byPatten, + dataViewsList, + adHocDataViews, +}: { + byId?: string; + byPatten?: string; + dataViewsList: DataViewListItem[]; + adHocDataViews: DataView[]; +}) => { + const allDataViews = [ + ...(dataViewsList ?? []), + ...adHocDataViews.map((dv) => ({ id: dv.id, title: dv.getIndexPattern() })), + ]; + if (byId) { + return allDataViews.find((dv) => dv.id === byId)?.title; + } + if (byPatten) { + return allDataViews.find((dv) => dv.title === byPatten)?.id; + } +}; + +export const useAdhocDataViews = ({ currentIndexPattern }: { currentIndexPattern: string }) => { + const { isLoading: isDataViewsLoading, data: dataViewsList = [], refetch } = useFetchDataViews(); + const { dataViews: dataViewsService } = useKibana().services; + const [adHocDataViews, setAdHocDataViews] = useState([]); + + useEffect(() => { + if (!isDataViewsLoading) { + const missingDataView = getDataViewPattern({ + byPatten: currentIndexPattern, + dataViewsList, + adHocDataViews, + }); + + if (!missingDataView && currentIndexPattern) { + async function loadMissingDataView() { + const dataView = await dataViewsService.create( + { + title: currentIndexPattern, + allowNoIndex: true, + }, + true + ); + if (dataView.getIndexPattern() === currentIndexPattern) { + setAdHocDataViews((prev) => [...prev, dataView]); + } + } + + loadMissingDataView(); + } + } + }, [adHocDataViews, currentIndexPattern, dataViewsList, dataViewsService, isDataViewsLoading]); + + return { + adHocDataViews, + setAdHocDataViews, + dataViewsList, + isDataViewsLoading, + refetch, + }; +}; diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_kql/custom_kql_indicator_type_form.tsx b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_kql/custom_kql_indicator_type_form.tsx index b1dc9da27762f..43f0648084086 100644 --- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_kql/custom_kql_indicator_type_form.tsx +++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_kql/custom_kql_indicator_type_form.tsx @@ -15,14 +15,16 @@ import { CreateSLOForm } from '../../types'; import { DataPreviewChart } from '../common/data_preview_chart'; import { IndexFieldSelector } from '../common/index_field_selector'; import { QueryBuilder } from '../common/query_builder'; -import { IndexSelection } from '../custom_common/index_selection'; +import { DATA_VIEW_FIELD, IndexSelection } from '../custom_common/index_selection'; export function CustomKqlIndicatorTypeForm() { const { watch } = useFormContext(); const index = watch('indicator.params.index'); + const dataViewId = watch(DATA_VIEW_FIELD); const { dataView, loading: isIndexFieldsLoading } = useCreateDataView({ indexPatternString: index, + dataViewId, }); const timestampFields = dataView?.fields?.filter((field) => field.type === 'date') ?? []; @@ -30,7 +32,7 @@ export function CustomKqlIndicatorTypeForm() { - + (); const index = watch('indicator.params.index'); + const dataViewId = watch(DATA_VIEW_FIELD); const { dataView, loading: isIndexFieldsLoading } = useCreateDataView({ indexPatternString: index, + dataViewId, }); const timestampFields = dataView?.fields.filter((field) => field.type === 'date'); @@ -79,7 +81,7 @@ export function CustomMetricIndicatorTypeForm() { @@ -141,6 +144,7 @@ export function CustomMetricIndicatorTypeForm() { type="total" metricFields={metricFields ?? []} isLoadingIndex={isIndexFieldsLoading} + dataView={dataView} />     diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_metric/metric_indicator.tsx b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_metric/metric_indicator.tsx index de19f2f5146c9..03939dce314b6 100644 --- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_metric/metric_indicator.tsx +++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/custom_metric/metric_indicator.tsx @@ -13,10 +13,11 @@ import { EuiFlexGroup, EuiFlexItem, EuiFormRow, + EuiHorizontalRule, EuiIconTip, EuiSpacer, } from '@elastic/eui'; -import { FieldSpec } from '@kbn/data-views-plugin/common'; +import { DataView, FieldSpec } from '@kbn/data-views-plugin/common'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import { first, range, xor } from 'lodash'; @@ -34,6 +35,7 @@ interface MetricIndicatorProps { type: 'good' | 'total'; metricFields: FieldSpec[]; isLoadingIndex: boolean; + dataView?: DataView; } export const NEW_CUSTOM_METRIC = { name: 'A', aggregation: 'sum' as const, field: '' }; @@ -82,7 +84,12 @@ const equationTooltip = ( /> ); -export function MetricIndicator({ type, metricFields, isLoadingIndex }: MetricIndicatorProps) { +export function MetricIndicator({ + type, + metricFields, + isLoadingIndex, + dataView, +}: MetricIndicatorProps) { const { control, watch, setValue, register, getFieldState } = useFormContext(); const [options, setOptions] = useState(createOptionsFromFields(metricFields)); const [aggregationOptions, setAggregationOptions] = useState(CUSTOM_METRIC_AGGREGATION_OPTIONS); @@ -125,96 +132,29 @@ export function MetricIndicator({ type, metricFields, isLoadingIndex }: MetricIn return ( <> - {fields?.map((metric, index) => ( - - - - - {i18n.translate('xpack.slo.sloEdit.customMetric.aggregationLabel', { - defaultMessage: 'Aggregation', - })}{' '} - {metric.name} - - } - > - ( - { - if (selected.length) { - return field.onChange(selected[0].value); - } - field.onChange(''); - }} - selectedOptions={ - !!indexPattern && - !!field.value && - CUSTOM_METRIC_AGGREGATION_OPTIONS.some((agg) => agg.value === field.value) - ? [ - { - value: field.value, - label: aggValueToLabel(field.value), - }, - ] - : [] - } - onSearchChange={(searchValue: string) => { - setAggregationOptions( - CUSTOM_METRIC_AGGREGATION_OPTIONS.filter(({ value }) => - value.includes(searchValue) - ) - ); - }} - options={aggregationOptions} - /> - )} - /> - - - {watch(`indicator.params.${type}.metrics.${index}.aggregation`) !== 'doc_count' && ( + {fields?.map((metric, index, arr) => ( +
    + + - {metricLabel} {metric.name} {metricTooltip} + {i18n.translate('xpack.slo.sloEdit.customMetric.aggregationLabel', { + defaultMessage: 'Aggregation', + })}{' '} + {metric.name} } > ( metricField.name === field.value) + CUSTOM_METRIC_AGGREGATION_OPTIONS.some((agg) => agg.value === field.value) ? [ { value: field.value, - label: field.value, + label: aggValueToLabel(field.value), }, ] : [] } onSearchChange={(searchValue: string) => { - setOptions( - createOptionsFromFields(metricFields, ({ value }) => + setAggregationOptions( + CUSTOM_METRIC_AGGREGATION_OPTIONS.filter(({ value }) => value.includes(searchValue) ) ); }} - options={options} + options={aggregationOptions} /> )} /> - )} - - - } - /> - - - - - + {watch(`indicator.params.${type}.metrics.${index}.aggregation`) !== 'doc_count' && ( + + + {metricLabel} {metric.name} {metricTooltip} + + } + > + ( + { + if (selected.length) { + return field.onChange(selected[0].value); + } + field.onChange(''); + }} + selectedOptions={ + !!indexPattern && + !!field.value && + metricFields.some((metricField) => metricField.name === field.value) + ? [ + { + value: field.value, + label: field.value, + }, + ] + : [] + } + onSearchChange={(searchValue: string) => { + setOptions( + createOptionsFromFields(metricFields, ({ value }) => + value.includes(searchValue) + ) + ); + }} + options={options} + /> + )} + /> + + + )} + + + + + + } + /> + {index !== arr.length - 1 && } +
    ))} diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/histogram/histogram_indicator.tsx b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/histogram/histogram_indicator.tsx index 3cbe4dcb798e4..009504e5e6979 100644 --- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/histogram/histogram_indicator.tsx +++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/histogram/histogram_indicator.tsx @@ -15,7 +15,7 @@ import { EuiIconTip, EuiSpacer, } from '@elastic/eui'; -import { FieldSpec } from '@kbn/data-views-plugin/common'; +import { DataView, FieldSpec } from '@kbn/data-views-plugin/common'; import { i18n } from '@kbn/i18n'; import React, { Fragment, useEffect, useState } from 'react'; import { Controller, useFormContext } from 'react-hook-form'; @@ -27,6 +27,7 @@ interface HistogramIndicatorProps { type: 'good' | 'total'; histogramFields: FieldSpec[]; isLoadingIndex: boolean; + dataView?: DataView; } const AGGREGATIONS = { @@ -50,7 +51,7 @@ const aggregationTooltip = ( @@ -94,6 +95,7 @@ export function HistogramIndicator({ type, histogramFields, isLoadingIndex, + dataView, }: HistogramIndicatorProps) { const { control, watch, getFieldState } = useFormContext(); const [options, setOptions] = useState(createOptionsFromFields(histogramFields)); @@ -282,7 +284,7 @@ export function HistogramIndicator({ (); const index = watch('indicator.params.index'); + const dataViewId = watch(DATA_VIEW_FIELD); const { dataView, loading: isIndexFieldsLoading } = useCreateDataView({ indexPatternString: index, + dataViewId, }); const histogramFields = dataView?.fields.filter((field) => field.type === 'histogram'); @@ -73,7 +75,7 @@ export function HistogramIndicatorTypeForm() { >(); + const dataViewId = watch(DATA_VIEW_FIELD); const [monitorIds = [], projects = [], tags = [], index, globalFilters] = watch([ 'indicator.params.monitorIds', @@ -34,6 +37,11 @@ export function SyntheticsAvailabilityIndicatorTypeForm() { 'indicator.params.filter', ]); + const { dataView } = useCreateDataView({ + indexPatternString: index, + dataViewId, + }); + const [range, _] = useState({ from: moment().subtract(1, 'day').toDate(), to: new Date(), @@ -112,7 +120,7 @@ export function SyntheticsAvailabilityIndicatorTypeForm() { ); -export function MetricIndicator({ indexFields, isLoadingIndex }: MetricIndicatorProps) { +export function MetricIndicator({ indexFields, isLoadingIndex, dataView }: MetricIndicatorProps) { const { control, watch, setValue, register, getFieldState } = useFormContext(); const { fields, append, remove } = useFieldArray({ @@ -112,7 +115,7 @@ export function MetricIndicator({ indexFields, isLoadingIndex }: MetricIndicator return ( <> - {fields?.map((metric, index) => ( + {fields?.map((metric, index, arr) => ( @@ -140,7 +143,29 @@ export function MetricIndicator({ indexFields, isLoadingIndex }: MetricIndicator /> - + + } + /> + {index !== arr.length - 1 && } ))} @@ -288,3 +313,7 @@ export function MetricIndicator({ indexFields, isLoadingIndex }: MetricIndicator ); } + +const filterLabel = i18n.translate('xpack.slo.sloEdit.sliType.timesliceMetric.filterLabel', { + defaultMessage: 'Filter', +}); diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/timeslice_metric/metric_input.tsx b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/timeslice_metric/metric_input.tsx index f4cb60d81daf2..ebb539b97dab2 100644 --- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/timeslice_metric/metric_input.tsx +++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/timeslice_metric/metric_input.tsx @@ -19,7 +19,6 @@ import { Controller, useFormContext } from 'react-hook-form'; import { AGGREGATION_OPTIONS, aggValueToLabel } from '../../helpers/aggregation_options'; import { createOptionsFromFields, Option } from '../../helpers/create_options'; import { CreateSLOForm } from '../../types'; -import { QueryBuilder } from '../common/query_builder'; const fieldLabel = i18n.translate('xpack.slo.sloEdit.sliType.timesliceMetric.fieldLabel', { defaultMessage: 'Field', @@ -30,10 +29,6 @@ const aggregationLabel = i18n.translate( { defaultMessage: 'Aggregation' } ); -const filterLabel = i18n.translate('xpack.slo.sloEdit.sliType.timesliceMetric.filterLabel', { - defaultMessage: 'Filter', -}); - const fieldTooltip = (     )} - - - } - /> - ); } diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/timeslice_metric/timeslice_metric_indicator.tsx b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/timeslice_metric/timeslice_metric_indicator.tsx index 8bb748ea075c7..82736e4e24a25 100644 --- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/timeslice_metric/timeslice_metric_indicator.tsx +++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/timeslice_metric/timeslice_metric_indicator.tsx @@ -24,7 +24,7 @@ import { CreateSLOForm } from '../../types'; import { DataPreviewChart } from '../common/data_preview_chart'; import { IndexFieldSelector } from '../common/index_field_selector'; import { QueryBuilder } from '../common/query_builder'; -import { IndexSelection } from '../custom_common/index_selection'; +import { DATA_VIEW_FIELD, IndexSelection } from '../custom_common/index_selection'; import { MetricIndicator } from './metric_indicator'; import { COMPARATOR_MAPPING } from '../../constants'; import { useCreateDataView } from '../../../../hooks/use_create_data_view'; @@ -34,9 +34,11 @@ export { NEW_TIMESLICE_METRIC } from './metric_indicator'; export function TimesliceMetricIndicatorTypeForm() { const { watch } = useFormContext(); const index = watch('indicator.params.index'); + const dataViewId = watch(DATA_VIEW_FIELD); const { dataView, loading: isIndexFieldsLoading } = useCreateDataView({ indexPatternString: index, + dataViewId, }); const timestampFields = dataView?.fields.filter((field) => field.type === 'date'); @@ -78,7 +80,7 @@ export function TimesliceMetricIndicatorTypeForm() { diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/hooks/use_find_runtime_usage.ts b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/hooks/use_find_runtime_usage.ts new file mode 100644 index 0000000000000..c7406a5dcd863 --- /dev/null +++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/hooks/use_find_runtime_usage.ts @@ -0,0 +1,50 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { DataView } from '@kbn/data-views-plugin/common'; +import { QuerySchema, querySchema } from '@kbn/slo-schema'; +import { FieldPath, useFormContext } from 'react-hook-form'; +import { CreateSLOForm } from '../types'; +const isFieldBeingUsed = (fieldName: string, query?: QuerySchema) => { + if (!query) { + return false; + } + const checkKql = (kql: string) => { + const queryStr = kql.replace(/\s{2,}/g, ' ').trim(); + return queryStr.includes(`${fieldName} :`) || queryStr.includes(`${fieldName}:`); + }; + if (typeof query === 'string') { + return checkKql(query); + } else { + const kql = query.kqlQuery; + const inKql = kql && checkKql(kql); + const inFilter = + query.filters && + query.filters.some((filter) => { + return filter.meta.field === fieldName || filter.meta.key === fieldName; + }); + return inKql || inFilter; + } +}; + +export const useRunTimeFieldBeingUsed = ( + name: FieldPath, + dataView?: DataView +): string[] => { + const { watch } = useFormContext(); + const value = watch(name); + + if (!dataView || !value) { + return []; + } + const runTimeMappings = dataView.getRuntimeMappings(); + const filter = querySchema.is(value) ? value : undefined; + const fieldNames = Object.keys(runTimeMappings).filter((key) => { + return isFieldBeingUsed(key, filter); + }); + return fieldNames ?? []; +}; diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/slo_edit.test.tsx b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/slo_edit.test.tsx index 8925c22f82050..5f6916720902b 100644 --- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/slo_edit.test.tsx +++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/slo_edit.test.tsx @@ -21,6 +21,7 @@ import { useFetchApmSuggestions } from '../../hooks/use_fetch_apm_suggestions'; import { useFetchSloDetails } from '../../hooks/use_fetch_slo_details'; import { useUpdateSlo } from '../../hooks/use_update_slo'; import { useCreateRule, useFetchDataViews } from '@kbn/observability-plugin/public'; +import { useCreateDataView } from '../../hooks/use_create_data_view'; import { useFetchIndices } from '../../hooks/use_fetch_indices'; import { useKibana } from '../../utils/kibana_react'; import { kibanaStartMock } from '../../utils/kibana_react.mock'; @@ -36,6 +37,7 @@ jest.mock('react-router-dom', () => ({ jest.mock('@kbn/observability-shared-plugin/public'); jest.mock('../../hooks/use_fetch_indices'); +jest.mock('../../hooks/use_create_data_view'); jest.mock('../../hooks/use_fetch_slo_details'); jest.mock('../../hooks/use_create_slo'); jest.mock('../../hooks/use_update_slo'); @@ -52,6 +54,7 @@ jest.mock('../../utils/kibana_react', () => ({ const useKibanaMock = useKibana as jest.Mock; const useFetchIndicesMock = useFetchIndices as jest.Mock; const useFetchDataViewsMock = useFetchDataViews as jest.Mock; +const useCreateDataViewsMock = useCreateDataView as jest.Mock; const useFetchSloMock = useFetchSloDetails as jest.Mock; const useCreateSloMock = useCreateSlo as jest.Mock; const useUpdateSloMock = useUpdateSlo as jest.Mock; @@ -90,6 +93,8 @@ const mockKibana = (license: ILicense | null = licenseMock) => { dataViews: { create: jest.fn().mockResolvedValue({ getIndexPattern: jest.fn().mockReturnValue('some-index'), + getRuntimeMappings: jest.fn().mockReturnValue({}), + id: 'some-data-view-id', }), }, docLinks: { @@ -156,8 +161,23 @@ describe('SLO Edit Page', () => { useFetchDataViewsMock.mockReturnValue({ isLoading: false, - data: [{ getName: () => 'dataview', getIndexPattern: () => '.dataview-index' }], + data: [ + { + getName: () => 'dataview', + getIndexPattern: () => '.dataview-index', + getRuntimeMappings: jest.fn().mockReturnValue({}), + }, + ], }); + + useCreateDataViewsMock.mockReturnValue({ + dataView: { + getName: () => 'dataview', + getIndexPattern: () => '.dataview-index', + getRuntimeMappings: jest.fn().mockReturnValue({}), + }, + }); + useFetchIndicesMock.mockReturnValue({ isLoading: false, data: ['some-index', 'index-2'], diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slos/slos.test.tsx b/x-pack/plugins/observability_solution/slo/public/pages/slos/slos.test.tsx index 007dd89382073..1d6debec567b4 100644 --- a/x-pack/plugins/observability_solution/slo/public/pages/slos/slos.test.tsx +++ b/x-pack/plugins/observability_solution/slo/public/pages/slos/slos.test.tsx @@ -27,6 +27,7 @@ import { useKibana } from '../../utils/kibana_react'; import { render } from '../../utils/test_helper'; import { SlosPage } from './slos'; import { useGetSettings } from '../slo_settings/use_get_settings'; +import { useCreateDataView } from '../../hooks/use_create_data_view'; jest.mock('react-router-dom', () => ({ ...jest.requireActual('react-router-dom'), @@ -43,6 +44,7 @@ jest.mock('../../hooks/use_delete_slo'); jest.mock('../../hooks/use_delete_slo_instance'); jest.mock('../../hooks/use_fetch_historical_summary'); jest.mock('../../hooks/use_capabilities'); +jest.mock('../../hooks/use_create_data_view'); const useGetSettingsMock = useGetSettings as jest.Mock; const useKibanaMock = useKibana as jest.Mock; @@ -53,6 +55,7 @@ const useDeleteSloMock = useDeleteSlo as jest.Mock; const useDeleteSloInstanceMock = useDeleteSloInstance as jest.Mock; const useFetchHistoricalSummaryMock = useFetchHistoricalSummary as jest.Mock; const useCapabilitiesMock = useCapabilities as jest.Mock; +const useCreateDataViewMock = useCreateDataView as jest.Mock; const TagsListMock = TagsList as jest.Mock; TagsListMock.mockReturnValue(
    Tags list
    ); @@ -67,6 +70,7 @@ const mockDeleteInstance = jest.fn(); useCreateSloMock.mockReturnValue({ mutate: mockCreateSlo }); useDeleteSloMock.mockReturnValue({ mutateAsync: mockDeleteSlo }); useDeleteSloInstanceMock.mockReturnValue({ mutateAsync: mockDeleteInstance }); +useCreateDataViewMock.mockReturnValue({}); const mockNavigate = jest.fn(); const mockAddSuccess = jest.fn(); diff --git a/x-pack/plugins/observability_solution/slo/server/plugin.ts b/x-pack/plugins/observability_solution/slo/server/plugin.ts index 7c3dd521a5d52..9c701a3477485 100644 --- a/x-pack/plugins/observability_solution/slo/server/plugin.ts +++ b/x-pack/plugins/observability_solution/slo/server/plugin.ts @@ -25,6 +25,7 @@ import { TaskManagerSetupContract, TaskManagerStartContract, } from '@kbn/task-manager-plugin/server'; +import { DataViewsServerPluginStart } from '@kbn/data-views-plugin/server'; import { CloudSetup } from '@kbn/cloud-plugin/server'; import { SharePluginSetup } from '@kbn/share-plugin/server'; import { UsageCollectionSetup } from '@kbn/usage-collection-plugin/server'; @@ -60,6 +61,7 @@ export interface PluginStart { taskManager: TaskManagerStartContract; spaces?: SpacesPluginStart; ruleRegistry: RuleRegistryPluginStartContract; + dataViews: DataViewsServerPluginStart; } const sloRuleTypes = [SLO_BURN_RATE_RULE_TYPE_ID]; @@ -148,6 +150,10 @@ export class SloPlugin implements Plugin { ...plugins, core, }, + getDataViewsStart: async () => { + const [, pluginStart] = await core.getStartServices(); + return pluginStart.dataViews; + }, getSpacesStart: async () => { const [, pluginStart] = await core.getStartServices(); return pluginStart.spaces; diff --git a/x-pack/plugins/observability_solution/slo/server/routes/register_routes.ts b/x-pack/plugins/observability_solution/slo/server/routes/register_routes.ts index e74b5abb811b9..8ddabede0d190 100644 --- a/x-pack/plugins/observability_solution/slo/server/routes/register_routes.ts +++ b/x-pack/plugins/observability_solution/slo/server/routes/register_routes.ts @@ -21,6 +21,7 @@ import { import { SpacesPluginStart } from '@kbn/spaces-plugin/server'; import axios from 'axios'; import * as t from 'io-ts'; +import { DataViewsServerPluginStart } from '@kbn/data-views-plugin/server'; import { SloConfig } from '..'; import { getHTTPResponseCode, ObservabilityError } from '../errors'; import { SloRequestHandlerContext } from '../types'; @@ -43,6 +44,7 @@ export interface RegisterRoutesDependencies { ruleDataService: RuleDataPluginService; getRulesClientWithRequest: (request: KibanaRequest) => Promise; getRacClientWithRequest: (request: KibanaRequest) => Promise; + getDataViewsStart: () => Promise; } export function registerRoutes({ config, repository, core, logger, dependencies }: RegisterRoutes) { diff --git a/x-pack/plugins/observability_solution/slo/server/routes/slo/route.ts b/x-pack/plugins/observability_solution/slo/server/routes/slo/route.ts index 61c081b087e15..f5075abac0c0a 100644 --- a/x-pack/plugins/observability_solution/slo/server/routes/slo/route.ts +++ b/x-pack/plugins/observability_solution/slo/server/routes/slo/route.ts @@ -101,17 +101,21 @@ const createSLORoute = createSloServerRoute({ await assertPlatinumLicense(context); const spaces = await dependencies.getSpacesStart(); + const dataViews = await dependencies.getDataViewsStart(); const spaceId = (await spaces?.spacesService?.getActiveSpace(request))?.id ?? 'default'; const esClient = (await context.core).elasticsearch.client.asCurrentUser; const basePath = dependencies.pluginsSetup.core.http.basePath; const soClient = (await context.core).savedObjects.client; const repository = new KibanaSavedObjectsSLORepository(soClient, logger); + + const dataViewsService = await dataViews.dataViewsServiceFactory(soClient, esClient); const transformManager = new DefaultTransformManager( transformGenerators, esClient, logger, - spaceId + spaceId, + dataViewsService ); const summaryTransformManager = new DefaultSummaryTransformManager( new DefaultSummaryTransformGenerator(), @@ -146,16 +150,19 @@ const inspectSLORoute = createSloServerRoute({ await assertPlatinumLicense(context); const spaces = await dependencies.getSpacesStart(); + const dataViews = await dependencies.getDataViewsStart(); const spaceId = (await spaces?.spacesService?.getActiveSpace(request))?.id ?? 'default'; const basePath = dependencies.pluginsSetup.core.http.basePath; const esClient = (await context.core).elasticsearch.client.asCurrentUser; const soClient = (await context.core).savedObjects.client; const repository = new KibanaSavedObjectsSLORepository(soClient, logger); + const dataViewsService = await dataViews.dataViewsServiceFactory(soClient, esClient); const transformManager = new DefaultTransformManager( transformGenerators, esClient, logger, - spaceId + spaceId, + dataViewsService ); const summaryTransformManager = new DefaultSummaryTransformManager( new DefaultSummaryTransformGenerator(), @@ -189,17 +196,19 @@ const updateSLORoute = createSloServerRoute({ const spaces = await dependencies.getSpacesStart(); const spaceId = (await spaces?.spacesService?.getActiveSpace(request))?.id ?? 'default'; + const dataViews = await dependencies.getDataViewsStart(); const basePath = dependencies.pluginsSetup.core.http.basePath; const esClient = (await context.core).elasticsearch.client.asCurrentUser; const soClient = (await context.core).savedObjects.client; - + const dataViewsService = await dataViews.dataViewsServiceFactory(soClient, esClient); const repository = new KibanaSavedObjectsSLORepository(soClient, logger); const transformManager = new DefaultTransformManager( transformGenerators, esClient, logger, - spaceId + spaceId, + dataViewsService ); const summaryTransformManager = new DefaultSummaryTransformManager( new DefaultSummaryTransformGenerator(), @@ -235,17 +244,21 @@ const deleteSLORoute = createSloServerRoute({ const spaces = await dependencies.getSpacesStart(); const spaceId = (await spaces?.spacesService?.getActiveSpace(request))?.id ?? 'default'; + const dataViews = await dependencies.getDataViewsStart(); const esClient = (await context.core).elasticsearch.client.asCurrentUser; const soClient = (await context.core).savedObjects.client; const rulesClient = await dependencies.getRulesClientWithRequest(request); + const dataViewsService = await dataViews.dataViewsServiceFactory(soClient, esClient); + const repository = new KibanaSavedObjectsSLORepository(soClient, logger); const transformManager = new DefaultTransformManager( transformGenerators, esClient, logger, - spaceId + spaceId, + dataViewsService ); const summaryTransformManager = new DefaultSummaryTransformManager( @@ -302,16 +315,18 @@ const enableSLORoute = createSloServerRoute({ const spaces = await dependencies.getSpacesStart(); const spaceId = (await spaces?.spacesService?.getActiveSpace(request))?.id ?? 'default'; + const dataViews = await dependencies.getDataViewsStart(); const soClient = (await context.core).savedObjects.client; const esClient = (await context.core).elasticsearch.client.asCurrentUser; - + const dataViewsService = await dataViews.dataViewsServiceFactory(soClient, esClient); const repository = new KibanaSavedObjectsSLORepository(soClient, logger); const transformManager = new DefaultTransformManager( transformGenerators, esClient, logger, - spaceId + spaceId, + dataViewsService ); const summaryTransformManager = new DefaultSummaryTransformManager( new DefaultSummaryTransformGenerator(), @@ -339,16 +354,18 @@ const disableSLORoute = createSloServerRoute({ const spaces = await dependencies.getSpacesStart(); const spaceId = (await spaces?.spacesService?.getActiveSpace(request))?.id ?? 'default'; + const dataViews = await dependencies.getDataViewsStart(); const soClient = (await context.core).savedObjects.client; const esClient = (await context.core).elasticsearch.client.asCurrentUser; - + const dataViewsService = await dataViews.dataViewsServiceFactory(soClient, esClient); const repository = new KibanaSavedObjectsSLORepository(soClient, logger); const transformManager = new DefaultTransformManager( transformGenerators, esClient, logger, - spaceId + spaceId, + dataViewsService ); const summaryTransformManager = new DefaultSummaryTransformManager( new DefaultSummaryTransformGenerator(), @@ -375,17 +392,20 @@ const resetSLORoute = createSloServerRoute({ await assertPlatinumLicense(context); const spaces = await dependencies.getSpacesStart(); + const dataViews = await dependencies.getDataViewsStart(); const spaceId = (await spaces?.spacesService?.getActiveSpace(request))?.id ?? 'default'; const soClient = (await context.core).savedObjects.client; const esClient = (await context.core).elasticsearch.client.asCurrentUser; const basePath = dependencies.pluginsSetup.core.http.basePath; + const dataViewsService = await dataViews.dataViewsServiceFactory(soClient, esClient); const repository = new KibanaSavedObjectsSLORepository(soClient, logger); const transformManager = new DefaultTransformManager( transformGenerators, esClient, logger, - spaceId + spaceId, + dataViewsService ); const summaryTransformManager = new DefaultSummaryTransformManager( new DefaultSummaryTransformGenerator(), @@ -629,9 +649,12 @@ const getPreviewData = createSloServerRoute({ const spaces = await dependencies.getSpacesStart(); const spaceId = (await spaces?.spacesService?.getActiveSpace(request))?.id ?? 'default'; + const dataViews = await dependencies.getDataViewsStart(); const esClient = (await context.core).elasticsearch.client.asCurrentUser; - const service = new GetPreviewData(esClient, spaceId); + const soClient = (await context.core).savedObjects.client; + const dataViewsService = await dataViews.dataViewsServiceFactory(soClient, esClient); + const service = new GetPreviewData(esClient, spaceId, dataViewsService); return await service.execute(params.body); }, }); diff --git a/x-pack/plugins/observability_solution/slo/server/services/__snapshots__/update_slo.test.ts.snap b/x-pack/plugins/observability_solution/slo/server/services/__snapshots__/update_slo.test.ts.snap deleted file mode 100644 index c1f0099d24343..0000000000000 --- a/x-pack/plugins/observability_solution/slo/server/services/__snapshots__/update_slo.test.ts.snap +++ /dev/null @@ -1,88 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`UpdateSLO when error happens during the update restores the previous SLO definition in the repository 1`] = ` -[MockFunction] { - "calls": Array [ - Array [ - "slo-summary-original-id-2", - ], - ], - "results": Array [ - Object { - "type": "return", - "value": undefined, - }, - ], -} -`; - -exports[`UpdateSLO when error happens during the update restores the previous SLO definition in the repository 2`] = ` -[MockFunction] { - "calls": Array [ - Array [ - "slo-summary-original-id-2", - ], - ], - "results": Array [ - Object { - "type": "return", - "value": undefined, - }, - ], -} -`; - -exports[`UpdateSLO when error happens during the update restores the previous SLO definition in the repository 3`] = ` -[MockFunction] { - "calls": Array [ - Array [ - "slo-original-id-2", - ], - ], - "results": Array [ - Object { - "type": "return", - "value": undefined, - }, - ], -} -`; - -exports[`UpdateSLO when error happens during the update restores the previous SLO definition in the repository 4`] = ` -[MockFunction] { - "calls": Array [ - Array [ - "slo-original-id-2", - ], - ], - "results": Array [ - Object { - "type": "return", - "value": undefined, - }, - ], -} -`; - -exports[`UpdateSLO when error happens during the update restores the previous SLO definition in the repository 5`] = ` -[MockFunction] { - "calls": Array [ - Array [ - Object { - "id": ".slo-observability.summary.pipeline-original-id-2", - }, - Object { - "ignore": Array [ - 404, - ], - }, - ], - ], - "results": Array [ - Object { - "type": "return", - "value": Promise {}, - }, - ], -} -`; diff --git a/x-pack/plugins/observability_solution/slo/server/services/create_slo.test.ts b/x-pack/plugins/observability_solution/slo/server/services/create_slo.test.ts index cefff32016e2b..7b45b321f4057 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/create_slo.test.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/create_slo.test.ts @@ -24,8 +24,8 @@ import { SLORepository } from './slo_repository'; import { TransformManager } from './transform_manager'; describe('CreateSLO', () => { - let esClientMock: ElasticsearchClientMock; - let loggerMock: jest.Mocked; + let mockEsClient: ElasticsearchClientMock; + let mockLogger: jest.Mocked; let mockRepository: jest.Mocked; let mockTransformManager: jest.Mocked; let mockSummaryTransformManager: jest.Mocked; @@ -34,17 +34,17 @@ describe('CreateSLO', () => { jest.useFakeTimers().setSystemTime(new Date('2024-01-01')); beforeEach(() => { - esClientMock = elasticsearchServiceMock.createElasticsearchClient(); - loggerMock = loggingSystemMock.createLogger(); + mockEsClient = elasticsearchServiceMock.createElasticsearchClient(); + mockLogger = loggingSystemMock.createLogger(); mockRepository = createSLORepositoryMock(); mockTransformManager = createTransformManagerMock(); mockSummaryTransformManager = createSummaryTransformManagerMock(); createSLO = new CreateSLO( - esClientMock, + mockEsClient, mockRepository, mockTransformManager, mockSummaryTransformManager, - loggerMock, + mockLogger, 'some-space', httpServiceMock.createStartContract().basePath ); @@ -82,10 +82,10 @@ describe('CreateSLO', () => { expect(mockTransformManager.install).toHaveBeenCalled(); expect(mockTransformManager.start).toHaveBeenCalled(); - expect(esClientMock.ingest.putPipeline.mock.calls[0]).toMatchSnapshot(); + expect(mockEsClient.ingest.putPipeline.mock.calls[0]).toMatchSnapshot(); expect(mockSummaryTransformManager.install).toHaveBeenCalled(); expect(mockSummaryTransformManager.start).toHaveBeenCalled(); - expect(esClientMock.index.mock.calls[0]).toMatchSnapshot(); + expect(mockEsClient.index.mock.calls[0]).toMatchSnapshot(); expect(response).toEqual(expect.objectContaining({ id: 'unique-id' })); }); @@ -156,7 +156,7 @@ describe('CreateSLO', () => { }); describe('unhappy path', () => { - it('rollbacks new resources on failure', async () => { + it('rollbacks completed operations when rollup transform install fails', async () => { mockTransformManager.install.mockRejectedValue(new Error('Rollup transform install error')); const sloParams = createSLOParams({ indicator: createAPMTransactionErrorRateIndicator() }); @@ -164,12 +164,48 @@ describe('CreateSLO', () => { 'Rollup transform install error' ); - expect(mockSummaryTransformManager.stop).toHaveBeenCalled(); - expect(mockSummaryTransformManager.uninstall).toHaveBeenCalled(); + expect(mockRepository.deleteById).toHaveBeenCalled(); + + expect(mockSummaryTransformManager.stop).not.toHaveBeenCalled(); + expect(mockSummaryTransformManager.uninstall).not.toHaveBeenCalled(); + expect(mockTransformManager.stop).not.toHaveBeenCalled(); + expect(mockTransformManager.uninstall).not.toHaveBeenCalled(); + expect(mockEsClient.ingest.deletePipeline).not.toHaveBeenCalled(); + }); + + it('rollbacks completed operations when summary transform start fails', async () => { + mockSummaryTransformManager.start.mockRejectedValue( + new Error('Summary transform install error') + ); + const sloParams = createSLOParams({ indicator: createAPMTransactionErrorRateIndicator() }); + + await expect(createSLO.execute(sloParams)).rejects.toThrowError( + 'Summary transform install error' + ); + + expect(mockRepository.deleteById).toHaveBeenCalled(); expect(mockTransformManager.stop).toHaveBeenCalled(); expect(mockTransformManager.uninstall).toHaveBeenCalled(); - expect(esClientMock.ingest.deletePipeline).toHaveBeenCalled(); + expect(mockEsClient.ingest.deletePipeline).toHaveBeenCalled(); + expect(mockSummaryTransformManager.uninstall).toHaveBeenCalled(); + + expect(mockSummaryTransformManager.stop).not.toHaveBeenCalled(); + }); + + it('rollbacks completed operations when create temporary document fails', async () => { + mockEsClient.index.mockRejectedValue(new Error('temporary document index failed')); + const sloParams = createSLOParams({ indicator: createAPMTransactionErrorRateIndicator() }); + + await expect(createSLO.execute(sloParams)).rejects.toThrowError( + 'temporary document index failed' + ); + expect(mockRepository.deleteById).toHaveBeenCalled(); + expect(mockTransformManager.stop).toHaveBeenCalled(); + expect(mockTransformManager.uninstall).toHaveBeenCalled(); + expect(mockEsClient.ingest.deletePipeline).toHaveBeenCalled(); + expect(mockSummaryTransformManager.stop).toHaveBeenCalled(); + expect(mockSummaryTransformManager.uninstall).toHaveBeenCalled(); }); }); }); diff --git a/x-pack/plugins/observability_solution/slo/server/services/create_slo.ts b/x-pack/plugins/observability_solution/slo/server/services/create_slo.ts index 60a5da93d9bf7..cb5b59bb3cf1e 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/create_slo.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/create_slo.ts @@ -8,8 +8,8 @@ import { TransformPutTransformRequest } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { ElasticsearchClient, IBasePath, Logger } from '@kbn/core/server'; import { ALL_VALUE, CreateSLOParams, CreateSLOResponse } from '@kbn/slo-schema'; +import { asyncForEach } from '@kbn/std'; import { v4 as uuidv4 } from 'uuid'; -import { getTransformQueryComposite } from './utils/get_transform_compite_query'; import { getSLOSummaryPipelineId, getSLOSummaryTransformId, @@ -24,6 +24,7 @@ import { retryTransientEsErrors } from '../utils/retry'; import { SLORepository } from './slo_repository'; import { createTempSummaryDocument } from './summary_transform_generator/helpers/create_temp_summary'; import { TransformManager } from './transform_manager'; +import { getTransformQueryComposite } from './utils/get_transform_compite_query'; export class CreateSLO { constructor( @@ -40,13 +41,20 @@ export class CreateSLO { const slo = this.toSLO(params); validateSLO(slo); + const rollbackOperations = []; + await this.repository.save(slo, { throwOnConflict: true }); + rollbackOperations.push(() => this.repository.deleteById(slo.id)); const rollupTransformId = getSLOTransformId(slo.id, slo.revision); const summaryTransformId = getSLOSummaryTransformId(slo.id, slo.revision); try { await this.transformManager.install(slo); + rollbackOperations.push(() => this.transformManager.uninstall(rollupTransformId)); + await this.transformManager.start(rollupTransformId); + rollbackOperations.push(() => this.transformManager.stop(rollupTransformId)); + await retryTransientEsErrors( () => this.esClient.ingest.putPipeline( @@ -54,9 +62,18 @@ export class CreateSLO { ), { logger: this.logger } ); + rollbackOperations.push(() => + this.esClient.ingest.deletePipeline( + { id: getSLOSummaryPipelineId(slo.id, slo.revision) }, + { ignore: [404] } + ) + ); await this.summaryTransformManager.install(slo); + rollbackOperations.push(() => this.summaryTransformManager.uninstall(summaryTransformId)); + await this.summaryTransformManager.start(summaryTransformId); + rollbackOperations.push(() => this.summaryTransformManager.stop(summaryTransformId)); await retryTransientEsErrors( () => @@ -73,15 +90,13 @@ export class CreateSLO { `Cannot install the SLO [id: ${slo.id}, revision: ${slo.revision}]. Rolling back.` ); - await this.summaryTransformManager.stop(summaryTransformId); - await this.summaryTransformManager.uninstall(summaryTransformId); - await this.transformManager.stop(rollupTransformId); - await this.transformManager.uninstall(rollupTransformId); - await this.esClient.ingest.deletePipeline( - { id: getSLOSummaryPipelineId(slo.id, slo.revision) }, - { ignore: [404] } - ); - await this.repository.deleteById(slo.id); + await asyncForEach(rollbackOperations.reverse(), async (operation) => { + try { + await operation(); + } catch (rollbackErr) { + this.logger.error('Rollback operation failed', rollbackErr); + } + }); throw err; } @@ -89,7 +104,7 @@ export class CreateSLO { return this.toResponse(slo); } - public inspect(params: CreateSLOParams): { + public async inspect(params: CreateSLOParams): Promise<{ slo: CreateSLOParams; pipeline: Record; rollUpTransform: TransformPutTransformRequest; @@ -97,13 +112,13 @@ export class CreateSLO { temporaryDoc: Record; rollUpTransformCompositeQuery: string; summaryTransformCompositeQuery: string; - } { + }> { const slo = this.toSLO(params); validateSLO(slo); - const rollUpTransform = this.transformManager.inspect(slo); + const rollUpTransform = await this.transformManager.inspect(slo); const pipeline = getSLOSummaryPipelineTemplate(slo, this.spaceId, this.basePath); - const summaryTransform = this.summaryTransformManager.inspect(slo); + const summaryTransform = await this.summaryTransformManager.inspect(slo); const temporaryDoc = createTempSummaryDocument(slo, this.spaceId, this.basePath); return { diff --git a/x-pack/plugins/observability_solution/slo/server/services/get_preview_data.ts b/x-pack/plugins/observability_solution/slo/server/services/get_preview_data.ts index 06d740aca3508..a18c4d035a096 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/get_preview_data.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/get_preview_data.ts @@ -21,6 +21,7 @@ import { assertNever } from '@kbn/std'; import moment from 'moment'; import { ElasticsearchClient } from '@kbn/core/server'; import { estypes } from '@elastic/elasticsearch'; +import { DataView, DataViewsService } from '@kbn/data-views-plugin/common'; import { getElasticsearchQueryOrThrow } from './transform_generators'; import { buildParamValues } from './transform_generators/synthetics_availability'; @@ -46,7 +47,23 @@ interface Options { groupings?: Record; } export class GetPreviewData { - constructor(private esClient: ElasticsearchClient, private spaceId: string) {} + constructor( + private esClient: ElasticsearchClient, + private spaceId: string, + private dataViewService: DataViewsService + ) {} + + public async buildRuntimeMappings({ dataViewId }: { dataViewId?: string }) { + let dataView: DataView | undefined; + if (dataViewId) { + try { + dataView = await this.dataViewService.get(dataViewId); + } catch (e) { + // If the data view is not found, we will continue without it + } + } + return dataView?.getRuntimeMappings?.() ?? {}; + } private async getAPMTransactionDurationPreviewData( indicator: APMTransactionDurationIndicator, @@ -81,6 +98,9 @@ export class GetPreviewData { const result = await typedSearch(this.esClient, { index, + runtime_mappings: await this.buildRuntimeMappings({ + dataViewId: indicator.params.dataViewId, + }), size: 0, query: { bool: { @@ -177,6 +197,9 @@ export class GetPreviewData { const result = await this.esClient.search({ index, + runtime_mappings: await this.buildRuntimeMappings({ + dataViewId: indicator.params.dataViewId, + }), size: 0, query: { bool: { @@ -256,6 +279,9 @@ export class GetPreviewData { const result = await this.esClient.search({ index, + runtime_mappings: await this.buildRuntimeMappings({ + dataViewId: indicator.params.dataViewId, + }), size: 0, query: { bool: { @@ -321,6 +347,9 @@ export class GetPreviewData { const result = await this.esClient.search({ index, + runtime_mappings: await this.buildRuntimeMappings({ + dataViewId: indicator.params.dataViewId, + }), size: 0, query: { bool: { @@ -389,6 +418,9 @@ export class GetPreviewData { const result = await this.esClient.search({ index, + runtime_mappings: await this.buildRuntimeMappings({ + dataViewId: indicator.params.dataViewId, + }), size: 0, query: { bool: { @@ -440,6 +472,9 @@ export class GetPreviewData { const result = await this.esClient.search({ index, + runtime_mappings: await this.buildRuntimeMappings({ + dataViewId: indicator.params.dataViewId, + }), size: 0, query: { bool: { @@ -523,6 +558,9 @@ export class GetPreviewData { const result = await this.esClient.search({ index, + runtime_mappings: await this.buildRuntimeMappings({ + dataViewId: indicator.params.dataViewId, + }), size: 0, query: { bool: { diff --git a/x-pack/plugins/observability_solution/slo/server/services/summay_transform_manager.ts b/x-pack/plugins/observability_solution/slo/server/services/summay_transform_manager.ts index 27276f59330e8..5529591a81e20 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/summay_transform_manager.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/summay_transform_manager.ts @@ -23,7 +23,7 @@ export class DefaultSummaryTransformManager implements TransformManager { ) {} async install(slo: SLODefinition): Promise { - const transformParams = this.generator.generate(slo); + const transformParams = await this.generator.generate(slo); try { await retryTransientEsErrors(() => this.esClient.transform.putTransform(transformParams), { logger: this.logger, @@ -40,7 +40,7 @@ export class DefaultSummaryTransformManager implements TransformManager { return transformParams.transform_id; } - inspect(slo: SLODefinition): TransformPutTransformRequest { + async inspect(slo: SLODefinition): Promise { return this.generator.generate(slo); } diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.test.ts index 2ab6b26442967..b764b83ea9349 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.test.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.test.ts @@ -13,28 +13,30 @@ import { createSLOWithTimeslicesBudgetingMethod, } from '../fixtures/slo'; import { ApmTransactionDurationTransformGenerator } from './apm_transaction_duration'; +import { dataViewsService } from '@kbn/data-views-plugin/server/mocks'; const generator = new ApmTransactionDurationTransformGenerator(); +const spaceId = 'custom-space'; describe('APM Transaction Duration Transform Generator', () => { - it('returns the expected transform params with every specified indicator params', () => { + it('returns the expected transform params with every specified indicator params', async () => { const slo = createSLO({ id: 'irrelevant', indicator: createAPMTransactionDurationIndicator() }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); - it('returns the expected transform params for timeslices slo', () => { + it('returns the expected transform params for timeslices slo', async () => { const slo = createSLOWithTimeslicesBudgetingMethod({ id: 'irrelevant', indicator: createAPMTransactionDurationIndicator(), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); - it('returns the expected transform params for timeslices slo using a timesliceTarget = 0', () => { + it('returns the expected transform params for timeslices slo using a timesliceTarget = 0', async () => { const slo = createSLOWithTimeslicesBudgetingMethod({ id: 'irrelevant', indicator: createAPMTransactionDurationIndicator(), @@ -44,12 +46,12 @@ describe('APM Transaction Duration Transform Generator', () => { timesliceWindow: twoMinute(), }, }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); - it("does not include the query filter when params are '*'", () => { + it("does not include the query filter when params are '*'", async () => { const slo = createSLO({ indicator: createAPMTransactionDurationIndicator({ environment: ALL_VALUE, @@ -58,36 +60,36 @@ describe('APM Transaction Duration Transform Generator', () => { transactionType: ALL_VALUE, }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); }); - it('uses the provided index params as source index', () => { + it('uses the provided index params as source index', async () => { const index = 'my-custom-apm-index*'; const slo = createSLO({ indicator: createAPMTransactionDurationIndicator({ index, }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.index).toEqual(index); }); - it('adds the custom kql filter to the query', () => { + it('adds the custom kql filter to the query', async () => { const filter = `"my.field" : "value" and ("foo" >= 12 or "bar" <= 100)`; const slo = createSLO({ indicator: createAPMTransactionDurationIndicator({ filter, }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); }); - it("groups by the 'service.name'", () => { + it("groups by the 'service.name'", async () => { const slo = createSLO({ indicator: createAPMTransactionDurationIndicator({ service: 'my-service', @@ -97,13 +99,13 @@ describe('APM Transaction Duration Transform Generator', () => { }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); expect(transform.pivot?.group_by).toMatchSnapshot(); }); - it("groups by the 'service.environment'", () => { + it("groups by the 'service.environment'", async () => { const slo = createSLO({ indicator: createAPMTransactionDurationIndicator({ service: ALL_VALUE, @@ -113,13 +115,13 @@ describe('APM Transaction Duration Transform Generator', () => { }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); expect(transform.pivot?.group_by).toMatchSnapshot(); }); - it("groups by the 'transaction.name'", () => { + it("groups by the 'transaction.name'", async () => { const slo = createSLO({ indicator: createAPMTransactionDurationIndicator({ service: ALL_VALUE, @@ -129,13 +131,13 @@ describe('APM Transaction Duration Transform Generator', () => { }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); expect(transform.pivot?.group_by).toMatchSnapshot(); }); - it("groups by the 'transaction.type'", () => { + it("groups by the 'transaction.type'", async () => { const slo = createSLO({ indicator: createAPMTransactionDurationIndicator({ service: ALL_VALUE, @@ -145,13 +147,13 @@ describe('APM Transaction Duration Transform Generator', () => { }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); expect(transform.pivot?.group_by).toMatchSnapshot(); }); - it("overrides the range filter when 'preventInitialBackfill' is true", () => { + it("overrides the range filter when 'preventInitialBackfill' is true", async () => { const slo = createSLO({ indicator: createAPMTransactionDurationIndicator(), settings: { @@ -161,7 +163,7 @@ describe('APM Transaction Duration Transform Generator', () => { }, }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); // @ts-ignore const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f); diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.ts index 6bbec476754cb..afb37b4f0a105 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.ts @@ -13,6 +13,7 @@ import { apmTransactionDurationIndicatorSchema, timeslicesBudgetingMethodSchema, } from '@kbn/slo-schema'; +import { DataViewsService } from '@kbn/data-views-plugin/common'; import { getElasticsearchQueryOrThrow, TransformGenerator } from '.'; import { getSLOTransformId, @@ -26,7 +27,11 @@ import { parseIndex } from './common'; import { getTimesliceTargetComparator, getFilterRange } from './common'; export class ApmTransactionDurationTransformGenerator extends TransformGenerator { - public getTransformParams(slo: SLODefinition): TransformPutTransformRequest { + public async getTransformParams( + slo: SLODefinition, + spaceId: string, + dataViewService: DataViewsService + ): Promise { if (!apmTransactionDurationIndicatorSchema.is(slo.indicator)) { throw new InvalidTransformError(`Cannot handle SLO of indicator type: ${slo.indicator.type}`); } @@ -34,7 +39,7 @@ export class ApmTransactionDurationTransformGenerator extends TransformGenerator return getSLOTransformTemplate( this.buildTransformId(slo), this.buildDescription(slo), - this.buildSource(slo, slo.indicator), + await this.buildSource(slo, slo.indicator, dataViewService), this.buildDestination(), this.buildGroupBy(slo, slo.indicator), this.buildAggregations(slo, slo.indicator), @@ -70,7 +75,11 @@ export class ApmTransactionDurationTransformGenerator extends TransformGenerator return this.buildCommonGroupBy(slo, '@timestamp', extraGroupByFields); } - private buildSource(slo: SLODefinition, indicator: APMTransactionDurationIndicator) { + private async buildSource( + slo: SLODefinition, + indicator: APMTransactionDurationIndicator, + dataViewService: DataViewsService + ) { const queryFilter: estypes.QueryDslQueryContainer[] = [getFilterRange(slo, '@timestamp')]; if (indicator.params.service !== ALL_VALUE) { @@ -104,14 +113,18 @@ export class ApmTransactionDurationTransformGenerator extends TransformGenerator }, }); } + const dataView = await this.getIndicatorDataView({ + dataViewService, + dataViewId: indicator.params.dataViewId, + }); if (!!indicator.params.filter) { - queryFilter.push(getElasticsearchQueryOrThrow(indicator.params.filter)); + queryFilter.push(getElasticsearchQueryOrThrow(indicator.params.filter, dataView)); } return { index: parseIndex(indicator.params.index), - runtime_mappings: this.buildCommonRuntimeMappings(slo), + runtime_mappings: this.buildCommonRuntimeMappings(slo, dataView), query: { bool: { filter: [ diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.test.ts index 5706521cdf2f6..13c73443960af 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.test.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.test.ts @@ -13,8 +13,10 @@ import { createSLOWithTimeslicesBudgetingMethod, } from '../fixtures/slo'; import { ApmTransactionErrorRateTransformGenerator } from './apm_transaction_error_rate'; +import { dataViewsService } from '@kbn/data-views-plugin/server/mocks'; const generator = new ApmTransactionErrorRateTransformGenerator(); +const spaceId = 'custom-space'; describe('APM Transaction Error Rate Transform Generator', () => { it('returns the expected transform params with every specified indicator params', async () => { @@ -22,7 +24,7 @@ describe('APM Transaction Error Rate Transform Generator', () => { id: 'irrelevant', indicator: createAPMTransactionErrorRateIndicator(), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); @@ -32,7 +34,7 @@ describe('APM Transaction Error Rate Transform Generator', () => { id: 'irrelevant', indicator: createAPMTransactionErrorRateIndicator(), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); @@ -47,7 +49,7 @@ describe('APM Transaction Error Rate Transform Generator', () => { timesliceWindow: twoMinute(), }, }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); @@ -61,7 +63,7 @@ describe('APM Transaction Error Rate Transform Generator', () => { transactionType: ALL_VALUE, }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); }); @@ -73,7 +75,7 @@ describe('APM Transaction Error Rate Transform Generator', () => { index, }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.index).toEqual(index); }); @@ -85,12 +87,12 @@ describe('APM Transaction Error Rate Transform Generator', () => { filter, }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); }); - it("groups by the 'service.name'", () => { + it("groups by the 'service.name'", async () => { const slo = createSLO({ indicator: createAPMTransactionErrorRateIndicator({ service: 'my-service', @@ -100,13 +102,13 @@ describe('APM Transaction Error Rate Transform Generator', () => { }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); expect(transform.pivot?.group_by).toMatchSnapshot(); }); - it("groups by the 'service.environment'", () => { + it("groups by the 'service.environment'", async () => { const slo = createSLO({ indicator: createAPMTransactionErrorRateIndicator({ service: ALL_VALUE, @@ -116,13 +118,13 @@ describe('APM Transaction Error Rate Transform Generator', () => { }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); expect(transform.pivot?.group_by).toMatchSnapshot(); }); - it("groups by the 'transaction.name'", () => { + it("groups by the 'transaction.name'", async () => { const slo = createSLO({ indicator: createAPMTransactionErrorRateIndicator({ service: ALL_VALUE, @@ -132,13 +134,13 @@ describe('APM Transaction Error Rate Transform Generator', () => { }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); expect(transform.pivot?.group_by).toMatchSnapshot(); }); - it("groups by the 'transaction.type'", () => { + it("groups by the 'transaction.type'", async () => { const slo = createSLO({ indicator: createAPMTransactionErrorRateIndicator({ service: ALL_VALUE, @@ -148,13 +150,13 @@ describe('APM Transaction Error Rate Transform Generator', () => { }), }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); expect(transform.pivot?.group_by).toMatchSnapshot(); }); - it("overrides the range filter when 'preventInitialBackfill' is true", () => { + it("overrides the range filter when 'preventInitialBackfill' is true", async () => { const slo = createSLO({ indicator: createAPMTransactionErrorRateIndicator(), settings: { @@ -164,7 +166,7 @@ describe('APM Transaction Error Rate Transform Generator', () => { }, }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); // @ts-ignore const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f); diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.ts index 59b753711a0d8..863a31cfc508c 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.ts @@ -12,6 +12,7 @@ import { timeslicesBudgetingMethodSchema, } from '@kbn/slo-schema'; import { estypes } from '@elastic/elasticsearch'; +import { DataViewsService } from '@kbn/data-views-plugin/common'; import { getElasticsearchQueryOrThrow, TransformGenerator } from '.'; import { getSLOTransformId, @@ -24,7 +25,11 @@ import { InvalidTransformError } from '../../errors'; import { parseIndex, getTimesliceTargetComparator, getFilterRange } from './common'; export class ApmTransactionErrorRateTransformGenerator extends TransformGenerator { - public getTransformParams(slo: SLODefinition): TransformPutTransformRequest { + public async getTransformParams( + slo: SLODefinition, + spaceId: string, + dataViewService: DataViewsService + ): Promise { if (!apmTransactionErrorRateIndicatorSchema.is(slo.indicator)) { throw new InvalidTransformError(`Cannot handle SLO of indicator type: ${slo.indicator.type}`); } @@ -32,7 +37,7 @@ export class ApmTransactionErrorRateTransformGenerator extends TransformGenerato return getSLOTransformTemplate( this.buildTransformId(slo), this.buildDescription(slo), - this.buildSource(slo, slo.indicator), + await this.buildSource(slo, slo.indicator, dataViewService), this.buildDestination(), this.buildGroupBy(slo, slo.indicator), this.buildAggregations(slo), @@ -68,7 +73,11 @@ export class ApmTransactionErrorRateTransformGenerator extends TransformGenerato return this.buildCommonGroupBy(slo, '@timestamp', extraGroupByFields); } - private buildSource(slo: SLODefinition, indicator: APMTransactionErrorRateIndicator) { + private async buildSource( + slo: SLODefinition, + indicator: APMTransactionErrorRateIndicator, + dataViewService: DataViewsService + ) { const queryFilter: estypes.QueryDslQueryContainer[] = [getFilterRange(slo, '@timestamp')]; if (indicator.params.service !== ALL_VALUE) { @@ -103,13 +112,18 @@ export class ApmTransactionErrorRateTransformGenerator extends TransformGenerato }); } + const dataView = await this.getIndicatorDataView({ + dataViewService, + dataViewId: indicator.params.dataViewId, + }); + if (indicator.params.filter) { - queryFilter.push(getElasticsearchQueryOrThrow(indicator.params.filter)); + queryFilter.push(getElasticsearchQueryOrThrow(indicator.params.filter, dataView)); } return { index: parseIndex(indicator.params.index), - runtime_mappings: this.buildCommonRuntimeMappings(slo), + runtime_mappings: this.buildCommonRuntimeMappings(slo, dataView), query: { bool: { filter: [ diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/common.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/common.ts index 283bc375a0db0..35a6e180650fa 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/common.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/common.ts @@ -8,17 +8,18 @@ import { buildEsQuery, fromKueryExpression, toElasticsearchQuery } from '@kbn/es-query'; import { QuerySchema, kqlQuerySchema } from '@kbn/slo-schema'; import { Logger } from '@kbn/logging'; +import { DataView } from '@kbn/data-views-plugin/common'; import { SLODefinition } from '../../domain/models'; import { getDelayInSecondsFromSLO } from '../../domain/services/get_delay_in_seconds_from_slo'; import { InvalidTransformError } from '../../errors'; -export function getElasticsearchQueryOrThrow(kuery: QuerySchema = '') { +export function getElasticsearchQueryOrThrow(kuery: QuerySchema = '', dataView?: DataView) { try { if (kqlQuerySchema.is(kuery)) { return toElasticsearchQuery(fromKueryExpression(kuery)); } else { return buildEsQuery( - undefined, + dataView, { query: kuery?.kqlQuery, language: 'kuery', diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.test.ts index 2307956564ba3..2de75b8f7d86c 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.test.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.test.ts @@ -12,12 +12,14 @@ import { createSLOWithTimeslicesBudgetingMethod, } from '../fixtures/slo'; import { HistogramTransformGenerator } from './histogram'; +import { dataViewsService } from '@kbn/data-views-plugin/server/mocks'; const generator = new HistogramTransformGenerator(); +const spaceId = 'custom-space'; describe('Histogram Transform Generator', () => { describe('validation', () => { - it('throws when the good filter is invalid', () => { + it('throws when the good filter is invalid', async () => { const anSLO = createSLO({ indicator: createHistogramIndicator({ good: { @@ -29,10 +31,13 @@ describe('Histogram Transform Generator', () => { }, }), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid KQL: foo:/); + + await expect(generator.getTransformParams(anSLO, spaceId, dataViewsService)).rejects.toThrow( + /Invalid KQL: foo:/ + ); }); - it('throws when the total filter is invalid', () => { + it('throws when the total filter is invalid', async () => { const anSLO = createSLO({ indicator: createHistogramIndicator({ good: { @@ -42,20 +47,25 @@ describe('Histogram Transform Generator', () => { }, }), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid KQL: foo:/); + + await expect(generator.getTransformParams(anSLO, spaceId, dataViewsService)).rejects.toThrow( + /Invalid KQL: foo:/ + ); }); - it('throws when the query_filter is invalid', () => { + it('throws when the query_filter is invalid', async () => { const anSLO = createSLO({ indicator: createHistogramIndicator({ filter: '{ kql.query: invalid' }), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid KQL/); + await expect(generator.getTransformParams(anSLO, spaceId, dataViewsService)).rejects.toThrow( + /Invalid KQL/ + ); }); }); it('returns the expected transform params with every specified indicator params', async () => { const anSLO = createSLO({ id: 'irrelevant', indicator: createHistogramIndicator() }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); @@ -65,7 +75,7 @@ describe('Histogram Transform Generator', () => { id: 'irrelevant', indicator: createHistogramIndicator(), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); @@ -80,7 +90,7 @@ describe('Histogram Transform Generator', () => { timesliceWindow: twoMinute(), }, }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); @@ -89,7 +99,7 @@ describe('Histogram Transform Generator', () => { const anSLO = createSLO({ indicator: createHistogramIndicator({ filter: 'labels.groupId: group-4' }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); }); @@ -98,7 +108,7 @@ describe('Histogram Transform Generator', () => { const anSLO = createSLO({ indicator: createHistogramIndicator({ index: 'my-own-index*' }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.source.index).toBe('my-own-index*'); }); @@ -109,7 +119,7 @@ describe('Histogram Transform Generator', () => { timestampField: 'my-date-field', }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.sync?.time?.field).toBe('my-date-field'); // @ts-ignore @@ -120,7 +130,7 @@ describe('Histogram Transform Generator', () => { const anSLO = createSLO({ indicator: createHistogramIndicator(), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!['slo.numerator']).toMatchSnapshot(); }); @@ -137,7 +147,7 @@ describe('Histogram Transform Generator', () => { }, }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!['slo.numerator']).toMatchSnapshot(); }); @@ -146,7 +156,7 @@ describe('Histogram Transform Generator', () => { const anSLO = createSLO({ indicator: createHistogramIndicator(), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!['slo.denominator']).toMatchSnapshot(); }); @@ -161,12 +171,12 @@ describe('Histogram Transform Generator', () => { }, }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!['slo.denominator']).toMatchSnapshot(); }); - it("overrides the range filter when 'preventInitialBackfill' is true", () => { + it("overrides the range filter when 'preventInitialBackfill' is true", async () => { const slo = createSLO({ indicator: createHistogramIndicator(), settings: { @@ -176,7 +186,7 @@ describe('Histogram Transform Generator', () => { }, }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); // @ts-ignore const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f); diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.ts index c8cfb52239f89..76325445a862c 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.ts @@ -11,20 +11,26 @@ import { histogramIndicatorSchema, timeslicesBudgetingMethodSchema, } from '@kbn/slo-schema'; + +import { DataViewsService } from '@kbn/data-views-plugin/common'; +import { InvalidTransformError } from '../../errors'; +import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_transform_template'; import { getElasticsearchQueryOrThrow, parseIndex, TransformGenerator } from '.'; import { getSLOTransformId, SLO_DESTINATION_INDEX_NAME, SLO_INGEST_PIPELINE_NAME, } from '../../../common/constants'; -import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_transform_template'; import { SLODefinition } from '../../domain/models'; -import { InvalidTransformError } from '../../errors'; import { GetHistogramIndicatorAggregation } from '../aggregations'; import { getTimesliceTargetComparator, getFilterRange } from './common'; export class HistogramTransformGenerator extends TransformGenerator { - public getTransformParams(slo: SLODefinition): TransformPutTransformRequest { + public async getTransformParams( + slo: SLODefinition, + spaceId: string, + dataViewService: DataViewsService + ): Promise { if (!histogramIndicatorSchema.is(slo.indicator)) { throw new InvalidTransformError(`Cannot handle SLO of indicator type: ${slo.indicator.type}`); } @@ -32,7 +38,7 @@ export class HistogramTransformGenerator extends TransformGenerator { return getSLOTransformTemplate( this.buildTransformId(slo), this.buildDescription(slo), - this.buildSource(slo, slo.indicator), + await this.buildSource(slo, slo.indicator, dataViewService), this.buildDestination(), this.buildCommonGroupBy(slo, slo.indicator.params.timestampField), this.buildAggregations(slo, slo.indicator), @@ -45,15 +51,24 @@ export class HistogramTransformGenerator extends TransformGenerator { return getSLOTransformId(slo.id, slo.revision); } - private buildSource(slo: SLODefinition, indicator: HistogramIndicator) { + private async buildSource( + slo: SLODefinition, + indicator: HistogramIndicator, + dataViewService: DataViewsService + ) { + const dataView = await this.getIndicatorDataView({ + dataViewService, + dataViewId: indicator.params.index, + }); + return { index: parseIndex(indicator.params.index), - runtime_mappings: this.buildCommonRuntimeMappings(slo), + runtime_mappings: this.buildCommonRuntimeMappings(slo, dataView), query: { bool: { filter: [ getFilterRange(slo, indicator.params.timestampField), - getElasticsearchQueryOrThrow(indicator.params.filter), + getElasticsearchQueryOrThrow(indicator.params.filter, dataView), ], }, }, diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.test.ts index 4b74695c8942e..c41e0d4b3df53 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.test.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.test.ts @@ -12,34 +12,42 @@ import { createSLOWithTimeslicesBudgetingMethod, } from '../fixtures/slo'; import { KQLCustomTransformGenerator } from './kql_custom'; +import { dataViewsService } from '@kbn/data-views-plugin/server/mocks'; const generator = new KQLCustomTransformGenerator(); +const spaceId = 'custom-space'; describe('KQL Custom Transform Generator', () => { describe('validation', () => { - it('throws when the KQL numerator is invalid', () => { + it('throws when the KQL numerator is invalid', async () => { const anSLO = createSLO({ indicator: createKQLCustomIndicator({ good: '{ kql.query: invalid' }), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid KQL/); + await expect(generator.getTransformParams(anSLO, spaceId, dataViewsService)).rejects.toThrow( + /Invalid KQL/ + ); }); - it('throws when the KQL denominator is invalid', () => { + it('throws when the KQL denominator is invalid', async () => { const anSLO = createSLO({ indicator: createKQLCustomIndicator({ total: '{ kql.query: invalid' }), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid KQL/); + await expect(generator.getTransformParams(anSLO, spaceId, dataViewsService)).rejects.toThrow( + /Invalid KQL/ + ); }); - it('throws when the KQL query_filter is invalid', () => { + it('throws when the KQL query_filter is invalid', async () => { const anSLO = createSLO({ indicator: createKQLCustomIndicator({ filter: '{ kql.query: invalid' }), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid KQL/); + await expect(generator.getTransformParams(anSLO, spaceId, dataViewsService)).rejects.toThrow( + /Invalid KQL/ + ); }); }); it('returns the expected transform params with every specified indicator params', async () => { const anSLO = createSLO({ id: 'irrelevant', indicator: createKQLCustomIndicator() }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); @@ -49,7 +57,7 @@ describe('KQL Custom Transform Generator', () => { id: 'irrelevant', indicator: createKQLCustomIndicator(), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); @@ -64,7 +72,7 @@ describe('KQL Custom Transform Generator', () => { timesliceWindow: twoMinute(), }, }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); @@ -73,7 +81,7 @@ describe('KQL Custom Transform Generator', () => { const anSLO = createSLO({ indicator: createKQLCustomIndicator({ filter: 'labels.groupId: group-4' }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); }); @@ -82,7 +90,7 @@ describe('KQL Custom Transform Generator', () => { const anSLO = createSLO({ indicator: createKQLCustomIndicator({ index: 'my-own-index*' }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.source.index).toBe('my-own-index*'); }); @@ -93,7 +101,7 @@ describe('KQL Custom Transform Generator', () => { timestampField: 'my-date-field', }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.sync?.time?.field).toBe('my-date-field'); // @ts-ignore @@ -106,7 +114,7 @@ describe('KQL Custom Transform Generator', () => { good: 'latency < 400 and (http.status_code: 2xx or http.status_code: 3xx or http.status_code: 4xx)', }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!['slo.numerator']).toMatchSnapshot(); }); @@ -117,12 +125,12 @@ describe('KQL Custom Transform Generator', () => { total: 'http.status_code: *', }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!['slo.denominator']).toMatchSnapshot(); }); - it("overrides the range filter when 'preventInitialBackfill' is true", () => { + it("overrides the range filter when 'preventInitialBackfill' is true", async () => { const slo = createSLO({ indicator: createKQLCustomIndicator(), settings: { @@ -132,7 +140,7 @@ describe('KQL Custom Transform Generator', () => { }, }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); // @ts-ignore const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f); diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.ts index 573a83a5400de..d721140f243cf 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.ts @@ -7,19 +7,25 @@ import { TransformPutTransformRequest } from '@elastic/elasticsearch/lib/api/types'; import { kqlCustomIndicatorSchema, timeslicesBudgetingMethodSchema } from '@kbn/slo-schema'; + +import { DataViewsService } from '@kbn/data-views-plugin/common'; +import { InvalidTransformError } from '../../errors'; +import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_transform_template'; import { getElasticsearchQueryOrThrow, parseIndex, TransformGenerator } from '.'; import { getSLOTransformId, SLO_DESTINATION_INDEX_NAME, SLO_INGEST_PIPELINE_NAME, } from '../../../common/constants'; -import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_transform_template'; import { KQLCustomIndicator, SLODefinition } from '../../domain/models'; -import { InvalidTransformError } from '../../errors'; import { getTimesliceTargetComparator, getFilterRange } from './common'; export class KQLCustomTransformGenerator extends TransformGenerator { - public getTransformParams(slo: SLODefinition): TransformPutTransformRequest { + public async getTransformParams( + slo: SLODefinition, + spaceId: string, + dataViewService: DataViewsService + ): Promise { if (!kqlCustomIndicatorSchema.is(slo.indicator)) { throw new InvalidTransformError(`Cannot handle SLO of indicator type: ${slo.indicator.type}`); } @@ -27,7 +33,7 @@ export class KQLCustomTransformGenerator extends TransformGenerator { return getSLOTransformTemplate( this.buildTransformId(slo), this.buildDescription(slo), - this.buildSource(slo, slo.indicator), + await this.buildSource(slo, slo.indicator, dataViewService), this.buildDestination(), this.buildCommonGroupBy(slo, slo.indicator.params.timestampField), this.buildAggregations(slo, slo.indicator), @@ -40,10 +46,18 @@ export class KQLCustomTransformGenerator extends TransformGenerator { return getSLOTransformId(slo.id, slo.revision); } - private buildSource(slo: SLODefinition, indicator: KQLCustomIndicator) { + private async buildSource( + slo: SLODefinition, + indicator: KQLCustomIndicator, + dataViewService: DataViewsService + ) { + const dataView = await this.getIndicatorDataView({ + dataViewService, + dataViewId: indicator.params.dataViewId, + }); return { index: parseIndex(indicator.params.index), - runtime_mappings: this.buildCommonRuntimeMappings(slo), + runtime_mappings: this.buildCommonRuntimeMappings(slo, dataView), query: { bool: { filter: [ diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.test.ts index 1f6a1638baf1e..85da6de832c98 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.test.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.test.ts @@ -12,12 +12,14 @@ import { createSLOWithTimeslicesBudgetingMethod, } from '../fixtures/slo'; import { MetricCustomTransformGenerator } from './metric_custom'; +import { dataViewsService } from '@kbn/data-views-plugin/server/mocks'; const generator = new MetricCustomTransformGenerator(); +const spaceId = 'custom-space'; describe('Metric Custom Transform Generator', () => { describe('validation', () => { - it('throws when the good equation is invalid', () => { + it('throws when the good equation is invalid', async () => { const anSLO = createSLO({ indicator: createMetricCustomIndicator({ good: { @@ -26,9 +28,11 @@ describe('Metric Custom Transform Generator', () => { }, }), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid equation/); + await expect(generator.getTransformParams(anSLO, spaceId, dataViewsService)).rejects.toThrow( + /Invalid equation/ + ); }); - it('throws when the good filter is invalid', () => { + it('throws when the good filter is invalid', async () => { const anSLO = createSLO({ indicator: createMetricCustomIndicator({ good: { @@ -37,9 +41,11 @@ describe('Metric Custom Transform Generator', () => { }, }), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid KQL: foo:/); + await expect(generator.getTransformParams(anSLO, spaceId, dataViewsService)).rejects.toThrow( + /Invalid KQL: foo:/ + ); }); - it('throws when the total equation is invalid', () => { + it('throws when the total equation is invalid', async () => { const anSLO = createSLO({ indicator: createMetricCustomIndicator({ total: { @@ -48,9 +54,11 @@ describe('Metric Custom Transform Generator', () => { }, }), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid equation/); + await expect(generator.getTransformParams(anSLO, spaceId, dataViewsService)).rejects.toThrow( + /Invalid equation/ + ); }); - it('throws when the total filter is invalid', () => { + it('throws when the total filter is invalid', async () => { const anSLO = createSLO({ indicator: createMetricCustomIndicator({ total: { @@ -59,19 +67,23 @@ describe('Metric Custom Transform Generator', () => { }, }), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid KQL: foo:/); + await expect(() => + generator.getTransformParams(anSLO, spaceId, dataViewsService) + ).rejects.toThrow(/Invalid KQL: foo:/); }); - it('throws when the query_filter is invalid', () => { + it('throws when the query_filter is invalid', async () => { const anSLO = createSLO({ indicator: createMetricCustomIndicator({ filter: '{ kql.query: invalid' }), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid KQL/); + await expect(() => + generator.getTransformParams(anSLO, spaceId, dataViewsService) + ).rejects.toThrow(/Invalid KQL/); }); }); it('returns the expected transform params with every specified indicator params', async () => { const anSLO = createSLO({ id: 'irrelevant', indicator: createMetricCustomIndicator() }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); @@ -81,7 +93,7 @@ describe('Metric Custom Transform Generator', () => { id: 'irrelevant', indicator: createMetricCustomIndicator(), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); @@ -90,7 +102,7 @@ describe('Metric Custom Transform Generator', () => { const anSLO = createSLO({ indicator: createMetricCustomIndicator({ filter: 'labels.groupId: group-4' }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); }); @@ -99,7 +111,7 @@ describe('Metric Custom Transform Generator', () => { const anSLO = createSLO({ indicator: createMetricCustomIndicator({ index: 'my-own-index*' }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.source.index).toBe('my-own-index*'); }); @@ -110,7 +122,7 @@ describe('Metric Custom Transform Generator', () => { timestampField: 'my-date-field', }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.sync?.time?.field).toBe('my-date-field'); // @ts-ignore @@ -126,7 +138,7 @@ describe('Metric Custom Transform Generator', () => { }, }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!['slo.numerator']).toMatchSnapshot(); }); @@ -140,7 +152,7 @@ describe('Metric Custom Transform Generator', () => { }, }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!['slo.numerator']).toMatchSnapshot(); }); @@ -156,7 +168,7 @@ describe('Metric Custom Transform Generator', () => { }, }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!['slo.numerator']).toMatchSnapshot(); }); @@ -170,7 +182,7 @@ describe('Metric Custom Transform Generator', () => { }, }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!['slo.numerator']).toMatchSnapshot(); }); @@ -184,7 +196,7 @@ describe('Metric Custom Transform Generator', () => { }, }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!['slo.denominator']).toMatchSnapshot(); }); @@ -198,7 +210,7 @@ describe('Metric Custom Transform Generator', () => { }, }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!['slo.denominator']).toMatchSnapshot(); }); @@ -212,12 +224,12 @@ describe('Metric Custom Transform Generator', () => { }, }), }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!['slo.denominator']).toMatchSnapshot(); }); - it("overrides the range filter when 'preventInitialBackfill' is true", () => { + it("overrides the range filter when 'preventInitialBackfill' is true", async () => { const slo = createSLO({ indicator: createMetricCustomIndicator(), settings: { @@ -227,7 +239,7 @@ describe('Metric Custom Transform Generator', () => { }, }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); // @ts-ignore const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f); diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.ts index d004b3e01d890..c6127b600a4eb 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.ts @@ -7,22 +7,28 @@ import { TransformPutTransformRequest } from '@elastic/elasticsearch/lib/api/types'; import { metricCustomIndicatorSchema, timeslicesBudgetingMethodSchema } from '@kbn/slo-schema'; + +import { DataViewsService } from '@kbn/data-views-plugin/common'; +import { InvalidTransformError } from '../../errors'; +import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_transform_template'; import { getElasticsearchQueryOrThrow, parseIndex, TransformGenerator } from '.'; import { getSLOTransformId, SLO_DESTINATION_INDEX_NAME, SLO_INGEST_PIPELINE_NAME, } from '../../../common/constants'; -import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_transform_template'; import { MetricCustomIndicator, SLODefinition } from '../../domain/models'; -import { InvalidTransformError } from '../../errors'; import { GetCustomMetricIndicatorAggregation } from '../aggregations'; import { getTimesliceTargetComparator, getFilterRange } from './common'; export const INVALID_EQUATION_REGEX = /[^A-Z|+|\-|\s|\d+|\.|\(|\)|\/|\*|>|<|=|\?|\:|&|\!|\|]+/g; export class MetricCustomTransformGenerator extends TransformGenerator { - public getTransformParams(slo: SLODefinition): TransformPutTransformRequest { + public async getTransformParams( + slo: SLODefinition, + spaceId: string, + dataViewService: DataViewsService + ): Promise { if (!metricCustomIndicatorSchema.is(slo.indicator)) { throw new InvalidTransformError(`Cannot handle SLO of indicator type: ${slo.indicator.type}`); } @@ -30,7 +36,7 @@ export class MetricCustomTransformGenerator extends TransformGenerator { return getSLOTransformTemplate( this.buildTransformId(slo), this.buildDescription(slo), - this.buildSource(slo, slo.indicator), + await this.buildSource(slo, slo.indicator, dataViewService), this.buildDestination(), this.buildCommonGroupBy(slo, slo.indicator.params.timestampField), this.buildAggregations(slo, slo.indicator), @@ -43,15 +49,23 @@ export class MetricCustomTransformGenerator extends TransformGenerator { return getSLOTransformId(slo.id, slo.revision); } - private buildSource(slo: SLODefinition, indicator: MetricCustomIndicator) { + private async buildSource( + slo: SLODefinition, + indicator: MetricCustomIndicator, + dataViewService: DataViewsService + ) { + const dataView = await this.getIndicatorDataView({ + dataViewService, + dataViewId: indicator.params.dataViewId, + }); return { index: parseIndex(indicator.params.index), - runtime_mappings: this.buildCommonRuntimeMappings(slo), + runtime_mappings: this.buildCommonRuntimeMappings(slo, dataView), query: { bool: { filter: [ getFilterRange(slo, indicator.params.timestampField), - getElasticsearchQueryOrThrow(indicator.params.filter), + getElasticsearchQueryOrThrow(indicator.params.filter, dataView), ], }, }, diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.test.ts index 2a3a6f188eaa9..b292b8d12f342 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.test.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.test.ts @@ -6,6 +6,7 @@ */ import { ALL_VALUE } from '@kbn/slo-schema'; +import { dataViewsService } from '@kbn/data-views-plugin/server/mocks'; import { SLODefinition } from '../../domain/models'; import { createSLO, createSyntheticsAvailabilityIndicator } from '../fixtures/slo'; import { SyntheticsAvailabilityTransformGenerator } from './synthetics_availability'; @@ -17,9 +18,9 @@ const generator = new SyntheticsAvailabilityTransformGenerator(); describe('Synthetics Availability Transform Generator', () => { const spaceId = 'custom-space'; - it('returns the expected transform params', () => { + it('returns the expected transform params', async () => { const slo = createSLO({ id: 'irrelevant', indicator: createSyntheticsAvailabilityIndicator() }); - const transform = generator.getTransformParams(slo, spaceId); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform).toEqual({ _meta: { @@ -164,12 +165,12 @@ describe('Synthetics Availability Transform Generator', () => { }); }); - it('groups by config id and observer.name when using default groupings', () => { + it('groups by config id and observer.name when using default groupings', async () => { const slo = createSLO({ id: 'irrelevant', indicator: createSyntheticsAvailabilityIndicator(), }); - const transform = generator.getTransformParams(slo, spaceId); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.pivot?.group_by).toEqual( expect.objectContaining({ @@ -187,13 +188,13 @@ describe('Synthetics Availability Transform Generator', () => { ); }); - it('does not include config id and observer.name when using non default groupings', () => { + it('does not include config id and observer.name when using non default groupings', async () => { const slo = createSLO({ id: 'irrelevant', indicator: createSyntheticsAvailabilityIndicator(), groupBy: ['host.name'], }); - const transform = generator.getTransformParams(slo, spaceId); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.pivot?.group_by).not.toEqual( expect.objectContaining({ @@ -223,13 +224,13 @@ describe('Synthetics Availability Transform Generator', () => { it.each([[[]], [[ALL_VALUE]]])( 'adds observer.geo.name and monitor.name to groupings key by default, multi group by', - (groupBy) => { + async (groupBy) => { const slo = createSLO({ id: 'irrelevant', indicator: createSyntheticsAvailabilityIndicator(), groupBy, }); - const transform = generator.getTransformParams(slo, spaceId); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.pivot?.group_by).toEqual( expect.objectContaining({ @@ -250,13 +251,13 @@ describe('Synthetics Availability Transform Generator', () => { it.each([[''], [ALL_VALUE]])( 'adds observer.geo.name and monitor.name to groupings key by default, single group by', - (groupBy) => { + async (groupBy) => { const slo = createSLO({ id: 'irrelevant', indicator: createSyntheticsAvailabilityIndicator(), groupBy, }); - const transform = generator.getTransformParams(slo, spaceId); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.pivot?.group_by).toEqual( expect.objectContaining({ @@ -275,13 +276,13 @@ describe('Synthetics Availability Transform Generator', () => { } ); - it.each([['host.name'], [['host.name']]])('handles custom groupBy', (groupBy) => { + it.each([['host.name'], [['host.name']]])('handles custom groupBy', async (groupBy) => { const slo = createSLO({ id: 'irrelevant', indicator: createSyntheticsAvailabilityIndicator(), groupBy, }); - const transform = generator.getTransformParams(slo, spaceId); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.pivot?.group_by).toEqual( expect.objectContaining({ @@ -294,9 +295,9 @@ describe('Synthetics Availability Transform Generator', () => { ); }); - it('filters by summary.final_attempt', () => { + it('filters by summary.final_attempt', async () => { const slo = createSLO({ id: 'irrelevant', indicator: createSyntheticsAvailabilityIndicator() }); - const transform = generator.getTransformParams(slo, spaceId); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query?.bool?.filter).toContainEqual({ term: { @@ -305,7 +306,7 @@ describe('Synthetics Availability Transform Generator', () => { }); }); - it('adds tag filters', () => { + it('adds tag filters', async () => { const tags = [ { value: 'tag-1', label: 'tag1' }, { value: 'tag-2', label: 'tag2' }, @@ -321,7 +322,7 @@ describe('Synthetics Availability Transform Generator', () => { }, } as SLODefinition['indicator'], }); - const transform = generator.getTransformParams(slo, spaceId); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query?.bool?.filter).toContainEqual({ terms: { @@ -335,7 +336,7 @@ describe('Synthetics Availability Transform Generator', () => { }); }); - it('adds monitorId filter', () => { + it('adds monitorId filter', async () => { const monitorIds = [ { value: 'id-1', label: 'Monitor name 1' }, { value: 'id-2', label: 'Monitor name 2' }, @@ -351,7 +352,7 @@ describe('Synthetics Availability Transform Generator', () => { }, } as SLODefinition['indicator'], }); - const transform = generator.getTransformParams(slo, spaceId); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query?.bool?.filter).toContainEqual({ terms: { @@ -365,7 +366,7 @@ describe('Synthetics Availability Transform Generator', () => { }); }); - it('adds project id filter', () => { + it('adds project id filter', async () => { const projects = [ { value: 'id-1', label: 'Project name 1' }, { value: 'id-2', label: 'Project name 2' }, @@ -381,7 +382,7 @@ describe('Synthetics Availability Transform Generator', () => { }, } as SLODefinition['indicator'], }); - const transform = generator.getTransformParams(slo, spaceId); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query?.bool?.filter).toContainEqual({ terms: { @@ -395,9 +396,9 @@ describe('Synthetics Availability Transform Generator', () => { }); }); - it('filters by space', () => { + it('filters by space', async () => { const slo = createSLO({ id: 'irrelevant', indicator: createSyntheticsAvailabilityIndicator() }); - const transform = generator.getTransformParams(slo, spaceId); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); expect(transform.source.query?.bool?.filter).toContainEqual({ term: { @@ -406,7 +407,7 @@ describe('Synthetics Availability Transform Generator', () => { }); }); - it("overrides the range filter when 'preventInitialBackfill' is true", () => { + it("overrides the range filter when 'preventInitialBackfill' is true", async () => { const slo = createSLO({ indicator: createSyntheticsAvailabilityIndicator(), settings: { @@ -416,7 +417,7 @@ describe('Synthetics Availability Transform Generator', () => { }, }); - const transform = generator.getTransformParams(slo, 'default'); + const transform = await generator.getTransformParams(slo, 'default', dataViewsService); // @ts-ignore const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f); diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.ts index a98f2a2b3e232..5839a5611351e 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.ts @@ -13,6 +13,7 @@ import { occurrencesBudgetingMethodSchema, SyntheticsAvailabilityIndicator, } from '@kbn/slo-schema'; +import { DataViewsService } from '@kbn/data-views-plugin/common'; import { getElasticsearchQueryOrThrow, TransformGenerator } from '.'; import { getSLOTransformId, @@ -27,7 +28,11 @@ import { SLODefinition } from '../../domain/models'; import { getFilterRange } from './common'; export class SyntheticsAvailabilityTransformGenerator extends TransformGenerator { - public getTransformParams(slo: SLODefinition, spaceId: string): TransformPutTransformRequest { + public async getTransformParams( + slo: SLODefinition, + spaceId: string, + dataViewService: DataViewsService + ): Promise { if (!syntheticsAvailabilityIndicatorSchema.is(slo.indicator)) { throw new InvalidTransformError(`Cannot handle SLO of indicator type: ${slo.indicator.type}`); } @@ -35,7 +40,7 @@ export class SyntheticsAvailabilityTransformGenerator extends TransformGenerator return getSLOTransformTemplate( this.buildTransformId(slo), this.buildDescription(slo), - this.buildSource(slo, slo.indicator, spaceId), + await this.buildSource(slo, slo.indicator, spaceId, dataViewService), this.buildDestination(), this.buildGroupBy(slo, slo.indicator), this.buildAggregations(slo), @@ -102,10 +107,11 @@ export class SyntheticsAvailabilityTransformGenerator extends TransformGenerator ); } - private buildSource( + private async buildSource( slo: SLODefinition, indicator: SyntheticsAvailabilityIndicator, - spaceId: string + spaceId: string, + dataViewService: DataViewsService ) { const queryFilter: estypes.QueryDslQueryContainer[] = [ { term: { 'summary.final_attempt': true } }, @@ -146,11 +152,14 @@ export class SyntheticsAvailabilityTransformGenerator extends TransformGenerator queryFilter.push(getElasticsearchQueryOrThrow(indicator.params.filter)); } + const dataView = await this.getIndicatorDataView({ + dataViewService, + dataViewId: indicator.params.dataViewId, + }); + return { index: SYNTHETICS_INDEX_PATTERN, - runtime_mappings: { - ...this.buildCommonRuntimeMappings(slo), - }, + runtime_mappings: this.buildCommonRuntimeMappings(slo, dataView), query: { bool: { filter: queryFilter, diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.test.ts index 1fcd8c6abe892..02c69f38d6705 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.test.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.test.ts @@ -12,8 +12,11 @@ import { createSLO, } from '../fixtures/slo'; import { TimesliceMetricTransformGenerator } from './timeslice_metric'; +import { dataViewsService } from '@kbn/data-views-plugin/server/mocks'; const generator = new TimesliceMetricTransformGenerator(); +const spaceId = 'custom-space'; + const everythingIndicator = createTimesliceMetricIndicator( [ { name: 'A', aggregation: 'avg', field: 'test.field', filter: 'test.category: "test"' }, @@ -28,36 +31,40 @@ const everythingIndicator = createTimesliceMetricIndicator( describe('Timeslice Metric Transform Generator', () => { describe('validation', () => { - it('throws when the budgeting method is occurrences', () => { + it('throws when the budgeting method is occurrences', async () => { const anSLO = createSLO({ indicator: createTimesliceMetricIndicator( [{ name: 'A', aggregation: 'avg', field: 'test.field' }], '(A / 200) + A' ), }); - expect(() => generator.getTransformParams(anSLO)).toThrow( + await expect(generator.getTransformParams(anSLO, spaceId, dataViewsService)).rejects.toThrow( 'The sli.metric.timeslice indicator MUST have a timeslice budgeting method.' ); }); - it('throws when the metric equation is invalid', () => { + it('throws when the metric equation is invalid', async () => { const anSLO = createSLOWithTimeslicesBudgetingMethod({ indicator: createTimesliceMetricIndicator( [{ name: 'A', aggregation: 'avg', field: 'test.field' }], '(a / 200) + A' ), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid equation/); + await expect(generator.getTransformParams(anSLO, spaceId, dataViewsService)).rejects.toThrow( + /Invalid equation/ + ); }); - it('throws when the metric filter is invalid', () => { + it('throws when the metric filter is invalid', async () => { const anSLO = createSLOWithTimeslicesBudgetingMethod({ indicator: createTimesliceMetricIndicator( [{ name: 'A', aggregation: 'avg', field: 'test.field', filter: 'test:' }], '(A / 200) + A' ), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid KQL: test:/); + await expect(generator.getTransformParams(anSLO, spaceId, dataViewsService)).rejects.toThrow( + /Invalid KQL: test:/ + ); }); - it('throws when the query_filter is invalid', () => { + it('throws when the query_filter is invalid', async () => { const anSLO = createSLOWithTimeslicesBudgetingMethod({ indicator: createTimesliceMetricIndicator( [{ name: 'A', aggregation: 'avg', field: 'test.field', filter: 'test.category: "test"' }], @@ -65,7 +72,9 @@ describe('Timeslice Metric Transform Generator', () => { 'test:' ), }); - expect(() => generator.getTransformParams(anSLO)).toThrow(/Invalid KQL/); + await expect(generator.getTransformParams(anSLO, spaceId, dataViewsService)).rejects.toThrow( + /Invalid KQL/ + ); }); }); @@ -74,7 +83,7 @@ describe('Timeslice Metric Transform Generator', () => { id: 'irrelevant', indicator: everythingIndicator, }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); @@ -84,7 +93,7 @@ describe('Timeslice Metric Transform Generator', () => { id: 'irrelevant', indicator: everythingIndicator, }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform).toMatchSnapshot(); }); @@ -93,7 +102,7 @@ describe('Timeslice Metric Transform Generator', () => { const anSLO = createSLOWithTimeslicesBudgetingMethod({ indicator: everythingIndicator, }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.source.query).toMatchSnapshot(); }); @@ -105,7 +114,7 @@ describe('Timeslice Metric Transform Generator', () => { params: { ...everythingIndicator.params, index: 'my-own-index*' }, }, }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.source.index).toBe('my-own-index*'); }); @@ -117,7 +126,7 @@ describe('Timeslice Metric Transform Generator', () => { params: { ...everythingIndicator.params, timestampField: 'my-date-field' }, }, }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.sync?.time?.field).toBe('my-date-field'); // @ts-ignore @@ -128,7 +137,7 @@ describe('Timeslice Metric Transform Generator', () => { const anSLO = createSLOWithTimeslicesBudgetingMethod({ indicator: everythingIndicator, }); - const transform = generator.getTransformParams(anSLO); + const transform = await generator.getTransformParams(anSLO, spaceId, dataViewsService); expect(transform.pivot!.aggregations!._metric).toEqual({ bucket_script: { @@ -166,7 +175,7 @@ describe('Timeslice Metric Transform Generator', () => { }); }); - it("overrides the range filter when 'preventInitialBackfill' is true", () => { + it("overrides the range filter when 'preventInitialBackfill' is true", async () => { const slo = createSLOWithTimeslicesBudgetingMethod({ indicator: everythingIndicator, settings: { @@ -176,7 +185,7 @@ describe('Timeslice Metric Transform Generator', () => { }, }); - const transform = generator.getTransformParams(slo); + const transform = await generator.getTransformParams(slo, spaceId, dataViewsService); // @ts-ignore const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f); diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.ts index 719766b0c4efe..579772b0eb1de 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.ts @@ -12,6 +12,7 @@ import { timesliceMetricIndicatorSchema, timeslicesBudgetingMethodSchema, } from '@kbn/slo-schema'; +import { DataViewsService } from '@kbn/data-views-plugin/common'; import { InvalidTransformError } from '../../errors'; import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_transform_template'; import { getElasticsearchQueryOrThrow, parseIndex, TransformGenerator } from '.'; @@ -27,7 +28,11 @@ import { getFilterRange } from './common'; const INVALID_EQUATION_REGEX = /[^A-Z|+|\-|\s|\d+|\.|\(|\)|\/|\*|>|<|=|\?|\:|&|\!|\|]+/g; export class TimesliceMetricTransformGenerator extends TransformGenerator { - public getTransformParams(slo: SLODefinition): TransformPutTransformRequest { + public async getTransformParams( + slo: SLODefinition, + spaceId: string, + dataViewService: DataViewsService + ): Promise { if (!timesliceMetricIndicatorSchema.is(slo.indicator)) { throw new InvalidTransformError(`Cannot handle SLO of indicator type: ${slo.indicator.type}`); } @@ -35,7 +40,7 @@ export class TimesliceMetricTransformGenerator extends TransformGenerator { return getSLOTransformTemplate( this.buildTransformId(slo), this.buildDescription(slo), - this.buildSource(slo, slo.indicator), + await this.buildSource(slo, slo.indicator, dataViewService), this.buildDestination(), this.buildCommonGroupBy(slo, slo.indicator.params.timestampField), this.buildAggregations(slo, slo.indicator), @@ -48,15 +53,23 @@ export class TimesliceMetricTransformGenerator extends TransformGenerator { return getSLOTransformId(slo.id, slo.revision); } - private buildSource(slo: SLODefinition, indicator: TimesliceMetricIndicator) { + private async buildSource( + slo: SLODefinition, + indicator: TimesliceMetricIndicator, + dataViewService: DataViewsService + ) { + const dataView = await this.getIndicatorDataView({ + dataViewService, + dataViewId: indicator.params.index, + }); return { index: parseIndex(indicator.params.index), - runtime_mappings: this.buildCommonRuntimeMappings(slo), + runtime_mappings: this.buildCommonRuntimeMappings(slo, dataView), query: { bool: { filter: [ getFilterRange(slo, indicator.params.timestampField), - getElasticsearchQueryOrThrow(indicator.params.filter), + getElasticsearchQueryOrThrow(indicator.params.filter, dataView), ], }, }, diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/transform_generator.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/transform_generator.ts index 0a2226d98d55a..37e20144435d7 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/transform_generator.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/transform_generator.ts @@ -10,16 +10,18 @@ import { TransformPutTransformRequest, } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { ALL_VALUE, timeslicesBudgetingMethodSchema } from '@kbn/slo-schema'; +import { DataView, DataViewsService } from '@kbn/data-views-plugin/common'; import { TransformSettings } from '../../assets/transform_templates/slo_transform_template'; import { SLODefinition } from '../../domain/models'; export abstract class TransformGenerator { public abstract getTransformParams( slo: SLODefinition, - spaceId: string - ): TransformPutTransformRequest; + spaceId: string, + dataViewService: DataViewsService + ): Promise; - public buildCommonRuntimeMappings(slo: SLODefinition): MappingRuntimeFields { + public buildCommonRuntimeMappings(slo: SLODefinition, dataView?: DataView): MappingRuntimeFields { return { 'slo.id': { type: 'keyword', @@ -33,6 +35,7 @@ export abstract class TransformGenerator { source: `emit(${slo.revision})`, }, }, + ...(dataView?.getRuntimeMappings?.() ?? {}), }; } @@ -81,6 +84,24 @@ export abstract class TransformGenerator { }; } + public async getIndicatorDataView({ + dataViewService, + dataViewId, + }: { + dataViewService: DataViewsService; + dataViewId?: string; + }): Promise { + let dataView: DataView | undefined; + if (dataViewId) { + try { + dataView = await dataViewService.get(dataViewId); + } catch (e) { + // If the data view is not found, we will continue without it + } + } + return dataView; + } + public buildSettings( slo: SLODefinition, sourceIndexTimestampField: string | undefined = '@timestamp' diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_manager.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_manager.test.ts index d7758f0fbdd4a..7e6cf50c169fa 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_manager.test.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_manager.test.ts @@ -26,6 +26,8 @@ import { createAPMTransactionErrorRateIndicator, createSLO, } from './fixtures/slo'; +import { dataViewsService } from '@kbn/data-views-plugin/server/mocks'; +import { DataViewsService } from '@kbn/data-views-plugin/common'; describe('TransformManager', () => { let esClientMock: ElasticsearchClientMock; @@ -44,7 +46,13 @@ describe('TransformManager', () => { const generators: Record = { 'sli.apm.transactionDuration': new DummyTransformGenerator(), }; - const service = new DefaultTransformManager(generators, esClientMock, loggerMock, spaceId); + const service = new DefaultTransformManager( + generators, + esClientMock, + loggerMock, + spaceId, + dataViewsService + ); await expect( service.install(createSLO({ indicator: createAPMTransactionErrorRateIndicator() })) @@ -60,7 +68,8 @@ describe('TransformManager', () => { generators, esClientMock, loggerMock, - spaceId + spaceId, + dataViewsService ); await expect( @@ -80,7 +89,8 @@ describe('TransformManager', () => { generators, esClientMock, loggerMock, - spaceId + spaceId, + dataViewsService ); const slo = createSLO({ indicator: createAPMTransactionErrorRateIndicator() }); @@ -101,7 +111,8 @@ describe('TransformManager', () => { generators, esClientMock, loggerMock, - spaceId + spaceId, + dataViewsService ); await transformManager.preview('slo-transform-id'); @@ -120,7 +131,8 @@ describe('TransformManager', () => { generators, esClientMock, loggerMock, - spaceId + spaceId, + dataViewsService ); await transformManager.start('slo-transform-id'); @@ -139,7 +151,8 @@ describe('TransformManager', () => { generators, esClientMock, loggerMock, - spaceId + spaceId, + dataViewsService ); await transformManager.stop('slo-transform-id'); @@ -158,7 +171,8 @@ describe('TransformManager', () => { generators, esClientMock, loggerMock, - spaceId + spaceId, + dataViewsService ); await transformManager.uninstall('slo-transform-id'); @@ -178,7 +192,8 @@ describe('TransformManager', () => { generators, esClientMock, loggerMock, - spaceId + spaceId, + dataViewsService ); await transformManager.uninstall('slo-transform-id'); @@ -189,13 +204,21 @@ describe('TransformManager', () => { }); class DummyTransformGenerator extends TransformGenerator { - getTransformParams(slo: SLODefinition): TransformPutTransformRequest { + async getTransformParams( + slo: SLODefinition, + spaceId: string, + dataViewService: DataViewsService + ): Promise { return {} as TransformPutTransformRequest; } } class FailTransformGenerator extends TransformGenerator { - getTransformParams(slo: SLODefinition): TransformPutTransformRequest { + getTransformParams( + slo: SLODefinition, + spaceId: string, + dataViewService: DataViewsService + ): Promise { throw new Error('Some error'); } } diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_manager.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_manager.ts index e00d67e9944bb..f90d240e30087 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/transform_manager.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/transform_manager.ts @@ -8,6 +8,7 @@ import { ElasticsearchClient, Logger } from '@kbn/core/server'; import { TransformPutTransformRequest } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import { DataViewsService } from '@kbn/data-views-plugin/server'; import { SLODefinition, IndicatorTypes } from '../domain/models'; import { SecurityException } from '../errors'; import { retryTransientEsErrors } from '../utils/retry'; @@ -17,7 +18,7 @@ type TransformId = string; export interface TransformManager { install(slo: SLODefinition): Promise; - inspect(slo: SLODefinition): TransformPutTransformRequest; + inspect(slo: SLODefinition): Promise; preview(transformId: TransformId): Promise; start(transformId: TransformId): Promise; stop(transformId: TransformId): Promise; @@ -29,7 +30,8 @@ export class DefaultTransformManager implements TransformManager { private generators: Record, private esClient: ElasticsearchClient, private logger: Logger, - private spaceId: string + private spaceId: string, + private dataViewService: DataViewsService ) {} async install(slo: SLODefinition): Promise { @@ -39,7 +41,11 @@ export class DefaultTransformManager implements TransformManager { throw new Error(`Unsupported indicator type [${slo.indicator.type}]`); } - const transformParams = generator.getTransformParams(slo, this.spaceId); + const transformParams = await generator.getTransformParams( + slo, + this.spaceId, + this.dataViewService + ); try { await retryTransientEsErrors(() => this.esClient.transform.putTransform(transformParams), { logger: this.logger, @@ -56,14 +62,14 @@ export class DefaultTransformManager implements TransformManager { return transformParams.transform_id; } - inspect(slo: SLODefinition): TransformPutTransformRequest { + async inspect(slo: SLODefinition): Promise { const generator = this.generators[slo.indicator.type]; if (!generator) { this.logger.error(`No transform generator found for indicator type [${slo.indicator.type}]`); throw new Error(`Unsupported indicator type [${slo.indicator.type}]`); } - return generator.getTransformParams(slo, this.spaceId); + return await generator.getTransformParams(slo, this.spaceId, this.dataViewService); } async preview(transformId: string): Promise { diff --git a/x-pack/plugins/observability_solution/slo/server/services/update_slo.test.ts b/x-pack/plugins/observability_solution/slo/server/services/update_slo.test.ts index 974f72561aeff..0c68d20b2308c 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/update_slo.test.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/update_slo.test.ts @@ -42,14 +42,14 @@ describe('UpdateSLO', () => { let mockRepository: jest.Mocked; let mockTransformManager: jest.Mocked; let mockEsClient: jest.Mocked; - let loggerMock: jest.Mocked; + let mockLogger: jest.Mocked; let mockSummaryTransformManager: jest.Mocked; let updateSLO: UpdateSLO; beforeEach(() => { mockRepository = createSLORepositoryMock(); mockTransformManager = createTransformManagerMock(); - loggerMock = loggingSystemMock.createLogger(); + mockLogger = loggingSystemMock.createLogger(); mockSummaryTransformManager = createSummaryTransformManagerMock(); mockEsClient = elasticsearchServiceMock.createElasticsearchClient(); updateSLO = new UpdateSLO( @@ -57,7 +57,7 @@ describe('UpdateSLO', () => { mockTransformManager, mockSummaryTransformManager, mockEsClient, - loggerMock, + mockLogger, 'some-space', httpServiceMock.createStartContract().basePath ); @@ -298,28 +298,52 @@ describe('UpdateSLO', () => { }); describe('when error happens during the update', () => { - it('restores the previous SLO definition in the repository', async () => { - const slo = createSLO({ + it('restores the previous SLO definition when updated summary transform install fails', async () => { + const originalSlo = createSLO({ id: 'original-id', indicator: createAPMTransactionErrorRateIndicator({ environment: 'development' }), }); - mockRepository.findById.mockResolvedValueOnce(slo); + mockRepository.findById.mockResolvedValueOnce(originalSlo); mockTransformManager.install.mockRejectedValueOnce(new Error('Transform install error')); const newIndicator = createAPMTransactionErrorRateIndicator({ environment: 'production' }); - await expect(updateSLO.execute(slo.id, { indicator: newIndicator })).rejects.toThrowError( - 'Transform install error' + await expect( + updateSLO.execute(originalSlo.id, { indicator: newIndicator }) + ).rejects.toThrowError('Transform install error'); + + expect(mockRepository.save).toHaveBeenCalledWith(originalSlo); + + expect(mockSummaryTransformManager.stop).not.toHaveBeenCalled(); + expect(mockSummaryTransformManager.uninstall).not.toHaveBeenCalled(); + expect(mockEsClient.ingest.deletePipeline).not.toHaveBeenCalled(); + expect(mockTransformManager.stop).not.toHaveBeenCalled(); + expect(mockTransformManager.uninstall).not.toHaveBeenCalled(); + }); + + it('restores the previous SLO definition and rollback succeeded operations until the summary transform start operation fails', async () => { + const originalSlo = createSLO({ + id: 'original-id', + indicator: createAPMTransactionErrorRateIndicator({ environment: 'development' }), + }); + mockRepository.findById.mockResolvedValueOnce(originalSlo); + mockSummaryTransformManager.start.mockRejectedValueOnce( + new Error('summary transform start error') ); - expect(mockRepository.save).toHaveBeenCalledWith(slo); + const newIndicator = createAPMTransactionErrorRateIndicator({ environment: 'production' }); + + await expect( + updateSLO.execute(originalSlo.id, { indicator: newIndicator }) + ).rejects.toThrowError('summary transform start error'); + + expect(mockRepository.save).toHaveBeenCalledWith(originalSlo); + expect(mockSummaryTransformManager.uninstall).toHaveBeenCalled(); + expect(mockEsClient.ingest.deletePipeline).toHaveBeenCalled(); + expect(mockTransformManager.stop).toHaveBeenCalled(); + expect(mockTransformManager.uninstall).toHaveBeenCalled(); - // these calls are related to the updated slo - expect(mockSummaryTransformManager.stop).toMatchSnapshot(); - expect(mockSummaryTransformManager.uninstall).toMatchSnapshot(); - expect(mockTransformManager.stop).toMatchSnapshot(); - expect(mockTransformManager.uninstall).toMatchSnapshot(); - expect(mockEsClient.ingest.deletePipeline).toMatchSnapshot(); + expect(mockSummaryTransformManager.stop).not.toHaveBeenCalled(); }); }); diff --git a/x-pack/plugins/observability_solution/slo/server/services/update_slo.ts b/x-pack/plugins/observability_solution/slo/server/services/update_slo.ts index 5c8812cd4a886..cefdc703bb434 100644 --- a/x-pack/plugins/observability_solution/slo/server/services/update_slo.ts +++ b/x-pack/plugins/observability_solution/slo/server/services/update_slo.ts @@ -7,6 +7,7 @@ import { ElasticsearchClient, IBasePath, Logger } from '@kbn/core/server'; import { UpdateSLOParams, UpdateSLOResponse, updateSLOResponseSchema } from '@kbn/slo-schema'; +import { asyncForEach } from '@kbn/std'; import { isEqual, pick } from 'lodash'; import { getSLOSummaryPipelineId, @@ -62,17 +63,38 @@ export class UpdateSLO { }); validateSLO(updatedSlo); + + const rollbackOperations = []; + await this.repository.save(updatedSlo); + rollbackOperations.push(() => this.repository.save(originalSlo)); if (!requireRevisionBump) { // At this point, we still need to update the summary pipeline to include the changes (name, desc, tags, ...) in the summary index - await retryTransientEsErrors( - () => - this.esClient.ingest.putPipeline( - getSLOSummaryPipelineTemplate(updatedSlo, this.spaceId, this.basePath) - ), - { logger: this.logger } - ); + + try { + await retryTransientEsErrors( + () => + this.esClient.ingest.putPipeline( + getSLOSummaryPipelineTemplate(updatedSlo, this.spaceId, this.basePath) + ), + { logger: this.logger } + ); + } catch (err) { + this.logger.error( + `Cannot update the SLO summary pipeline [id: ${updatedSlo.id}, revision: ${updatedSlo.revision}].` + ); + + await asyncForEach(rollbackOperations.reverse(), async (operation) => { + try { + await operation(); + } catch (rollbackErr) { + this.logger.error('Rollback operation failed', rollbackErr); + } + }); + + throw err; + } return this.toResponse(updatedSlo); } @@ -82,7 +104,10 @@ export class UpdateSLO { try { await this.transformManager.install(updatedSlo); + rollbackOperations.push(() => this.transformManager.uninstall(updatedRollupTransformId)); + await this.transformManager.start(updatedRollupTransformId); + rollbackOperations.push(() => this.transformManager.stop(updatedRollupTransformId)); await retryTransientEsErrors( () => @@ -91,9 +116,20 @@ export class UpdateSLO { ), { logger: this.logger } ); + rollbackOperations.push(() => + this.esClient.ingest.deletePipeline( + { id: getSLOSummaryPipelineId(updatedSlo.id, updatedSlo.revision) }, + { ignore: [404] } + ) + ); await this.summaryTransformManager.install(updatedSlo); + rollbackOperations.push(() => + this.summaryTransformManager.uninstall(updatedSummaryTransformId) + ); + await this.summaryTransformManager.start(updatedSummaryTransformId); + rollbackOperations.push(() => this.summaryTransformManager.stop(updatedSummaryTransformId)); await retryTransientEsErrors( () => @@ -110,17 +146,13 @@ export class UpdateSLO { `Cannot update the SLO [id: ${updatedSlo.id}, revision: ${updatedSlo.revision}]. Rolling back.` ); - // Restore the previous slo definition - await this.repository.save(originalSlo); - // delete the created resources for the updated slo - await this.summaryTransformManager.stop(updatedSummaryTransformId); - await this.summaryTransformManager.uninstall(updatedSummaryTransformId); - await this.transformManager.stop(updatedRollupTransformId); - await this.transformManager.uninstall(updatedRollupTransformId); - await this.esClient.ingest.deletePipeline( - { id: getSLOSummaryPipelineId(updatedSlo.id, updatedSlo.revision) }, - { ignore: [404] } - ); + await asyncForEach(rollbackOperations.reverse(), async (operation) => { + try { + await operation(); + } catch (rollbackErr) { + this.logger.error('Rollback operation failed', rollbackErr); + } + }); throw err; } diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/alerts/query_bar.tsx b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/alerts/query_bar.tsx index b2192731b4ab9..f090f807a0fb8 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/alerts/query_bar.tsx +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/alerts/query_bar.tsx @@ -47,7 +47,7 @@ export const AlertQueryBar = ({ query = '', onChange }: Props) => { const { data: dataView } = useFetcher(async () => { return await dataViews.create({ title: SYNTHETICS_INDEX_PATTERN }); - }, []); + }, [dataViews]); useEffect(() => { onChange(query); diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/components/monitor_inspect.tsx b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/components/monitor_inspect.tsx index f7fff9c9ce332..90d30606b860d 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/components/monitor_inspect.tsx +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/components/monitor_inspect.tsx @@ -70,6 +70,9 @@ const MonitorInspect = ({ isValid, monitorFields }: InspectorProps) => { monitor: monitorFields, }); } + // FIXME: Dario couldn't find a solution for monitorFields + // which is not memoized downstream + // eslint-disable-next-line react-hooks/exhaustive-deps }, [isInspecting, hideParams]); let flyout; diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/components/stderr_logs.tsx b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/components/stderr_logs.tsx index b4a28335ce132..2b332ec78671f 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/components/stderr_logs.tsx +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/components/stderr_logs.tsx @@ -86,7 +86,7 @@ export const StdErrorLogs = ({ } : undefined, }); - }, [checkGroup, timestamp]); + }, [checkGroup, timestamp, discover, exploratoryView]); const search = { box: { diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/monitor_test_result/result_details_successful.tsx b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/monitor_test_result/result_details_successful.tsx index 08194c3b77f26..25f0ed0843472 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/monitor_test_result/result_details_successful.tsx +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/common/monitor_test_result/result_details_successful.tsx @@ -25,14 +25,22 @@ export const ResultDetailsSuccessful = ({ }) => { const { euiTheme } = useEuiTheme(); + const timestamp = step['@timestamp']; + const monitorId = step.monitor.id; + const stepIndex = Number(step.synthetics.step?.index); + const location = step.observer?.geo?.name; + const { data, loading } = useFetcher(() => { return fetchLastSuccessfulCheck({ - timestamp: step['@timestamp'], - monitorId: step.monitor.id, - stepIndex: Number(step.synthetics.step?.index), - location: step.observer?.geo?.name, + timestamp, + monitorId, + stepIndex, + location, }); - }, [step._id, step['@timestamp']]); + // FIXME: Dario is not sure what step._id is being used for, + // so he'll leave it in place + // eslint-disable-next-line react-hooks/exhaustive-deps + }, [timestamp, monitorId, stepIndex, location, step._id]); const { currentStep } = useJourneySteps( data?.monitor.check_group, diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/form/run_test_btn.tsx b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/form/run_test_btn.tsx index 579cf526c1b3a..00ddc5b4a7ef3 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/form/run_test_btn.tsx +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/form/run_test_btn.tsx @@ -52,7 +52,7 @@ export const RunTestButton = ({ id: testRun.id, }); } - }, [testRun?.id]); + }, [testRun?.id, testRun?.monitor]); const { tooltipContent, isDisabled } = useTooltipContent(formState.isValid, inProgress); diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/hooks/use_monitor_save.tsx b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/hooks/use_monitor_save.tsx index 4fa482eb63bbd..1ba3cec885889 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/hooks/use_monitor_save.tsx +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/hooks/use_monitor_save.tsx @@ -39,6 +39,9 @@ export const useMonitorSave = ({ monitorData }: { monitorData?: SyntheticsMonito }); } } + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Synthetics folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [monitorData]); useEffect(() => { diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/monitor_edit_page.tsx b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/monitor_edit_page.tsx index 772a4bc36022b..f339c69610672 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/monitor_edit_page.tsx +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_add_edit/monitor_edit_page.tsx @@ -45,6 +45,9 @@ export const MonitorEditPage: React.FC = () => { const { data, loading, error } = useFetcher(() => { return getDecryptedMonitorAPI({ id: monitorId }); + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Synthetics folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, []); const monitorNotFoundError = useMonitorNotFound( diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_details/monitor_selector/use_recently_viewed_monitors.ts b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_details/monitor_selector/use_recently_viewed_monitors.ts index 74efd982c3d17..0988e6c2aefc5 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_details/monitor_selector/use_recently_viewed_monitors.ts +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitor_details/monitor_selector/use_recently_viewed_monitors.ts @@ -92,6 +92,9 @@ export const useRecentlyViewedMonitors = () => { updateRecentlyViewed(); } } + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Synthetics folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [monitorQueryId]); return useMemo( diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitors_page/overview/overview/monitor_detail_flyout.tsx b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitors_page/overview/overview/monitor_detail_flyout.tsx index cb8da8a64cad6..78ac9dd2f663f 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitors_page/overview/overview/monitor_detail_flyout.tsx +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/monitors_page/overview/overview/monitor_detail_flyout.tsx @@ -255,7 +255,13 @@ export function MonitorDetailFlyout(props: Props) { error, status, loading, - } = useFetcher(() => fetchSyntheticsMonitor({ monitorId: configId }), [configId, upsertSuccess]); + } = useFetcher( + () => fetchSyntheticsMonitor({ monitorId: configId }), + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Synthetics folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps + [configId, upsertSuccess] + ); const [isActionsPopoverOpen, setIsActionsPopoverOpen] = useState(false); diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/policy_link.tsx b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/policy_link.tsx index c36296b1ff42c..0c9cb465c127f 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/policy_link.tsx +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/policy_link.tsx @@ -24,6 +24,9 @@ export const PolicyLink = ({ name }: { name: string }) => { const { data } = useFetcher(async () => { return ilmLocator?.getLocation({ page: 'policy_edit', policyName: name }); + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Synthetics folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [name]); if (!data) { @@ -31,7 +34,7 @@ export const PolicyLink = ({ name }: { name: string }) => { } if (!name) { - return <>--; + return <>{i18n.translate('xpack.synthetics.policyLink.Label', { defaultMessage: '--' })}; } if (!canManageILM) { diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/private_locations/hooks/use_locations_api.ts b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/private_locations/hooks/use_locations_api.ts index 6ee8acd4a93e7..6b3899a5b44c8 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/private_locations/hooks/use_locations_api.ts +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/private_locations/hooks/use_locations_api.ts @@ -44,6 +44,9 @@ export const usePrivateLocationsAPI = () => { dispatch(getPrivateLocationsAction.get()); return result; } + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Synthetics folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [formData]); const onSubmit = (data: NewLocation) => { @@ -62,6 +65,9 @@ export const usePrivateLocationsAPI = () => { dispatch(getPrivateLocationsAction.get()); return result; } + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Synthetics folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [deleteId]); return { diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/project_api_keys/project_api_keys.tsx b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/project_api_keys/project_api_keys.tsx index 5ea801dea4ed3..4a8752e8b9926 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/project_api_keys/project_api_keys.tsx +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/settings/project_api_keys/project_api_keys.tsx @@ -38,6 +38,9 @@ export const ProjectAPIKeys = () => { return fetchProjectAPIKey(accessToElasticManagedLocations && Boolean(canUsePublicLocations)); } return null; + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Synthetics folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [loadAPIKey, canUsePublicLocations]); useEffect(() => { diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/step_details_page/step_screenshot/last_successful_screenshot.tsx b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/step_details_page/step_screenshot/last_successful_screenshot.tsx index 45052a38a21fd..cde0cb93fed11 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/step_details_page/step_screenshot/last_successful_screenshot.tsx +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/step_details_page/step_screenshot/last_successful_screenshot.tsx @@ -35,6 +35,9 @@ export const LastSuccessfulScreenshot = ({ stepIndex: Number(stepIndex ?? stepInd), location: step.observer?.geo?.name, }); + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Synthetics folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [step._id, step['@timestamp']]); return ( diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/hooks/use_browser_run_once_monitors.ts b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/hooks/use_browser_run_once_monitors.ts index 2ad18149f26dc..c5b11dc272233 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/hooks/use_browser_run_once_monitors.ts +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/hooks/use_browser_run_once_monitors.ts @@ -187,6 +187,9 @@ export const useBrowserRunOnceMonitors = ({ } return Promise.resolve(null); + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Synthetics folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [checkGroupCheckSum, setCheckGroupResults, lastRefresh]); // Whenever a new found document is fetched, update lastUpdated diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/hooks/use_test_flyout_open.ts b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/hooks/use_test_flyout_open.ts index ed3bf648cfe57..082a7ffc84c7e 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/hooks/use_test_flyout_open.ts +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/hooks/use_test_flyout_open.ts @@ -7,7 +7,7 @@ import { useDispatch, useSelector } from 'react-redux'; import { useRouteMatch } from 'react-router-dom'; -import { useEffect } from 'react'; +import { useEffect, useMemo } from 'react'; import { MONITOR_ROUTE, OVERVIEW_ROUTE } from '../../../../../../common/constants'; import { hideTestNowFlyoutAction, testNowRunsSelector } from '../../../state/manual_test_runs'; @@ -24,9 +24,11 @@ export const useTestFlyoutOpen = () => { const dispatch = useDispatch(); - const flyoutTestOpen = Object.values(testNowRuns).find((value) => { - return value.isTestNowFlyoutOpen; - }); + const flyoutTestOpen = useMemo(() => { + return Object.values(testNowRuns).find((value) => { + return value.isTestNowFlyoutOpen; + }); + }, [testNowRuns]); const isSameMonitor = flyoutTestOpen?.configId === isMonitorDetails?.params.monitorId; diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/test_now_mode_flyout_container.tsx b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/test_now_mode_flyout_container.tsx index ff3114c98f845..b550cdbd2745e 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/test_now_mode_flyout_container.tsx +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/components/test_now_mode/test_now_mode_flyout_container.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import React, { useCallback } from 'react'; +import React, { useCallback, useMemo } from 'react'; import { useDispatch, useSelector } from 'react-redux'; import { useTestFlyoutOpen } from './hooks/use_test_flyout_open'; @@ -50,27 +50,30 @@ export function TestNowModeFlyoutContainer() { [dispatch] ); - const flyout = flyoutOpenTestRun ? ( - handleFlyoutClose(flyoutOpenTestRun.testRunId)} - onDone={onDone} - isPushing={flyoutOpenTestRun.status === 'loading'} - errors={flyoutOpenTestRun.errors ?? []} - /> - ) : null; + const testRun = useMemo(() => { + return flyoutOpenTestRun?.testRunId && flyoutOpenTestRun?.monitor + ? { + id: flyoutOpenTestRun.testRunId, + monitor: flyoutOpenTestRun.monitor, + name: flyoutOpenTestRun.name, + } + : undefined; + }, [flyoutOpenTestRun]); + + const flyout = + flyoutOpenTestRun && testRun ? ( + handleFlyoutClose(flyoutOpenTestRun.testRunId)} + onDone={onDone} + isPushing={flyoutOpenTestRun.status === 'loading'} + errors={flyoutOpenTestRun.errors ?? []} + /> + ) : null; return ( <> diff --git a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/contexts/synthetics_data_view_context.tsx b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/contexts/synthetics_data_view_context.tsx index b7a7c8f25602b..04c502e3f181f 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/contexts/synthetics_data_view_context.tsx +++ b/x-pack/plugins/observability_solution/synthetics/public/apps/synthetics/contexts/synthetics_data_view_context.tsx @@ -19,7 +19,7 @@ export const SyntheticsDataViewContextProvider: FC< > = ({ children, dataViews }) => { const { data } = useFetcher>(async () => { return dataViews.create({ title: SYNTHETICS_INDEX_PATTERN }); - }, []); + }, [dataViews]); return ; }; diff --git a/x-pack/plugins/observability_solution/synthetics/public/hooks/use_capabilities.ts b/x-pack/plugins/observability_solution/synthetics/public/hooks/use_capabilities.ts index 1f9d7f1538b95..6e09a9bfe5935 100644 --- a/x-pack/plugins/observability_solution/synthetics/public/hooks/use_capabilities.ts +++ b/x-pack/plugins/observability_solution/synthetics/public/hooks/use_capabilities.ts @@ -62,7 +62,7 @@ export const useCanReadSyntheticsIndex = () => { }, }); }); - }, []); + }, [dataPublicPluginStart.search]); return { canRead: data?.canRead, diff --git a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/use_in_progress_image.ts b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/use_in_progress_image.ts index 0a252651c9ed4..bc85b45857c23 100644 --- a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/use_in_progress_image.ts +++ b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/use_in_progress_image.ts @@ -43,6 +43,9 @@ export const useInProgressImage = ({ } if (hasIntersected && !hasImage) return getJourneyScreenshot(imgPath); + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Uptime folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [hasIntersected, imgPath, skippedStep, retryLoading]); useEffect(() => { diff --git a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/overview/alerts/alerts_containers/use_snap_shot.ts b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/overview/alerts/alerts_containers/use_snap_shot.ts index 30445a5441cca..b6d250a2cb70f 100644 --- a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/overview/alerts/alerts_containers/use_snap_shot.ts +++ b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/overview/alerts/alerts_containers/use_snap_shot.ts @@ -24,6 +24,9 @@ export const useSnapShotCount = ({ query, filters }: { query: string; filters?: dateRangeEnd: 'now', filters: error ? undefined : esKuery, }), + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Uptime folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps [esKuery, query] ); diff --git a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/overview/integration_deprecation/index.tsx b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/overview/integration_deprecation/index.tsx index afff54bb69f26..ac7e20db41b17 100644 --- a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/overview/integration_deprecation/index.tsx +++ b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/overview/integration_deprecation/index.tsx @@ -26,6 +26,9 @@ export const IntegrationDeprecation = () => { return getHasIntegrationMonitors(); } return undefined; + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Uptime folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [monitorList.isLoaded]); const hasIntegrationMonitors = !loading && data && data.hasIntegrationMonitors; const [shouldShowNotice, setShouldShowNotice] = useState( diff --git a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/overview/snapshot/use_snap_shot.ts b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/overview/snapshot/use_snap_shot.ts index 8932d5755e700..15ffd98c739c3 100644 --- a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/overview/snapshot/use_snap_shot.ts +++ b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/overview/snapshot/use_snap_shot.ts @@ -22,6 +22,9 @@ export const useSnapShotCount = () => { const { data, loading } = useFetcher( () => fetchSnapshotCount({ query, dateRangeStart, dateRangeEnd, filters: esKuery }), + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Uptime folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps [dateRangeStart, dateRangeEnd, esKuery, lastRefresh, query] ); diff --git a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/synthetics/check_steps/stderr_logs.tsx b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/synthetics/check_steps/stderr_logs.tsx index 1b17bb5f1702b..7eab37d2b9afe 100644 --- a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/synthetics/check_steps/stderr_logs.tsx +++ b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/synthetics/check_steps/stderr_logs.tsx @@ -90,6 +90,9 @@ export const StdErrorLogs = ({ }); } return ''; + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Uptime folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [checkGroup, timestamp]); const search = { diff --git a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx index 8a4f101fdc4da..606019c99429d 100644 --- a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx +++ b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx @@ -40,6 +40,9 @@ export const StepScreenshots = ({ step }: Props) => { location: step.observer?.geo?.name, }); } + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Uptime folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [step._id, step['@timestamp']]); const lastSuccessfulCheck: Ping | undefined = data; diff --git a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/synthetics/step_screenshot_display.tsx b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/synthetics/step_screenshot_display.tsx index 7afb544fdeac8..b7d2f6d85fe2b 100644 --- a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/synthetics/step_screenshot_display.tsx +++ b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/components/synthetics/step_screenshot_display.tsx @@ -135,6 +135,9 @@ export const StepScreenshotDisplay: FC = ({ if (isScreenshotRef) { return getJourneyScreenshot(imgSrc); } + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Uptime folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [basePath, checkGroup, imgSrc, stepIndex, isScreenshotRef, lastRefresh]); const refDimensions = useMemo(() => { diff --git a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/contexts/uptime_data_view_context.tsx b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/contexts/uptime_data_view_context.tsx index edcf638b4414f..7abbdf3fde8c8 100644 --- a/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/contexts/uptime_data_view_context.tsx +++ b/x-pack/plugins/observability_solution/uptime/public/legacy_uptime/contexts/uptime_data_view_context.tsx @@ -26,6 +26,9 @@ export const UptimeDataViewContextProvider: FC< // this only creates an dateView in memory, not as saved object return dataViews.create({ title: heartbeatIndices }); } + // FIXME: Dario thinks there is a better way to do this but + // he's getting tired and maybe the Uptime folks can fix it + // eslint-disable-next-line react-hooks/exhaustive-deps }, [heartbeatIndices, indexStatus?.indexExists]); return ; diff --git a/x-pack/plugins/rollup/public/crud_app/sections/job_list/job_table/job_table.js b/x-pack/plugins/rollup/public/crud_app/sections/job_list/job_table/job_table.js index 5a30f9e6ec5f3..16ec3dd11c20e 100644 --- a/x-pack/plugins/rollup/public/crud_app/sections/job_list/job_table/job_table.js +++ b/x-pack/plugins/rollup/public/crud_app/sections/job_list/job_table/job_table.js @@ -305,7 +305,6 @@ export class JobTable extends Component { { @@ -393,7 +392,6 @@ export class JobTable extends Component { id="selectAllJobsCheckbox" checked={this.areAllItemsSelected()} onChange={this.toggleAll} - type="inList" aria-label={i18n.translate('xpack.rollupJobs.jobTable.selectAllRows', { defaultMessage: 'Select all rows', })} diff --git a/x-pack/plugins/security/public/management/roles/edit_role/privileges/es/elasticsearch_privileges.tsx b/x-pack/plugins/security/public/management/roles/edit_role/privileges/es/elasticsearch_privileges.tsx index 1ff2ede4c575c..44a4dd68816ad 100644 --- a/x-pack/plugins/security/public/management/roles/edit_role/privileges/es/elasticsearch_privileges.tsx +++ b/x-pack/plugins/security/public/management/roles/edit_role/privileges/es/elasticsearch_privileges.tsx @@ -106,6 +106,39 @@ export class ElasticsearchPrivileges extends Component { + {buildFlavor === 'traditional' && canUseRemoteClusters && ( + <> + +

    + +

    +     + + +

    + + {this.learnMore(docLinks.links.security.clusterPrivileges)} +

    +     + + + + + )} {buildFlavor === 'traditional' && ( <> @@ -222,40 +255,6 @@ export class ElasticsearchPrivileges extends Component { /> )} - {buildFlavor === 'traditional' && canUseRemoteClusters && ( - <> - - - - -

    - -

    -     - - -

    - - {this.learnMore(docLinks.links.security.clusterPrivileges)} -

    -     - - - )} ); }; diff --git a/x-pack/plugins/security/server/config_deprecations.ts b/x-pack/plugins/security/server/config_deprecations.ts index 511fe1d04119d..2e6a14b2028a2 100644 --- a/x-pack/plugins/security/server/config_deprecations.ts +++ b/x-pack/plugins/security/server/config_deprecations.ts @@ -122,6 +122,7 @@ export const securityConfigDeprecationProvider: ConfigDeprecationProvider = ({ title: i18n.translate('xpack.security.deprecations.maxRedirectURLSizeTitle', { defaultMessage: '"xpack.security.authc.providers.saml..maxRedirectURLSize" has no effect', + ignoreTag: true, }), message: i18n.translate('xpack.security.deprecations.maxRedirectURLSizeMessage', { defaultMessage: 'This setting is no longer used.', @@ -133,6 +134,7 @@ export const securityConfigDeprecationProvider: ConfigDeprecationProvider = ({ i18n.translate('xpack.security.deprecations.maxRedirectURLSize.manualSteps1', { defaultMessage: 'Remove "xpack.security.authc.providers.saml..maxRedirectURLSize" from kibana.yml.', + ignoreTag: true, }), ], }, diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_create_rules/bulk_create_rules_route.schema.yaml b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_create_rules/bulk_create_rules_route.schema.yaml index 3b5d56f5b736d..002fa5613eed9 100644 --- a/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_create_rules/bulk_create_rules_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_create_rules/bulk_create_rules_route.schema.yaml @@ -5,6 +5,7 @@ info: paths: /api/detection_engine/rules/_bulk_create: post: + x-labels: [ess] operationId: BulkCreateRules x-codegen-enabled: true deprecated: true diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/create_rule/create_rule_route.schema.yaml b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/create_rule/create_rule_route.schema.yaml index 4dff72dc216e1..464a2df0641e3 100644 --- a/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/create_rule/create_rule_route.schema.yaml +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/create_rule/create_rule_route.schema.yaml @@ -5,6 +5,7 @@ info: paths: /api/detection_engine/rules: post: + x-labels: [ess, serverless] operationId: CreateRule x-codegen-enabled: true description: Create a single detection rule diff --git a/x-pack/plugins/security_solution/public/common/components/control_columns/translations.ts b/x-pack/plugins/security_solution/public/common/components/control_columns/translations.ts index 31872dd0087a0..ab8f90224bf52 100644 --- a/x-pack/plugins/security_solution/public/common/components/control_columns/translations.ts +++ b/x-pack/plugins/security_solution/public/common/components/control_columns/translations.ts @@ -18,5 +18,5 @@ export const CHECKBOX_FOR_ROW = ({ i18n.translate('xpack.securitySolution.controlColumns.checkboxForRowAriaLabel', { values: { ariaRowindex, checked, columnValues }, defaultMessage: - '{checked, select, false {unchecked} true {checked}} checkbox for the alert or event in row {ariaRowindex}, with columns {columnValues}', + '{checked, select, true {checked} other {unchecked}} checkbox for the alert or event in row {ariaRowindex}, with columns {columnValues}', }); diff --git a/x-pack/plugins/security_solution/public/management/cypress/e2e/policy/policy_details.cy.ts b/x-pack/plugins/security_solution/public/management/cypress/e2e/policy/policy_details.cy.ts index a46cc515ce7fc..4f5c00c6861ee 100644 --- a/x-pack/plugins/security_solution/public/management/cypress/e2e/policy/policy_details.cy.ts +++ b/x-pack/plugins/security_solution/public/management/cypress/e2e/policy/policy_details.cy.ts @@ -19,7 +19,12 @@ import { loadPage } from '../../tasks/common'; describe( 'Policy Details', { - tags: ['@ess', '@serverless'], + tags: [ + '@ess', + '@serverless', + // skipped on MKI since feature flags are not supported there + '@skipInServerlessMKI', + ], env: { ftrConfig: { kbnServerArgs: [ diff --git a/x-pack/plugins/security_solution/scripts/openapi/bundle.js b/x-pack/plugins/security_solution/scripts/openapi/bundle.js index 82280d0ef0ebf..cba548cfd2903 100644 --- a/x-pack/plugins/security_solution/scripts/openapi/bundle.js +++ b/x-pack/plugins/security_solution/scripts/openapi/bundle.js @@ -15,6 +15,20 @@ bundle({ sourceGlob: join(SECURITY_SOLUTION_ROOT, 'common/api/**/*.schema.yaml'), outputFilePath: join( SECURITY_SOLUTION_ROOT, - 'target/openapi/security_solution-{version}.bundled.schema.yaml' + 'target/openapi/serverless/security_solution-{version}.bundled.schema.yaml' ), + options: { + includeLabels: ['serverless'], + }, +}); + +bundle({ + sourceGlob: join(SECURITY_SOLUTION_ROOT, 'common/api/**/*.schema.yaml'), + outputFilePath: join( + SECURITY_SOLUTION_ROOT, + 'target/openapi/ess/security_solution-{version}.bundled.schema.yaml' + ), + options: { + includeLabels: ['ess'], + }, }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_objects/create_prebuilt_rules.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_objects/create_prebuilt_rules.ts index ef3d34b657505..8da1055156d3d 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_objects/create_prebuilt_rules.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_objects/create_prebuilt_rules.ts @@ -9,7 +9,7 @@ import { MAX_RULES_TO_UPDATE_IN_PARALLEL } from '../../../../../../common/consta import { initPromisePool } from '../../../../../utils/promise_pool'; import { withSecuritySpan } from '../../../../../utils/with_security_span'; import type { PrebuiltRuleAsset } from '../../model/rule_assets/prebuilt_rule_asset'; -import type { IDetectionRulesClient } from '../../../rule_management/logic/rule_management/detection_rules_client'; +import type { IDetectionRulesClient } from '../../../rule_management/logic/detection_rules_client/detection_rules_client_interface'; export const createPrebuiltRules = ( detectionRulesClient: IDetectionRulesClient, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_objects/upgrade_prebuilt_rules.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_objects/upgrade_prebuilt_rules.ts index 4ae595cca16b0..2c9a81a7af6ce 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_objects/upgrade_prebuilt_rules.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_objects/upgrade_prebuilt_rules.ts @@ -9,7 +9,7 @@ import { MAX_RULES_TO_UPDATE_IN_PARALLEL } from '../../../../../../common/consta import { initPromisePool } from '../../../../../utils/promise_pool'; import { withSecuritySpan } from '../../../../../utils/with_security_span'; import type { PrebuiltRuleAsset } from '../../model/rule_assets/prebuilt_rule_asset'; -import type { IDetectionRulesClient } from '../../../rule_management/logic/rule_management/detection_rules_client'; +import type { IDetectionRulesClient } from '../../../rule_management/logic/detection_rules_client/detection_rules_client_interface'; /** * Upgrades existing prebuilt rules given a set of rules and output index. diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_context.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_context.ts index a2e6f2f038546..fa9fcc1fa5e22 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_context.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_context.ts @@ -38,7 +38,7 @@ import { riskEngineDataClientMock } from '../../../entity_analytics/risk_engine/ import { riskScoreDataClientMock } from '../../../entity_analytics/risk_score/risk_score_data_client.mock'; import { assetCriticalityDataClientMock } from '../../../entity_analytics/asset_criticality/asset_criticality_data_client.mock'; import { auditLoggerMock } from '@kbn/security-plugin/server/audit/mocks'; -import { detectionRulesClientMock } from '../../rule_management/logic/rule_management/__mocks__/detection_rules_client'; +import { detectionRulesClientMock } from '../../rule_management/logic/detection_rules_client/__mocks__/detection_rules_client'; export const createMockClients = () => { const core = coreMock.createRequestHandlerContext(); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions/api/create_rule_exceptions/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions/api/create_rule_exceptions/route.ts index c5dfc3a0d847e..c8c257770e26a 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions/api/create_rule_exceptions/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions/api/create_rule_exceptions/route.ts @@ -37,13 +37,13 @@ import { CreateRuleExceptionsRequestParams, } from '../../../../../../common/api/detection_engine/rule_exceptions'; -import { readRules } from '../../../rule_management/logic/rule_management/read_rules'; +import { readRules } from '../../../rule_management/logic/detection_rules_client/read_rules'; import { checkDefaultRuleExceptionListReferences } from '../../../rule_management/logic/exceptions/check_for_default_rule_exception_list'; import type { RuleParams } from '../../../rule_schema'; import type { SecuritySolutionPluginRouter } from '../../../../../types'; import { buildSiemResponse } from '../../../routes/utils'; import { buildRouteValidation } from '../../../../../utils/build_validation/route_validation'; -import type { IDetectionRulesClient } from '../../../rule_management/logic/rule_management/detection_rules_client'; +import type { IDetectionRulesClient } from '../../../rule_management/logic/detection_rules_client/detection_rules_client_interface'; export const createRuleExceptionsRoute = (router: SecuritySolutionPluginRouter) => { router.versioned diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_actions/fetch_rules_by_query_or_ids.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_actions/fetch_rules_by_query_or_ids.ts index 1ef231bb0b5ad..d59ba5676b607 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_actions/fetch_rules_by_query_or_ids.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_actions/fetch_rules_by_query_or_ids.ts @@ -11,7 +11,7 @@ import { MAX_RULES_TO_UPDATE_IN_PARALLEL } from '../../../../../../../common/con import type { PromisePoolOutcome } from '../../../../../../utils/promise_pool'; import { initPromisePool } from '../../../../../../utils/promise_pool'; import type { RuleAlertType } from '../../../../rule_schema'; -import { readRules } from '../../../logic/rule_management/read_rules'; +import { readRules } from '../../../logic/detection_rules_client/read_rules'; import { findRules } from '../../../logic/search/find_rules'; import { MAX_RULES_TO_PROCESS_TOTAL } from './route'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_actions/route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_actions/route.test.ts index d74afe0bea65e..37ad3dc7d8487 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_actions/route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_actions/route.test.ts @@ -30,10 +30,10 @@ import { getBulkDisableRuleActionSchemaMock, } from '../../../../../../../common/api/detection_engine/rule_management/mocks'; import { loggingSystemMock } from '@kbn/core/server/mocks'; -import { readRules } from '../../../logic/rule_management/read_rules'; +import { readRules } from '../../../logic/detection_rules_client/read_rules'; jest.mock('../../../../../machine_learning/authz'); -jest.mock('../../../logic/rule_management/read_rules', () => ({ readRules: jest.fn() })); +jest.mock('../../../logic/detection_rules_client/read_rules', () => ({ readRules: jest.fn() })); describe('Perform bulk action route', () => { const readRulesMock = readRules as jest.Mock; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/route.ts index e4373e1563532..a8e5a0446c6e3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/route.ts @@ -16,7 +16,7 @@ import { } from '../../../../../../../common/api/detection_engine/rule_management'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; -import { readRules } from '../../../logic/rule_management/read_rules'; +import { readRules } from '../../../logic/detection_rules_client/read_rules'; import { getDuplicates } from './get_duplicates'; import { transformValidateBulkError } from '../../../utils/validate'; import { buildRouteValidationWithZod } from '../../../../../../utils/build_validation/route_validation'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_delete_rules/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_delete_rules/route.ts index 2ac6fb3340bab..234439eb49052 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_delete_rules/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_delete_rules/route.ts @@ -24,7 +24,7 @@ import { createBulkErrorObject, transformBulkError, } from '../../../../routes/utils'; -import { readRules } from '../../../logic/rule_management/read_rules'; +import { readRules } from '../../../logic/detection_rules_client/read_rules'; import { getIdBulkError } from '../../../utils/utils'; import { transformValidateBulkError } from '../../../utils/validate'; import { getDeprecatedBulkEndpointHeader, logDeprecatedBulkEndpoint } from '../../deprecation'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_patch_rules/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_patch_rules/route.ts index 1ed5f529b2014..a3752d421380b 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_patch_rules/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_patch_rules/route.ts @@ -19,7 +19,7 @@ import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import { transformBulkError, buildSiemResponse } from '../../../../routes/utils'; import { getIdBulkError } from '../../../utils/utils'; import { transformValidateBulkError } from '../../../utils/validate'; -import { readRules } from '../../../logic/rule_management/read_rules'; +import { readRules } from '../../../logic/detection_rules_client/read_rules'; import { getDeprecatedBulkEndpointHeader, logDeprecatedBulkEndpoint } from '../../deprecation'; import { validateRuleDefaultExceptionList } from '../../../logic/exceptions/validate_rule_default_exception_list'; import { validateRulesWithDuplicatedDefaultExceptionsList } from '../../../logic/exceptions/validate_rules_with_duplicated_default_exceptions_list'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_update_rules/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_update_rules/route.ts index 2b3ee7c2f751a..e08d781cd74d8 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_update_rules/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_update_rules/route.ts @@ -24,7 +24,7 @@ import { buildSiemResponse, createBulkErrorObject, } from '../../../../routes/utils'; -import { readRules } from '../../../logic/rule_management/read_rules'; +import { readRules } from '../../../logic/detection_rules_client/read_rules'; import { getDeprecatedBulkEndpointHeader, logDeprecatedBulkEndpoint } from '../../deprecation'; import { validateRuleDefaultExceptionList } from '../../../logic/exceptions/validate_rule_default_exception_list'; import { validateRulesWithDuplicatedDefaultExceptionsList } from '../../../logic/exceptions/validate_rules_with_duplicated_default_exceptions_list'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/create_rule/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/create_rule/route.ts index db01f1f783892..03642aa12266b 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/create_rule/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/create_rule/route.ts @@ -16,7 +16,7 @@ import { DETECTION_ENGINE_RULES_URL } from '../../../../../../../common/constant import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import { buildRouteValidationWithZod } from '../../../../../../utils/build_validation/route_validation'; import { buildSiemResponse } from '../../../../routes/utils'; -import { readRules } from '../../../logic/rule_management/read_rules'; +import { readRules } from '../../../logic/detection_rules_client/read_rules'; import { checkDefaultRuleExceptionListReferences } from '../../../logic/exceptions/check_for_default_rule_exception_list'; import { validateRuleDefaultExceptionList } from '../../../logic/exceptions/validate_rule_default_exception_list'; import { transformValidate, validateResponseActionsPermissions } from '../../../utils/validate'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/delete_rule/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/delete_rule/route.ts index 31b72c76daaa6..3cf9aa6a2fb55 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/delete_rule/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/delete_rule/route.ts @@ -16,7 +16,7 @@ import { DETECTION_ENGINE_RULES_URL } from '../../../../../../../common/constant import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import { buildRouteValidationWithZod } from '../../../../../../utils/build_validation/route_validation'; import { buildSiemResponse } from '../../../../routes/utils'; -import { readRules } from '../../../logic/rule_management/read_rules'; +import { readRules } from '../../../logic/detection_rules_client/read_rules'; import { getIdError, transform } from '../../../utils/utils'; export const deleteRuleRoute = (router: SecuritySolutionPluginRouter) => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/patch_rule/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/patch_rule/route.ts index 78c5a15ef0581..38b283b2c5fb6 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/patch_rule/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/patch_rule/route.ts @@ -16,7 +16,7 @@ import { DETECTION_ENGINE_RULES_URL } from '../../../../../../../common/constant import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import { buildRouteValidationWithZod } from '../../../../../../utils/build_validation/route_validation'; import { buildSiemResponse } from '../../../../routes/utils'; -import { readRules } from '../../../logic/rule_management/read_rules'; +import { readRules } from '../../../logic/detection_rules_client/read_rules'; import { checkDefaultRuleExceptionListReferences } from '../../../logic/exceptions/check_for_default_rule_exception_list'; import { validateRuleDefaultExceptionList } from '../../../logic/exceptions/validate_rule_default_exception_list'; import { getIdError } from '../../../utils/utils'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/read_rule/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/read_rule/route.ts index aabf538367930..95992618b0625 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/read_rule/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/read_rule/route.ts @@ -16,7 +16,7 @@ import { DETECTION_ENGINE_RULES_URL } from '../../../../../../../common/constant import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import { buildRouteValidationWithZod } from '../../../../../../utils/build_validation/route_validation'; import { buildSiemResponse } from '../../../../routes/utils'; -import { readRules } from '../../../logic/rule_management/read_rules'; +import { readRules } from '../../../logic/detection_rules_client/read_rules'; import { getIdError, transform } from '../../../utils/utils'; export const readRuleRoute = (router: SecuritySolutionPluginRouter, logger: Logger) => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/update_rule/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/update_rule/route.ts index 8c46e1979a43d..5ac2df600908c 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/update_rule/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/update_rule/route.ts @@ -16,7 +16,7 @@ import { DETECTION_ENGINE_RULES_URL } from '../../../../../../../common/constant import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import { buildRouteValidationWithZod } from '../../../../../../utils/build_validation/route_validation'; import { buildSiemResponse } from '../../../../routes/utils'; -import { readRules } from '../../../logic/rule_management/read_rules'; +import { readRules } from '../../../logic/detection_rules_client/read_rules'; import { checkDefaultRuleExceptionListReferences } from '../../../logic/exceptions/check_for_default_rule_exception_list'; import { validateRuleDefaultExceptionList } from '../../../logic/exceptions/validate_rule_default_exception_list'; import { getIdError } from '../../../utils/utils'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/__mocks__/detection_rules_client.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/__mocks__/detection_rules_client.ts similarity index 97% rename from x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/__mocks__/detection_rules_client.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/__mocks__/detection_rules_client.ts index 2411de933fb1f..b6d14a307801e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/__mocks__/detection_rules_client.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/__mocks__/detection_rules_client.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { IDetectionRulesClient } from '../detection_rules_client'; +import type { IDetectionRulesClient } from '../detection_rules_client_interface'; export type DetectionRulesClientMock = jest.Mocked; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/__mocks__/read_rules.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/__mocks__/read_rules.ts similarity index 100% rename from x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/__mocks__/read_rules.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/__mocks__/read_rules.ts diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/create_custom_rule.detection_rules_client.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.create_custom_rule.test.ts similarity index 99% rename from x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/create_custom_rule.detection_rules_client.test.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.create_custom_rule.test.ts index 6053d5109676c..a8335108d7cbe 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/create_custom_rule.detection_rules_client.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.create_custom_rule.test.ts @@ -16,7 +16,7 @@ import { DEFAULT_INDICATOR_SOURCE_PATH } from '../../../../../../common/constant import { buildMlAuthz } from '../../../../machine_learning/authz'; import { throwAuthzError } from '../../../../machine_learning/validation'; import { createDetectionRulesClient } from './detection_rules_client'; -import type { IDetectionRulesClient } from './detection_rules_client'; +import type { IDetectionRulesClient } from './detection_rules_client_interface'; jest.mock('../../../../machine_learning/authz'); jest.mock('../../../../machine_learning/validation'); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/create_prebuilt_rule.detection_rules_client.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.create_prebuilt_rule.test.ts similarity index 99% rename from x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/create_prebuilt_rule.detection_rules_client.test.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.create_prebuilt_rule.test.ts index c6d80ad412dc5..d2a61dcc65e45 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/create_prebuilt_rule.detection_rules_client.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.create_prebuilt_rule.test.ts @@ -16,7 +16,7 @@ import { DEFAULT_INDICATOR_SOURCE_PATH } from '../../../../../../common/constant import { buildMlAuthz } from '../../../../machine_learning/authz'; import { throwAuthzError } from '../../../../machine_learning/validation'; import { createDetectionRulesClient } from './detection_rules_client'; -import type { IDetectionRulesClient } from './detection_rules_client'; +import type { IDetectionRulesClient } from './detection_rules_client_interface'; jest.mock('../../../../machine_learning/authz'); jest.mock('../../../../machine_learning/validation'); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/delete_rule.detection_rules_client.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.delete_rule.test.ts similarity index 98% rename from x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/delete_rule.detection_rules_client.test.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.delete_rule.test.ts index 2182927a373df..37cb8e0aa709e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/delete_rule.detection_rules_client.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.delete_rule.test.ts @@ -8,7 +8,7 @@ import { rulesClientMock } from '@kbn/alerting-plugin/server/mocks'; import { buildMlAuthz } from '../../../../machine_learning/authz'; import { createDetectionRulesClient } from './detection_rules_client'; -import type { IDetectionRulesClient } from './detection_rules_client'; +import type { IDetectionRulesClient } from './detection_rules_client_interface'; jest.mock('../../../../machine_learning/authz'); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/import_rule.detection_rules_client.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.import_rule.test.ts similarity index 95% rename from x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/import_rule.detection_rules_client.test.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.import_rule.test.ts index f783c5963c2be..4d2cb0ee65519 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/import_rule.detection_rules_client.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.import_rule.test.ts @@ -13,7 +13,7 @@ import { getQueryRuleParams } from '../../../rule_schema/mocks'; import { buildMlAuthz } from '../../../../machine_learning/authz'; import { throwAuthzError } from '../../../../machine_learning/validation'; import { createDetectionRulesClient } from './detection_rules_client'; -import type { IDetectionRulesClient } from './detection_rules_client'; +import type { IDetectionRulesClient } from './detection_rules_client_interface'; jest.mock('../../../../machine_learning/authz'); jest.mock('../../../../machine_learning/validation'); @@ -50,7 +50,7 @@ describe('DetectionRulesClient.importRule', () => { await detectionRulesClient.importRule({ ruleToImport, overwriteRules: true, - options: { allowMissingConnectorSecrets }, + allowMissingConnectorSecrets, }); expect(rulesClient.create).toHaveBeenCalledWith( @@ -78,7 +78,7 @@ describe('DetectionRulesClient.importRule', () => { detectionRulesClient.importRule({ ruleToImport, overwriteRules: true, - options: { allowMissingConnectorSecrets }, + allowMissingConnectorSecrets, }) ).rejects.toThrow('mocked MLAuth error'); @@ -92,7 +92,7 @@ describe('DetectionRulesClient.importRule', () => { await detectionRulesClient.importRule({ ruleToImport, overwriteRules: true, - options: { allowMissingConnectorSecrets }, + allowMissingConnectorSecrets, }); expect(rulesClient.update).toHaveBeenCalledWith( @@ -133,7 +133,7 @@ describe('DetectionRulesClient.importRule', () => { timestamp_override: undefined, }, overwriteRules: true, - options: { allowMissingConnectorSecrets }, + allowMissingConnectorSecrets, }); expect(rulesClient.create).not.toHaveBeenCalled(); @@ -154,7 +154,7 @@ describe('DetectionRulesClient.importRule', () => { detectionRulesClient.importRule({ ruleToImport, overwriteRules: false, - options: { allowMissingConnectorSecrets }, + allowMissingConnectorSecrets, }) ).rejects.toMatchObject({ error: { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/patch_rule.detection_rules_client.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.patch_rule.test.ts similarity index 99% rename from x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/patch_rule.detection_rules_client.test.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.patch_rule.test.ts index 59d250606e285..7f1c219888636 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/patch_rule.detection_rules_client.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.patch_rule.test.ts @@ -17,7 +17,7 @@ import { readRules } from './read_rules'; import { buildMlAuthz } from '../../../../machine_learning/authz'; import { throwAuthzError } from '../../../../machine_learning/validation'; import { createDetectionRulesClient } from './detection_rules_client'; -import type { IDetectionRulesClient } from './detection_rules_client'; +import type { IDetectionRulesClient } from './detection_rules_client_interface'; jest.mock('../../../../machine_learning/authz'); jest.mock('../../../../machine_learning/validation'); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.ts new file mode 100644 index 0000000000000..7256441697e65 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.ts @@ -0,0 +1,78 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { RulesClient } from '@kbn/alerting-plugin/server'; +import type { MlAuthz } from '../../../../machine_learning/authz'; + +import type { RuleAlertType } from '../../../rule_schema'; +import type { + IDetectionRulesClient, + CreateCustomRuleArgs, + CreatePrebuiltRuleArgs, + UpdateRuleArgs, + PatchRuleArgs, + DeleteRuleArgs, + UpgradePrebuiltRuleArgs, + ImportRuleArgs, +} from './detection_rules_client_interface'; + +import { createCustomRule } from './methods/create_custom_rule'; +import { createPrebuiltRule } from './methods/create_prebuilt_rule'; +import { updateRule } from './methods/update_rule'; +import { patchRule } from './methods/patch_rule'; +import { deleteRule } from './methods/delete_rule'; +import { upgradePrebuiltRule } from './methods/upgrade_prebuilt_rule'; +import { importRule } from './methods/import_rule'; + +import { withSecuritySpan } from '../../../../../utils/with_security_span'; + +export const createDetectionRulesClient = ( + rulesClient: RulesClient, + mlAuthz: MlAuthz +): IDetectionRulesClient => ({ + async createCustomRule(args: CreateCustomRuleArgs): Promise { + return withSecuritySpan('DetectionRulesClient.createCustomRule', async () => { + return createCustomRule(rulesClient, args, mlAuthz); + }); + }, + + async createPrebuiltRule(args: CreatePrebuiltRuleArgs): Promise { + return withSecuritySpan('DetectionRulesClient.createPrebuiltRule', async () => { + return createPrebuiltRule(rulesClient, args, mlAuthz); + }); + }, + + async updateRule(args: UpdateRuleArgs): Promise { + return withSecuritySpan('DetectionRulesClient.updateRule', async () => { + return updateRule(rulesClient, args, mlAuthz); + }); + }, + + async patchRule(args: PatchRuleArgs): Promise { + return withSecuritySpan('DetectionRulesClient.patchRule', async () => { + return patchRule(rulesClient, args, mlAuthz); + }); + }, + + async deleteRule(args: DeleteRuleArgs): Promise { + return withSecuritySpan('DetectionRulesClient.deleteRule', async () => { + return deleteRule(rulesClient, args); + }); + }, + + async upgradePrebuiltRule(args: UpgradePrebuiltRuleArgs): Promise { + return withSecuritySpan('DetectionRulesClient.upgradePrebuiltRule', async () => { + return upgradePrebuiltRule(rulesClient, args, mlAuthz); + }); + }, + + async importRule(args: ImportRuleArgs): Promise { + return withSecuritySpan('DetectionRulesClient.importRule', async () => { + return importRule(rulesClient, args, mlAuthz); + }); + }, +}); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/update_rule.detection_rules_client.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.update_rule.test.ts similarity index 89% rename from x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/update_rule.detection_rules_client.test.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.update_rule.test.ts index f538672444b0e..671460b046fea 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/update_rule.detection_rules_client.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.update_rule.test.ts @@ -13,10 +13,11 @@ import { getCreateMachineLearningRulesSchemaMock, getCreateRulesSchemaMock, } from '../../../../../../common/api/detection_engine/model/rule_schema/mocks'; -import { updateRule } from './update_rule'; import { readRules } from './read_rules'; import { buildMlAuthz } from '../../../../machine_learning/authz'; import { throwAuthzError } from '../../../../machine_learning/validation'; +import { createDetectionRulesClient } from './detection_rules_client'; +import type { IDetectionRulesClient } from './detection_rules_client_interface'; jest.mock('../../../../machine_learning/authz'); jest.mock('../../../../machine_learning/validation'); @@ -25,10 +26,13 @@ jest.mock('./read_rules'); describe('DetectionRulesClient.updateRule', () => { let rulesClient: ReturnType; + let detectionRulesClient: IDetectionRulesClient; + const mlAuthz = (buildMlAuthz as jest.Mock)(); beforeEach(() => { rulesClient = rulesClientMock.create(); + detectionRulesClient = createDetectionRulesClient(rulesClient, mlAuthz); }); it('calls the rulesClient with expected params', async () => { @@ -37,7 +41,7 @@ describe('DetectionRulesClient.updateRule', () => { (readRules as jest.Mock).mockResolvedValueOnce(existingRule); rulesClient.update.mockResolvedValue(getRuleMock(getQueryRuleParams())); - await updateRule(rulesClient, { ruleUpdate }, mlAuthz); + await detectionRulesClient.updateRule({ ruleUpdate }); expect(rulesClient.update).toHaveBeenCalledWith( expect.objectContaining({ @@ -58,7 +62,7 @@ describe('DetectionRulesClient.updateRule', () => { (readRules as jest.Mock).mockResolvedValueOnce(existingRule); rulesClient.update.mockResolvedValue(getRuleMock(getQueryRuleParams())); - const rule = await updateRule(rulesClient, { ruleUpdate }, mlAuthz); + const rule = await detectionRulesClient.updateRule({ ruleUpdate }); expect(rule.enabled).toBe(true); }); @@ -69,7 +73,7 @@ describe('DetectionRulesClient.updateRule', () => { (readRules as jest.Mock).mockResolvedValueOnce(existingRule); rulesClient.update.mockResolvedValue(getRuleMock(getMlRuleParams())); - await updateRule(rulesClient, { ruleUpdate }, mlAuthz); + await detectionRulesClient.updateRule({ ruleUpdate }); expect(rulesClient.update).toHaveBeenCalledWith( expect.objectContaining({ @@ -92,7 +96,7 @@ describe('DetectionRulesClient.updateRule', () => { (readRules as jest.Mock).mockResolvedValueOnce(existingRule); rulesClient.update.mockResolvedValue(getRuleMock(getMlRuleParams())); - await updateRule(rulesClient, { ruleUpdate }, mlAuthz); + await detectionRulesClient.updateRule({ ruleUpdate }); expect(rulesClient.update).toHaveBeenCalledWith( expect.objectContaining({ @@ -118,7 +122,7 @@ describe('DetectionRulesClient.updateRule', () => { rulesClient.update.mockResolvedValue(getRuleMock(getQueryRuleParams())); (readRules as jest.Mock).mockResolvedValueOnce(existingRule); - await updateRule(rulesClient, { ruleUpdate }, mlAuthz); + await detectionRulesClient.updateRule({ ruleUpdate }); expect(rulesClient.disable).toHaveBeenCalledWith( expect.objectContaining({ @@ -139,7 +143,7 @@ describe('DetectionRulesClient.updateRule', () => { rulesClient.update.mockResolvedValue(getRuleMock(getQueryRuleParams())); (readRules as jest.Mock).mockResolvedValueOnce(existingRule); - await updateRule(rulesClient, { ruleUpdate }, mlAuthz); + await detectionRulesClient.updateRule({ ruleUpdate }); expect(rulesClient.enable).toHaveBeenCalledWith( expect.objectContaining({ @@ -158,7 +162,7 @@ describe('DetectionRulesClient.updateRule', () => { enabled: true, }; - await expect(updateRule(rulesClient, { ruleUpdate }, mlAuthz)).rejects.toThrow( + await expect(detectionRulesClient.updateRule({ ruleUpdate })).rejects.toThrow( 'mocked MLAuth error' ); @@ -184,7 +188,7 @@ describe('DetectionRulesClient.updateRule', () => { (readRules as jest.Mock).mockResolvedValueOnce(existingRule); rulesClient.update.mockResolvedValue(getRuleMock(getQueryRuleParams())); - await updateRule(rulesClient, { ruleUpdate }, mlAuthz); + await detectionRulesClient.updateRule({ ruleUpdate }); expect(rulesClient.update).toHaveBeenCalledWith( expect.objectContaining({ @@ -222,7 +226,7 @@ describe('DetectionRulesClient.updateRule', () => { rulesClient.update.mockResolvedValue(getRuleMock(getQueryRuleParams())); (readRules as jest.Mock).mockResolvedValueOnce(existingRule); - await updateRule(rulesClient, { ruleUpdate }, mlAuthz); + await detectionRulesClient.updateRule({ ruleUpdate }); expect(rulesClient.update).toHaveBeenCalledWith( expect.objectContaining({ diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/upgrade_prebuilt_rule.detection_rules_client.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.upgrade_prebuilt_rule.test.ts similarity index 99% rename from x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/upgrade_prebuilt_rule.detection_rules_client.test.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.upgrade_prebuilt_rule.test.ts index 50dc69b660c0f..97a564cbf86e6 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/upgrade_prebuilt_rule.detection_rules_client.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client.upgrade_prebuilt_rule.test.ts @@ -20,7 +20,7 @@ import { getEqlRuleParams, getQueryRuleParams } from '../../../rule_schema/mocks import { buildMlAuthz } from '../../../../machine_learning/authz'; import { throwAuthzError } from '../../../../machine_learning/validation'; import { createDetectionRulesClient } from './detection_rules_client'; -import type { IDetectionRulesClient } from './detection_rules_client'; +import type { IDetectionRulesClient } from './detection_rules_client_interface'; jest.mock('../../../../machine_learning/authz'); jest.mock('../../../../machine_learning/validation'); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client_interface.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client_interface.ts new file mode 100644 index 0000000000000..d99b0b9c2cbd0 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client_interface.ts @@ -0,0 +1,58 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { RuleCreateProps } from '../../../../../../common/api/detection_engine/model/rule_schema'; +import type { PrebuiltRuleAsset } from '../../../prebuilt_rules'; +import type { + RuleUpdateProps, + RulePatchProps, + RuleObjectId, + RuleToImport, +} from '../../../../../../common/api/detection_engine'; +import type { RuleAlertType } from '../../../rule_schema'; + +export interface IDetectionRulesClient { + createCustomRule: (createCustomRulePayload: CreateCustomRuleArgs) => Promise; + createPrebuiltRule: (createPrebuiltRulePayload: CreatePrebuiltRuleArgs) => Promise; + updateRule: (updateRulePayload: UpdateRuleArgs) => Promise; + patchRule: (patchRulePayload: PatchRuleArgs) => Promise; + deleteRule: (deleteRulePayload: DeleteRuleArgs) => Promise; + upgradePrebuiltRule: ( + upgradePrebuiltRulePayload: UpgradePrebuiltRuleArgs + ) => Promise; + importRule: (importRulePayload: ImportRuleArgs) => Promise; +} + +export interface CreateCustomRuleArgs { + params: RuleCreateProps; +} + +export interface CreatePrebuiltRuleArgs { + ruleAsset: PrebuiltRuleAsset; +} + +export interface UpdateRuleArgs { + ruleUpdate: RuleUpdateProps; +} + +export interface PatchRuleArgs { + nextParams: RulePatchProps; +} + +export interface DeleteRuleArgs { + ruleId: RuleObjectId; +} + +export interface UpgradePrebuiltRuleArgs { + ruleAsset: PrebuiltRuleAsset; +} + +export interface ImportRuleArgs { + ruleToImport: RuleToImport; + overwriteRules?: boolean; + allowMissingConnectorSecrets?: boolean; +} diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/create_custom_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/create_custom_rule.ts new file mode 100644 index 0000000000000..c9b3b7b542a17 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/create_custom_rule.ts @@ -0,0 +1,30 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { RulesClient } from '@kbn/alerting-plugin/server'; +import type { CreateCustomRuleArgs } from '../detection_rules_client_interface'; +import type { MlAuthz } from '../../../../../machine_learning/authz'; +import type { RuleAlertType, RuleParams } from '../../../../rule_schema'; +import { convertCreateAPIToInternalSchema } from '../../../normalization/rule_converters'; + +import { validateMlAuth } from '../utils'; + +export const createCustomRule = async ( + rulesClient: RulesClient, + args: CreateCustomRuleArgs, + mlAuthz: MlAuthz +): Promise => { + const { params } = args; + await validateMlAuth(mlAuthz, params.type); + + const internalRule = convertCreateAPIToInternalSchema(params, { immutable: false }); + const rule = await rulesClient.create({ + data: internalRule, + }); + + return rule; +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/create_prebuilt_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/create_prebuilt_rule.ts new file mode 100644 index 0000000000000..0ada0197137a4 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/create_prebuilt_rule.ts @@ -0,0 +1,35 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { RulesClient } from '@kbn/alerting-plugin/server'; +import type { CreatePrebuiltRuleArgs } from '../detection_rules_client_interface'; +import type { MlAuthz } from '../../../../../machine_learning/authz'; +import type { RuleAlertType, RuleParams } from '../../../../rule_schema'; +import { convertCreateAPIToInternalSchema } from '../../../normalization/rule_converters'; + +import { validateMlAuth } from '../utils'; + +export const createPrebuiltRule = async ( + rulesClient: RulesClient, + args: CreatePrebuiltRuleArgs, + mlAuthz: MlAuthz +): Promise => { + const { ruleAsset } = args; + + await validateMlAuth(mlAuthz, ruleAsset.type); + + const internalRule = convertCreateAPIToInternalSchema(ruleAsset, { + immutable: true, + defaultEnabled: false, + }); + + const rule = await rulesClient.create({ + data: internalRule, + }); + + return rule; +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/delete_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/delete_rule.ts new file mode 100644 index 0000000000000..ec1491e8159d7 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/delete_rule.ts @@ -0,0 +1,14 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { RulesClient } from '@kbn/alerting-plugin/server'; +import type { DeleteRuleArgs } from '../detection_rules_client_interface'; + +export const deleteRule = async (rulesClient: RulesClient, args: DeleteRuleArgs): Promise => { + const { ruleId } = args; + await rulesClient.delete({ id: ruleId }); +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/import_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/import_rule.ts new file mode 100644 index 0000000000000..8761478e30eda --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/import_rule.ts @@ -0,0 +1,63 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { RulesClient } from '@kbn/alerting-plugin/server'; +import type { MlAuthz } from '../../../../../machine_learning/authz'; +import type { ImportRuleArgs } from '../detection_rules_client_interface'; +import type { RuleAlertType, RuleParams } from '../../../../rule_schema'; +import { createBulkErrorObject } from '../../../../routes/utils'; +import { + convertCreateAPIToInternalSchema, + convertUpdateAPIToInternalSchema, +} from '../../../normalization/rule_converters'; + +import { validateMlAuth } from '../utils'; + +import { readRules } from '../read_rules'; + +export const importRule = async ( + rulesClient: RulesClient, + importRulePayload: ImportRuleArgs, + mlAuthz: MlAuthz +): Promise => { + const { ruleToImport, overwriteRules, allowMissingConnectorSecrets } = importRulePayload; + + await validateMlAuth(mlAuthz, ruleToImport.type); + + const existingRule = await readRules({ + rulesClient, + ruleId: ruleToImport.rule_id, + id: undefined, + }); + + if (!existingRule) { + const internalRule = convertCreateAPIToInternalSchema(ruleToImport, { + immutable: false, + }); + + return rulesClient.create({ + data: internalRule, + allowMissingConnectorSecrets, + }); + } else if (existingRule && overwriteRules) { + const newInternalRule = convertUpdateAPIToInternalSchema({ + existingRule, + ruleUpdate: ruleToImport, + }); + + return rulesClient.update({ + id: existingRule.id, + data: newInternalRule, + }); + } else { + throw createBulkErrorObject({ + ruleId: existingRule.params.ruleId, + statusCode: 409, + message: `rule_id: "${existingRule.params.ruleId}" already exists`, + }); + } +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/patch_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/patch_rule.ts new file mode 100644 index 0000000000000..b7c8c1539d664 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/patch_rule.ts @@ -0,0 +1,54 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { RulesClient } from '@kbn/alerting-plugin/server'; +import type { MlAuthz } from '../../../../../machine_learning/authz'; +import type { PatchRuleArgs } from '../detection_rules_client_interface'; +import type { RuleAlertType } from '../../../../rule_schema'; +import { getIdError } from '../../../utils/utils'; +import { convertPatchAPIToInternalSchema } from '../../../normalization/rule_converters'; + +import { validateMlAuth, ClientError, toggleRuleEnabledOnUpdate } from '../utils'; + +import { readRules } from '../read_rules'; + +export const patchRule = async ( + rulesClient: RulesClient, + args: PatchRuleArgs, + mlAuthz: MlAuthz +): Promise => { + const { nextParams } = args; + const { rule_id: ruleId, id } = nextParams; + + const existingRule = await readRules({ + rulesClient, + ruleId, + id, + }); + + if (existingRule == null) { + const error = getIdError({ id, ruleId }); + throw new ClientError(error.message, error.statusCode); + } + + await validateMlAuth(mlAuthz, nextParams.type ?? existingRule.params.type); + + const patchedRule = convertPatchAPIToInternalSchema(nextParams, existingRule); + + const update = await rulesClient.update({ + id: existingRule.id, + data: patchedRule, + }); + + await toggleRuleEnabledOnUpdate(rulesClient, existingRule, nextParams.enabled); + + if (nextParams.enabled != null) { + return { ...update, enabled: nextParams.enabled }; + } else { + return update; + } +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/update_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/update_rule.ts new file mode 100644 index 0000000000000..a37b5eaddcee0 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/update_rule.ts @@ -0,0 +1,53 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { RulesClient } from '@kbn/alerting-plugin/server'; +import type { MlAuthz } from '../../../../../machine_learning/authz'; +import type { RuleAlertType } from '../../../../rule_schema'; +import type { UpdateRuleArgs } from '../detection_rules_client_interface'; +import { getIdError } from '../../../utils/utils'; +import { convertUpdateAPIToInternalSchema } from '../../../normalization/rule_converters'; + +import { validateMlAuth, ClientError, toggleRuleEnabledOnUpdate } from '../utils'; + +import { readRules } from '../read_rules'; + +export const updateRule = async ( + rulesClient: RulesClient, + args: UpdateRuleArgs, + mlAuthz: MlAuthz +): Promise => { + const { ruleUpdate } = args; + const { rule_id: ruleId, id } = ruleUpdate; + + await validateMlAuth(mlAuthz, ruleUpdate.type); + + const existingRule = await readRules({ + rulesClient, + ruleId, + id, + }); + + if (existingRule == null) { + const error = getIdError({ id, ruleId }); + throw new ClientError(error.message, error.statusCode); + } + + const newInternalRule = convertUpdateAPIToInternalSchema({ + existingRule, + ruleUpdate, + }); + + const update = await rulesClient.update({ + id: existingRule.id, + data: newInternalRule, + }); + + await toggleRuleEnabledOnUpdate(rulesClient, existingRule, ruleUpdate.enabled); + + return { ...update, enabled: ruleUpdate.enabled ?? existingRule.enabled }; +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/upgrade_prebuilt_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/upgrade_prebuilt_rule.ts new file mode 100644 index 0000000000000..528f81ac9c57b --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/methods/upgrade_prebuilt_rule.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { RulesClient } from '@kbn/alerting-plugin/server'; +import type { MlAuthz } from '../../../../../machine_learning/authz'; +import type { RuleAlertType, RuleParams } from '../../../../rule_schema'; +import type { UpgradePrebuiltRuleArgs } from '../detection_rules_client_interface'; +import { + convertPatchAPIToInternalSchema, + convertCreateAPIToInternalSchema, +} from '../../../normalization/rule_converters'; +import { transformAlertToRuleAction } from '../../../../../../../common/detection_engine/transform_actions'; + +import { validateMlAuth, ClientError } from '../utils'; + +import { readRules } from '../read_rules'; + +export const upgradePrebuiltRule = async ( + rulesClient: RulesClient, + upgradePrebuiltRulePayload: UpgradePrebuiltRuleArgs, + mlAuthz: MlAuthz +): Promise => { + const { ruleAsset } = upgradePrebuiltRulePayload; + + await validateMlAuth(mlAuthz, ruleAsset.type); + + const existingRule = await readRules({ + rulesClient, + ruleId: ruleAsset.rule_id, + id: undefined, + }); + + if (!existingRule) { + throw new ClientError(`Failed to find rule ${ruleAsset.rule_id}`, 500); + } + + if (ruleAsset.type !== existingRule.params.type) { + // If we're trying to change the type of a prepackaged rule, we need to delete the old one + // and replace it with the new rule, keeping the enabled setting, actions, throttle, id, + // and exception lists from the old rule + await rulesClient.delete({ id: existingRule.id }); + + const internalRule = convertCreateAPIToInternalSchema( + { + ...ruleAsset, + enabled: existingRule.enabled, + exceptions_list: existingRule.params.exceptionsList, + actions: existingRule.actions.map(transformAlertToRuleAction), + timeline_id: existingRule.params.timelineId, + timeline_title: existingRule.params.timelineTitle, + }, + { immutable: true, defaultEnabled: existingRule.enabled } + ); + + return rulesClient.create({ + data: internalRule, + options: { id: existingRule.id }, + }); + } + + // Else, simply patch it. + const patchedRule = convertPatchAPIToInternalSchema(ruleAsset, existingRule); + + await rulesClient.update({ + id: existingRule.id, + data: patchedRule, + }); + + const updatedRule = await readRules({ + rulesClient, + ruleId: ruleAsset.rule_id, + id: undefined, + }); + + if (!updatedRule) { + throw new ClientError(`Rule ${ruleAsset.rule_id} not found after upgrade`, 500); + } + + return updatedRule; +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/read_rules.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/read_rules.test.ts similarity index 100% rename from x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/read_rules.test.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/read_rules.test.ts diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/read_rules.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/read_rules.ts similarity index 100% rename from x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/read_rules.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/read_rules.ts diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/utils.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/utils.ts similarity index 100% rename from x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/utils.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/detection_rules_client/utils.ts diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/import_rules_utils.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/import_rules_utils.ts index 8c8f32181c230..5c64a2a6f9a33 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/import_rules_utils.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/import_rules_utils.ts @@ -16,7 +16,7 @@ import type { RuleToImport } from '../../../../../../common/api/detection_engine import type { ImportRuleResponse } from '../../../routes/utils'; import { createBulkErrorObject } from '../../../routes/utils'; import { checkRuleExceptionReferences } from './check_rule_exception_references'; -import type { IDetectionRulesClient } from '../rule_management/detection_rules_client'; +import type { IDetectionRulesClient } from '../detection_rules_client/detection_rules_client_interface'; export type PromiseFromStreams = RuleToImport | Error; export interface RuleExceptionsPromiseFromStreams { @@ -94,9 +94,7 @@ export const importRules = async ({ exceptions_list: [...exceptions], }, overwriteRules, - options: { - allowMissingConnectorSecrets, - }, + allowMissingConnectorSecrets, }); resolve({ diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/create_custom_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/create_custom_rule.ts deleted file mode 100644 index c8951d5ff4a65..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/create_custom_rule.ts +++ /dev/null @@ -1,36 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import type { RulesClient } from '@kbn/alerting-plugin/server'; -import type { RuleCreateProps } from '../../../../../../common/api/detection_engine'; -import type { MlAuthz } from '../../../../machine_learning/authz'; -import type { RuleAlertType, RuleParams } from '../../../rule_schema'; -import { withSecuritySpan } from '../../../../../utils/with_security_span'; -import { convertCreateAPIToInternalSchema } from '../../normalization/rule_converters'; - -import { validateMlAuth } from './utils'; - -export interface CreateCustomRuleProps { - params: RuleCreateProps; -} - -export const createCustomRule = async ( - rulesClient: RulesClient, - createCustomRulePayload: CreateCustomRuleProps, - mlAuthz: MlAuthz -): Promise => - withSecuritySpan('DetectionRulesClient.createCustomRule', async () => { - const { params } = createCustomRulePayload; - await validateMlAuth(mlAuthz, params.type); - - const internalRule = convertCreateAPIToInternalSchema(params, { immutable: false }); - const rule = await rulesClient.create({ - data: internalRule, - }); - - return rule; - }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/create_prebuilt_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/create_prebuilt_rule.ts deleted file mode 100644 index 7cf13cec63822..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/create_prebuilt_rule.ts +++ /dev/null @@ -1,41 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import type { RulesClient } from '@kbn/alerting-plugin/server'; -import type { PrebuiltRuleAsset } from '../../../prebuilt_rules'; -import type { MlAuthz } from '../../../../machine_learning/authz'; -import type { RuleAlertType, RuleParams } from '../../../rule_schema'; -import { withSecuritySpan } from '../../../../../utils/with_security_span'; -import { convertCreateAPIToInternalSchema } from '../../normalization/rule_converters'; - -import { validateMlAuth } from './utils'; - -export interface CreatePrebuiltRuleProps { - ruleAsset: PrebuiltRuleAsset; -} - -export const createPrebuiltRule = async ( - rulesClient: RulesClient, - createPrebuiltRulePayload: CreatePrebuiltRuleProps, - mlAuthz: MlAuthz -): Promise => - withSecuritySpan('DetectionRulesClient.createPrebuiltRule', async () => { - const { ruleAsset } = createPrebuiltRulePayload; - - await validateMlAuth(mlAuthz, ruleAsset.type); - - const internalRule = convertCreateAPIToInternalSchema(ruleAsset, { - immutable: true, - defaultEnabled: false, - }); - - const rule = await rulesClient.create({ - data: internalRule, - }); - - return rule; - }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/delete_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/delete_rule.ts deleted file mode 100644 index a2b4acfc6a58b..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/delete_rule.ts +++ /dev/null @@ -1,23 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import type { RulesClient } from '@kbn/alerting-plugin/server'; -import type { RuleObjectId } from '../../../../../../common/api/detection_engine'; -import { withSecuritySpan } from '../../../../../utils/with_security_span'; - -export interface DeleteRuleProps { - ruleId: RuleObjectId; -} - -export const deleteRule = async ( - rulesClient: RulesClient, - deleteRulePayload: DeleteRuleProps -): Promise => - withSecuritySpan('DetectionRulesClient.deleteRule', async () => { - const { ruleId } = deleteRulePayload; - await rulesClient.delete({ id: ruleId }); - }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/detection_rules_client.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/detection_rules_client.ts deleted file mode 100644 index c976f6d247ac5..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/detection_rules_client.ts +++ /dev/null @@ -1,80 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import type { RulesClient } from '@kbn/alerting-plugin/server'; -import type { MlAuthz } from '../../../../machine_learning/authz'; - -import type { RuleAlertType } from '../../../rule_schema'; - -import type { CreateCustomRuleProps } from './create_custom_rule'; -import type { CreatePrebuiltRuleProps } from './create_prebuilt_rule'; -import type { UpdateRuleProps } from './update_rule'; -import type { PatchRuleProps } from './patch_rule'; -import type { DeleteRuleProps } from './delete_rule'; -import type { UpgradePrebuiltRuleProps } from './upgrade_prebuilt_rule'; -import type { ImportRuleProps } from './import_rule'; - -import { createCustomRule } from './create_custom_rule'; -import { createPrebuiltRule } from './create_prebuilt_rule'; -import { updateRule } from './update_rule'; -import { patchRule } from './patch_rule'; -import { deleteRule } from './delete_rule'; -import { upgradePrebuiltRule } from './upgrade_prebuilt_rule'; -import { importRule } from './import_rule'; - -export interface IDetectionRulesClient { - createCustomRule: (createCustomRulePayload: CreateCustomRuleProps) => Promise; - createPrebuiltRule: ( - createPrebuiltRulePayload: CreatePrebuiltRuleProps - ) => Promise; - updateRule: (updateRulePayload: UpdateRuleProps) => Promise; - patchRule: (patchRulePayload: PatchRuleProps) => Promise; - deleteRule: (deleteRulePayload: DeleteRuleProps) => Promise; - upgradePrebuiltRule: ( - upgradePrebuiltRulePayload: UpgradePrebuiltRuleProps - ) => Promise; - importRule: (importRulePayload: ImportRuleProps) => Promise; -} - -export const createDetectionRulesClient = ( - rulesClient: RulesClient, - mlAuthz: MlAuthz -): IDetectionRulesClient => ({ - createCustomRule: async ( - createCustomRulePayload: CreateCustomRuleProps - ): Promise => { - return createCustomRule(rulesClient, createCustomRulePayload, mlAuthz); - }, - - createPrebuiltRule: async ( - createPrebuiltRulePayload: CreatePrebuiltRuleProps - ): Promise => { - return createPrebuiltRule(rulesClient, createPrebuiltRulePayload, mlAuthz); - }, - - updateRule: async (updateRulePayload: UpdateRuleProps): Promise => { - return updateRule(rulesClient, updateRulePayload, mlAuthz); - }, - - patchRule: async (patchRulePayload: PatchRuleProps): Promise => { - return patchRule(rulesClient, patchRulePayload, mlAuthz); - }, - - deleteRule: async (deleteRulePayload: DeleteRuleProps): Promise => { - return deleteRule(rulesClient, deleteRulePayload); - }, - - upgradePrebuiltRule: async ( - upgradePrebuiltRulePayload: UpgradePrebuiltRuleProps - ): Promise => { - return upgradePrebuiltRule(rulesClient, upgradePrebuiltRulePayload, mlAuthz); - }, - - importRule: async (importRulePayload: ImportRuleProps): Promise => { - return importRule(rulesClient, importRulePayload, mlAuthz); - }, -}); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/import_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/import_rule.ts deleted file mode 100644 index 643d59a0c495f..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/import_rule.ts +++ /dev/null @@ -1,75 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import type { RulesClient } from '@kbn/alerting-plugin/server'; -import type { MlAuthz } from '../../../../machine_learning/authz'; -import type { RuleAlertType, RuleParams } from '../../../rule_schema'; -import { withSecuritySpan } from '../../../../../utils/with_security_span'; -import type { RuleToImport } from '../../../../../../common/api/detection_engine'; -import { createBulkErrorObject } from '../../../routes/utils'; -import { - convertCreateAPIToInternalSchema, - convertUpdateAPIToInternalSchema, -} from '../../normalization/rule_converters'; - -import { validateMlAuth } from './utils'; - -import { readRules } from './read_rules'; - -interface ImportRuleOptions { - allowMissingConnectorSecrets?: boolean; -} - -export interface ImportRuleProps { - ruleToImport: RuleToImport; - overwriteRules?: boolean; - options: ImportRuleOptions; -} - -export const importRule = async ( - rulesClient: RulesClient, - importRulePayload: ImportRuleProps, - mlAuthz: MlAuthz -): Promise => - withSecuritySpan('DetectionRulesClient.importRule', async () => { - const { ruleToImport, overwriteRules, options } = importRulePayload; - - await validateMlAuth(mlAuthz, ruleToImport.type); - - const existingRule = await readRules({ - rulesClient, - ruleId: ruleToImport.rule_id, - id: undefined, - }); - - if (!existingRule) { - const internalRule = convertCreateAPIToInternalSchema(ruleToImport, { - immutable: false, - }); - - return rulesClient.create({ - data: internalRule, - allowMissingConnectorSecrets: options.allowMissingConnectorSecrets, - }); - } else if (existingRule && overwriteRules) { - const newInternalRule = convertUpdateAPIToInternalSchema({ - existingRule, - ruleUpdate: ruleToImport, - }); - - return rulesClient.update({ - id: existingRule.id, - data: newInternalRule, - }); - } else { - throw createBulkErrorObject({ - ruleId: existingRule.params.ruleId, - statusCode: 409, - message: `rule_id: "${existingRule.params.ruleId}" already exists`, - }); - } - }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/patch_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/patch_rule.ts deleted file mode 100644 index dad3d74a6f208..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/patch_rule.ts +++ /dev/null @@ -1,60 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import type { RulesClient } from '@kbn/alerting-plugin/server'; -import type { PatchRuleRequestBody } from '../../../../../../common/api/detection_engine'; -import type { MlAuthz } from '../../../../machine_learning/authz'; -import type { RuleAlertType } from '../../../rule_schema'; -import { withSecuritySpan } from '../../../../../utils/with_security_span'; -import { getIdError } from '../../utils/utils'; -import { convertPatchAPIToInternalSchema } from '../../normalization/rule_converters'; - -import { validateMlAuth, ClientError, toggleRuleEnabledOnUpdate } from './utils'; - -import { readRules } from './read_rules'; - -export interface PatchRuleProps { - nextParams: PatchRuleRequestBody; -} - -export const patchRule = async ( - rulesClient: RulesClient, - patchRulePayload: PatchRuleProps, - mlAuthz: MlAuthz -): Promise => - withSecuritySpan('DetectionRulesClient.patchRule', async () => { - const { nextParams } = patchRulePayload; - const { rule_id: ruleId, id } = nextParams; - - const existingRule = await readRules({ - rulesClient, - ruleId, - id, - }); - - if (existingRule == null) { - const error = getIdError({ id, ruleId }); - throw new ClientError(error.message, error.statusCode); - } - - await validateMlAuth(mlAuthz, nextParams.type ?? existingRule.params.type); - - const patchedRule = convertPatchAPIToInternalSchema(nextParams, existingRule); - - const update = await rulesClient.update({ - id: existingRule.id, - data: patchedRule, - }); - - await toggleRuleEnabledOnUpdate(rulesClient, existingRule, nextParams.enabled); - - if (nextParams.enabled != null) { - return { ...update, enabled: nextParams.enabled }; - } else { - return update; - } - }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/update_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/update_rule.ts deleted file mode 100644 index 4370e4f457448..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/update_rule.ts +++ /dev/null @@ -1,59 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import type { RulesClient } from '@kbn/alerting-plugin/server'; -import type { RuleUpdateProps } from '../../../../../../common/api/detection_engine'; -import type { MlAuthz } from '../../../../machine_learning/authz'; -import type { RuleAlertType } from '../../../rule_schema'; -import { withSecuritySpan } from '../../../../../utils/with_security_span'; -import { getIdError } from '../../utils/utils'; -import { convertUpdateAPIToInternalSchema } from '../../normalization/rule_converters'; - -import { validateMlAuth, ClientError, toggleRuleEnabledOnUpdate } from './utils'; - -import { readRules } from './read_rules'; - -export interface UpdateRuleProps { - ruleUpdate: RuleUpdateProps; -} - -export const updateRule = async ( - rulesClient: RulesClient, - updateRulePayload: UpdateRuleProps, - mlAuthz: MlAuthz -): Promise => - withSecuritySpan('DetectionRulesClient.updateRule', async () => { - const { ruleUpdate } = updateRulePayload; - const { rule_id: ruleId, id } = ruleUpdate; - - await validateMlAuth(mlAuthz, ruleUpdate.type); - - const existingRule = await readRules({ - rulesClient, - ruleId, - id, - }); - - if (existingRule == null) { - const error = getIdError({ id, ruleId }); - throw new ClientError(error.message, error.statusCode); - } - - const newInternalRule = convertUpdateAPIToInternalSchema({ - existingRule, - ruleUpdate, - }); - - const update = await rulesClient.update({ - id: existingRule.id, - data: newInternalRule, - }); - - await toggleRuleEnabledOnUpdate(rulesClient, existingRule, ruleUpdate.enabled); - - return { ...update, enabled: ruleUpdate.enabled ?? existingRule.enabled }; - }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/upgrade_prebuilt_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/upgrade_prebuilt_rule.ts deleted file mode 100644 index b516fc997055c..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/rule_management/upgrade_prebuilt_rule.ts +++ /dev/null @@ -1,90 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import type { RulesClient } from '@kbn/alerting-plugin/server'; -import type { PrebuiltRuleAsset } from '../../../prebuilt_rules'; -import type { MlAuthz } from '../../../../machine_learning/authz'; -import type { RuleAlertType, RuleParams } from '../../../rule_schema'; -import { withSecuritySpan } from '../../../../../utils/with_security_span'; -import { - convertPatchAPIToInternalSchema, - convertCreateAPIToInternalSchema, -} from '../../normalization/rule_converters'; -import { transformAlertToRuleAction } from '../../../../../../common/detection_engine/transform_actions'; - -import { validateMlAuth, ClientError } from './utils'; - -import { readRules } from './read_rules'; - -export interface UpgradePrebuiltRuleProps { - ruleAsset: PrebuiltRuleAsset; -} - -export const upgradePrebuiltRule = async ( - rulesClient: RulesClient, - upgradePrebuiltRulePayload: UpgradePrebuiltRuleProps, - mlAuthz: MlAuthz -): Promise => - withSecuritySpan('DetectionRulesClient.upgradePrebuiltRule', async () => { - const { ruleAsset } = upgradePrebuiltRulePayload; - - await validateMlAuth(mlAuthz, ruleAsset.type); - - const existingRule = await readRules({ - rulesClient, - ruleId: ruleAsset.rule_id, - id: undefined, - }); - - if (!existingRule) { - throw new ClientError(`Failed to find rule ${ruleAsset.rule_id}`, 500); - } - - if (ruleAsset.type !== existingRule.params.type) { - // If we're trying to change the type of a prepackaged rule, we need to delete the old one - // and replace it with the new rule, keeping the enabled setting, actions, throttle, id, - // and exception lists from the old rule - await rulesClient.delete({ id: existingRule.id }); - - const internalRule = convertCreateAPIToInternalSchema( - { - ...ruleAsset, - enabled: existingRule.enabled, - exceptions_list: existingRule.params.exceptionsList, - actions: existingRule.actions.map(transformAlertToRuleAction), - timeline_id: existingRule.params.timelineId, - timeline_title: existingRule.params.timelineTitle, - }, - { immutable: true, defaultEnabled: existingRule.enabled } - ); - - return rulesClient.create({ - data: internalRule, - options: { id: existingRule.id }, - }); - } - - // Else, simply patch it. - const patchedRule = convertPatchAPIToInternalSchema(ruleAsset, existingRule); - - await rulesClient.update({ - id: existingRule.id, - data: patchedRule, - }); - - const updatedRule = await readRules({ - rulesClient, - ruleId: ruleAsset.rule_id, - id: undefined, - }); - - if (!updatedRule) { - throw new ClientError(`Rule ${ruleAsset.rule_id} not found after upgrade`, 500); - } - - return updatedRule; - }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/fetch_rule_by_id.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/fetch_rule_by_id.ts index 520363eb67e5c..4272af8ee9f94 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/fetch_rule_by_id.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/fetch_rule_by_id.ts @@ -11,7 +11,7 @@ import type { RuleObjectId, RuleResponse, } from '../../../../../../../common/api/detection_engine/model/rule_schema'; -import { readRules } from '../../../../rule_management/logic/rule_management/read_rules'; +import { readRules } from '../../../../rule_management/logic/detection_rules_client/read_rules'; import { transform } from '../../../../rule_management/utils/utils'; // TODO: https://github.com/elastic/kibana/issues/125642 Move to rule_management into a DetectionRulesClient diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/rule_type.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/rule_type.ts index 6a863728cd746..6cf237ca583e2 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/rule_type.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/rule_type.ts @@ -104,6 +104,14 @@ export const createRuleTypeMocks = ( alertWithPersistence: jest.fn(), logger: loggerMock, shouldWriteAlerts: () => true, + dataViews: { + createDataViewLazy: jest.fn().mockResolvedValue({ + getFields: jest.fn().mockResolvedValue({ + getFieldMapSorted: jest.fn().mockReturnValue({}), + }), + getSourceFiltering: jest.fn().mockReturnValue({ excludes: [] }), + }), + }, }; return { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/create_security_rule_type_wrapper.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/create_security_rule_type_wrapper.ts index 72caa1d61ff63..471087fa77a4a 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/create_security_rule_type_wrapper.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/create_security_rule_type_wrapper.ts @@ -26,6 +26,8 @@ import { hasTimestampFields, isMachineLearningParams, isEsqlParams, + isQueryParams, + isEqlParams, getDisabledActionsWarningText, } from './utils/utils'; import { DEFAULT_MAX_SIGNALS, DEFAULT_SEARCH_AFTER_PAGE_SIZE } from '../../../../common/constants'; @@ -341,7 +343,12 @@ export const createSecurityRuleTypeWrapper: CreateSecurityRuleTypeWrapper = }); } - if (!isMachineLearningParams(params) && !isEsqlParams(params)) { + if ( + !isMachineLearningParams(params) && + !isEsqlParams(params) && + !isQueryParams(params) && + !isEqlParams(params) + ) { inputIndexFields = await getFieldsForWildcard({ index: inputIndex, dataViews: services.dataViews, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/utils/generate_alert_id.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/utils/generate_alert_id.test.ts index b3bc78e6b9478..d16e1fa405882 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/utils/generate_alert_id.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/utils/generate_alert_id.test.ts @@ -142,15 +142,5 @@ describe('generateAlertId', () => { modifiedIdParams.completeRule.ruleParams.query = 'from packetbeat*'; expect(id).toBe(generateAlertId(modifiedIdParams)); }); - - it('creates id dependant on suppression terms', () => { - modifiedIdParams.suppressionTerms = [{ field: 'agent.name', value: ['test-1'] }]; - const id1 = generateAlertId(modifiedIdParams); - modifiedIdParams.suppressionTerms = [{ field: 'agent.name', value: ['test-2'] }]; - const id2 = generateAlertId(modifiedIdParams); - - expect(id).not.toBe(id1); - expect(id1).not.toBe(id2); - }); }); }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/utils/generate_alert_id.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/utils/generate_alert_id.ts index 0f549783f922e..b064079c743fd 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/utils/generate_alert_id.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/utils/generate_alert_id.ts @@ -11,7 +11,6 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/types'; import type { CompleteRule, EsqlRuleParams } from '../../../rule_schema'; import type { SignalSource } from '../../types'; -import type { SuppressionTerm } from '../../utils/suppression_utils'; /** * Generates id for ES|QL alert. * Id is generated as hash of event properties and rule/space config identifiers. @@ -24,7 +23,6 @@ export const generateAlertId = ({ tuple, isRuleAggregating, index, - suppressionTerms, }: { isRuleAggregating: boolean; event: estypes.SearchHit; @@ -36,18 +34,11 @@ export const generateAlertId = ({ maxSignals: number; }; index: number; - suppressionTerms?: SuppressionTerm[]; }) => { const ruleRunId = tuple.from.toISOString() + tuple.to.toISOString(); return !isRuleAggregating && event._id - ? objectHash([ - event._id, - event._version, - event._index, - `${spaceId}:${completeRule.alertId}`, - ...(suppressionTerms ? [suppressionTerms] : []), - ]) + ? objectHash([event._id, event._version, event._index, `${spaceId}:${completeRule.alertId}`]) : objectHash([ ruleRunId, completeRule.ruleParams.query, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/wrap_suppressed_esql_alerts.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/wrap_suppressed_esql_alerts.test.ts index 0c3c910efa056..c52dd25689e1b 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/wrap_suppressed_esql_alerts.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/wrap_suppressed_esql_alerts.test.ts @@ -55,10 +55,10 @@ describe('wrapSuppressedEsqlAlerts', () => { }, }); - expect(alerts[0]._id).toEqual('d94fb11e6062d7dce881ea07d952a1280398663a'); - expect(alerts[0]._source[ALERT_UUID]).toEqual('d94fb11e6062d7dce881ea07d952a1280398663a'); + expect(alerts[0]._id).toEqual('ed7fbf575371c898e0f0aea48cdf0bf1865939a9'); + expect(alerts[0]._source[ALERT_UUID]).toEqual('ed7fbf575371c898e0f0aea48cdf0bf1865939a9'); expect(alerts[0]._source[ALERT_URL]).toContain( - 'http://somekibanabaseurl.com/app/security/alerts/redirect/d94fb11e6062d7dce881ea07d952a1280398663a?index=.alerts-security.alerts-default' + 'http://somekibanabaseurl.com/app/security/alerts/redirect/ed7fbf575371c898e0f0aea48cdf0bf1865939a9?index=.alerts-security.alerts-default' ); expect(alerts[0]._source[ALERT_SUPPRESSION_DOCS_COUNT]).toEqual(0); expect(alerts[0]._source[ALERT_INSTANCE_ID]).toEqual( diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/wrap_suppressed_esql_alerts.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/wrap_suppressed_esql_alerts.ts index 057cd5c906167..7b180d1adfa62 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/wrap_suppressed_esql_alerts.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/esql/wrap_suppressed_esql_alerts.ts @@ -69,7 +69,6 @@ export const wrapSuppressedEsqlAlerts = ({ tuple, isRuleAggregating, index: i, - suppressionTerms, }); const instanceId = objectHash([suppressionTerms, completeRule.alertId, spaceId]); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/new_terms/wrap_suppressed_new_terms_alerts.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/new_terms/wrap_suppressed_new_terms_alerts.test.ts index e92bbad598941..d5cf50fbefcdd 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/new_terms/wrap_suppressed_new_terms_alerts.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/new_terms/wrap_suppressed_new_terms_alerts.test.ts @@ -48,11 +48,11 @@ describe('wrapSuppressedNewTermsAlerts', () => { primaryTimestamp: '@timestamp', }); - expect(alerts[0]._id).toEqual('3b67aa2ebdc628afc98febc65082d2d83a116d79'); - expect(alerts[0]._source[ALERT_UUID]).toEqual('3b67aa2ebdc628afc98febc65082d2d83a116d79'); + expect(alerts[0]._id).toEqual('a36d9fe6fe4b2f65058fb1a487733275f811af58'); + expect(alerts[0]._source[ALERT_UUID]).toEqual('a36d9fe6fe4b2f65058fb1a487733275f811af58'); expect(alerts[0]._source[ALERT_NEW_TERMS]).toEqual(['127.0.0.1']); expect(alerts[0]._source[ALERT_URL]).toContain( - 'http://somekibanabaseurl.com/app/security/alerts/redirect/3b67aa2ebdc628afc98febc65082d2d83a116d79?index=.alerts-security.alerts-default' + 'http://somekibanabaseurl.com/app/security/alerts/redirect/a36d9fe6fe4b2f65058fb1a487733275f811af58?index=.alerts-security.alerts-default' ); expect(alerts[0]._source[ALERT_SUPPRESSION_DOCS_COUNT]).toEqual(0); expect(alerts[0]._source[ALERT_INSTANCE_ID]).toEqual( @@ -83,10 +83,10 @@ describe('wrapSuppressedNewTermsAlerts', () => { primaryTimestamp: '@timestamp', }); - expect(alerts[0]._id).toEqual('3e0436a03b735af12d6e5358cb36d2c3b39425a8'); - expect(alerts[0]._source[ALERT_UUID]).toEqual('3e0436a03b735af12d6e5358cb36d2c3b39425a8'); + expect(alerts[0]._id).toEqual('a36d9fe6fe4b2f65058fb1a487733275f811af58'); + expect(alerts[0]._source[ALERT_UUID]).toEqual('a36d9fe6fe4b2f65058fb1a487733275f811af58'); expect(alerts[0]._source[ALERT_URL]).toContain( - 'http://somekibanabaseurl.com/app/security/alerts/redirect/3e0436a03b735af12d6e5358cb36d2c3b39425a8?index=.alerts-security.alerts-default' + 'http://somekibanabaseurl.com/app/security/alerts/redirect/a36d9fe6fe4b2f65058fb1a487733275f811af58?index=.alerts-security.alerts-default' ); expect(alerts[0]._source[ALERT_SUPPRESSION_DOCS_COUNT]).toEqual(0); expect(alerts[0]._source[ALERT_INSTANCE_ID]).toEqual( @@ -111,10 +111,10 @@ describe('wrapSuppressedNewTermsAlerts', () => { primaryTimestamp: '@timestamp', }); - expect(alerts[0]._id).toEqual('f8a029df9c99e245dc83977153a0612178f3d2e8'); - expect(alerts[0]._source[ALERT_UUID]).toEqual('f8a029df9c99e245dc83977153a0612178f3d2e8'); + expect(alerts[0]._id).toEqual('f7877a31b1cc83373dbc9ba5939ebfab1db66545'); + expect(alerts[0]._source[ALERT_UUID]).toEqual('f7877a31b1cc83373dbc9ba5939ebfab1db66545'); expect(alerts[0]._source[ALERT_URL]).toContain( - 'http://somekibanabaseurl.com/s/otherSpace/app/security/alerts/redirect/f8a029df9c99e245dc83977153a0612178f3d2e8?index=.alerts-security.alerts-otherSpace' + 'http://somekibanabaseurl.com/s/otherSpace/app/security/alerts/redirect/f7877a31b1cc83373dbc9ba5939ebfab1db66545?index=.alerts-security.alerts-otherSpace' ); }); @@ -132,11 +132,11 @@ describe('wrapSuppressedNewTermsAlerts', () => { primaryTimestamp: '@timestamp', }); - expect(alerts[0]._id).toEqual('cb8684ec72592346d32839b1838e4f4080dc052e'); - expect(alerts[0]._source[ALERT_UUID]).toEqual('cb8684ec72592346d32839b1838e4f4080dc052e'); + expect(alerts[0]._id).toEqual('75e5a507a4bc48bcd983820c7fd2d9621ff4e2ea'); + expect(alerts[0]._source[ALERT_UUID]).toEqual('75e5a507a4bc48bcd983820c7fd2d9621ff4e2ea'); expect(alerts[0]._source[ALERT_NEW_TERMS]).toEqual(['127.0.0.2']); expect(alerts[0]._source[ALERT_URL]).toContain( - 'http://somekibanabaseurl.com/s/otherSpace/app/security/alerts/redirect/cb8684ec72592346d32839b1838e4f4080dc052e?index=.alerts-security.alerts-otherSpace' + 'http://somekibanabaseurl.com/s/otherSpace/app/security/alerts/redirect/75e5a507a4bc48bcd983820c7fd2d9621ff4e2ea?index=.alerts-security.alerts-otherSpace' ); }); }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/new_terms/wrap_suppressed_new_terms_alerts.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/new_terms/wrap_suppressed_new_terms_alerts.ts index 6aeb48e30fd99..274a11fc4ffcc 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/new_terms/wrap_suppressed_new_terms_alerts.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/new_terms/wrap_suppressed_new_terms_alerts.ts @@ -67,7 +67,6 @@ export const wrapSuppressedNewTermsAlerts = ({ String(eventAndTerms.event._version), `${spaceId}:${completeRule.alertId}`, eventAndTerms.newTerms, - suppressionTerms, ]); const baseAlert: BaseFieldsLatest = buildBulkBody( diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts index b3de5a39d829f..272184dbf1e58 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts @@ -59,6 +59,7 @@ export const queryExecutor = async ({ index: runOpts.inputIndex, exceptionFilter: runOpts.exceptionFilter, fields: runOpts.inputIndexFields, + loadFields: true, }); const license = await firstValueFrom(licensing.license$); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/wrap_suppressed_threshold_alerts.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/wrap_suppressed_threshold_alerts.ts index f19c4c7ddfe57..492d27fba091f 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/wrap_suppressed_threshold_alerts.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/wrap_suppressed_threshold_alerts.ts @@ -82,12 +82,7 @@ export const wrapSuppressedThresholdALerts = ({ const suppressedValues = sortBy(Object.entries(bucket.key).map(([_, value]) => value)); - const id = objectHash([ - hit._index, - hit._id, - `${spaceId}:${completeRule.alertId}`, - suppressedValues, - ]); + const id = objectHash([hit._index, hit._id, `${spaceId}:${completeRule.alertId}`]); const instanceId = objectHash([suppressedValues, completeRule.alertId, spaceId]); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_filter.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_filter.ts index 7d7492bd17e2b..920e2c2df9c5e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_filter.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_filter.ts @@ -26,7 +26,8 @@ import type { SavedIdOrUndefined } from '../../../../../common/api/detection_eng import type { PartialFilter } from '../../types'; import { withSecuritySpan } from '../../../../utils/with_security_span'; import type { ESBoolQuery } from '../../../../../common/typed_json'; -import { getQueryFilter } from './get_query_filter'; +import { getQueryFilter as getQueryFilterNoLoadFields } from './get_query_filter'; +import { getQueryFilterLoadFields } from './get_query_filter_load_fields'; export interface GetFilterArgs { type: Type; @@ -38,6 +39,7 @@ export interface GetFilterArgs { index: IndexPatternArray | undefined; exceptionFilter: Filter | undefined; fields?: DataViewFieldBase[]; + loadFields?: boolean; } interface QueryAttributes { @@ -59,7 +61,11 @@ export const getFilter = async ({ query, exceptionFilter, fields = [], + loadFields = false, }: GetFilterArgs): Promise => { + const getQueryFilter = loadFields + ? getQueryFilterLoadFields(services.dataViews) + : getQueryFilterNoLoadFields; const queryFilter = () => { if (query != null && language != null && index != null) { return getQueryFilter({ diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_query_filter_load_fields.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_query_filter_load_fields.ts new file mode 100644 index 0000000000000..d1c8eab7ac2c2 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_query_filter_load_fields.ts @@ -0,0 +1,67 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { Language } from '@kbn/securitysolution-io-ts-alerting-types'; +import type { Filter, EsQueryConfig, DataViewFieldBase } from '@kbn/es-query'; +import { DataView } from '@kbn/data-views-plugin/server'; +import { queryToFields } from '@kbn/data-plugin/common'; +import type { DataViewsContract } from '@kbn/data-views-plugin/common'; +import type { FieldFormatsStartCommon } from '@kbn/field-formats-plugin/common'; +import { buildEsQuery } from '@kbn/es-query'; +import type { ESBoolQuery } from '../../../../../common/typed_json'; +import { getAllFilters } from './get_query_filter'; +import type { + IndexPatternArray, + RuleQuery, +} from '../../../../../common/api/detection_engine/model/rule_schema'; + +export const getQueryFilterLoadFields = + (dataViewsService: DataViewsContract) => + async ({ + query, + language, + filters, + index, + exceptionFilter, + }: { + query: RuleQuery; + language: Language; + filters: unknown; + index: IndexPatternArray; + exceptionFilter: Filter | undefined; + fields?: DataViewFieldBase[]; + }): Promise => { + const config: EsQueryConfig = { + allowLeadingWildcards: true, + queryStringOptions: { analyze_wildcard: true }, + ignoreFilterIfFieldNotInIndex: false, + dateFormatTZ: 'Zulu', + }; + + const initialQuery = { query, language }; + const allFilters = getAllFilters(filters as Filter[], exceptionFilter); + + const title = (index ?? []).join(); + + const dataViewLazy = await dataViewsService.createDataViewLazy({ title }); + + const flds = await queryToFields({ + dataView: dataViewLazy, + request: { query: [initialQuery], filters: allFilters }, + }); + + const dataViewLimitedFields = new DataView({ + spec: { title }, + fieldFormats: {} as unknown as FieldFormatsStartCommon, + shortDotsEnable: false, + metaFields: [], + }); + + dataViewLimitedFields.fields.replaceAll(Object.values(flds).map((fld) => fld.toSpec())); + + return buildEsQuery(dataViewLimitedFields, initialQuery, allFilters, config); + }; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/wrap_suppressed_alerts.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/wrap_suppressed_alerts.ts index d08a1f47dc07b..3268c78dd8ab3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/wrap_suppressed_alerts.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/wrap_suppressed_alerts.ts @@ -20,6 +20,7 @@ import type { CompleteRule } from '../../rule_schema'; import type { IRuleExecutionLogForExecutors } from '../../rule_monitoring'; import { buildBulkBody } from '../factories/utils/build_bulk_body'; import { getSuppressionAlertFields, getSuppressionTerms } from './suppression_utils'; +import { generateId } from './utils'; import type { BuildReasonMessage } from './reason_formatters'; @@ -59,12 +60,12 @@ export const wrapSuppressedAlerts = ({ fields: event.fields, }); - const id = objectHash([ + const id = generateId( event._index, event._id, - `${spaceId}:${completeRule.alertId}`, - suppressionTerms, - ]); + String(event._version), + `${spaceId}:${completeRule.alertId}` + ); const instanceId = objectHash([suppressionTerms, completeRule.alertId, spaceId]); diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_engine/risk_engine_data_client.test.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_engine/risk_engine_data_client.test.ts index b13a9cda99352..5eb9b436c59b4 100644 --- a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_engine/risk_engine_data_client.test.ts +++ b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_engine/risk_engine_data_client.test.ts @@ -57,7 +57,7 @@ jest.mock('../utils/create_or_update_index', () => ({ })); jest.spyOn(transforms, 'createTransform').mockResolvedValue(Promise.resolve()); -jest.spyOn(transforms, 'startTransform').mockResolvedValue(Promise.resolve()); +jest.spyOn(transforms, 'scheduleTransformNow').mockResolvedValue(Promise.resolve()); describe('RiskEngineDataClient', () => { for (const useDataStreamForAlerts of [false, true]) { diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/configurations.test.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/configurations.test.ts new file mode 100644 index 0000000000000..b0fab13b109bf --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/configurations.test.ts @@ -0,0 +1,52 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { getTransformOptions } from './configurations'; + +describe('getTransformOptions', () => { + it('transform content has changed, please update the transform version and regenerate the snapshot', () => { + const options = getTransformOptions({ + dest: 'dest', + source: ['source'], + }); + + expect(options).toMatchInlineSnapshot(` + Object { + "_meta": Object { + "managed": true, + "managed_by": "security-entity-analytics", + "version": 2, + }, + "dest": Object { + "index": "dest", + }, + "frequency": "1h", + "latest": Object { + "sort": "@timestamp", + "unique_key": Array [ + "host.name", + "user.name", + ], + }, + "settings": Object { + "unattended": true, + }, + "source": Object { + "index": Array [ + "source", + ], + }, + "sync": Object { + "time": Object { + "delay": "0s", + "field": "@timestamp", + }, + }, + } + `); + }); +}); diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/configurations.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/configurations.ts index 2077a152e07b4..6dbf68c699fd5 100644 --- a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/configurations.ts +++ b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/configurations.ts @@ -4,6 +4,7 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ +import type { TransformPutTransformRequest } from '@elastic/elasticsearch/lib/api/types'; import type { FieldMap } from '@kbn/alerts-as-data-utils'; import type { IdentifierType } from '../../../../common/entity_analytics/risk_engine'; import { @@ -135,11 +136,24 @@ export const getIndexPatternDataStream = (namespace: string): IIndexPatternStrin alias: `${riskScoreBaseIndexName}.${riskScoreBaseIndexName}-${namespace}`, }); -export const getTransformOptions = ({ dest, source }: { dest: string; source: string[] }) => ({ +export type TransformOptions = Omit; + +/** + * WARNING: We must increase the version when changing any configuration + * + * The risk engine starts the transforms executions after writing the documents to the risk score index. + * So the transform don't need to run on a schedule. + */ +export const getTransformOptions = ({ + dest, + source, +}: { + dest: string; + source: string[]; +}): Omit => ({ dest: { index: dest, }, - frequency: '1h', latest: { sort: '@timestamp', unique_key: [`host.name`, `user.name`], @@ -147,10 +161,20 @@ export const getTransformOptions = ({ dest, source }: { dest: string; source: st source: { index: source, }, + frequency: '1h', // 1h is the maximum value sync: { time: { - delay: '2s', + delay: '0s', // It doesn't have any delay because the risk engine writes the documents to the index and schedules the transform synchronously. field: '@timestamp', }, }, + settings: { + unattended: true, // In unattended mode, the transform retries indefinitely in case of an error + }, + _meta: { + version: 2, // When this field is updated we automatically update the transform + + managed: true, // Metadata that identifies the transform. It has no functionality + managed_by: 'security-entity-analytics', // Metadata that identifies the transform. It has no functionality + }, }); diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_data_client.test.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_data_client.test.ts index 493f419cf6cc2..2ddd04a766944 100644 --- a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_data_client.test.ts +++ b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_data_client.test.ts @@ -36,7 +36,7 @@ jest.mock('../utils/create_or_update_index', () => ({ })); jest.spyOn(transforms, 'createTransform').mockResolvedValue(Promise.resolve()); -jest.spyOn(transforms, 'startTransform').mockResolvedValue(Promise.resolve()); +jest.spyOn(transforms, 'scheduleTransformNow').mockResolvedValue(Promise.resolve()); describe('RiskScoreDataClient', () => { let riskScoreDataClient: RiskScoreDataClient; @@ -428,11 +428,19 @@ describe('RiskScoreDataClient', () => { }, sync: { time: { - delay: '2s', + delay: '0s', field: '@timestamp', }, }, transform_id: 'risk_score_latest_transform_default', + settings: { + unattended: true, + }, + _meta: { + version: 2, + managed: true, + managed_by: 'security-entity-analytics', + }, }, }); }); diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_data_client.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_data_client.ts index c0920188acd31..a95b29e5cc6ee 100644 --- a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_data_client.ts +++ b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_data_client.ts @@ -28,7 +28,10 @@ import { import { createDataStream } from '../utils/create_datastream'; import type { RiskEngineDataWriter as Writer } from './risk_engine_data_writer'; import { RiskEngineDataWriter } from './risk_engine_data_writer'; -import { getRiskScoreLatestIndex } from '../../../../common/entity_analytics/risk_engine'; +import { + getRiskScoreLatestIndex, + getRiskScoreTimeSeriesIndex, +} from '../../../../common/entity_analytics/risk_engine'; import { createTransform, getLatestTransformId } from '../utils/transforms'; import { getRiskInputsIndex } from './get_risk_inputs_index'; @@ -71,6 +74,12 @@ export class RiskScoreDataClient { return writer; } + public refreshRiskScoreIndex = async () => { + await this.options.esClient.indices.refresh({ + index: getRiskScoreTimeSeriesIndex(this.options.namespace), + }); + }; + public getRiskInputsIndex = ({ dataViewId }: { dataViewId: string }) => getRiskInputsIndex({ dataViewId, diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_service.mock.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_service.mock.ts index 2423a87559b17..d1b74637725db 100644 --- a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_service.mock.ts +++ b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_service.mock.ts @@ -35,6 +35,7 @@ const createRiskScoreServiceMock = (): jest.Mocked => ({ getConfigurationWithDefaults: jest.fn(), getRiskInputsIndex: jest.fn(), scheduleLatestTransformNow: jest.fn(), + refreshRiskScoreIndex: jest.fn(), }); export const riskScoreServiceMock = { diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_service.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_service.ts index cb89d61d8720d..4d39eb9a068a5 100644 --- a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_service.ts +++ b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/risk_score_service.ts @@ -35,6 +35,7 @@ export interface RiskScoreService { ) => Promise; getRiskInputsIndex: ({ dataViewId }: { dataViewId: string }) => Promise; scheduleLatestTransformNow: () => Promise; + refreshRiskScoreIndex: () => Promise; } export interface RiskScoreServiceFactoryParams { @@ -83,5 +84,7 @@ export const riskScoreServiceFactory = ({ }; }, getRiskInputsIndex: async (params) => riskScoreDataClient.getRiskInputsIndex(params), - scheduleLatestTransformNow: () => scheduleLatestTransformNow({ namespace: spaceId, esClient }), + scheduleLatestTransformNow: () => + scheduleLatestTransformNow({ namespace: spaceId, esClient, logger }), + refreshRiskScoreIndex: () => riskScoreDataClient.refreshRiskScoreIndex(), }); diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/routes/entity_calculation.test.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/routes/entity_calculation.test.ts index dbb8459d0ae42..54b42d02c5495 100644 --- a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/routes/entity_calculation.test.ts +++ b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/routes/entity_calculation.test.ts @@ -85,6 +85,16 @@ describe('entity risk score calculation route', () => { expect(response.status).toEqual(200); }); + it('should schedule transform when risk scores are persisted ', async () => { + const request = buildRequest(); + + const response = await server.inject(request, requestContextMock.convertContext(context)); + + expect(mockRiskScoreService.scheduleLatestTransformNow).toHaveBeenCalled(); + + expect(response.status).toEqual(200); + }); + it('should call "calculateAndPersistScores" with entity filter', async () => { const request = buildRequest(); diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/routes/entity_calculation.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/routes/entity_calculation.ts index 502e296db3644..fe6e404e9e96d 100644 --- a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/routes/entity_calculation.ts +++ b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/routes/entity_calculation.ts @@ -146,6 +146,10 @@ export const riskScoreEntityCalculationRoute = ( }); } + if (result.scores_written > 0) { + await riskScoreService.scheduleLatestTransformNow(); + } + const score = result.scores_written === 1 ? result.scores?.[identifierType]?.[0] : undefined; diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.test.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.test.ts index 7e1519e3745c4..2b7f77b407d31 100644 --- a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.test.ts +++ b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.test.ts @@ -474,19 +474,6 @@ describe('Risk Scoring Task', () => { expect.stringContaining('task was cancelled') ); }); - - it('schedules the transform to run now', async () => { - await runTask({ - getRiskScoreService, - isCancelled: mockIsCancelled, - logger: mockLogger, - taskInstance: riskScoringTaskInstanceMock, - telemetry: mockTelemetry, - entityAnalyticsConfig, - }); - - expect(mockRiskScoreService.scheduleLatestTransformNow).toHaveBeenCalledTimes(1); - }); }); describe('when execution was successful', () => { @@ -520,6 +507,19 @@ describe('Risk Scoring Task', () => { expect(mockRiskScoreService.scheduleLatestTransformNow).toHaveBeenCalledTimes(1); }); + + it('refreshes the risk score index', async () => { + await runTask({ + getRiskScoreService, + isCancelled: mockIsCancelled, + logger: mockLogger, + taskInstance: riskScoringTaskInstanceMock, + telemetry: mockTelemetry, + entityAnalyticsConfig, + }); + + expect(mockRiskScoreService.refreshRiskScoreIndex).toHaveBeenCalledTimes(1); + }); }); describe('when execution was unsuccessful', () => { diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.ts index 1b2b44dae6a95..da4a48dfd02d2 100644 --- a/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.ts +++ b/x-pack/plugins/security_solution/server/lib/entity_analytics/risk_score/tasks/risk_scoring_task.ts @@ -310,15 +310,20 @@ export const runTask = async ({ }; telemetry.reportEvent(RISK_SCORE_EXECUTION_SUCCESS_EVENT.eventType, telemetryEvent); - await riskScoreService.scheduleLatestTransformNow(); - if (isCancelled()) { log('task was cancelled'); telemetry.reportEvent(RISK_SCORE_EXECUTION_CANCELLATION_EVENT.eventType, telemetryEvent); } + if (scoresWritten > 0) { + log('refreshing risk score index and scheduling transform'); + await riskScoreService.refreshRiskScoreIndex(); + await riskScoreService.scheduleLatestTransformNow(); + } + log('task run completed'); log(JSON.stringify({ ...telemetryEvent, runs })); + return { state: updatedState, }; diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/utils/transforms.test.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/utils/transforms.test.ts index 25aeaa4ad566d..ff1aa5e041c60 100644 --- a/x-pack/plugins/security_solution/server/lib/entity_analytics/utils/transforms.test.ts +++ b/x-pack/plugins/security_solution/server/lib/entity_analytics/utils/transforms.test.ts @@ -5,9 +5,17 @@ * 2.0. */ -import type { TransformGetTransformStatsResponse } from '@elastic/elasticsearch/lib/api/types'; -import { elasticsearchServiceMock } from '@kbn/core/server/mocks'; -import { scheduleTransformNow } from './transforms'; +import type { + TransformGetTransformResponse, + TransformGetTransformStatsResponse, +} from '@elastic/elasticsearch/lib/api/types'; +import { elasticsearchServiceMock, loggingSystemMock } from '@kbn/core/server/mocks'; +import { + getRiskScoreLatestIndex, + getRiskScoreTimeSeriesIndex, +} from '../../../../common/entity_analytics/risk_engine'; +import { getTransformOptions } from '../risk_score/configurations'; +import { scheduleLatestTransformNow, scheduleTransformNow } from './transforms'; const transformId = 'test_transform_id'; @@ -31,6 +39,44 @@ const stoppedTransformsMock = { ], } as TransformGetTransformStatsResponse; +const latestIndex = getRiskScoreLatestIndex('tests'); +const timeSeriesIndex = getRiskScoreTimeSeriesIndex('tests'); +const transformConfig = getTransformOptions({ + dest: latestIndex, + source: [timeSeriesIndex], +}); + +const updatedTransformsMock = { + count: 1, + transforms: [ + { + id: 'test_transform_id_3', + ...transformConfig, + }, + ], +} as TransformGetTransformResponse; + +const outdatedTransformsMock = { + count: 1, + transforms: [ + { + ...transformConfig, + id: 'test_transform_id_3', + sync: { + time: { + field: '@timestamp', + delay: '2s', + }, + }, + _meta: { + version: '1', + }, + }, + ], +} as TransformGetTransformResponse; + +const logger = loggingSystemMock.createLogger(); + describe('transforms utils', () => { beforeEach(() => { jest.resetAllMocks(); @@ -55,4 +101,39 @@ describe('transforms utils', () => { expect(esClient.transform.scheduleNowTransform).toHaveBeenCalled(); }); }); + + describe('scheduleLatestTransformNow', () => { + it('update the latest transform when scheduleTransformNow is called and the transform is outdated', async () => { + const esClient = elasticsearchServiceMock.createScopedClusterClient().asCurrentUser; + esClient.transform.getTransformStats.mockResolvedValueOnce(stoppedTransformsMock); + esClient.transform.getTransform.mockResolvedValueOnce(outdatedTransformsMock); + + await scheduleLatestTransformNow({ esClient, namespace: 'tests', logger }); + + expect(esClient.transform.updateTransform).toHaveBeenCalled(); + }); + + it('does not update the latest transform when scheduleTransformNow is called if the transform is updated', async () => { + const esClient = elasticsearchServiceMock.createScopedClusterClient().asCurrentUser; + esClient.transform.getTransformStats.mockResolvedValueOnce(stoppedTransformsMock); + esClient.transform.getTransform.mockResolvedValueOnce(updatedTransformsMock); + + await scheduleLatestTransformNow({ esClient, namespace: 'tests', logger }); + + expect(esClient.transform.updateTransform).not.toHaveBeenCalled(); + }); + + it('it logs the error if update transform fails', async () => { + const esClient = elasticsearchServiceMock.createScopedClusterClient().asCurrentUser; + esClient.transform.getTransformStats.mockResolvedValueOnce(stoppedTransformsMock); + esClient.transform.getTransform.mockResolvedValueOnce(outdatedTransformsMock); + esClient.transform.updateTransform.mockRejectedValueOnce(new Error('Test error')); + + await scheduleLatestTransformNow({ esClient, namespace: 'tests', logger }); + + expect(logger.error).toHaveBeenCalledWith( + 'There was an error upgrading the transform risk_score_latest_transform_tests. Continuing with transform scheduling. Test error' + ); + }); + }); }); diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/utils/transforms.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/utils/transforms.ts index d1a544233339e..35a7f7113bfa5 100644 --- a/x-pack/plugins/security_solution/server/lib/entity_analytics/utils/transforms.ts +++ b/x-pack/plugins/security_solution/server/lib/entity_analytics/utils/transforms.ts @@ -14,11 +14,17 @@ import type { TransformPutTransformRequest, TransformGetTransformStatsTransformStats, } from '@elastic/elasticsearch/lib/api/types'; +import { + getRiskScoreLatestIndex, + getRiskScoreTimeSeriesIndex, +} from '../../../../common/entity_analytics/risk_engine'; import { RiskScoreEntity } from '../../../../common/search_strategy'; import { getRiskScorePivotTransformId, getRiskScoreLatestTransformId, } from '../../../../common/utils/risk_score_modules'; +import type { TransformOptions } from '../risk_score/configurations'; +import { getTransformOptions } from '../risk_score/configurations'; export const getLegacyTransforms = async ({ namespace, @@ -107,51 +113,66 @@ const hasTransformStarted = (transformStats: TransformGetTransformStatsTransform return transformStats.state === 'indexing' || transformStats.state === 'started'; }; -export const startTransform = async ({ +export const scheduleTransformNow = async ({ esClient, transformId, }: { esClient: ElasticsearchClient; transformId: string; -}): Promise => { +}): Promise => { const transformStats = await esClient.transform.getTransformStats({ transform_id: transformId, }); if (transformStats.count <= 0) { throw new Error( - `Unable to find transform status for [${transformId}] while attempting to start` + `Unable to find transform status for [${transformId}] while attempting to schedule` ); } - if (hasTransformStarted(transformStats.transforms[0])) { - return; - } - return esClient.transform.startTransform({ transform_id: transformId }); + if (!hasTransformStarted(transformStats.transforms[0])) { + await esClient.transform.startTransform({ + transform_id: transformId, + }); + } else { + await esClient.transform.scheduleNowTransform({ + transform_id: transformId, + }); + } }; -export const scheduleTransformNow = async ({ +/** + * Whenever we change the latest transform configuration, we must ensure we update the transform in environments where it has already been installed. + */ +const upgradeLatestTransformIfNeeded = async ({ esClient, - transformId, + namespace, + logger, }: { esClient: ElasticsearchClient; - transformId: string; + namespace: string; + logger: Logger; }): Promise => { - const transformStats = await esClient.transform.getTransformStats({ + const transformId = getLatestTransformId(namespace); + const latestIndex = getRiskScoreLatestIndex(namespace); + const timeSeriesIndex = getRiskScoreTimeSeriesIndex(namespace); + + const response = await esClient.transform.getTransform({ transform_id: transformId, }); - if (transformStats.count <= 0) { - throw new Error( - `Unable to find transform status for [${transformId}] while attempting to schedule now` - ); - } - if (hasTransformStarted(transformStats.transforms[0])) { - await esClient.transform.scheduleNowTransform({ - transform_id: transformId, - }); - } else { - await esClient.transform.startTransform({ + const newConfig = getTransformOptions({ + dest: latestIndex, + source: [timeSeriesIndex], + }); + + if (isTransformOutdated(response.transforms[0], newConfig)) { + logger.info(`Upgrading transform ${transformId}`); + + const { latest: _unused, ...changes } = newConfig; + + await esClient.transform.updateTransform({ transform_id: transformId, + ...changes, }); } }; @@ -159,10 +180,30 @@ export const scheduleTransformNow = async ({ export const scheduleLatestTransformNow = async ({ namespace, esClient, + logger, }: { namespace: string; esClient: ElasticsearchClient; + logger: Logger; }): Promise => { const transformId = getLatestTransformId(namespace); + + try { + await upgradeLatestTransformIfNeeded({ esClient, namespace, logger }); + } catch (err) { + logger.error( + `There was an error upgrading the transform ${transformId}. Continuing with transform scheduling. ${err.message}` + ); + } + await scheduleTransformNow({ esClient, transformId }); }; + +/** + * Whitelist the transform fields that we can update. + */ + +const isTransformOutdated = ( + transform: TransformGetTransformTransformSummary, + newConfig: TransformOptions +): boolean => transform._meta?.version !== newConfig._meta?.version; diff --git a/x-pack/plugins/security_solution/server/request_context_factory.ts b/x-pack/plugins/security_solution/server/request_context_factory.ts index a47535772dd83..1f36f7ecff234 100644 --- a/x-pack/plugins/security_solution/server/request_context_factory.ts +++ b/x-pack/plugins/security_solution/server/request_context_factory.ts @@ -28,7 +28,7 @@ import type { EndpointAppContextService } from './endpoint/endpoint_app_context_ import { RiskEngineDataClient } from './lib/entity_analytics/risk_engine/risk_engine_data_client'; import { RiskScoreDataClient } from './lib/entity_analytics/risk_score/risk_score_data_client'; import { AssetCriticalityDataClient } from './lib/entity_analytics/asset_criticality'; -import { createDetectionRulesClient } from './lib/detection_engine/rule_management/logic/rule_management/detection_rules_client'; +import { createDetectionRulesClient } from './lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client'; import { buildMlAuthz } from './lib/machine_learning/authz'; export interface IRequestContextFactory { @@ -114,7 +114,7 @@ export class RequestContextFactory implements IRequestContextFactory { getAuditLogger, - getDetectionRulesClient: () => { + getDetectionRulesClient: memoize(() => { const mlAuthz = buildMlAuthz({ license: licensing.license, ml: plugins.ml, @@ -126,7 +126,7 @@ export class RequestContextFactory implements IRequestContextFactory { startPlugins.alerting.getRulesClientWithRequest(request), mlAuthz ); - }, + }), getDetectionEngineHealthClient: memoize(() => ruleMonitoringService.createDetectionEngineHealthClient({ diff --git a/x-pack/plugins/security_solution/server/types.ts b/x-pack/plugins/security_solution/server/types.ts index 563d61bfae307..121eb7b1758f4 100644 --- a/x-pack/plugins/security_solution/server/types.ts +++ b/x-pack/plugins/security_solution/server/types.ts @@ -33,7 +33,7 @@ import type { EndpointInternalFleetServicesInterface } from './endpoint/services import type { RiskEngineDataClient } from './lib/entity_analytics/risk_engine/risk_engine_data_client'; import type { RiskScoreDataClient } from './lib/entity_analytics/risk_score/risk_score_data_client'; import type { AssetCriticalityDataClient } from './lib/entity_analytics/asset_criticality'; -import type { IDetectionRulesClient } from './lib/detection_engine/rule_management/logic/rule_management/detection_rules_client'; +import type { IDetectionRulesClient } from './lib/detection_engine/rule_management/logic/detection_rules_client/detection_rules_client_interface'; export { AppClient }; export interface SecuritySolutionApiRequestHandlerContext { diff --git a/x-pack/plugins/stack_alerts/public/rule_types/threshold/visualization.tsx b/x-pack/plugins/stack_alerts/public/rule_types/threshold/visualization.tsx index f31dc2fab4383..a6af4a2ae48a4 100644 --- a/x-pack/plugins/stack_alerts/public/rule_types/threshold/visualization.tsx +++ b/x-pack/plugins/stack_alerts/public/rule_types/threshold/visualization.tsx @@ -223,7 +223,6 @@ export const ThresholdVisualization: React.FunctionComponent = ({ } color="danger" diff --git a/x-pack/plugins/translations/translations/fr-FR.json b/x-pack/plugins/translations/translations/fr-FR.json index 80423bd7d1308..8d05512424464 100644 --- a/x-pack/plugins/translations/translations/fr-FR.json +++ b/x-pack/plugins/translations/translations/fr-FR.json @@ -324,7 +324,6 @@ "console.requestOptions.openDocumentationButtonLabel": "Ouvrir la documentation", "console.requestOptionsButtonAriaLabel": "Options de requête", "console.requestTimeElapasedBadgeTooltipContent": "Temps écoulé", - "console.sendRequestButtonTooltip": "Cliquer pour envoyer la requête", "console.settingsPage.accessibilityOverlayLabel": "Superposition d’accessibilité", "console.settingsPage.autocompleteLabel": "Saisie semi-automatique", "console.settingsPage.cancelButtonLabel": "Annuler", @@ -12807,8 +12806,6 @@ "xpack.csp.findings.findingsFlyout.overviewTab.indexTitle": "Index", "xpack.csp.findings.findingsFlyout.overviewTab.rationaleTitle": "Environnement", "xpack.csp.findings.findingsFlyout.overviewTab.remediationTitle": "Résolution", - "xpack.csp.findings.findingsFlyout.overviewTab.resourceIdTitle": "ID ressource", - "xpack.csp.findings.findingsFlyout.overviewTab.resourceNameTitle": "Nom de ressource", "xpack.csp.findings.findingsFlyout.overviewTab.ruleNameTitle": "Nom de règle", "xpack.csp.findings.findingsFlyout.overviewTab.ruleNameTooltip": "Gérer la règle", "xpack.csp.findings.findingsFlyout.overviewTab.ruleTagsTitle": "Balises de règle", @@ -22171,8 +22168,6 @@ "xpack.ingestPipelines.form.metaAriaLabel": "Éditeur de données du champ _meta", "xpack.ingestPipelines.form.metaDescription": "Informations supplémentaires sur le pipeline d'ingestion. Ces informations sont stockées dans l'état de cluster. Elles doivent donc être aussi brèves que possible.", "xpack.ingestPipelines.form.metaFieldLabel": "Données du champ _meta (facultatif)", - "xpack.ingestPipelines.form.metaSwitchCaption": "Ajouter des métadonnées", - "xpack.ingestPipelines.form.metaTitle": "Métadonnées", "xpack.ingestPipelines.form.nameDescription": "Identificateur unique pour ce pipeline.", "xpack.ingestPipelines.form.nameFieldLabel": "Nom", "xpack.ingestPipelines.form.nameTitle": "Nom", @@ -22184,7 +22179,6 @@ "xpack.ingestPipelines.form.unknownError": "Une erreur inconnue s'est produite.", "xpack.ingestPipelines.form.validation.metaJsonError": "L'entrée n'est pas valide.", "xpack.ingestPipelines.form.versionFieldLabel": "Version (facultatif)", - "xpack.ingestPipelines.form.versionToggleDescription": "Ajouter un numéro de version", "xpack.ingestPipelines.list.listTitle": "Pipelines d'ingestion", "xpack.ingestPipelines.list.loadErrorTitle": "Impossible de charger les pipelines", "xpack.ingestPipelines.list.loadingMessage": "Chargement des pipelines...", @@ -44138,7 +44132,6 @@ "advancedSettings.advancedSettingsLabel": "Paramètres avancés", "advancedSettings.featureCatalogueTitle": "Personnalisez votre expérience Kibana : modifiez le format de date, activez le mode sombre, et bien plus encore.", "aiAssistantManagementSelection.aiAssistantSelectionPage.observabilityLabel": "Assistant d'IA Elastic pour Observability", - "aiAssistantManagementSelection.aiAssistantSelectionPage.thisFeatureIsDisabledCallOutLabel": "Cette fonctionnalité est désactivée. Elle peut être activée dans Espaces > Fonctionnalités.", "aiAssistantManagementSelection.aiAssistantSettingsPage.descriptionTextLabel": "L'Assistant d'IA utilise l'IA générative pour aider votre équipe en expliquant les erreurs, en suggérant une résolution et en vous aidant à demander, analyser et visualiser vos données.", "aiAssistantManagementSelection.aiAssistantSettingsPage.h2.aIAssistantLabel": "Assistant d'intelligence artificielle", "aiAssistantManagementSelection.aiAssistantSettingsPage.obsAssistant.documentationLinkLabel": "Documentation", @@ -44856,4 +44849,4 @@ "xpack.serverlessObservability.nav.projectSettings": "Paramètres de projet", "xpack.serverlessObservability.nav.synthetics": "Synthetics" } -} \ No newline at end of file +} diff --git a/x-pack/plugins/translations/translations/ja-JP.json b/x-pack/plugins/translations/translations/ja-JP.json index 47ffa3c8770aa..db6337bae1952 100644 --- a/x-pack/plugins/translations/translations/ja-JP.json +++ b/x-pack/plugins/translations/translations/ja-JP.json @@ -324,7 +324,6 @@ "console.requestOptions.openDocumentationButtonLabel": "ドキュメントを開く", "console.requestOptionsButtonAriaLabel": "リクエストオプション", "console.requestTimeElapasedBadgeTooltipContent": "経過時間", - "console.sendRequestButtonTooltip": "クリックしてリクエストを送信", "console.settingsPage.accessibilityOverlayLabel": "アクセシビリティオーバーレイ", "console.settingsPage.autocompleteLabel": "自動入力", "console.settingsPage.cancelButtonLabel": "キャンセル", @@ -12788,8 +12787,6 @@ "xpack.csp.findings.findingsFlyout.overviewTab.indexTitle": "インデックス", "xpack.csp.findings.findingsFlyout.overviewTab.rationaleTitle": "根拠", "xpack.csp.findings.findingsFlyout.overviewTab.remediationTitle": "修正", - "xpack.csp.findings.findingsFlyout.overviewTab.resourceIdTitle": "リソースID", - "xpack.csp.findings.findingsFlyout.overviewTab.resourceNameTitle": "リソース名", "xpack.csp.findings.findingsFlyout.overviewTab.ruleNameTitle": "ルール名", "xpack.csp.findings.findingsFlyout.overviewTab.ruleNameTooltip": "ルールの管理", "xpack.csp.findings.findingsFlyout.overviewTab.ruleTagsTitle": "ルールタグ", @@ -22147,8 +22144,6 @@ "xpack.ingestPipelines.form.metaAriaLabel": "_meta fieldデータエディター", "xpack.ingestPipelines.form.metaDescription": "インジェストパイプラインに関する詳細情報。この情報はクラスター状態に格納されるため、簡潔にすることをお勧めします。", "xpack.ingestPipelines.form.metaFieldLabel": "_metaフィールドデータ（任意）", - "xpack.ingestPipelines.form.metaSwitchCaption": "メタデータを追加", - "xpack.ingestPipelines.form.metaTitle": "メタデータ", "xpack.ingestPipelines.form.nameDescription": "このパイプラインの固有の識別子です。", "xpack.ingestPipelines.form.nameFieldLabel": "名前", "xpack.ingestPipelines.form.nameTitle": "名前", @@ -22160,7 +22155,6 @@ "xpack.ingestPipelines.form.unknownError": "不明なエラーが発生しました。", "xpack.ingestPipelines.form.validation.metaJsonError": "入力が無効です。", "xpack.ingestPipelines.form.versionFieldLabel": "バージョン（任意）", - "xpack.ingestPipelines.form.versionToggleDescription": "バージョン番号を追加", "xpack.ingestPipelines.list.listTitle": "インジェストパイプライン", "xpack.ingestPipelines.list.loadErrorTitle": "パイプラインを読み込めません", "xpack.ingestPipelines.list.loadingMessage": "パイプラインを読み込み中...", @@ -44110,7 +44104,6 @@ "advancedSettings.advancedSettingsLabel": "高度な設定", "advancedSettings.featureCatalogueTitle": "日付形式の変更、ダークモードの有効化など、Kibanaエクスペリエンスをカスタマイズします。", "aiAssistantManagementSelection.aiAssistantSelectionPage.observabilityLabel": "Elastic AI Assistant for Observability", - "aiAssistantManagementSelection.aiAssistantSelectionPage.thisFeatureIsDisabledCallOutLabel": "この機能は無効です。［スペース］>［機能］から有効化できます。", "aiAssistantManagementSelection.aiAssistantSettingsPage.descriptionTextLabel": "AI Assistantは、生成AIを使用して、エラーを説明したり、改善策を提案したり、データのリクエスト、分析、可視化を支援したりすることで、チームを支援します。", "aiAssistantManagementSelection.aiAssistantSettingsPage.h2.aIAssistantLabel": "AI Assistant", "aiAssistantManagementSelection.aiAssistantSettingsPage.obsAssistant.documentationLinkLabel": "ドキュメント", @@ -44828,4 +44821,4 @@ "xpack.serverlessObservability.nav.projectSettings": "プロジェクト設定", "xpack.serverlessObservability.nav.synthetics": "Synthetics" } -} \ No newline at end of file +} diff --git a/x-pack/plugins/translations/translations/zh-CN.json b/x-pack/plugins/translations/translations/zh-CN.json index fee776d8db51a..b8c07755ed313 100644 --- a/x-pack/plugins/translations/translations/zh-CN.json +++ b/x-pack/plugins/translations/translations/zh-CN.json @@ -324,7 +324,6 @@ "console.requestOptions.openDocumentationButtonLabel": "打开文档", "console.requestOptionsButtonAriaLabel": "请求选项", "console.requestTimeElapasedBadgeTooltipContent": "已用时间", - "console.sendRequestButtonTooltip": "单击以发送请求", "console.settingsPage.accessibilityOverlayLabel": "辅助功能覆盖", "console.settingsPage.autocompleteLabel": "自动完成", "console.settingsPage.cancelButtonLabel": "取消", @@ -12813,8 +12812,6 @@ "xpack.csp.findings.findingsFlyout.overviewTab.indexTitle": "索引", "xpack.csp.findings.findingsFlyout.overviewTab.rationaleTitle": "理由", "xpack.csp.findings.findingsFlyout.overviewTab.remediationTitle": "补救", - "xpack.csp.findings.findingsFlyout.overviewTab.resourceIdTitle": "资源 ID", - "xpack.csp.findings.findingsFlyout.overviewTab.resourceNameTitle": "资源名称", "xpack.csp.findings.findingsFlyout.overviewTab.ruleNameTitle": "规则名称", "xpack.csp.findings.findingsFlyout.overviewTab.ruleNameTooltip": "管理规则", "xpack.csp.findings.findingsFlyout.overviewTab.ruleTagsTitle": "规则标签", @@ -22179,8 +22176,6 @@ "xpack.ingestPipelines.form.metaAriaLabel": "_meta 字段数据编辑器", "xpack.ingestPipelines.form.metaDescription": "有关采集管道的任何其他信息。此信息以集群状态存储，因此最好使其保持简短。", "xpack.ingestPipelines.form.metaFieldLabel": "_meta 字段数据（可选）", - "xpack.ingestPipelines.form.metaSwitchCaption": "添加元数据", - "xpack.ingestPipelines.form.metaTitle": "元数据", "xpack.ingestPipelines.form.nameDescription": "此管道的唯一标识符。", "xpack.ingestPipelines.form.nameFieldLabel": "名称", "xpack.ingestPipelines.form.nameTitle": "名称", @@ -22192,7 +22187,6 @@ "xpack.ingestPipelines.form.unknownError": "发生了未知错误。", "xpack.ingestPipelines.form.validation.metaJsonError": "输入无效。", "xpack.ingestPipelines.form.versionFieldLabel": "版本（可选）", - "xpack.ingestPipelines.form.versionToggleDescription": "添加版本号", "xpack.ingestPipelines.list.listTitle": "采集管道", "xpack.ingestPipelines.list.loadErrorTitle": "无法加载管道", "xpack.ingestPipelines.list.loadingMessage": "正在加载管道……", @@ -44158,7 +44152,6 @@ "advancedSettings.advancedSettingsLabel": "高级设置", "advancedSettings.featureCatalogueTitle": "定制您的 Kibana 体验 — 更改日期格式、打开深色模式，等等。", "aiAssistantManagementSelection.aiAssistantSelectionPage.observabilityLabel": "适用于 Observability 的 Elastic AI 助手", - "aiAssistantManagementSelection.aiAssistantSelectionPage.thisFeatureIsDisabledCallOutLabel": "此功能处于禁用状态。可以从“工作区 > 功能”中启用该功能。", "aiAssistantManagementSelection.aiAssistantSettingsPage.descriptionTextLabel": "通过解释错误，建议补救措施并帮助您请求、分析和可视化数据，AI 助手使用生成式 AI 来为您的团队提供帮助。", "aiAssistantManagementSelection.aiAssistantSettingsPage.h2.aIAssistantLabel": "AI 助手", "aiAssistantManagementSelection.aiAssistantSettingsPage.obsAssistant.documentationLinkLabel": "文档", @@ -44876,4 +44869,4 @@ "xpack.serverlessObservability.nav.projectSettings": "项目设置", "xpack.serverlessObservability.nav.synthetics": "Synthetics" } -} \ No newline at end of file +} diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/test_connector_form.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/test_connector_form.tsx index 15e61c7b14940..e04a0d6e42a1f 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/test_connector_form.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/test_connector_form.tsx @@ -187,7 +187,6 @@ const SuccessfulExecution = () => ( 'xpack.triggersActionsUI.sections.testConnectorForm.executionSuccessfulTitle', { defaultMessage: 'Test was successful', - values: {}, } )} color="success" diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/alerts_table.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/alerts_table.tsx index b87633ad22b54..c707b8dba875f 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/alerts_table.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/alerts_table.tsx @@ -343,6 +343,7 @@ const AlertsTable: React.FunctionComponent = memo((props: Aler useBulkActionsConfig: alertsTableConfiguration.useBulkActions, refresh: alertsRefresh, featureIds, + hideBulkActions: Boolean(alertsTableConfiguration.hideBulkActions), }; }, [alerts, alertsTableConfiguration, query, alertsRefresh, featureIds]); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/alerts_table_state.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/alerts_table_state.tsx index 70aaf7a304453..65353acf5c9a6 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/alerts_table_state.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/alerts_table_state.tsx @@ -92,6 +92,7 @@ export type AlertsTableStateProps = { dynamicRowHeight?: boolean; lastReloadRequestTime?: number; renderCellPopover?: AlertsTableProps['renderCellPopover']; + emptyStateHeight?: 'tall' | 'short'; } & Omit, 'renderCellPopover'>; export interface AlertsTableStorage { @@ -214,6 +215,7 @@ const AlertsTableStateWithQueryProvider = memo( shouldHighlightRow, dynamicRowHeight, lastReloadRequestTime, + emptyStateHeight, }: AlertsTableStateProps) => { const { cases: casesService, fieldFormats } = useKibana<{ cases?: CasesService; @@ -530,6 +532,7 @@ const AlertsTableStateWithQueryProvider = memo( controls={persistentControls} getInspectQuery={getInspectQuery} showInpectButton={showInspectButton} + height={emptyStateHeight} /> )} diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/use_bulk_actions.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/use_bulk_actions.test.tsx index 042eeab219633..d966dbbba8fcb 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/use_bulk_actions.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/use_bulk_actions.test.tsx @@ -463,5 +463,42 @@ describe('bulk action hooks', () => { const newBulkActions = result.current.bulkActions[0].items; expect(initialBulkActions).toEqual(newBulkActions); }); + + it('hides bulk actions if hideBulkActions == true', () => { + // make sure by default some actions are returned for this + // config + const { result: resultWithoutHideBulkActions } = renderHook( + () => + useBulkActions({ + alerts: [], + query: {}, + casesConfig, + refresh, + featureIds: ['observability'], + }), + { + wrapper: appMockRender.AppWrapper, + } + ); + + expect(resultWithoutHideBulkActions.current.bulkActions.length).toBeGreaterThan(0); + + const { result: resultWithHideBulkActions } = renderHook( + () => + useBulkActions({ + alerts: [], + query: {}, + casesConfig, + refresh, + featureIds: ['observability'], + hideBulkActions: true, + }), + { + wrapper: appMockRender.AppWrapper, + } + ); + + expect(resultWithHideBulkActions.current.bulkActions.length).toBe(0); + }); }); }); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/use_bulk_actions.ts b/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/use_bulk_actions.ts index 17c1b5be3c7ef..1d275abc68d91 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/use_bulk_actions.ts +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/alerts_table/hooks/use_bulk_actions.ts @@ -42,6 +42,7 @@ interface BulkActionsProps { useBulkActionsConfig?: UseBulkActionsRegistry; refresh: () => void; featureIds?: ValidFeatureId[]; + hideBulkActions?: boolean; } export interface UseBulkActions { @@ -278,6 +279,7 @@ export function useBulkActions({ refresh, useBulkActionsConfig = () => [], featureIds, + hideBulkActions, }: BulkActionsProps): UseBulkActions { const { bulkActions: [bulkActionsState, updateBulkActionsState], @@ -302,17 +304,22 @@ export function useBulkActions({ featureIds, isAllSelected: bulkActionsState.isAllSelected, }); + const initialItems = useMemo(() => { return [...caseBulkActions, ...(featureIds?.includes('siem') ? [] : untrackBulkActions)]; }, [caseBulkActions, featureIds, untrackBulkActions]); const bulkActions = useMemo(() => { + if (hideBulkActions) { + return []; + } + return initialItems.length ? addItemsToInitialPanel({ panels: configBulkActionPanels, items: initialItems, }) : configBulkActionPanels; - }, [configBulkActionPanels, initialItems]); + }, [configBulkActionPanels, initialItems, hideBulkActions]); const isBulkActionsColumnActive = bulkActions.length !== 0; diff --git a/x-pack/plugins/triggers_actions_ui/public/types.ts b/x-pack/plugins/triggers_actions_ui/public/types.ts index 218b6365457bf..f2a8d86eeb88a 100644 --- a/x-pack/plugins/triggers_actions_ui/public/types.ts +++ b/x-pack/plugins/triggers_actions_ui/public/types.ts @@ -763,6 +763,7 @@ export interface AlertsTableConfigurationRegistry { }; useFieldBrowserOptions?: UseFieldBrowserOptions; showInspectButton?: boolean; + hideBulkActions?: boolean; ruleTypeIds?: string[]; useFetchPageContext?: PreFetchPageContext; actions?: { diff --git a/x-pack/plugins/upgrade_assistant/server/lib/es_deprecations_status.ts b/x-pack/plugins/upgrade_assistant/server/lib/es_deprecations_status.ts index b557e636c618a..d343aca07f9f6 100644 --- a/x-pack/plugins/upgrade_assistant/server/lib/es_deprecations_status.ts +++ b/x-pack/plugins/upgrade_assistant/server/lib/es_deprecations_status.ts @@ -42,6 +42,7 @@ export function getShardCapacityDeprecationInfo({ { defaultMessage: 'The number of nodes that are running low on disk and it is likely that they will run out of space. Their disk usage has tripped the <>.', + ignoreTag: true, } ) ); @@ -54,6 +55,7 @@ export function getShardCapacityDeprecationInfo({ { defaultMessage: 'The number of nodes that have run out of disk. Their disk usage has tripped the <>.', + ignoreTag: true, } ) ); diff --git a/x-pack/test/api_integration/services/usage_api.ts b/x-pack/test/api_integration/services/usage_api.ts index 500212d96ddfc..14ead21c86d2b 100644 --- a/x-pack/test/api_integration/services/usage_api.ts +++ b/x-pack/test/api_integration/services/usage_api.ts @@ -20,21 +20,38 @@ export interface UsageStatsPayloadTestFriendly extends UsageStatsPayload { export function UsageAPIProvider({ getService }: FtrProviderContext) { const supertest = getService('supertest'); - async function getTelemetryStats(payload: { - unencrypted: true; - refreshCache?: boolean; - }): Promise>; - async function getTelemetryStats(payload: { - unencrypted: false; - refreshCache?: boolean; - }): Promise>; - async function getTelemetryStats(payload: { - unencrypted?: boolean; - refreshCache?: boolean; - }): Promise> { + async function getTelemetryStats( + payload: { + unencrypted: true; + refreshCache?: boolean; + }, + options?: { authHeader: Record } + ): Promise>; + async function getTelemetryStats( + payload: { + unencrypted: false; + refreshCache?: boolean; + }, + options?: { authHeader: Record } + ): Promise>; + async function getTelemetryStats( + payload: { + unencrypted: false; + refreshCache?: boolean; + }, + options?: { authHeader: Record } + ): Promise>; + async function getTelemetryStats( + payload: { + unencrypted?: boolean; + refreshCache?: boolean; + }, + options?: { authHeader: Record } + ): Promise> { const { body } = await supertest .post('/internal/telemetry/clusters/_stats') .set('kbn-xsrf', 'xxx') + .set(options?.authHeader ?? {}) .set(ELASTIC_HTTP_VERSION_HEADER, '2') .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana') .send({ refreshCache: true, ...payload }) diff --git a/x-pack/test/cloud_security_posture_functional/cloud_tests/README.md b/x-pack/test/cloud_security_posture_functional/cloud_tests/README.md new file mode 100644 index 0000000000000..ce67cefa1022a --- /dev/null +++ b/x-pack/test/cloud_security_posture_functional/cloud_tests/README.md @@ -0,0 +1,24 @@ +## Tests Development Process + +**Preparation** + +- **Environment Deployment** - Initially, to start tests development, deploy the environment using the [Create Environment](https://github.com/elastic/cloudbeat/blob/main/dev-docs/Cloud-Env-Testing.md) workflow. + +- **Configuration & Run** - After provisioning the environment, configure the FTR environment variables accordingly. At a minimum, configure the following variables: TEST_KIBANA_URL, TEST_ES_URL, TEST_CLOUD, ES_SECURITY_ENABLED. More information can be found in the [FTR documentation](https://www.elastic.co/guide/en/kibana/current/development-tests.html#development-functional-tests). Note that URLs should contain the user and password. + +``` bash +export TEST_KIBANA_URL=https://elastic:password@my-kbn-cluster.elastic-cloud.com:443 +export TEST_ES_URL=https://elastic:password@my-es-cluster.elastic-cloud.com:443 + +export TEST_CLOUD=1 +export ES_SECURITY_ENABLED=1 + +node scripts/functional_test_runner [--config ] [--es-version ] +``` + +- **Suite Config** - The config file is located here: `x-pack/test/cloud_security_posture_functional/config.cloud.ts`. + + +**Final Testing on Demand** + +After finishing the implementation and ensuring that the whole suite is working locally, proceed to execution in the Create Environment workflow. [This PR](https://github.com/elastic/cloudbeat/pull/2219) adds the feature to run UI tests. To do this, open a PR in Kibana, then find the PR commit and apply it in the Create Environment workflow for the final end-to-end process. This process takes time, so proceed only after a few local runs to ensure test stability. \ No newline at end of file diff --git a/x-pack/test/cloud_security_posture_functional/cloud_tests/basic_ui_sanity.ts b/x-pack/test/cloud_security_posture_functional/cloud_tests/basic_ui_sanity.ts new file mode 100644 index 0000000000000..495105017e5c2 --- /dev/null +++ b/x-pack/test/cloud_security_posture_functional/cloud_tests/basic_ui_sanity.ts @@ -0,0 +1,75 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import expect from '@kbn/expect'; +import { FtrProviderContext } from '../ftr_provider_context'; + +// eslint-disable-next-line import/no-default-export +export default ({ getPageObjects, getService }: FtrProviderContext) => { + const retry = getService('retry'); + const pageObjects = getPageObjects(['common', 'cloudPostureDashboard', 'header']); + + describe('Cloud Posture Dashboard Page', function () { + this.tags(['cloud_security_posture_ui_sanity']); + let cspDashboard: typeof pageObjects.cloudPostureDashboard; + let dashboard: typeof pageObjects.cloudPostureDashboard.dashboard; + + before(async () => { + cspDashboard = pageObjects.cloudPostureDashboard; + dashboard = pageObjects.cloudPostureDashboard.dashboard; + await cspDashboard.waitForPluginInitialized(); + await cspDashboard.navigateToComplianceDashboardPage(); + await retry.waitFor( + 'Cloud posture integration dashboard to be displayed', + async () => !!dashboard.getIntegrationDashboardContainer() + ); + }); + + describe('Cloud Dashboard', () => { + it('displays compliance score greater than 40', async () => { + await pageObjects.header.waitUntilLoadingHasFinished(); + const scoreElement = await dashboard.getCloudComplianceScore(); + const score = parseInt((await scoreElement.getVisibleText()).replace('%', ''), 10); + expect(score).to.be.greaterThan(40); + }); + + it('displays all compliance scores', async () => { + const scoresElements = await dashboard.getAllCloudComplianceScores(); + const scores: string[] = []; + for (const scoreElement of scoresElements) { + scores.push(await scoreElement.getVisibleText()); + } + // 3 scores for each cloud provider + 1 summary score + expect(scores.length).to.be(4); + }); + + it('displays a number of resources evaluated greater than 3000', async () => { + const resourcesEvaluated = await dashboard.getCloudResourcesEvaluated(); + const visibleText = await resourcesEvaluated.getVisibleText(); + const resourcesEvaluatedCount = parseInt(visibleText.replace(/,/g, ''), 10); + expect(resourcesEvaluatedCount).greaterThan(3000); + }); + }); + + describe('Kubernetes Dashboard', () => { + it('displays compliance score greater than 80', async () => { + await pageObjects.header.waitUntilLoadingHasFinished(); + const scoreElement = await dashboard.getKubernetesComplianceScore(); + const score = parseInt((await scoreElement.getVisibleText()).replace('%', ''), 10); + expect(score).to.be.greaterThan(80); + }); + + it('displays a number of resources evaluated greater than 150', async () => { + const resourcesEvaluated = await dashboard.getKubernetesResourcesEvaluated(); + const resourcesEvaluatedCount = parseInt( + (await resourcesEvaluated.getVisibleText()).replace(/,/g, ''), + 10 + ); + expect(resourcesEvaluatedCount).greaterThan(150); + }); + }); + }); +}; diff --git a/x-pack/test/cloud_security_posture_functional/cloud_tests/index.ts b/x-pack/test/cloud_security_posture_functional/cloud_tests/index.ts new file mode 100644 index 0000000000000..b08970ccaed13 --- /dev/null +++ b/x-pack/test/cloud_security_posture_functional/cloud_tests/index.ts @@ -0,0 +1,15 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { FtrProviderContext } from '../ftr_provider_context'; + +// eslint-disable-next-line import/no-default-export +export default function ({ loadTestFile }: FtrProviderContext) { + describe('Cloud Security Posture', function () { + loadTestFile(require.resolve('./basic_ui_sanity')); + }); +} diff --git a/x-pack/test/cloud_security_posture_functional/config.cloud.ts b/x-pack/test/cloud_security_posture_functional/config.cloud.ts new file mode 100644 index 0000000000000..1fc18baeba743 --- /dev/null +++ b/x-pack/test/cloud_security_posture_functional/config.cloud.ts @@ -0,0 +1,25 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { resolve } from 'path'; +import type { FtrConfigProviderContext } from '@kbn/test'; +import { pageObjects } from './page_objects'; + +export default async function ({ readConfigFile }: FtrConfigProviderContext) { + const xpackFunctionalConfig = await readConfigFile( + require.resolve('../functional/config.base.js') + ); + // FTR configuration for cloud testing + return { + ...xpackFunctionalConfig.getAll(), + pageObjects, + testFiles: [resolve(__dirname, './cloud_tests')], + junit: { + reportName: 'X-Pack Cloud Security Posture Sanity Tests', + }, + }; +} diff --git a/x-pack/test/cloud_security_posture_functional/page_objects/csp_dashboard_page.ts b/x-pack/test/cloud_security_posture_functional/page_objects/csp_dashboard_page.ts index 24a89549fb025..4343662e32efd 100644 --- a/x-pack/test/cloud_security_posture_functional/page_objects/csp_dashboard_page.ts +++ b/x-pack/test/cloud_security_posture_functional/page_objects/csp_dashboard_page.ts @@ -96,11 +96,26 @@ export function CspDashboardPageProvider({ getService, getPageObjects }: FtrProv return await testSubjects.find('dashboard-summary-section'); }, + getAllCloudComplianceScores: async () => { + await dashboard.getCloudDashboard(); + return await testSubjects.findAll('dashboard-summary-section-compliance-score'); + }, + getCloudComplianceScore: async () => { await dashboard.getCloudSummarySection(); return await testSubjects.find('dashboard-summary-section-compliance-score'); }, + getCloudResourcesEvaluatedCard: async () => { + await dashboard.getCloudDashboard(); + return await testSubjects.find('dashboard-counter-card-resources-evaluated'); + }, + + getCloudResourcesEvaluated: async () => { + const resourcesEvaluatedCard = await dashboard.getCloudResourcesEvaluatedCard(); + return await resourcesEvaluatedCard.findByXpath('//div/p/span'); + }, + // Kubernetes Dashboard getKubernetesDashboard: async () => { @@ -121,6 +136,16 @@ export function CspDashboardPageProvider({ getService, getPageObjects }: FtrProv return await testSubjects.find('dashboard-summary-section-compliance-score'); }, + + getKubernetesResourcesEvaluatedCard: async () => { + await dashboard.getKubernetesDashboard(); + return await testSubjects.find('dashboard-counter-card-resources-evaluated'); + }, + + getKubernetesResourcesEvaluated: async () => { + const resourcesEvaluatedCard = await dashboard.getKubernetesResourcesEvaluatedCard(); + return await resourcesEvaluatedCard.findByXpath('//div/p/span'); + }, }; const navigateToComplianceDashboardPage = async () => { diff --git a/x-pack/test/functional/apps/ingest_pipelines/ingest_pipelines.ts b/x-pack/test/functional/apps/ingest_pipelines/ingest_pipelines.ts index c6f1eb4d189a0..b4a6bfe60e010 100644 --- a/x-pack/test/functional/apps/ingest_pipelines/ingest_pipelines.ts +++ b/x-pack/test/functional/apps/ingest_pipelines/ingest_pipelines.ts @@ -133,6 +133,22 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { }); }); + it('Shows a prompt when trying to navigate away from the creation form when the form is dirty', async () => { + // Navigate to creation flow + await testSubjects.click('createPipelineDropdown'); + await testSubjects.click('createNewPipeline'); + + // Fill in the form with some data + await testSubjects.setValue('nameField > input', 'test_name'); + await testSubjects.setValue('descriptionField > input', 'test_description'); + + // Try to navigate to another page + await testSubjects.click('logo'); + + // Since the form is now dirty it should trigger a confirmation prompt + expect(await testSubjects.exists('navigationBlockConfirmModal')).to.be(true); + }); + describe('Create pipeline', () => { afterEach(async () => { // Delete the pipeline that was created diff --git a/x-pack/test/functional/apps/observability_logs_explorer/columns_selection.ts b/x-pack/test/functional/apps/observability_logs_explorer/columns_selection.ts index 1c64c85534d66..2ce47eb927d8c 100644 --- a/x-pack/test/functional/apps/observability_logs_explorer/columns_selection.ts +++ b/x-pack/test/functional/apps/observability_logs_explorer/columns_selection.ts @@ -85,7 +85,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('render content virtual column properly', async () => { it('should render log level and log message when present', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 3); + const cellElement = await dataGrid.getCellElement(0, 4); const cellValue = await cellElement.getVisibleText(); expect(cellValue.includes('info')).to.be(true); expect(cellValue.includes('A sample log')).to.be(true); @@ -94,7 +94,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render log message when present and skip log level when missing', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(1, 3); + const cellElement = await dataGrid.getCellElement(1, 4); const cellValue = await cellElement.getVisibleText(); expect(cellValue.includes('info')).to.be(false); expect(cellValue.includes('A sample log')).to.be(true); @@ -103,7 +103,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render message from error object when top level message not present', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(2, 3); + const cellElement = await dataGrid.getCellElement(2, 4); const cellValue = await cellElement.getVisibleText(); expect(cellValue.includes('info')).to.be(true); expect(cellValue.includes('error.message')).to.be(true); @@ -113,7 +113,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render message from event.original when top level message and error.message not present', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(3, 3); + const cellElement = await dataGrid.getCellElement(3, 4); const cellValue = await cellElement.getVisibleText(); expect(cellValue.includes('info')).to.be(true); expect(cellValue.includes('event.original')).to.be(true); @@ -123,7 +123,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render the whole JSON when neither message, error.message and event.original are present', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(4, 3); + const cellElement = await dataGrid.getCellElement(4, 4); const cellValue = await cellElement.getVisibleText(); expect(cellValue.includes('info')).to.be(true); @@ -137,7 +137,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('on cell expansion with no message field should open JSON Viewer', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - await dataGrid.clickCellExpandButton(4, 3); + await dataGrid.clickCellExpandButton(4, 4); await testSubjects.existOrFail('dataTableExpandCellActionJsonPopover'); }); }); @@ -145,7 +145,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('on cell expansion with message field should open regular popover', async () => { await navigateToLogsExplorer(); await retry.tryForTime(TEST_TIMEOUT, async () => { - await dataGrid.clickCellExpandButton(3, 3); + await dataGrid.clickCellExpandButton(3, 4); await testSubjects.existOrFail('euiDataGridExpansionPopover'); }); }); @@ -154,7 +154,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('render resource virtual column properly', async () => { it('should render service name and host name when present', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 2); + const cellElement = await dataGrid.getCellElement(0, 3); const cellValue = await cellElement.getVisibleText(); expect(cellValue.includes('synth-service')).to.be(true); expect(cellValue.includes('synth-host')).to.be(true); @@ -168,7 +168,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { }); it('should render a popover with cell actions when a chip on content column is clicked', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 3); + const cellElement = await dataGrid.getCellElement(0, 4); const logLevelChip = await cellElement.findByTestSubject( 'dataTablePopoverChip_log.level' ); @@ -184,7 +184,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render the table filtered where log.level value is info when filter in action is clicked', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 3); + const cellElement = await dataGrid.getCellElement(0, 4); const logLevelChip = await cellElement.findByTestSubject( 'dataTablePopoverChip_log.level' ); @@ -204,7 +204,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render the table filtered where log.level value is not info when filter out action is clicked', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 3); + const cellElement = await dataGrid.getCellElement(0, 4); const logLevelChip = await cellElement.findByTestSubject( 'dataTablePopoverChip_log.level' ); @@ -222,7 +222,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render the table filtered where service.name value is selected', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 2); + const cellElement = await dataGrid.getCellElement(0, 3); const serviceNameChip = await cellElement.findByTestSubject( 'dataTablePopoverChip_service.name' ); diff --git a/x-pack/test/functional/apps/observability_logs_explorer/custom_control_columns.ts b/x-pack/test/functional/apps/observability_logs_explorer/custom_control_columns.ts index 9fcea31d6b8b7..21dd8a6772bb7 100644 --- a/x-pack/test/functional/apps/observability_logs_explorer/custom_control_columns.ts +++ b/x-pack/test/functional/apps/observability_logs_explorer/custom_control_columns.ts @@ -46,30 +46,30 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('should render custom control columns properly', async () => { it('should render control column with proper header', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - // First control column has no title, so empty string, last control column has title + // First control column has no title, so empty string, leading control column has title expect(await dataGrid.getControlColumnHeaderFields()).to.eql(['', 'actions']); }); }); - it('should render the expand icon in the last control column', async () => { + it('should render the expand icon in the leading control column', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 4); + const cellElement = await dataGrid.getCellElement(0, 1); const expandButton = await cellElement.findByTestSubject('docTableExpandToggleColumn'); expect(expandButton).to.not.be.empty(); }); }); - it('should render the degraded icon in the last control column if degraded doc exists', async () => { + it('should render the degraded icon in the leading control column if degraded doc exists', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(1, 4); + const cellElement = await dataGrid.getCellElement(1, 1); const degradedButton = await cellElement.findByTestSubject('docTableDegradedDocExist'); expect(degradedButton).to.not.be.empty(); }); }); - it('should render the disabled degraded icon in the last control column when degraded doc does not exists', async () => { + it('should render the disabled degraded icon in the leading control column when degraded doc does not exists', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 4); + const cellElement = await dataGrid.getCellElement(0, 1); const degradedDisableButton = await cellElement.findByTestSubject( 'docTableDegradedDocDoesNotExist' ); @@ -77,17 +77,17 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { }); }); - it('should render the stacktrace icon in the last control column when stacktrace exists', async () => { + it('should render the stacktrace icon in the leading control column when stacktrace exists', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(4, 4); + const cellElement = await dataGrid.getCellElement(4, 1); const stacktraceButton = await cellElement.findByTestSubject('docTableStacktraceExist'); expect(stacktraceButton).to.not.be.empty(); }); }); - it('should render the stacktrace icon disabled in the last control column when stacktrace does not exists', async () => { + it('should render the stacktrace icon disabled in the leading control column when stacktrace does not exists', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(1, 4); + const cellElement = await dataGrid.getCellElement(1, 1); const stacktraceButton = await cellElement.findByTestSubject( 'docTableStacktraceDoesNotExist' ); diff --git a/x-pack/test/functional/apps/observability_logs_explorer/flyout.ts b/x-pack/test/functional/apps/observability_logs_explorer/flyout.ts index 22732d9933bbb..c5c11cac57185 100644 --- a/x-pack/test/functional/apps/observability_logs_explorer/flyout.ts +++ b/x-pack/test/functional/apps/observability_logs_explorer/flyout.ts @@ -66,7 +66,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { }); it('should display the logs overview tab', async () => { - await dataGrid.clickRowToggle({ columnIndex: 4 }); + await dataGrid.clickRowToggle({ columnIndex: 1 }); await testSubjects.existOrFail('docViewerTab-doc_view_logs_overview'); }); }); diff --git a/x-pack/test/functional/page_objects/ingest_pipelines_page.ts b/x-pack/test/functional/page_objects/ingest_pipelines_page.ts index d7a2e32f302d2..218a34e5c1ae2 100644 --- a/x-pack/test/functional/page_objects/ingest_pipelines_page.ts +++ b/x-pack/test/functional/page_objects/ingest_pipelines_page.ts @@ -32,6 +32,7 @@ export function IngestPipelinesPageProvider({ getService, getPageObjects }: FtrP processors?: string; onFailureProcessors?: string; }) { + await pageObjects.common.sleep(250); await testSubjects.click('createPipelineDropdown'); await testSubjects.click('createNewPipeline'); @@ -82,6 +83,7 @@ export function IngestPipelinesPageProvider({ getService, getPageObjects }: FtrP }, async createPipelineFromCsv({ name }: { name: string }) { + await pageObjects.common.sleep(250); await testSubjects.click('createPipelineDropdown'); await testSubjects.click('createPipelineFromCsv'); diff --git a/x-pack/test/observability_ai_assistant_api_integration/tests/complete/complete.spec.ts b/x-pack/test/observability_ai_assistant_api_integration/tests/complete/complete.spec.ts index 01f6e8cdd7bce..eb5ed07d3ea08 100644 --- a/x-pack/test/observability_ai_assistant_api_integration/tests/complete/complete.spec.ts +++ b/x-pack/test/observability_ai_assistant_api_integration/tests/complete/complete.spec.ts @@ -193,7 +193,6 @@ export default function ApiTest({ getService }: FtrProviderContext) { role: MessageRole.Assistant, function_call: { name: 'context', - arguments: JSON.stringify({ queries: [], categories: [] }), trigger: MessageRole.Assistant, }, }, diff --git a/x-pack/test/observability_ai_assistant_api_integration/tests/public_complete/public_complete.spec.ts b/x-pack/test/observability_ai_assistant_api_integration/tests/public_complete/public_complete.spec.ts index ac2fa36f6b0fd..f496e42868ac8 100644 --- a/x-pack/test/observability_ai_assistant_api_integration/tests/public_complete/public_complete.spec.ts +++ b/x-pack/test/observability_ai_assistant_api_integration/tests/public_complete/public_complete.spec.ts @@ -72,6 +72,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { format, }) .set('kbn-xsrf', 'foo') + .set('elastic-api-version', '2023-10-31') .send({ messages, connectorId, @@ -83,13 +84,20 @@ export default function ApiTest({ getService }: FtrProviderContext) { if (err) { return reject(err); } + if (response.status !== 200) { + return reject(new Error(`${response.status}: ${JSON.stringify(response.body)}`)); + } return resolve(response); }); }); - const [conversationSimulator, titleSimulator] = await Promise.all([ - conversationInterceptor.waitForIntercept(), - titleInterceptor.waitForIntercept(), + const [conversationSimulator, titleSimulator] = await Promise.race([ + Promise.all([ + conversationInterceptor.waitForIntercept(), + titleInterceptor.waitForIntercept(), + ]), + // make sure any request failures (like 400s) are properly propagated + responsePromise.then(() => []), ]); await titleSimulator.status(200); diff --git a/x-pack/test/observability_ai_assistant_functional/tests/conversations/index.spec.ts b/x-pack/test/observability_ai_assistant_functional/tests/conversations/index.spec.ts index b7c33db0a4122..3e766877c5bca 100644 --- a/x-pack/test/observability_ai_assistant_functional/tests/conversations/index.spec.ts +++ b/x-pack/test/observability_ai_assistant_functional/tests/conversations/index.spec.ts @@ -94,7 +94,7 @@ export default function ApiTest({ getService, getPageObjects }: FtrProviderConte content: '', function_call: { name: 'context', - arguments: '{"queries":[],"categories":[]}', + arguments: '{}', trigger: MessageRole.Assistant, }, }, @@ -290,7 +290,6 @@ export default function ApiTest({ getService, getPageObjects }: FtrProviderConte expect(pick(contextRequest.function_call, 'name', 'arguments')).to.eql({ name: 'context', - arguments: JSON.stringify({ queries: [], categories: [] }), }); expect(contextResponse.name).to.eql('context'); @@ -354,7 +353,6 @@ export default function ApiTest({ getService, getPageObjects }: FtrProviderConte expect(pick(contextRequest.function_call, 'name', 'arguments')).to.eql({ name: 'context', - arguments: JSON.stringify({ queries: [], categories: [] }), }); expect(contextResponse.name).to.eql('context'); diff --git a/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/eql_alert_suppression.ts b/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/eql_alert_suppression.ts index b4e1eaa391744..b0a0e3f8b66ba 100644 --- a/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/eql_alert_suppression.ts +++ b/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/eql_alert_suppression.ts @@ -7,6 +7,8 @@ import expect from 'expect'; import { v4 as uuidv4 } from 'uuid'; +import sortBy from 'lodash/sortBy'; + import { EqlRuleCreateProps } from '@kbn/security-solution-plugin/common/api/detection_engine'; import { ALERT_SUPPRESSION_START, @@ -255,6 +257,96 @@ export default ({ getService }: FtrProviderContext) => { ); }); + it('deduplicates new alerts if they were previously created without suppression', async () => { + const id = uuidv4(); + const firstTimestamp = new Date().toISOString(); + + const ruleWithoutSuppression: EqlRuleCreateProps = { + ...getEqlRuleForAlertTesting(['ecs_compliant']), + query: getQuery(id), + from: 'now-35m', + interval: '30m', + }; + const alertSuppression = { + group_by: ['host.name'], + duration: { + value: 300, + unit: 'm' as const, + }, + missing_fields_strategy: 'suppress', + }; + + const firstDocument = { + id, + '@timestamp': firstTimestamp, + host: { + name: 'host-a', + }, + }; + await indexListOfSourceDocuments([firstDocument, firstDocument]); + + const createdRule = await createRule(supertest, log, ruleWithoutSuppression); + const alerts = await getOpenAlerts(supertest, log, es, createdRule); + expect(alerts.hits.hits).toHaveLength(2); + // alert does not have suppression properties + alerts.hits.hits.forEach((previewAlert) => { + const source = previewAlert._source; + expect(source).toHaveProperty('id', id); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_DOCS_COUNT); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_END); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_TERMS); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_DOCS_COUNT); + }); + + const secondTimestamp = new Date().toISOString(); + const secondDocument = { + id, + '@timestamp': secondTimestamp, + host: { + name: 'host-a', + }, + }; + + await indexListOfSourceDocuments([secondDocument, secondDocument]); + + // update the rule to include suppression + await patchRule(supertest, log, { + id: createdRule.id, + alert_suppression: alertSuppression, + enabled: false, + }); + await patchRule(supertest, log, { id: createdRule.id, enabled: true }); + + const afterTimestamp = new Date(); + const secondAlerts = await getOpenAlerts( + supertest, + log, + es, + createdRule, + RuleExecutionStatusEnum.succeeded, + undefined, + afterTimestamp + ); + + expect(secondAlerts.hits.hits.length).toEqual(3); + + const sortedAlerts = sortBy(secondAlerts.hits.hits, ALERT_ORIGINAL_TIME); + + // third alert is generated with suppression + expect(sortedAlerts[2]._source).toEqual( + expect.objectContaining({ + [ALERT_SUPPRESSION_TERMS]: [ + { + field: 'host.name', + value: ['host-a'], + }, + ], + [ALERT_ORIGINAL_TIME]: secondTimestamp, + [ALERT_SUPPRESSION_DOCS_COUNT]: 1, + }) + ); + }); + it('does not suppress alerts when suppression duration is less than rule interval', async () => { const id = uuidv4(); const firstTimestamp = '2020-10-28T05:45:00.000Z'; diff --git a/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/esql_suppression.ts b/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/esql_suppression.ts index 7ab53b9817970..39724206cfab3 100644 --- a/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/esql_suppression.ts +++ b/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/esql_suppression.ts @@ -256,6 +256,95 @@ export default ({ getService }: FtrProviderContext) => { ); }); + it('deduplicates new alerts if they were previously created without suppression', async () => { + const id = uuidv4(); + const firstTimestamp = new Date().toISOString(); + + const ruleWithoutSuppression: EsqlRuleCreateProps = { + ...getCreateEsqlRulesSchemaMock('rule-1', true), + query: getNonAggRuleQueryWithMetadata(id), + from: 'now-35m', + interval: '30m', + }; + const alertSuppression = { + group_by: ['host.name'], + duration: { + value: 300, + unit: 'm' as const, + }, + missing_fields_strategy: 'suppress', + }; + + const firstExecutionDocuments = [ + { + host: { name: 'host-0' }, + id, + '@timestamp': firstTimestamp, + }, + ]; + + await indexListOfDocuments(firstExecutionDocuments); + + const createdRule = await createRule(supertest, log, ruleWithoutSuppression); + const alerts = await getOpenAlerts(supertest, log, es, createdRule); + expect(alerts.hits.hits).toHaveLength(1); + // alert does not have suppression properties + alerts.hits.hits.forEach((previewAlert) => { + const source = previewAlert._source; + expect(source).toHaveProperty('id', id); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_DOCS_COUNT); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_END); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_TERMS); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_DOCS_COUNT); + }); + + const secondTimestamp = new Date().toISOString(); + const secondExecutionDocument = { + host: { name: 'host-0' }, + id, + '@timestamp': secondTimestamp, + }; + + await indexListOfDocuments([secondExecutionDocument, secondExecutionDocument]); + + // update the rule to include suppression + await patchRule(supertest, log, { + id: createdRule.id, + alert_suppression: alertSuppression, + enabled: false, + }); + await patchRule(supertest, log, { id: createdRule.id, enabled: true }); + + const afterTimestamp = new Date(); + const secondAlerts = await getOpenAlerts( + supertest, + log, + es, + createdRule, + RuleExecutionStatusEnum.succeeded, + undefined, + afterTimestamp + ); + + expect(secondAlerts.hits.hits.length).toEqual(2); + + const sortedAlerts = sortBy(secondAlerts.hits.hits, ALERT_ORIGINAL_TIME); + + // second alert is generated with suppression + expect(sortedAlerts[1]._source).toEqual( + expect.objectContaining({ + [ALERT_SUPPRESSION_TERMS]: [ + { + field: 'host.name', + value: 'host-0', + }, + ], + [ALERT_ORIGINAL_TIME]: secondTimestamp, + [ALERT_SUPPRESSION_DOCS_COUNT]: 1, + }) + ); + }); + it('should NOT suppress alerts when suppression period is less than rule interval', async () => { const id = uuidv4(); const firstTimestamp = '2020-10-28T05:45:00.000Z'; diff --git a/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/indicator_match_alert_suppression.ts b/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/indicator_match_alert_suppression.ts index c0b8e85ec27af..1868fbdef1555 100644 --- a/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/indicator_match_alert_suppression.ts +++ b/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/indicator_match_alert_suppression.ts @@ -7,6 +7,7 @@ import { v4 as uuidv4 } from 'uuid'; import expect from 'expect'; +import sortBy from 'lodash/sortBy'; import { ALERT_SUPPRESSION_START, @@ -372,6 +373,109 @@ export default ({ getService }: FtrProviderContext) => { ); }); + it('deduplicates new alerts if they were previously created without suppression', async () => { + const id = uuidv4(); + const firstTimestamp = new Date().toISOString(); + + await eventsFiller({ id, count: eventsCount, timestamp: [firstTimestamp] }); + await threatsFiller({ id, count: threatsCount, timestamp: firstTimestamp }); + + const firstDocument = { + id, + '@timestamp': firstTimestamp, + host: { + name: 'host-a', + }, + }; + await indexListOfSourceDocuments([firstDocument]); + + await addThreatDocuments({ + id, + timestamp: firstTimestamp, + fields: { + host: { + name: 'host-a', + }, + }, + count: 1, + }); + + const ruleWithoutSuppression: ThreatMatchRuleCreateProps = { + ...indicatorMatchRule(id), + from: 'now-35m', + interval: '30m', + }; + const alertSuppression = { + group_by: ['host.name'], + duration: { + value: 300, + unit: 'm' as const, + }, + missing_fields_strategy: 'suppress', + }; + + const createdRule = await createRule(supertest, log, ruleWithoutSuppression); + const alerts = await getOpenAlerts(supertest, log, es, createdRule); + expect(alerts.hits.hits).toHaveLength(1); + // alert does not have suppression properties + alerts.hits.hits.forEach((previewAlert) => { + const source = previewAlert._source; + expect(source).toHaveProperty('id', id); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_DOCS_COUNT); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_END); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_TERMS); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_DOCS_COUNT); + }); + + const secondTimestamp = new Date().toISOString(); + const secondDocument = { + id, + '@timestamp': secondTimestamp, + host: { + name: 'host-a', + }, + }; + + await indexListOfSourceDocuments([secondDocument, secondDocument]); + + // update the rule to include suppression + await patchRule(supertest, log, { + id: createdRule.id, + alert_suppression: alertSuppression, + enabled: false, + }); + await patchRule(supertest, log, { id: createdRule.id, enabled: true }); + + const afterTimestamp = new Date(); + const secondAlerts = await getOpenAlerts( + supertest, + log, + es, + createdRule, + RuleExecutionStatusEnum.succeeded, + undefined, + afterTimestamp + ); + + expect(secondAlerts.hits.hits.length).toEqual(2); + + const sortedAlerts = sortBy(secondAlerts.hits.hits, ALERT_ORIGINAL_TIME); + + // second alert is generated with suppression + expect(sortedAlerts[1]._source).toEqual( + expect.objectContaining({ + [ALERT_SUPPRESSION_TERMS]: [ + { + field: 'host.name', + value: ['host-a'], + }, + ], + [ALERT_ORIGINAL_TIME]: secondTimestamp, + [ALERT_SUPPRESSION_DOCS_COUNT]: 1, + }) + ); + }); + it('should NOT suppress alerts when suppression period is less than rule interval', async () => { const id = uuidv4(); const firstTimestamp = '2020-10-28T05:45:00.000Z'; diff --git a/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/new_terms_alert_suppression.ts b/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/new_terms_alert_suppression.ts index 863a107af8ab5..4a2644a9737a6 100644 --- a/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/new_terms_alert_suppression.ts +++ b/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/new_terms_alert_suppression.ts @@ -7,6 +7,7 @@ import { v4 as uuidv4 } from 'uuid'; import expect from 'expect'; +import sortBy from 'lodash/sortBy'; import { ALERT_SUPPRESSION_START, @@ -276,6 +277,105 @@ export default ({ getService }: FtrProviderContext) => { ); }); + it('deduplicates new alerts if they were previously created without suppression', async () => { + const id = uuidv4(); + const firstTimestamp = new Date().toISOString(); + + const ruleWithoutSuppression: NewTermsRuleCreateProps = { + ...getCreateNewTermsRulesSchemaMock(id, true), + new_terms_fields: ['host.ip'], + index: ['ecs_compliant'], + history_window_start: historicalWindowStart, + from: 'now-35m', + interval: '30m', + query: `id: "${id}"`, + }; + const alertSuppression = { + group_by: ['host.name'], + duration: { + value: 300, + unit: 'm' as const, + }, + missing_fields_strategy: 'suppress', + }; + + const firstExecutionDocuments = [ + { + host: { name: 'host-0', ip: '127.0.0.3' }, + id, + '@timestamp': firstTimestamp, + }, + ]; + + await indexListOfDocuments(firstExecutionDocuments); + + const createdRule = await createRule(supertest, log, ruleWithoutSuppression); + const alerts = await getOpenAlerts(supertest, log, es, createdRule); + expect(alerts.hits.hits).toHaveLength(1); + // alert does not have suppression properties + alerts.hits.hits.forEach((previewAlert) => { + const source = previewAlert._source; + expect(source).toHaveProperty('id', id); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_DOCS_COUNT); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_END); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_TERMS); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_DOCS_COUNT); + }); + + const secondTimestamp = new Date().toISOString(); + const secondExecutionDocuments = [ + { + host: { name: 'host-0', ip: '127.0.0.5' }, + id, + '@timestamp': secondTimestamp, + }, + { + host: { name: 'host-0', ip: '127.0.0.6' }, + id, + '@timestamp': secondTimestamp, + }, + ]; + + await indexListOfDocuments(secondExecutionDocuments); + + // update the rule to include suppression + await patchRule(supertest, log, { + id: createdRule.id, + alert_suppression: alertSuppression, + enabled: false, + }); + await patchRule(supertest, log, { id: createdRule.id, enabled: true }); + + const afterTimestamp = new Date(); + const secondAlerts = await getOpenAlerts( + supertest, + log, + es, + createdRule, + RuleExecutionStatusEnum.succeeded, + undefined, + afterTimestamp + ); + + expect(secondAlerts.hits.hits.length).toEqual(2); + + const sortedAlerts = sortBy(secondAlerts.hits.hits, ALERT_ORIGINAL_TIME); + + // second alert is generated with suppression + expect(sortedAlerts[1]._source).toEqual( + expect.objectContaining({ + [ALERT_SUPPRESSION_TERMS]: [ + { + field: 'host.name', + value: ['host-0'], + }, + ], + [ALERT_ORIGINAL_TIME]: secondTimestamp, + [ALERT_SUPPRESSION_DOCS_COUNT]: 1, + }) + ); + }); + it('should NOT suppress alerts when suppression period is less than rule interval', async () => { const id = uuidv4(); const firstTimestamp = '2020-10-28T05:45:00.000Z'; diff --git a/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/threshold_alert_suppression.ts b/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/threshold_alert_suppression.ts index 53b03edba30df..d97bd0d517314 100644 --- a/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/threshold_alert_suppression.ts +++ b/x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/trial_license_complete_tier/execution_logic/threshold_alert_suppression.ts @@ -7,7 +7,7 @@ import { v4 as uuidv4 } from 'uuid'; import expect from 'expect'; - +import sortBy from 'lodash/sortBy'; import { ALERT_SUPPRESSION_START, ALERT_SUPPRESSION_END, @@ -24,9 +24,11 @@ import { RuleExecutionStatusEnum } from '@kbn/security-solution-plugin/common/ap import { ENABLE_ASSET_CRITICALITY_SETTING } from '@kbn/security-solution-plugin/common/constants'; import { ALERT_ORIGINAL_TIME } from '@kbn/security-solution-plugin/common/field_maps/field_names'; +import { AlertSuppression } from '@kbn/security-solution-plugin/common/api/detection_engine/model/rule_schema'; import { createRule } from '../../../../../../../common/utils/security_solution'; import { getAlerts, + getOpenAlerts, getPreviewAlerts, getThresholdRuleForAlertTesting, previewRule, @@ -248,6 +250,96 @@ export default ({ getService }: FtrProviderContext) => { ); }); + it('deduplicates new alerts if they were previously created without suppression', async () => { + const id = uuidv4(); + const firstTimestamp = new Date().toISOString(); + const firstDocument = { + id, + '@timestamp': firstTimestamp, + agent: { + name: 'agent-1', + }, + }; + await indexListOfDocuments([firstDocument]); + + const ruleWithoutSuppression: ThresholdRuleCreateProps = { + ...getThresholdRuleForAlertTesting(['ecs_compliant']), + query: `id:${id}`, + threshold: { + field: ['agent.name'], + value: 1, + }, + from: 'now-35m', + interval: '30m', + }; + const alertSuppression = { + duration: { + value: 300, + unit: 'm', + }, + }; + + const createdRule = await createRule(supertest, log, ruleWithoutSuppression); + const alerts = await getOpenAlerts(supertest, log, es, createdRule); + expect(alerts.hits.hits).toHaveLength(1); + // alert does not have suppression properties + alerts.hits.hits.forEach((previewAlert) => { + const source = previewAlert._source; + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_DOCS_COUNT); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_END); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_TERMS); + expect(source).not.toHaveProperty(ALERT_SUPPRESSION_DOCS_COUNT); + }); + + const secondTimestamp = new Date().toISOString(); + const secondDocument = { + id, + '@timestamp': secondTimestamp, + agent: { + name: 'agent-1', + }, + }; + + await indexListOfDocuments([secondDocument, secondDocument]); + + // update the rule to include suppression + await patchRule(supertest, log, { + id: createdRule.id, + alert_suppression: alertSuppression as AlertSuppression, + enabled: false, + }); + await patchRule(supertest, log, { id: createdRule.id, enabled: true }); + + const afterTimestamp = new Date(); + const secondAlerts = await getOpenAlerts( + supertest, + log, + es, + createdRule, + RuleExecutionStatusEnum.succeeded, + undefined, + afterTimestamp + ); + + expect(secondAlerts.hits.hits.length).toEqual(2); + + const sortedAlerts = sortBy(secondAlerts.hits.hits, ALERT_ORIGINAL_TIME); + + // second alert is generated with suppression + expect(sortedAlerts[1]._source).toEqual( + expect.objectContaining({ + [ALERT_SUPPRESSION_TERMS]: [ + { + field: 'agent.name', + value: 'agent-1', + }, + ], + [ALERT_ORIGINAL_TIME]: secondTimestamp, + [ALERT_SUPPRESSION_DOCS_COUNT]: 0, + }) + ); + }); + it('should generate an alert per rule run when duration is less than rule interval', async () => { const id = uuidv4(); const timestamp = '2020-10-28T05:45:00.000Z'; diff --git a/x-pack/test/security_solution_api_integration/test_suites/entity_analytics/risk_engine/trial_license_complete_tier/telemetry_usage.ts b/x-pack/test/security_solution_api_integration/test_suites/entity_analytics/risk_engine/trial_license_complete_tier/telemetry_usage.ts index 3eca71c37dab5..6b45ab7a18427 100644 --- a/x-pack/test/security_solution_api_integration/test_suites/entity_analytics/risk_engine/trial_license_complete_tier/telemetry_usage.ts +++ b/x-pack/test/security_solution_api_integration/test_suites/entity_analytics/risk_engine/trial_license_complete_tier/telemetry_usage.ts @@ -100,10 +100,10 @@ export default ({ getService }: FtrProviderContext) => { ...otherStats } = await getRiskEngineStats(supertest, log); const expected = { - unique_host_risk_score_total: 0, - unique_user_risk_score_total: 0, - unique_user_risk_score_day: 0, - unique_host_risk_score_day: 0, + unique_host_risk_score_total: 10, + unique_user_risk_score_total: 10, + unique_user_risk_score_day: 10, + unique_host_risk_score_day: 10, all_user_risk_scores_total: 10, all_host_risk_scores_total: 10, all_user_risk_scores_total_day: 10, diff --git a/x-pack/test/security_solution_cypress/cypress/e2e/entity_analytics/dashboards/upgrade_risk_score.cy.ts b/x-pack/test/security_solution_cypress/cypress/e2e/entity_analytics/dashboards/upgrade_risk_score.cy.ts index 5fa97ed2f90f9..518980c29c908 100644 --- a/x-pack/test/security_solution_cypress/cypress/e2e/entity_analytics/dashboards/upgrade_risk_score.cy.ts +++ b/x-pack/test/security_solution_cypress/cypress/e2e/entity_analytics/dashboards/upgrade_risk_score.cy.ts @@ -35,7 +35,8 @@ import { deleteRiskEngineConfiguration } from '../../../tasks/api_calls/risk_eng const spaceId = 'default'; -describe('Upgrade risk scores', { tags: ['@ess'] }, () => { +// Failing: See https://github.com/elastic/kibana/issues/185024 +describe.skip('Upgrade risk scores', { tags: ['@ess'] }, () => { beforeEach(() => { login(); deleteRiskEngineConfiguration(); diff --git a/x-pack/test/security_solution_cypress/cypress/e2e/investigations/alerts/detection_page_filters.cy.ts b/x-pack/test/security_solution_cypress/cypress/e2e/investigations/alerts/detection_page_filters.cy.ts index ce95eed9c6671..142ae6efbd439 100644 --- a/x-pack/test/security_solution_cypress/cypress/e2e/investigations/alerts/detection_page_filters.cy.ts +++ b/x-pack/test/security_solution_cypress/cypress/e2e/investigations/alerts/detection_page_filters.cy.ts @@ -105,7 +105,8 @@ const assertFilterControlsWithFilterObject = ( }); }; -describe(`Detections : Page Filters`, { tags: ['@ess', '@serverless'] }, () => { +// FLAKY: https://github.com/elastic/kibana/issues/167914 +describe.skip(`Detections : Page Filters`, { tags: ['@ess', '@serverless'] }, () => { beforeEach(() => { deleteAlertsAndRules(); createRule(getNewRule()); diff --git a/x-pack/test_serverless/api_integration/services/slo_api.ts b/x-pack/test_serverless/api_integration/services/slo_api.ts index 7312905589cb7..96b7f9e518f31 100644 --- a/x-pack/test_serverless/api_integration/services/slo_api.ts +++ b/x-pack/test_serverless/api_integration/services/slo_api.ts @@ -10,6 +10,7 @@ import { FetchHistoricalSummaryResponse, } from '@kbn/slo-schema'; import * as t from 'io-ts'; +import type { RoleCredentials } from '../../shared/services'; import { FtrProviderContext } from '../ftr_provider_context'; type DurationUnit = 'm' | 'h' | 'd' | 'w' | 'M'; @@ -70,50 +71,58 @@ type FetchHistoricalSummaryParams = t.OutputOf< export function SloApiProvider({ getService }: FtrProviderContext) { const es = getService('es'); const supertest = getService('supertest'); + const svlCommonApi = getService('svlCommonApi'); const retry = getService('retry'); const requestTimeout = 30 * 1000; const retryTimeout = 180 * 1000; return { - async create(slo: SloParams) { + async create(slo: SloParams, roleAuthc: RoleCredentials) { const { body } = await supertest .post(`/api/observability/slos`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo') + .set(svlCommonApi.getInternalRequestHeader()) + .set(roleAuthc.apiKeyHeader) .send(slo); return body; }, - async delete(sloId: string) { + async delete({ sloId, roleAuthc }: { sloId: string; roleAuthc: RoleCredentials }) { const response = await supertest .delete(`/api/observability/slos/${sloId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + .set(svlCommonApi.getInternalRequestHeader()) + .set(roleAuthc.apiKeyHeader); return response; }, async fetchHistoricalSummary( - params: FetchHistoricalSummaryParams + params: FetchHistoricalSummaryParams, + roleAuthc: RoleCredentials ): Promise { const { body } = await supertest .post(`/internal/observability/slos/_historical_summary`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo') + .set(svlCommonApi.getInternalRequestHeader()) + .set(roleAuthc.apiKeyHeader) .send(params); return body; }, - async waitForSloToBeDeleted(sloId: string) { + async waitForSloToBeDeleted({ + sloId, + roleAuthc, + }: { + sloId: string; + roleAuthc: RoleCredentials; + }) { if (!sloId) { throw new Error(`sloId is undefined`); } return await retry.tryForTime(retryTimeout, async () => { const response = await supertest .delete(`/api/observability/slos/${sloId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo') + .set(svlCommonApi.getInternalRequestHeader()) + .set(roleAuthc.apiKeyHeader) .timeout(requestTimeout); if (!response.ok) { throw new Error(`slodId [${sloId}] was not deleted`); @@ -122,15 +131,15 @@ export function SloApiProvider({ getService }: FtrProviderContext) { }); }, - async waitForSloCreated({ sloId }: { sloId: string }) { + async waitForSloCreated({ sloId, roleAuthc }: { sloId: string; roleAuthc: RoleCredentials }) { if (!sloId) { throw new Error(`'sloId is undefined`); } return await retry.tryForTime(retryTimeout, async () => { const response = await supertest .get(`/api/observability/slos/${sloId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo') + .set(svlCommonApi.getInternalRequestHeader()) + .set(roleAuthc.apiKeyHeader) .timeout(requestTimeout); if (response.body.id === undefined) { throw new Error(`No slo with id ${sloId} found`); @@ -187,16 +196,14 @@ export function SloApiProvider({ getService }: FtrProviderContext) { async deleteAllSLOs() { const response = await supertest .get(`/api/observability/slos/_definitions`) - .set('kbn-xsrf', 'true') - .set('x-elastic-internal-origin', 'foo') + .set(svlCommonApi.getInternalRequestHeader()) .send() .expect(200); await Promise.all( response.body.results.map(({ id }: { id: string }) => { return supertest .delete(`/api/observability/slos/${id}`) - .set('kbn-xsrf', 'true') - .set('x-elastic-internal-origin', 'foo') + .set(svlCommonApi.getInternalRequestHeader()) .send() .expect(204); }) diff --git a/x-pack/test_serverless/api_integration/services/svl_cases/api.ts b/x-pack/test_serverless/api_integration/services/svl_cases/api.ts index 7089655551fbe..c01365861c2d3 100644 --- a/x-pack/test_serverless/api_integration/services/svl_cases/api.ts +++ b/x-pack/test_serverless/api_integration/services/svl_cases/api.ts @@ -5,13 +5,13 @@ * 2.0. */ -import type SuperTest from 'supertest'; import { CASES_URL } from '@kbn/cases-plugin/common'; import { Case, CaseSeverity, CaseStatuses } from '@kbn/cases-plugin/common/types/domain'; import type { CasePostRequest } from '@kbn/cases-plugin/common/types/api'; import { ConnectorTypes } from '@kbn/cases-plugin/common/types/domain'; import { CasesFindResponse } from '@kbn/cases-plugin/common/types/api'; import { kbnTestConfig, kibanaTestSuperuserServerless } from '@kbn/test'; +import type { RoleCredentials } from '../../../shared/services'; import { FtrProviderContext } from '../../ftr_provider_context'; export interface User { @@ -23,13 +23,8 @@ export interface User { export function SvlCasesApiServiceProvider({ getService }: FtrProviderContext) { const kbnServer = getService('kibanaServer'); - const supertest = getService('supertest'); - - const superUser: User = { - username: 'superuser', - password: 'superuser', - roles: ['superuser'], - }; + const supertestWithoutAuth = getService('supertestWithoutAuth'); + const svlCommonApi = getService('svlCommonApi'); const defaultUser = { email: null, @@ -57,22 +52,6 @@ export function SvlCasesApiServiceProvider({ getService }: FtrProviderContext) { }; return { - setupAuth({ - apiCall, - headers, - auth, - }: { - apiCall: SuperTest.Test; - headers: Record; - auth?: { user: User; space: string | null } | null; - }): SuperTest.Test { - if (!Object.hasOwn(headers, 'Cookie') && auth != null) { - return apiCall.auth(auth.user.username, auth.user.password); - } - - return apiCall; - }, - getSpaceUrlPrefix(spaceId: string | undefined | null) { return spaceId && spaceId !== 'default' ? `/s/${spaceId}` : ``; }, @@ -139,65 +118,65 @@ export function SvlCasesApiServiceProvider({ getService }: FtrProviderContext) { async createCase( params: CasePostRequest, - expectedHttpCode: number = 200, - auth: { user: User; space: string | null } | null = { user: superUser, space: null }, - headers: Record = {} + roleAuthc: RoleCredentials, + expectedHttpCode: number = 200 ): Promise { - const apiCall = supertest.post(`${CASES_URL}`); - - this.setupAuth({ apiCall, headers, auth }); + const apiCall = supertestWithoutAuth.post(`${CASES_URL}`); const response = await apiCall - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo') - .set(headers) + .set(svlCommonApi.getInternalRequestHeader()) + .set(roleAuthc.apiKeyHeader) .send(params) .expect(expectedHttpCode); return response.body; }, - async findCases({ - query = {}, - expectedHttpCode = 200, - auth = { user: superUser, space: null }, - }: { - query?: Record; - expectedHttpCode?: number; - auth?: { user: User; space: string | null }; - }): Promise { - const { body: res } = await supertest - .get(`${this.getSpaceUrlPrefix(auth.space)}${CASES_URL}/_find`) - .auth(auth.user.username, auth.user.password) + async findCases( + { + query = {}, + expectedHttpCode = 200, + space = 'default', + }: { + query?: Record; + expectedHttpCode?: number; + space?: string; + }, + roleAuthc: RoleCredentials + ): Promise { + const { body: res } = await supertestWithoutAuth + .get(`${this.getSpaceUrlPrefix(space)}${CASES_URL}/_find`) + .set(svlCommonApi.getInternalRequestHeader()) + .set(roleAuthc.apiKeyHeader) .query({ sortOrder: 'asc', ...query }) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo') .send() .expect(expectedHttpCode); return res; }, - async getCase({ - caseId, - includeComments = false, - expectedHttpCode = 200, - auth = { user: superUser, space: null }, - }: { - caseId: string; - includeComments?: boolean; - expectedHttpCode?: number; - auth?: { user: User; space: string | null }; - }): Promise { - const { body: theCase } = await supertest + async getCase( + { + caseId, + space = 'default', + includeComments = false, + expectedHttpCode = 200, + }: { + caseId: string; + space?: string; + includeComments?: boolean; + expectedHttpCode?: number; + }, + roleAuthc: RoleCredentials + ): Promise { + const { body: theCase } = await supertestWithoutAuth .get( `${this.getSpaceUrlPrefix( - auth?.space + space )}${CASES_URL}/${caseId}?includeComments=${includeComments}` ) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo') - .auth(auth.user.username, auth.user.password) + .set(svlCommonApi.getInternalRequestHeader()) + .set(roleAuthc.apiKeyHeader) .expect(expectedHttpCode); return theCase; diff --git a/x-pack/test_serverless/api_integration/test_suites/common/alerting/alert_documents.ts b/x-pack/test_serverless/api_integration/test_suites/common/alerting/alert_documents.ts index 26f72d754c4d6..3e0f400d35e78 100644 --- a/x-pack/test_serverless/api_integration/test_suites/common/alerting/alert_documents.ts +++ b/x-pack/test_serverless/api_integration/test_suites/common/alerting/alert_documents.ts @@ -54,7 +54,6 @@ export default function ({ getService }: FtrProviderContext) { let roleAdmin: RoleCredentials; let internalReqHeader: InternalRequestHeader; const supertest = getService('supertest'); - const esClient = getService('es'); const objectRemover = new ObjectRemover(supertest); diff --git a/x-pack/test_serverless/api_integration/test_suites/common/alerting/rules.ts b/x-pack/test_serverless/api_integration/test_suites/common/alerting/rules.ts index 70d8f07cc8b84..5c6120c8bd60f 100644 --- a/x-pack/test_serverless/api_integration/test_suites/common/alerting/rules.ts +++ b/x-pack/test_serverless/api_integration/test_suites/common/alerting/rules.ts @@ -31,7 +31,7 @@ import { waitForExecutionEventLog, waitForNumRuleRuns, } from './helpers/alerting_wait_for_helpers'; -import { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; +import type { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; export default function ({ getService }: FtrProviderContext) { const supertest = getService('supertest'); @@ -60,14 +60,8 @@ export default function ({ getService }: FtrProviderContext) { }); afterEach(async () => { - await supertest - .delete(`/api/actions/connector/${connectorId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); - await supertest - .delete(`/api/alerting/rule/${ruleId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + await supertest.delete(`/api/actions/connector/${connectorId}`).set(internalReqHeader); + await supertest.delete(`/api/alerting/rule/${ruleId}`).set(internalReqHeader); await esClient.deleteByQuery({ index: '.kibana-event-log-*', conflicts: 'proceed', diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/apm_api_integration/common/apm_api_supertest.ts b/x-pack/test_serverless/api_integration/test_suites/observability/apm_api_integration/common/apm_api_supertest.ts index 62db8c2eddda4..1478ba20a007d 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/apm_api_integration/common/apm_api_supertest.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/apm_api_integration/common/apm_api_supertest.ts @@ -14,6 +14,7 @@ import type { import { Config, kbnTestConfig, kibanaTestSuperuserServerless } from '@kbn/test'; import type { APIEndpoint } from '@kbn/apm-plugin/server'; import { formatRequest } from '@kbn/server-route-repository'; +import type { InternalRequestHeader, RoleCredentials } from '../../../../../shared/services'; import { InheritedFtrProviderContext } from '../../../../services'; export function createApmApiClient(st: supertest.Agent) { @@ -21,20 +22,18 @@ export function createApmApiClient(st: supertest.Agent) { options: { type?: 'form-data'; endpoint: TEndpoint; + roleAuthc: RoleCredentials; + internalReqHeader: InternalRequestHeader; } & APIClientRequestParamsOf & { params?: { query?: { _inspect?: boolean } } } ): Promise> => { - const { endpoint, type } = options; + const { endpoint, type, roleAuthc, internalReqHeader } = options; const params = 'params' in options ? (options.params as Record) : {}; const { method, pathname, version } = formatRequest(endpoint, params.path); const url = format({ pathname, query: params?.query }); - const headers: Record = { - 'kbn-xsrf': 'foo', - 'x-elastic-internal-origin': 'foo', - }; - + const headers: Record = { ...internalReqHeader, ...roleAuthc.apiKeyHeader }; if (version) { headers['Elastic-Api-Version'] = version; } diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/apm_api_integration/feature_flags.ts b/x-pack/test_serverless/api_integration/test_suites/observability/apm_api_integration/feature_flags.ts index 279a1e0970b57..9701107994e56 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/apm_api_integration/feature_flags.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/apm_api_integration/feature_flags.ts @@ -6,6 +6,7 @@ */ import expect from 'expect'; +import type { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; import { APMFtrContextProvider } from './common/services'; import { ApmApiClient } from './common/apm_api_supertest'; @@ -49,7 +50,11 @@ const SAMPLE_SOURCEMAP = { mappings: 'A,AAAB;;ABCDE;', }; -async function uploadSourcemap(apmApiClient: ApmApiClient) { +async function uploadSourcemap( + apmApiClient: ApmApiClient, + roleAuthc: RoleCredentials, + internalReqHeader: InternalRequestHeader +) { const response = await apmApiClient.slsUser({ endpoint: 'POST /api/apm/sourcemaps 2023-10-31', type: 'form-data', @@ -61,14 +66,30 @@ async function uploadSourcemap(apmApiClient: ApmApiClient) { sourcemap: JSON.stringify(SAMPLE_SOURCEMAP), }, }, + roleAuthc, + internalReqHeader, }); return response.body; } export default function ({ getService }: APMFtrContextProvider) { const apmApiClient = getService('apmApiClient'); + const svlUserManager = getService('svlUserManager'); + const svlCommonApi = getService('svlCommonApi'); describe('apm feature flags', () => { + let roleAuthc: RoleCredentials; + let internalReqHeader: InternalRequestHeader; + + before(async () => { + internalReqHeader = svlCommonApi.getInternalRequestHeader(); + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + }); + + after(async () => { + await svlUserManager.invalidateApiKeyForRole(roleAuthc); + }); + describe('fleet migrations', () => { it('rejects requests to save apm server schema', async () => { try { @@ -81,6 +102,8 @@ export default function ({ getService }: APMFtrContextProvider) { }, }, }, + roleAuthc, + internalReqHeader, }); } catch (err) { expect(err.res.status).toBe(fleetMigrationResponse.statusCode); @@ -92,6 +115,8 @@ export default function ({ getService }: APMFtrContextProvider) { try { await apmApiClient.slsUser({ endpoint: 'GET /internal/apm/fleet/apm_server_schema/unsupported', + roleAuthc, + internalReqHeader, }); } catch (err) { expect(err.res.status).toBe(fleetMigrationResponse.statusCode); @@ -103,6 +128,8 @@ export default function ({ getService }: APMFtrContextProvider) { try { await apmApiClient.slsUser({ endpoint: 'GET /internal/apm/fleet/migration_check', + roleAuthc, + internalReqHeader, }); } catch (err) { expect(err.res.status).toBe(fleetMigrationResponse.statusCode); @@ -116,6 +143,8 @@ export default function ({ getService }: APMFtrContextProvider) { try { await apmApiClient.slsUser({ endpoint: 'GET /api/apm/settings/agent-configuration 2023-10-31', + roleAuthc, + internalReqHeader, }); } catch (err) { expect(err.res.status).toBe(agentConfigurationResponse.statusCode); @@ -127,6 +156,8 @@ export default function ({ getService }: APMFtrContextProvider) { try { await apmApiClient.slsUser({ endpoint: 'GET /api/apm/settings/agent-configuration/view 2023-10-31', + roleAuthc, + internalReqHeader, }); } catch (err) { expect(err.res.status).toBe(agentConfigurationResponse.statusCode); @@ -143,6 +174,8 @@ export default function ({ getService }: APMFtrContextProvider) { service: {}, }, }, + roleAuthc, + internalReqHeader, }); } catch (err) { expect(err.res.status).toBe(agentConfigurationResponse.statusCode); @@ -160,6 +193,8 @@ export default function ({ getService }: APMFtrContextProvider) { settings: { transaction_sample_rate: '0.55' }, }, }, + roleAuthc, + internalReqHeader, }); } catch (err) { expect(err.res.status).toBe(agentConfigurationResponse.statusCode); @@ -177,6 +212,8 @@ export default function ({ getService }: APMFtrContextProvider) { etag: '7312bdcc34999629a3d39df24ed9b2a7553c0c39', }, }, + roleAuthc, + internalReqHeader, }); } catch (err) { expect(err.res.status).toBe(agentConfigurationResponse.statusCode); @@ -190,6 +227,8 @@ export default function ({ getService }: APMFtrContextProvider) { try { await apmApiClient.slsUser({ endpoint: 'GET /api/apm/sourcemaps 2023-10-31', + roleAuthc, + internalReqHeader, }); } catch (err) { expect(err.res.status).toBe(sourceMapsResponse.statusCode); @@ -199,7 +238,7 @@ export default function ({ getService }: APMFtrContextProvider) { it('rejects requests to upload source maps', async () => { try { - await uploadSourcemap(apmApiClient); + await uploadSourcemap(apmApiClient, roleAuthc, internalReqHeader); } catch (err) { expect(err.res.status).toBe(sourceMapsResponse.statusCode); expect(err.res.body).toStrictEqual(sourceMapsResponse); @@ -211,6 +250,8 @@ export default function ({ getService }: APMFtrContextProvider) { await apmApiClient.slsUser({ endpoint: 'DELETE /api/apm/sourcemaps/{id} 2023-10-31', params: { path: { id: 'foo' } }, + roleAuthc, + internalReqHeader, }); } catch (err) { expect(err.res.status).toBe(sourceMapsResponse.statusCode); diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/burn_rate_rule/burn_rate_rule.ts b/x-pack/test_serverless/api_integration/test_suites/observability/burn_rate_rule/burn_rate_rule.ts index d16169aa77f39..1d5dd1de80a9f 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/burn_rate_rule/burn_rate_rule.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/burn_rate_rule/burn_rate_rule.ts @@ -14,7 +14,7 @@ import { cleanup, Dataset, generate, PartialConfig } from '@kbn/data-forge'; import expect from '@kbn/expect'; import { FtrProviderContext } from '../../../ftr_provider_context'; -import { RoleCredentials } from '../../../../shared/services'; +import { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; export default function ({ getService }: FtrProviderContext) { const esClient = getService('es'); @@ -25,7 +25,9 @@ export default function ({ getService }: FtrProviderContext) { const dataViewApi = getService('dataViewApi'); const sloApi = getService('sloApi'); const svlUserManager = getService('svlUserManager'); + const svlCommonApi = getService('svlCommonApi'); let roleAuthc: RoleCredentials; + let internalReqHeader: InternalRequestHeader; describe('Burn rate rule', () => { const RULE_TYPE_ID = 'slo.rules.burnRate'; @@ -41,6 +43,7 @@ export default function ({ getService }: FtrProviderContext) { before(async () => { roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + internalReqHeader = svlCommonApi.getInternalRequestHeader(); dataForgeConfig = { schedule: [ { @@ -63,17 +66,12 @@ export default function ({ getService }: FtrProviderContext) { id: DATA_VIEW_ID, title: DATA_VIEW, }); + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); }); after(async () => { - await supertest - .delete(`/api/alerting/rule/${ruleId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); - await supertest - .delete(`/api/actions/connector/${actionId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + await supertest.delete(`/api/alerting/rule/${ruleId}`).set(internalReqHeader); + await supertest.delete(`/api/actions/connector/${actionId}`).set(internalReqHeader); await esClient.deleteByQuery({ index: '.kibana-event-log-*', query: { term: { 'rule.id': ruleId } }, @@ -82,10 +80,7 @@ export default function ({ getService }: FtrProviderContext) { await dataViewApi.delete({ id: DATA_VIEW_ID, }); - await supertest - .delete('/api/observability/slos/my-custom-id') - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + await supertest.delete('/api/observability/slos/my-custom-id').set(internalReqHeader); await esDeleteAllIndices([ALERT_ACTION_INDEX, ...dataForgeIndices]); await cleanup({ client: esClient, config: dataForgeConfig, logger }); @@ -100,29 +95,32 @@ export default function ({ getService }: FtrProviderContext) { indexName: ALERT_ACTION_INDEX, }); - await sloApi.create({ - id: 'my-custom-id', - name: 'my custom name', - description: 'my custom description', - indicator: { - type: 'sli.kql.custom', - params: { - index: DATA_VIEW, - good: 'system.cpu.total.norm.pct > 1', - total: 'system.cpu.total.norm.pct: *', - timestampField: '@timestamp', + await sloApi.create( + { + id: 'my-custom-id', + name: 'my custom name', + description: 'my custom description', + indicator: { + type: 'sli.kql.custom', + params: { + index: DATA_VIEW, + good: 'system.cpu.total.norm.pct > 1', + total: 'system.cpu.total.norm.pct: *', + timestampField: '@timestamp', + }, }, + timeWindow: { + duration: '7d', + type: 'rolling', + }, + budgetingMethod: 'occurrences', + objective: { + target: 0.999, + }, + groupBy: '*', }, - timeWindow: { - duration: '7d', - type: 'rolling', - }, - budgetingMethod: 'occurrences', - objective: { - target: 0.999, - }, - groupBy: '*', - }); + roleAuthc + ); const dependencyRule = await alertingApi.createRule({ roleAuthc, diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/cases/find_cases.ts b/x-pack/test_serverless/api_integration/test_suites/observability/cases/find_cases.ts index c28247b3cea0b..e18c8fd55ba7b 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/cases/find_cases.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/cases/find_cases.ts @@ -5,19 +5,28 @@ * 2.0. */ +import { CasePostRequest } from '@kbn/cases-plugin/common/types/api'; import expect from '@kbn/expect'; +import type { RoleCredentials } from '../../../../shared/services'; import { FtrProviderContext } from '../../../ftr_provider_context'; export default ({ getService }: FtrProviderContext): void => { const svlCases = getService('svlCases'); + const svlUserManager = getService('svlUserManager'); let findCasesResp: any; - let postCaseReq: any; + let postCaseReq: CasePostRequest; describe('find_cases', () => { + let roleAuthc: RoleCredentials; before(async () => { findCasesResp = svlCases.api.getFindCasesResp(); postCaseReq = svlCases.api.getPostCaseReq('observability'); + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + }); + + after(async () => { + await svlUserManager.invalidateApiKeyForRole(roleAuthc); }); afterEach(async () => { @@ -25,16 +34,16 @@ export default ({ getService }: FtrProviderContext): void => { }); it('should return empty response', async () => { - const cases = await svlCases.api.findCases({}); + const cases = await svlCases.api.findCases({}, roleAuthc); expect(cases).to.eql(findCasesResp); }); it('should return cases', async () => { - const a = await svlCases.api.createCase(postCaseReq); - const b = await svlCases.api.createCase(postCaseReq); - const c = await svlCases.api.createCase(postCaseReq); + const a = await svlCases.api.createCase(postCaseReq, roleAuthc); + const b = await svlCases.api.createCase(postCaseReq, roleAuthc); + const c = await svlCases.api.createCase(postCaseReq, roleAuthc); - const cases = await svlCases.api.findCases({}); + const cases = await svlCases.api.findCases({}, roleAuthc); expect(cases).to.eql({ ...findCasesResp, @@ -45,14 +54,22 @@ export default ({ getService }: FtrProviderContext): void => { }); it('returns empty response when trying to find cases with owner as cases', async () => { - const cases = await svlCases.api.findCases({ query: { owner: 'cases' } }); + const cases = await svlCases.api.findCases( + { + query: { owner: 'cases' }, + }, + roleAuthc + ); expect(cases).to.eql(findCasesResp); }); it('returns empty response when trying to find cases with owner as securitySolution', async () => { - const cases = await svlCases.api.findCases({ - query: { owner: 'securitySolution' }, - }); + const cases = await svlCases.api.findCases( + { + query: { owner: 'securitySolution' }, + }, + roleAuthc + ); expect(cases).to.eql(findCasesResp); }); }); diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/cases/get_case.ts b/x-pack/test_serverless/api_integration/test_suites/observability/cases/get_case.ts index 30fbe518085cb..717d02715f3ba 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/cases/get_case.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/cases/get_case.ts @@ -6,28 +6,47 @@ */ import expect from '@kbn/expect'; - +import type { RoleCredentials } from '../../../../shared/services'; import { FtrProviderContext } from '../../../ftr_provider_context'; export default ({ getService }: FtrProviderContext): void => { const svlCases = getService('svlCases'); + const svlUserManager = getService('svlUserManager'); describe('get_case', () => { + let roleAuthc: RoleCredentials; + + before(async () => { + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + }); + + after(async () => { + await svlUserManager.invalidateApiKeyForRole(roleAuthc); + }); + afterEach(async () => { await svlCases.api.deleteCases(); }); it('should return a case', async () => { const postedCase = await svlCases.api.createCase( - svlCases.api.getPostCaseRequest('observability') + svlCases.api.getPostCaseRequest('observability'), + roleAuthc ); - const theCase = await svlCases.api.getCase({ - caseId: postedCase.id, - includeComments: true, - }); + const theCase = await svlCases.api.getCase( + { + caseId: postedCase.id, + includeComments: true, + }, + roleAuthc + ); + + const { created_by: createdBy, ...data } = + svlCases.omit.removeServerGeneratedPropertiesFromCase(theCase); + const { created_by: _, ...expectedData } = svlCases.api.postCaseResp('observability'); - const data = svlCases.omit.removeServerGeneratedPropertiesFromCase(theCase); - expect(data).to.eql(svlCases.api.postCaseResp('observability')); + expect(data).to.eql(expectedData); + expect(createdBy).to.have.keys('full_name', 'email', 'username'); expect(data.comments?.length).to.eql(0); }); }); diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/cases/post_case.ts b/x-pack/test_serverless/api_integration/test_suites/observability/cases/post_case.ts index 79f180a5092ff..ccc1d5f79aee2 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/cases/post_case.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/cases/post_case.ts @@ -7,13 +7,24 @@ import expect from '@kbn/expect'; import { ConnectorTypes } from '@kbn/cases-plugin/common/types/domain'; - +import type { RoleCredentials } from '../../../../shared/services'; import { FtrProviderContext } from '../../../ftr_provider_context'; export default ({ getService }: FtrProviderContext): void => { const svlCases = getService('svlCases'); + const svlUserManager = getService('svlUserManager'); describe('post_case', () => { + let roleAuthc: RoleCredentials; + + before(async () => { + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + }); + + after(async () => { + await svlUserManager.invalidateApiKeyForRole(roleAuthc); + }); + afterEach(async () => { await svlCases.api.deleteCases(); }); @@ -29,6 +40,7 @@ export default ({ getService }: FtrProviderContext): void => { fields: { issueType: 'Task', priority: 'High', parent: null }, }, }), + roleAuthc, 200 ) ); @@ -40,6 +52,7 @@ export default ({ getService }: FtrProviderContext): void => { svlCases.api.getPostCaseRequest('observability', { owner: 'securitySolution', }), + roleAuthc, 403 ) ); @@ -51,6 +64,7 @@ export default ({ getService }: FtrProviderContext): void => { svlCases.api.getPostCaseRequest('observability', { owner: 'cases', }), + roleAuthc, 403 ) ); diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/avg_pct_fired.ts b/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/avg_pct_fired.ts index 4a1e97c83cb27..e0f207ef2ee94 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/avg_pct_fired.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/avg_pct_fired.ts @@ -13,10 +13,11 @@ import { OBSERVABILITY_THRESHOLD_RULE_TYPE_ID } from '@kbn/rule-data-utils'; import { parseSearchParams } from '@kbn/share-plugin/common/url_service'; import { omit } from 'lodash'; import { COMPARATORS } from '@kbn/alerting-comparators'; +import { kbnTestConfig } from '@kbn/test'; import { FtrProviderContext } from '../../../ftr_provider_context'; import { ISO_DATE_REGEX } from './constants'; import { ActionDocument, LogsExplorerLocatorParsedParams } from './typings'; -import { RoleCredentials } from '../../../../shared/services'; +import type { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; export default function ({ getService }: FtrProviderContext) { const esClient = getService('es'); @@ -25,8 +26,10 @@ export default function ({ getService }: FtrProviderContext) { const alertingApi = getService('alertingApi'); const dataViewApi = getService('dataViewApi'); const logger = getService('log'); + const svlCommonApi = getService('svlCommonApi'); const svlUserManager = getService('svlUserManager'); let roleAuthc: RoleCredentials; + let internalReqHeader: InternalRequestHeader; describe('Custom Threshold rule - AVG - PCT - FIRED', () => { const CUSTOM_THRESHOLD_RULE_ALERT_INDEX = '.alerts-observability.threshold.alerts-default'; @@ -42,6 +45,7 @@ export default function ({ getService }: FtrProviderContext) { before(async () => { roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + internalReqHeader = svlCommonApi.getInternalRequestHeader(); dataForgeConfig = { schedule: [ { @@ -71,14 +75,8 @@ export default function ({ getService }: FtrProviderContext) { }); after(async () => { - await supertest - .delete(`/api/alerting/rule/${ruleId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); - await supertest - .delete(`/api/actions/connector/${actionId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + await supertest.delete(`/api/alerting/rule/${ruleId}`).set(internalReqHeader); + await supertest.delete(`/api/actions/connector/${actionId}`).set(internalReqHeader); await esClient.deleteByQuery({ index: CUSTOM_THRESHOLD_RULE_ALERT_INDEX, query: { term: { 'kibana.alert.rule.uuid': ruleId } }, @@ -234,9 +232,10 @@ export default function ({ getService }: FtrProviderContext) { docCountTarget: 1, }); + const { protocol, hostname, port } = kbnTestConfig.getUrlParts(); expect(resp.hits.hits[0]._source?.ruleType).eql('observability.rules.custom_threshold'); expect(resp.hits.hits[0]._source?.alertDetailsUrl).eql( - `http://localhost:5620/app/observability/alerts/${alertId}` + `${protocol}://${hostname}${port ? `:${port}` : ''}/app/observability/alerts/${alertId}` ); expect(resp.hits.hits[0]._source?.reason).eql( `Average system.cpu.user.pct is 250%, above the threshold of 50%. (duration: 5 mins, data view: ${DATA_VIEW_NAME})` diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/avg_pct_no_data.ts b/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/avg_pct_no_data.ts index 333c34f68ab4d..90d6c5f29f799 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/avg_pct_no_data.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/avg_pct_no_data.ts @@ -12,10 +12,11 @@ import { OBSERVABILITY_THRESHOLD_RULE_TYPE_ID } from '@kbn/rule-data-utils'; import { parseSearchParams } from '@kbn/share-plugin/common/url_service'; import { omit } from 'lodash'; import { COMPARATORS } from '@kbn/alerting-comparators'; +import { kbnTestConfig } from '@kbn/test'; import { FtrProviderContext } from '../../../ftr_provider_context'; import { ISO_DATE_REGEX } from './constants'; import { ActionDocument, LogsExplorerLocatorParsedParams } from './typings'; -import { RoleCredentials } from '../../../../shared/services'; +import type { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; export default function ({ getService }: FtrProviderContext) { const esClient = getService('es'); @@ -24,7 +25,9 @@ export default function ({ getService }: FtrProviderContext) { const dataViewApi = getService('dataViewApi'); const esDeleteAllIndices = getService('esDeleteAllIndices'); const svlUserManager = getService('svlUserManager'); + const svlCommonApi = getService('svlCommonApi'); let roleAuthc: RoleCredentials; + let internalReqHeader: InternalRequestHeader; describe('Custom Threshold rule - AVG - PCT - NoData', () => { const CUSTOM_THRESHOLD_RULE_ALERT_INDEX = '.alerts-observability.threshold.alerts-default'; @@ -38,6 +41,7 @@ export default function ({ getService }: FtrProviderContext) { before(async () => { roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + internalReqHeader = svlCommonApi.getInternalRequestHeader(); await dataViewApi.create({ name: DATA_VIEW_NAME, id: DATA_VIEW_ID, @@ -46,14 +50,8 @@ export default function ({ getService }: FtrProviderContext) { }); after(async () => { - await supertest - .delete(`/api/alerting/rule/${ruleId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); - await supertest - .delete(`/api/actions/connector/${actionId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + await supertest.delete(`/api/alerting/rule/${ruleId}`).set(internalReqHeader); + await supertest.delete(`/api/actions/connector/${actionId}`).set(internalReqHeader); await esClient.deleteByQuery({ index: CUSTOM_THRESHOLD_RULE_ALERT_INDEX, query: { term: { 'kibana.alert.rule.uuid': ruleId } }, @@ -210,9 +208,10 @@ export default function ({ getService }: FtrProviderContext) { docCountTarget: 1, }); + const { protocol, hostname, port } = kbnTestConfig.getUrlParts(); expect(resp.hits.hits[0]._source?.ruleType).eql('observability.rules.custom_threshold'); expect(resp.hits.hits[0]._source?.alertDetailsUrl).eql( - `http://localhost:5620/app/observability/alerts/${alertId}` + `${protocol}://${hostname}${port ? `:${port}` : ''}/app/observability/alerts/${alertId}` ); expect(resp.hits.hits[0]._source?.reason).eql( 'Average system.cpu.user.pct reported no data in the last 5m' diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/custom_eq_avg_bytes_fired.ts b/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/custom_eq_avg_bytes_fired.ts index 1fc2bab9afa40..53f39bdec4319 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/custom_eq_avg_bytes_fired.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/custom_eq_avg_bytes_fired.ts @@ -17,7 +17,8 @@ import { COMPARATORS } from '@kbn/alerting-comparators'; import { FIRED_ACTIONS_ID } from '@kbn/observability-plugin/server/lib/rules/custom_threshold/constants'; import expect from '@kbn/expect'; import { OBSERVABILITY_THRESHOLD_RULE_TYPE_ID } from '@kbn/rule-data-utils'; -import { RoleCredentials } from '../../../../shared/services'; +import { kbnTestConfig } from '@kbn/test'; +import type { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; import { FtrProviderContext } from '../../../ftr_provider_context'; import { ActionDocument } from './typings'; @@ -29,7 +30,9 @@ export default function ({ getService }: FtrProviderContext) { const alertingApi = getService('alertingApi'); const dataViewApi = getService('dataViewApi'); const svlUserManager = getService('svlUserManager'); + const svlCommonApi = getService('svlCommonApi'); let roleAuthc: RoleCredentials; + let internalReqHeader: InternalRequestHeader; describe('Custom Threshold rule - CUSTOM_EQ - AVG - BYTES - FIRED', () => { const CUSTOM_THRESHOLD_RULE_ALERT_INDEX = '.alerts-observability.threshold.alerts-default'; @@ -44,6 +47,7 @@ export default function ({ getService }: FtrProviderContext) { before(async () => { roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + internalReqHeader = svlCommonApi.getInternalRequestHeader(); dataForgeConfig = { schedule: [ { @@ -74,14 +78,8 @@ export default function ({ getService }: FtrProviderContext) { }); after(async () => { - await supertest - .delete(`/api/alerting/rule/${ruleId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); - await supertest - .delete(`/api/actions/connector/${actionId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + await supertest.delete(`/api/alerting/rule/${ruleId}`).set(internalReqHeader); + await supertest.delete(`/api/actions/connector/${actionId}`).set(internalReqHeader); await esClient.deleteByQuery({ index: CUSTOM_THRESHOLD_RULE_ALERT_INDEX, query: { term: { 'kibana.alert.rule.uuid': ruleId } }, @@ -241,9 +239,10 @@ export default function ({ getService }: FtrProviderContext) { docCountTarget: 1, }); + const { protocol, hostname, port } = kbnTestConfig.getUrlParts(); expect(resp.hits.hits[0]._source?.ruleType).eql('observability.rules.custom_threshold'); expect(resp.hits.hits[0]._source?.alertDetailsUrl).eql( - `http://localhost:5620/app/observability/alerts/${alertId}` + `${protocol}://${hostname}${port ? `:${port}` : ''}/app/observability/alerts/${alertId}` ); expect(resp.hits.hits[0]._source?.reason).eql( `Custom equation is 1 B, above the threshold of 0.9 B. (duration: 1 min, data view: ${DATA_VIEW})` diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/documents_count_fired.ts b/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/documents_count_fired.ts index 84f1d74527fdf..de32e95f1a939 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/documents_count_fired.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/documents_count_fired.ts @@ -13,10 +13,11 @@ import { OBSERVABILITY_THRESHOLD_RULE_TYPE_ID } from '@kbn/rule-data-utils'; import { parseSearchParams } from '@kbn/share-plugin/common/url_service'; import { omit } from 'lodash'; import { COMPARATORS } from '@kbn/alerting-comparators'; +import { kbnTestConfig } from '@kbn/test'; import { FtrProviderContext } from '../../../ftr_provider_context'; import { ISO_DATE_REGEX } from './constants'; import { ActionDocument, LogsExplorerLocatorParsedParams } from './typings'; -import { RoleCredentials } from '../../../../shared/services'; +import type { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; export default function ({ getService }: FtrProviderContext) { const esClient = getService('es'); @@ -26,7 +27,9 @@ export default function ({ getService }: FtrProviderContext) { const alertingApi = getService('alertingApi'); const dataViewApi = getService('dataViewApi'); const svlUserManager = getService('svlUserManager'); + const svlCommonApi = getService('svlCommonApi'); let roleAuthc: RoleCredentials; + let internalReqHeader: InternalRequestHeader; describe('Custom Threshold rule - DOCUMENTS_COUNT - FIRED', () => { const CUSTOM_THRESHOLD_RULE_ALERT_INDEX = '.alerts-observability.threshold.alerts-default'; @@ -42,6 +45,7 @@ export default function ({ getService }: FtrProviderContext) { before(async () => { roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + internalReqHeader = svlCommonApi.getInternalRequestHeader(); dataForgeConfig = { schedule: [ { @@ -75,14 +79,8 @@ export default function ({ getService }: FtrProviderContext) { }); after(async () => { - await supertest - .delete(`/api/alerting/rule/${ruleId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); - await supertest - .delete(`/api/actions/connector/${actionId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + await supertest.delete(`/api/alerting/rule/${ruleId}`).set(internalReqHeader); + await supertest.delete(`/api/actions/connector/${actionId}`).set(internalReqHeader); await esClient.deleteByQuery({ index: CUSTOM_THRESHOLD_RULE_ALERT_INDEX, query: { term: { 'kibana.alert.rule.uuid': ruleId } }, @@ -239,9 +237,11 @@ export default function ({ getService }: FtrProviderContext) { docCountTarget: 1, }); + const { protocol, hostname, port } = kbnTestConfig.getUrlParts(); + expect(resp.hits.hits[0]._source?.ruleType).eql('observability.rules.custom_threshold'); expect(resp.hits.hits[0]._source?.alertDetailsUrl).eql( - `http://localhost:5620/app/observability/alerts/${alertId}` + `${protocol}://${hostname}${port ? `:${port}` : ''}/app/observability/alerts/${alertId}` ); expect(resp.hits.hits[0]._source?.reason).eql( diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/group_by_fired.ts b/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/group_by_fired.ts index 59c9e393df956..7caf393c3dbd3 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/group_by_fired.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/group_by_fired.ts @@ -20,7 +20,7 @@ import { OBSERVABILITY_THRESHOLD_RULE_TYPE_ID } from '@kbn/rule-data-utils'; import { COMPARATORS } from '@kbn/alerting-comparators'; import { FtrProviderContext } from '../../../ftr_provider_context'; import { ActionDocument } from './typings'; -import { RoleCredentials } from '../../../../shared/services'; +import type { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; export default function ({ getService }: FtrProviderContext) { const esClient = getService('es'); @@ -29,9 +29,11 @@ export default function ({ getService }: FtrProviderContext) { const logger = getService('log'); const alertingApi = getService('alertingApi'); const dataViewApi = getService('dataViewApi'); - let alertId: string; const svlUserManager = getService('svlUserManager'); + const svlCommonApi = getService('svlCommonApi'); + let alertId: string; let roleAuthc: RoleCredentials; + let internalReqHeader: InternalRequestHeader; describe('Custom Threshold rule - GROUP_BY - FIRED', () => { const CUSTOM_THRESHOLD_RULE_ALERT_INDEX = '.alerts-observability.threshold.alerts-default'; @@ -45,6 +47,7 @@ export default function ({ getService }: FtrProviderContext) { before(async () => { roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + internalReqHeader = svlCommonApi.getInternalRequestHeader(); dataForgeConfig = { schedule: [ { @@ -75,14 +78,8 @@ export default function ({ getService }: FtrProviderContext) { }); after(async () => { - await supertest - .delete(`/api/alerting/rule/${ruleId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); - await supertest - .delete(`/api/actions/connector/${actionId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + await supertest.delete(`/api/alerting/rule/${ruleId}`).set(internalReqHeader); + await supertest.delete(`/api/actions/connector/${actionId}`).set(internalReqHeader); await esClient.deleteByQuery({ index: CUSTOM_THRESHOLD_RULE_ALERT_INDEX, query: { term: { 'kibana.alert.rule.uuid': ruleId } }, @@ -123,7 +120,11 @@ export default function ({ getService }: FtrProviderContext) { timeSize: 1, timeUnit: 'm', metrics: [ - { name: 'A', field: 'system.cpu.total.norm.pct', aggType: Aggregators.AVERAGE }, + { + name: 'A', + field: 'system.cpu.total.norm.pct', + aggType: Aggregators.AVERAGE, + }, ], }, ], @@ -265,7 +266,7 @@ export default function ({ getService }: FtrProviderContext) { expect(resp.hits.hits[0]._source?.ruleType).eql('observability.rules.custom_threshold'); expect(resp.hits.hits[0]._source?.alertDetailsUrl).eql( - `${protocol}://${hostname}:${port}/app/observability/alerts/${alertId}` + `${protocol}://${hostname}${port ? `:${port}` : ''}/app/observability/alerts/${alertId}` ); expect(resp.hits.hits[0]._source?.reason).eql( `Average system.cpu.total.norm.pct is 80%, above or equal the threshold of 20%. (duration: 1 min, data view: ${DATA_VIEW}, group: host-0,container-0)` diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/p99_pct_fired.ts b/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/p99_pct_fired.ts index aa00aa6a7b0a6..461654677ef13 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/p99_pct_fired.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/custom_threshold_rule/p99_pct_fired.ts @@ -13,10 +13,11 @@ import { OBSERVABILITY_THRESHOLD_RULE_TYPE_ID } from '@kbn/rule-data-utils'; import { parseSearchParams } from '@kbn/share-plugin/common/url_service'; import { omit } from 'lodash'; import { COMPARATORS } from '@kbn/alerting-comparators'; +import { kbnTestConfig } from '@kbn/test'; import { FtrProviderContext } from '../../../ftr_provider_context'; import { ISO_DATE_REGEX } from './constants'; import { ActionDocument, LogsExplorerLocatorParsedParams } from './typings'; -import { RoleCredentials } from '../../../../shared/services'; +import type { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; export default function ({ getService }: FtrProviderContext) { const esClient = getService('es'); @@ -25,7 +26,9 @@ export default function ({ getService }: FtrProviderContext) { const alertingApi = getService('alertingApi'); const logger = getService('log'); const svlUserManager = getService('svlUserManager'); + const svlCommonApi = getService('svlCommonApi'); let roleAuthc: RoleCredentials; + let internalReqHeader: InternalRequestHeader; describe('Custom Threshold rule - P99 - PCT - FIRED', () => { const CUSTOM_THRESHOLD_RULE_ALERT_INDEX = '.alerts-observability.threshold.alerts-default'; @@ -52,6 +55,7 @@ export default function ({ getService }: FtrProviderContext) { before(async () => { roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + internalReqHeader = svlCommonApi.getInternalRequestHeader(); dataForgeConfig = { schedule: [ { @@ -77,14 +81,8 @@ export default function ({ getService }: FtrProviderContext) { }); after(async () => { - await supertest - .delete(`/api/alerting/rule/${ruleId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); - await supertest - .delete(`/api/actions/connector/${actionId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + await supertest.delete(`/api/alerting/rule/${ruleId}`).set(internalReqHeader); + await supertest.delete(`/api/actions/connector/${actionId}`).set(internalReqHeader); await esClient.deleteByQuery({ index: CUSTOM_THRESHOLD_RULE_ALERT_INDEX, query: { term: { 'kibana.alert.rule.uuid': ruleId } }, @@ -238,9 +236,10 @@ export default function ({ getService }: FtrProviderContext) { docCountTarget: 1, }); + const { protocol, hostname, port } = kbnTestConfig.getUrlParts(); expect(resp.hits.hits[0]._source?.ruleType).eql('observability.rules.custom_threshold'); expect(resp.hits.hits[0]._source?.alertDetailsUrl).eql( - `http://localhost:5620/app/observability/alerts/${alertId}` + `${protocol}://${hostname}${port ? `:${port}` : ''}/app/observability/alerts/${alertId}` ); expect(resp.hits.hits[0]._source?.reason).eql( `99th percentile of system.cpu.user.pct is 250%, above the threshold of 50%. (duration: 5 mins, data view: ${DATA_VIEW_NAME})` diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/dataset_quality_api_integration/common/dataset_quality_api_supertest.ts b/x-pack/test_serverless/api_integration/test_suites/observability/dataset_quality_api_integration/common/dataset_quality_api_supertest.ts index f1d746b49ff06..83aec6feb343d 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/dataset_quality_api_integration/common/dataset_quality_api_supertest.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/dataset_quality_api_integration/common/dataset_quality_api_supertest.ts @@ -11,6 +11,7 @@ import type { APIClientRequestParamsOf, APIReturnType } from '@kbn/dataset-quali import { Config, kbnTestConfig, kibanaTestSuperuserServerless } from '@kbn/test'; import type { APIEndpoint } from '@kbn/dataset-quality-plugin/server/routes'; import { formatRequest } from '@kbn/server-route-repository'; +import { InternalRequestHeader, RoleCredentials } from '../../../../../shared/services'; import { InheritedFtrProviderContext } from '../../../../services'; export function createDatasetQualityApiClient(st: supertest.Agent) { @@ -18,20 +19,18 @@ export function createDatasetQualityApiClient(st: supertest.Agent) { options: { type?: 'form-data'; endpoint: TEndpoint; + roleAuthc: RoleCredentials; + internalReqHeader: InternalRequestHeader; } & APIClientRequestParamsOf & { params?: { query?: { _inspect?: boolean } } } ): Promise> => { - const { endpoint, type } = options; + const { endpoint, type, internalReqHeader, roleAuthc } = options; const params = 'params' in options ? (options.params as Record) : {}; const { method, pathname, version } = formatRequest(endpoint, params.path); const url = format({ pathname, query: params?.query }); - const headers: Record = { - 'kbn-xsrf': 'foo', - 'x-elastic-internal-origin': 'foo', - }; - + const headers: Record = { ...internalReqHeader, ...roleAuthc.apiKeyHeader }; if (version) { headers['Elastic-Api-Version'] = version; } diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/dataset_quality_api_integration/data_stream_details.ts b/x-pack/test_serverless/api_integration/test_suites/observability/dataset_quality_api_integration/data_stream_details.ts index 1a4db10f140dc..563e3d53afd69 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/dataset_quality_api_integration/data_stream_details.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/dataset_quality_api_integration/data_stream_details.ts @@ -7,6 +7,7 @@ import { log, timerange } from '@kbn/apm-synthtrace-client'; import expect from '@kbn/expect'; +import type { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; import { expectToReject } from './utils'; import { DatasetQualityApiClient, @@ -17,6 +18,8 @@ import { DatasetQualityFtrContextProvider } from './common/services'; export default function ({ getService }: DatasetQualityFtrContextProvider) { const datasetQualityApiClient: DatasetQualityApiClient = getService('datasetQualityApiClient'); const synthtrace = getService('logSynthtraceEsClient'); + const svlUserManager = getService('svlUserManager'); + const svlCommonApi = getService('svlCommonApi'); const start = '2023-12-11T18:00:00.000Z'; const end = '2023-12-11T18:01:00.000Z'; const type = 'logs'; @@ -25,7 +28,11 @@ export default function ({ getService }: DatasetQualityFtrContextProvider) { const serviceName = 'my-service'; const hostName = 'synth-host'; - async function callApi(dataStream: string) { + async function callApi( + dataStream: string, + roleAuthc: RoleCredentials, + internalReqHeader: InternalRequestHeader + ) { return await datasetQualityApiClient.slsUser({ endpoint: 'GET /internal/dataset_quality/data_streams/{dataStream}/details', params: { @@ -37,12 +44,19 @@ export default function ({ getService }: DatasetQualityFtrContextProvider) { end, }, }, + roleAuthc, + internalReqHeader, }); } describe('gets the data stream details', () => { + let roleAuthc: RoleCredentials; + let internalReqHeader: InternalRequestHeader; + before(async () => { - await synthtrace.index([ + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + internalReqHeader = svlCommonApi.getInternalRequestHeader(); + return synthtrace.index([ timerange(start, end) .interval('1m') .rate(1) @@ -61,11 +75,14 @@ export default function ({ getService }: DatasetQualityFtrContextProvider) { ), ]); }); + after(async () => { + await svlUserManager.invalidateApiKeyForRole(roleAuthc); + }); it('returns error when dataStream param is not provided', async () => { const expectedMessage = 'Data Stream name cannot be empty'; const err = await expectToReject(() => - callApi(encodeURIComponent(' ')) + callApi(encodeURIComponent(' '), roleAuthc, internalReqHeader) ); expect(err.res.status).to.be(400); expect(err.res.body.message.indexOf(expectedMessage)).to.greaterThan(-1); @@ -74,17 +91,17 @@ export default function ({ getService }: DatasetQualityFtrContextProvider) { it('returns {} if matching data stream is not available', async () => { const nonExistentDataSet = 'Non-existent'; const nonExistentDataStream = `${type}-${nonExistentDataSet}-${namespace}`; - const resp = await callApi(nonExistentDataStream); + const resp = await callApi(nonExistentDataStream, roleAuthc, internalReqHeader); expect(resp.body).empty(); }); it('returns "sizeBytes" as null in serverless', async () => { - const resp = await callApi(`${type}-${dataset}-${namespace}`); + const resp = await callApi(`${type}-${dataset}-${namespace}`, roleAuthc, internalReqHeader); expect(resp.body.sizeBytes).to.be(null); }); it('returns service.name and host.name correctly', async () => { - const resp = await callApi(`${type}-${dataset}-${namespace}`); + const resp = await callApi(`${type}-${dataset}-${namespace}`, roleAuthc, internalReqHeader); expect(resp.body.services).to.eql({ ['service.name']: [serviceName] }); expect(resp.body.hosts?.['host.name']).to.eql([hostName]); }); diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/dataset_quality_api_integration/data_stream_settings.ts b/x-pack/test_serverless/api_integration/test_suites/observability/dataset_quality_api_integration/data_stream_settings.ts index a0ea813a83931..5c99f690abf8e 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/dataset_quality_api_integration/data_stream_settings.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/dataset_quality_api_integration/data_stream_settings.ts @@ -7,6 +7,7 @@ import { log, timerange } from '@kbn/apm-synthtrace-client'; import expect from '@kbn/expect'; +import type { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; import { expectToReject, getDataStreamSettingsOfEarliestIndex, rolloverDataStream } from './utils'; import { DatasetQualityApiClient, @@ -17,6 +18,8 @@ import { DatasetQualityFtrContextProvider } from './common/services'; export default function ({ getService }: DatasetQualityFtrContextProvider) { const datasetQualityApiClient: DatasetQualityApiClient = getService('datasetQualityApiClient'); const synthtrace = getService('logSynthtraceEsClient'); + const svlCommonApi = getService('svlCommonApi'); + const svlUserManager = getService('svlUserManager'); const esClient = getService('es'); const start = '2023-12-11T18:00:00.000Z'; const end = '2023-12-11T18:01:00.000Z'; @@ -26,7 +29,11 @@ export default function ({ getService }: DatasetQualityFtrContextProvider) { const serviceName = 'my-service'; const hostName = 'synth-host'; - async function callApi(dataStream: string) { + async function callApi( + dataStream: string, + roleAuthc: RoleCredentials, + internalReqHeader: InternalRequestHeader + ) { return await datasetQualityApiClient.slsUser({ endpoint: 'GET /internal/dataset_quality/data_streams/{dataStream}/settings', params: { @@ -34,12 +41,18 @@ export default function ({ getService }: DatasetQualityFtrContextProvider) { dataStream, }, }, + roleAuthc, + internalReqHeader, }); } describe('gets the data stream settings', () => { + let roleAuthc: RoleCredentials; + let internalReqHeader: InternalRequestHeader; before(async () => { - await synthtrace.index([ + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + internalReqHeader = svlCommonApi.getInternalRequestHeader(); + return synthtrace.index([ timerange(start, end) .interval('1m') .rate(1) @@ -59,10 +72,14 @@ export default function ({ getService }: DatasetQualityFtrContextProvider) { ]); }); + after(async () => { + await svlUserManager.invalidateApiKeyForRole(roleAuthc); + }); + it('returns error when dataStream param is not provided', async () => { const expectedMessage = 'Data Stream name cannot be empty'; const err = await expectToReject(() => - callApi(encodeURIComponent(' ')) + callApi(encodeURIComponent(' '), roleAuthc, internalReqHeader) ); expect(err.res.status).to.be(400); expect(err.res.body.message.indexOf(expectedMessage)).to.greaterThan(-1); @@ -71,7 +88,7 @@ export default function ({ getService }: DatasetQualityFtrContextProvider) { it('returns {} if matching data stream is not available', async () => { const nonExistentDataSet = 'Non-existent'; const nonExistentDataStream = `${type}-${nonExistentDataSet}-${namespace}`; - const resp = await callApi(nonExistentDataStream); + const resp = await callApi(nonExistentDataStream, roleAuthc, internalReqHeader); expect(resp.body).empty(); }); @@ -80,7 +97,7 @@ export default function ({ getService }: DatasetQualityFtrContextProvider) { esClient, `${type}-${dataset}-${namespace}` ); - const resp = await callApi(`${type}-${dataset}-${namespace}`); + const resp = await callApi(`${type}-${dataset}-${namespace}`, roleAuthc, internalReqHeader); expect(resp.body.createdOn).to.be(Number(dataStreamSettings?.index?.creation_date)); }); @@ -90,7 +107,7 @@ export default function ({ getService }: DatasetQualityFtrContextProvider) { esClient, `${type}-${dataset}-${namespace}` ); - const resp = await callApi(`${type}-${dataset}-${namespace}`); + const resp = await callApi(`${type}-${dataset}-${namespace}`, roleAuthc, internalReqHeader); expect(resp.body.createdOn).to.be(Number(dataStreamSettings?.index?.creation_date)); }); diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/es_query_rule/es_query_rule.ts b/x-pack/test_serverless/api_integration/test_suites/observability/es_query_rule/es_query_rule.ts index b473f62c4f108..c7afd2ff5a165 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/es_query_rule/es_query_rule.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/es_query_rule/es_query_rule.ts @@ -38,14 +38,9 @@ export default function ({ getService }: FtrProviderContext) { }); after(async () => { - await supertest - .delete(`/api/alerting/rule/${ruleId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); - await supertest - .delete(`/api/actions/connector/${actionId}`) - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + await supertest.delete(`/api/alerting/rule/${ruleId}`).set(internalReqHeader); + await supertest.delete(`/api/actions/connector/${actionId}`).set(internalReqHeader); + await esClient.deleteByQuery({ index: '.kibana-event-log-*', query: { term: { 'rule.id': ruleId } }, diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/fleet/fleet.ts b/x-pack/test_serverless/api_integration/test_suites/observability/fleet/fleet.ts index 547d16399bdab..85cd638bdde5b 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/fleet/fleet.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/fleet/fleet.ts @@ -6,6 +6,7 @@ */ import expect from 'expect'; +import type { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; import { FtrProviderContext } from '../../../ftr_provider_context'; import { expectDefaultElasticsearchOutput, @@ -14,24 +15,35 @@ import { export default function (ctx: FtrProviderContext) { const svlCommonApi = ctx.getService('svlCommonApi'); - const supertest = ctx.getService('supertest'); + const svlUserManager = ctx.getService('svlUserManager'); + const supertestWithoutAuth = ctx.getService('supertestWithoutAuth'); describe('fleet', function () { let defaultFleetServerHostUrl: string = ''; let defaultEsOutputUrl: string = ''; + let roleAuthc: RoleCredentials; + let internalReqHeader: InternalRequestHeader; before(async () => { + internalReqHeader = svlCommonApi.getInternalRequestHeader(); defaultFleetServerHostUrl = await expectDefaultFleetServer(ctx); expect(defaultFleetServerHostUrl).not.toBe(''); defaultEsOutputUrl = await expectDefaultElasticsearchOutput(ctx); expect(defaultEsOutputUrl).not.toBe(''); + + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + }); + + after(async () => { + await svlUserManager.invalidateApiKeyForRole(roleAuthc); }); it('rejects request to create a new fleet server hosts if host url is different from default', async () => { - const { body, status } = await supertest + const { body, status } = await supertestWithoutAuth .post('/api/fleet/fleet_server_hosts') - .set(svlCommonApi.getInternalRequestHeader()) + .set(internalReqHeader) + .set(roleAuthc.apiKeyHeader) .send({ name: 'test', host_urls: ['https://localhost:8221'], @@ -47,9 +59,10 @@ export default function (ctx: FtrProviderContext) { }); it('accepts request to create a new fleet server hosts if host url is same as default', async () => { - const { body, status } = await supertest + const { body, status } = await supertestWithoutAuth .post('/api/fleet/fleet_server_hosts') - .set(svlCommonApi.getInternalRequestHeader()) + .set(internalReqHeader) + .set(roleAuthc.apiKeyHeader) .send({ name: 'Test Fleet server host', host_urls: [defaultFleetServerHostUrl], @@ -65,9 +78,10 @@ export default function (ctx: FtrProviderContext) { }); it('rejects request to create a new elasticsearch output if host is different from default', async () => { - const { body, status } = await supertest + const { body, status } = await supertestWithoutAuth .post('/api/fleet/outputs') - .set(svlCommonApi.getInternalRequestHeader()) + .set(internalReqHeader) + .set(roleAuthc.apiKeyHeader) .send({ name: 'Test output', type: 'elasticsearch', @@ -83,9 +97,10 @@ export default function (ctx: FtrProviderContext) { }); it('accepts request to create a new elasticsearch output if host url is same as default', async () => { - const { body, status } = await supertest + const { body, status } = await supertestWithoutAuth .post('/api/fleet/outputs') - .set(svlCommonApi.getInternalRequestHeader()) + .set(internalReqHeader) + .set(roleAuthc.apiKeyHeader) .send({ name: 'Test output', type: 'elasticsearch', diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/infra/infra.ts b/x-pack/test_serverless/api_integration/test_suites/observability/infra/infra.ts index d6fad63b9751b..78b385ba301e1 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/infra/infra.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/infra/infra.ts @@ -10,8 +10,7 @@ import type { GetInfraMetricsRequestBodyPayload, GetInfraMetricsResponsePayload, } from '@kbn/infra-plugin/common/http_api'; - -import { kbnTestConfig, kibanaTestSuperuserServerless } from '@kbn/test'; +import type { RoleCredentials } from '../../../../shared/services'; import type { FtrProviderContext } from '../../../ftr_provider_context'; import { DATES, ARCHIVE_NAME } from './constants'; @@ -23,67 +22,77 @@ const timeRange = { export default function ({ getService }: FtrProviderContext) { const esArchiver = getService('esArchiver'); - const supertest = getService('supertest'); - const username = kbnTestConfig.getUrlParts(kibanaTestSuperuserServerless).username || ''; - const password = kbnTestConfig.getUrlParts(kibanaTestSuperuserServerless).password || ''; + const supertestWithoutAuth = getService('supertestWithoutAuth'); + const svlUserManager = getService('svlUserManager'); + const svlCommonApi = getService('svlCommonApi'); const fetchInfraHosts = async ( - body: GetInfraMetricsRequestBodyPayload + body: GetInfraMetricsRequestBodyPayload, + roleAuthc: RoleCredentials ): Promise => { - const response = await supertest + const response = await supertestWithoutAuth .post('/api/metrics/infra') - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo') - .auth(username, password) + .set(svlCommonApi.getInternalRequestHeader()) + .set(roleAuthc.apiKeyHeader) .send(body) .expect(200); return response.body; }; describe('API /metrics/infra', () => { + let roleAuthc: RoleCredentials; describe('works', () => { describe('with host asset', () => { - before(async () => esArchiver.load(ARCHIVE_NAME)); - after(async () => esArchiver.unload(ARCHIVE_NAME)); + before(async () => { + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + return esArchiver.load(ARCHIVE_NAME); + }); + after(async () => { + await svlUserManager.invalidateApiKeyForRole(roleAuthc); + return esArchiver.unload(ARCHIVE_NAME); + }); it('received data', async () => { - const infraHosts = await fetchInfraHosts({ - type: 'host', - limit: 100, - metrics: [ - { - type: 'rx', - }, - { - type: 'tx', - }, - { - type: 'memory', - }, - { - type: 'cpu', - }, - { - type: 'diskSpaceUsage', - }, - { - type: 'memoryFree', + const infraHosts = await fetchInfraHosts( + { + type: 'host', + limit: 100, + metrics: [ + { + type: 'rx', + }, + { + type: 'tx', + }, + { + type: 'memory', + }, + { + type: 'cpu', + }, + { + type: 'diskSpaceUsage', + }, + { + type: 'memoryFree', + }, + ], + query: { + bool: { + must: [], + filter: [], + should: [], + must_not: [], + }, }, - ], - query: { - bool: { - must: [], - filter: [], - should: [], - must_not: [], + range: { + from: timeRange.from, + to: timeRange.to, }, + sourceId: 'default', }, - range: { - from: timeRange.from, - to: timeRange.to, - }, - sourceId: 'default', - }); + roleAuthc + ); if (infraHosts) { const { nodes } = infraHosts; diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/infra/metadata.ts b/x-pack/test_serverless/api_integration/test_suites/observability/infra/metadata.ts index 4b21967d6460e..b711674ebb95e 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/infra/metadata.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/infra/metadata.ts @@ -10,7 +10,7 @@ import type { InfraMetadata, InfraMetadataRequest, } from '@kbn/infra-plugin/common/http_api/metadata_api'; -import { kbnTestConfig, kibanaTestSuperuserServerless } from '@kbn/test'; +import type { RoleCredentials } from '../../../../shared/services'; import type { FtrProviderContext } from '../../../ftr_provider_context'; import { DATES, ARCHIVE_NAME } from './constants'; @@ -22,34 +22,45 @@ const timeRange = { export default function ({ getService }: FtrProviderContext) { const esArchiver = getService('esArchiver'); - const supertest = getService('supertest'); - const username = kbnTestConfig.getUrlParts(kibanaTestSuperuserServerless).username || ''; - const password = kbnTestConfig.getUrlParts(kibanaTestSuperuserServerless).password || ''; + const supertestWithoutAuth = getService('supertestWithoutAuth'); + const svlUserManager = getService('svlUserManager'); + const svlCommonApi = getService('svlCommonApi'); - const fetchMetadata = async (body: InfraMetadataRequest): Promise => { - const response = await supertest + const fetchMetadata = async ( + body: InfraMetadataRequest, + roleAuthc: RoleCredentials + ): Promise => { + const response = await supertestWithoutAuth .post('/api/infra/metadata') - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo') - .auth(username, password) + .set(svlCommonApi.getInternalRequestHeader()) + .set(roleAuthc.apiKeyHeader) .send(body) .expect(200); return response.body; }; describe('API /infra/metadata', () => { + let roleAuthc: RoleCredentials; describe('works', () => { describe('Host asset type', () => { - before(async () => esArchiver.load(ARCHIVE_NAME)); - after(async () => esArchiver.unload(ARCHIVE_NAME)); - + before(async () => { + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + await esArchiver.load(ARCHIVE_NAME); + }); + after(async () => { + await esArchiver.unload(ARCHIVE_NAME); + await svlUserManager.invalidateApiKeyForRole(roleAuthc); + }); it('with serverless existing host', async () => { - const metadata = await fetchMetadata({ - sourceId: 'default', - nodeId: 'serverless-host', - nodeType: 'host', - timeRange, - }); + const metadata = await fetchMetadata( + { + sourceId: 'default', + nodeId: 'serverless-host', + nodeType: 'host', + timeRange, + }, + roleAuthc + ); if (metadata) { expect(metadata.features.length).to.be(4); diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/infra/processes.ts b/x-pack/test_serverless/api_integration/test_suites/observability/infra/processes.ts index 14e072fb03897..e6f490ec4bfae 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/infra/processes.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/infra/processes.ts @@ -11,27 +11,33 @@ import { ProcessListAPIResponseRT, } from '@kbn/infra-plugin/common/http_api/host_details/process_list'; import { decodeOrThrow } from '@kbn/infra-plugin/common/runtime_types'; -import { kbnTestConfig, kibanaTestSuperuserServerless } from '@kbn/test'; +import type { RoleCredentials } from '../../../../shared/services'; + import type { FtrProviderContext } from '../../../ftr_provider_context'; import { DATES, ARCHIVE_NAME } from './constants'; export default function ({ getService }: FtrProviderContext) { const esArchiver = getService('esArchiver'); - const supertest = getService('supertest'); + const supertestWithoutAuth = getService('supertestWithoutAuth'); + const svlUserManager = getService('svlUserManager'); + const svlCommonApi = getService('svlCommonApi'); describe('API /metrics/process_list', () => { - const username = kbnTestConfig.getUrlParts(kibanaTestSuperuserServerless).username || ''; - const password = kbnTestConfig.getUrlParts(kibanaTestSuperuserServerless).password || ''; - - before(async () => esArchiver.load(ARCHIVE_NAME)); - after(async () => esArchiver.unload(ARCHIVE_NAME)); + let roleAuthc: RoleCredentials; + before(async () => { + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + await esArchiver.load(ARCHIVE_NAME); + }); + after(async () => { + await esArchiver.unload(ARCHIVE_NAME); + await svlUserManager.invalidateApiKeyForRole(roleAuthc); + }); it('works', async () => { - const response = await supertest + const response = await supertestWithoutAuth .post('/api/metrics/process_list') - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo') - .auth(username, password) + .set(svlCommonApi.getInternalRequestHeader()) + .set(roleAuthc.apiKeyHeader) .send( ProcessListAPIRequestRT.encode({ hostTerm: { diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/infra/snapshot.ts b/x-pack/test_serverless/api_integration/test_suites/observability/infra/snapshot.ts index ff6d5a5a4785e..1b3d5ba899b1e 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/infra/snapshot.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/infra/snapshot.ts @@ -10,48 +10,60 @@ import type { SnapshotNodeResponse, SnapshotRequest, } from '@kbn/infra-plugin/common/http_api/snapshot_api'; -import { kbnTestConfig, kibanaTestSuperuserServerless } from '@kbn/test'; +import type { RoleCredentials } from '../../../../shared/services'; import type { FtrProviderContext } from '../../../ftr_provider_context'; import { DATES, ARCHIVE_NAME } from './constants'; export default function ({ getService }: FtrProviderContext) { const esArchiver = getService('esArchiver'); - const supertest = getService('supertest'); + const supertestWithoutAuth = getService('supertestWithoutAuth'); + const svlUserManager = getService('svlUserManager'); + const svlCommonApi = getService('svlCommonApi'); + const fetchSnapshot = async ( - body: SnapshotRequest + body: SnapshotRequest, + roleAuthc: RoleCredentials ): Promise => { - const username = kbnTestConfig.getUrlParts(kibanaTestSuperuserServerless).username || ''; - const password = kbnTestConfig.getUrlParts(kibanaTestSuperuserServerless).password || ''; - const response = await supertest + const response = await supertestWithoutAuth .post('/api/metrics/snapshot') - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo') - .auth(username, password) + .set(svlCommonApi.getInternalRequestHeader()) + .set(roleAuthc.apiKeyHeader) .send(body) .expect(200); return response.body; }; describe('API /metrics/snapshot', () => { + let roleAuthc: RoleCredentials; + describe('Snapshot nodes', () => { const { min, max } = DATES.serverlessTestingHost; - before(async () => esArchiver.load(ARCHIVE_NAME)); - after(async () => esArchiver.unload(ARCHIVE_NAME)); + before(async () => { + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + await esArchiver.load(ARCHIVE_NAME); + }); + after(async () => { + await esArchiver.unload(ARCHIVE_NAME); + await svlUserManager.invalidateApiKeyForRole(roleAuthc); + }); it('should work', async () => { - const snapshot = await fetchSnapshot({ - sourceId: 'default', - timerange: { - to: max, - from: min, - interval: '10m', + const snapshot = await fetchSnapshot( + { + sourceId: 'default', + timerange: { + to: max, + from: min, + interval: '10m', + }, + metrics: [{ type: 'cpu' }], + nodeType: 'host', + groupBy: [], + includeTimeseries: false, }, - metrics: [{ type: 'cpu' }], - nodeType: 'host', - groupBy: [], - includeTimeseries: false, - }); + roleAuthc + ); if (!snapshot) { return; diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/slos/create_slo.ts b/x-pack/test_serverless/api_integration/test_suites/observability/slos/create_slo.ts index d8caf935906d0..02ac42ad6e81a 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/slos/create_slo.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/slos/create_slo.ts @@ -15,6 +15,7 @@ import { getSLOSummaryPipelineId, SLO_SUMMARY_TEMP_INDEX_NAME, } from '@kbn/slo-plugin/common/constants'; +import type { RoleCredentials } from '../../../../shared/services'; import { FtrProviderContext } from '../../../ftr_provider_context'; interface ExpectedTransforms { @@ -50,6 +51,8 @@ export default function ({ getService }: FtrProviderContext) { const sloApi = getService('sloApi'); const kibanaServer = getService('kibanaServer'); const transform = getService('transform'); + const svlUserManager = getService('svlUserManager'); + const svlCommonApi = getService('svlCommonApi'); describe('create_slo', () => { // DATE_VIEW should match the index template: @@ -57,6 +60,7 @@ export default function ({ getService }: FtrProviderContext) { const DATE_VIEW = 'kbn-data-forge-fake_hosts'; const DATA_VIEW_ID = 'data-view-id'; let infraDataIndex: string; + let roleAuthc: RoleCredentials; before(async () => { infraDataIndex = await generate({ @@ -70,6 +74,7 @@ export default function ({ getService }: FtrProviderContext) { title: DATE_VIEW, }); await kibanaServer.savedObjects.cleanStandardList(); + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); }); after(async () => { @@ -78,57 +83,57 @@ export default function ({ getService }: FtrProviderContext) { }); await supertest .delete('/api/observability/slos/my-custom-id1') - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + .set(svlCommonApi.getInternalRequestHeader()); await supertest .delete('/api/observability/slos/my-custom-id2') - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + .set(svlCommonApi.getInternalRequestHeader()); await supertest .delete('/api/observability/slos/my-custom-id3') - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + .set(svlCommonApi.getInternalRequestHeader()); await supertest .delete('/api/observability/slos/my-custom-id4') - .set('kbn-xsrf', 'foo') - .set('x-elastic-internal-origin', 'foo'); + .set(svlCommonApi.getInternalRequestHeader()); await esDeleteAllIndices([infraDataIndex]); await cleanup({ esClient, logger }); await kibanaServer.savedObjects.clean({ types: [SO_SLO_TYPE] }); await transform.api.cleanTransformIndices(); + await svlUserManager.invalidateApiKeyForRole(roleAuthc); }); describe('non partition by SLO', () => { const sloId = 'my-custom-id1'; before(async () => { - await sloApi.create({ - id: sloId, - name: 'my custom name', - description: 'my custom description', - indicator: { - type: 'sli.kql.custom', - params: { - index: infraDataIndex, - good: 'system.cpu.total.norm.pct > 1', - total: 'system.cpu.total.norm.pct: *', - timestampField: '@timestamp', + await sloApi.create( + { + id: sloId, + name: 'my custom name', + description: 'my custom description', + indicator: { + type: 'sli.kql.custom', + params: { + index: infraDataIndex, + good: 'system.cpu.total.norm.pct > 1', + total: 'system.cpu.total.norm.pct: *', + timestampField: '@timestamp', + }, }, + timeWindow: { + duration: '7d', + type: 'rolling', + }, + budgetingMethod: 'occurrences', + objective: { + target: 0.999, + }, + groupBy: ALL_VALUE, }, - timeWindow: { - duration: '7d', - type: 'rolling', - }, - budgetingMethod: 'occurrences', - objective: { - target: 0.999, - }, - groupBy: ALL_VALUE, - }); + roleAuthc + ); }); it('saves the SLO definition', async () => { @@ -158,6 +163,7 @@ export default function ({ getService }: FtrProviderContext) { .set('kbn-xsrf', 'foo') .set('x-elastic-internal-origin', 'foo') .set('elastic-api-version', '1') + .set(roleAuthc.apiKeyHeader) .send(); transform.api.assertResponseStatusCode(200, status, body); assertTransformsResponseBody(body, expectedTransforms); @@ -182,7 +188,10 @@ export default function ({ getService }: FtrProviderContext) { }); it('finds the created SLO', async () => { - const createdSlo = await sloApi.waitForSloCreated({ sloId }); + const createdSlo = await sloApi.waitForSloCreated({ + sloId, + roleAuthc, + }); expect(createdSlo.id).to.be(sloId); expect(createdSlo.groupBy).to.be(ALL_VALUE); }); @@ -191,32 +200,38 @@ export default function ({ getService }: FtrProviderContext) { describe('SLO with long description', () => { it('creates an SLO with description over 256 characters', async () => { const sloId = 'my-custom-id2'; - await sloApi.create({ - id: sloId, - name: 'my super long SLO name and description', - description: - 'Lorem Ipsum has been the industry standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. ', - indicator: { - type: 'sli.kql.custom', - params: { - index: infraDataIndex, - good: 'system.cpu.total.norm.pct > 1', - total: 'system.cpu.total.norm.pct: *', - timestampField: '@timestamp', + await sloApi.create( + { + id: sloId, + name: 'my super long SLO name and description', + description: + 'Lorem Ipsum has been the industry standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. ', + indicator: { + type: 'sli.kql.custom', + params: { + index: infraDataIndex, + good: 'system.cpu.total.norm.pct > 1', + total: 'system.cpu.total.norm.pct: *', + timestampField: '@timestamp', + }, }, + timeWindow: { + duration: '7d', + type: 'rolling', + }, + budgetingMethod: 'occurrences', + objective: { + target: 0.999, + }, + groupBy: '*', }, - timeWindow: { - duration: '7d', - type: 'rolling', - }, - budgetingMethod: 'occurrences', - objective: { - target: 0.999, - }, - groupBy: '*', - }); + roleAuthc + ); - const createdSlo = await sloApi.waitForSloCreated({ sloId }); + const createdSlo = await sloApi.waitForSloCreated({ + sloId, + roleAuthc, + }); expect(createdSlo.id).to.be(sloId); }); }); @@ -224,31 +239,37 @@ export default function ({ getService }: FtrProviderContext) { describe('SLO with special characters in the description', () => { it("creates an SLO that has ' character in the description", async () => { const sloId = 'my-custom-id3'; - await sloApi.create({ - id: sloId, - name: 'my SLO with weird characters in the description', - description: - "Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged.", - indicator: { - type: 'sli.kql.custom', - params: { - index: infraDataIndex, - good: 'system.cpu.total.norm.pct > 1', - total: 'system.cpu.total.norm.pct: *', - timestampField: '@timestamp', + await sloApi.create( + { + id: sloId, + name: 'my SLO with weird characters in the description', + description: + "Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged.", + indicator: { + type: 'sli.kql.custom', + params: { + index: infraDataIndex, + good: 'system.cpu.total.norm.pct > 1', + total: 'system.cpu.total.norm.pct: *', + timestampField: '@timestamp', + }, }, + timeWindow: { + duration: '7d', + type: 'rolling', + }, + budgetingMethod: 'occurrences', + objective: { + target: 0.999, + }, + groupBy: '*', }, - timeWindow: { - duration: '7d', - type: 'rolling', - }, - budgetingMethod: 'occurrences', - objective: { - target: 0.999, - }, - groupBy: '*', + roleAuthc + ); + const createdSlo = await sloApi.waitForSloCreated({ + sloId, + roleAuthc, }); - const createdSlo = await sloApi.waitForSloCreated({ sloId }); expect(createdSlo.id).to.be(sloId); }); }); @@ -256,30 +277,36 @@ export default function ({ getService }: FtrProviderContext) { describe('partition by SLO', () => { it('creates a partition by SLO', async () => { const sloId = 'my-custom-id4'; - await sloApi.create({ - id: sloId, - name: 'Group by SLO', - description: 'This is a group by SLO.', - indicator: { - type: 'sli.kql.custom', - params: { - index: infraDataIndex, - good: 'system.cpu.total.norm.pct > 1', - total: 'system.cpu.total.norm.pct: *', - timestampField: '@timestamp', + await sloApi.create( + { + id: sloId, + name: 'Group by SLO', + description: 'This is a group by SLO.', + indicator: { + type: 'sli.kql.custom', + params: { + index: infraDataIndex, + good: 'system.cpu.total.norm.pct > 1', + total: 'system.cpu.total.norm.pct: *', + timestampField: '@timestamp', + }, }, + timeWindow: { + duration: '7d', + type: 'rolling', + }, + budgetingMethod: 'occurrences', + objective: { + target: 0.999, + }, + groupBy: 'host.name', }, - timeWindow: { - duration: '7d', - type: 'rolling', - }, - budgetingMethod: 'occurrences', - objective: { - target: 0.999, - }, - groupBy: 'host.name', + roleAuthc + ); + const createdSlo = await sloApi.waitForSloCreated({ + sloId, + roleAuthc, }); - const createdSlo = await sloApi.waitForSloCreated({ sloId }); expect(createdSlo.id).to.be(sloId); expect(createdSlo.groupBy).not.to.be(ALL_VALUE); expect(createdSlo.groupBy).to.be('host.name'); @@ -320,6 +347,7 @@ export default function ({ getService }: FtrProviderContext) { .set('kbn-xsrf', 'foo') .set('x-elastic-internal-origin', 'foo') .set('elastic-api-version', '1') + .set(roleAuthc.apiKeyHeader) .send(); transform.api.assertResponseStatusCode(200, status, body); assertTransformsResponseBody(body, expectedTransforms); diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/slos/delete_slo.ts b/x-pack/test_serverless/api_integration/test_suites/observability/slos/delete_slo.ts index f49cd75a23edc..6546fc585fb3e 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/slos/delete_slo.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/slos/delete_slo.ts @@ -18,9 +18,9 @@ import { SLO_DESTINATION_INDEX_PATTERN, SLO_SUMMARY_DESTINATION_INDEX_PATTERN, } from '@kbn/slo-plugin/common/constants'; -import { ElasticsearchClient } from '@kbn/core/server'; - +import type { RoleCredentials } from '../../../../shared/services'; import { FtrProviderContext } from '../../../ftr_provider_context'; + export default function ({ getService }: FtrProviderContext) { const esClient = getService('es'); const logger = getService('log'); @@ -31,12 +31,9 @@ export default function ({ getService }: FtrProviderContext) { const esDeleteAllIndices = getService('esDeleteAllIndices'); const dataViewApi = getService('dataViewApi'); + const svlUserManager = getService('svlUserManager'); - const fetchSloSummaryPipeline = async ( - client: ElasticsearchClient, - sloId: string, - sloRevision: number - ) => { + const fetchSloSummaryPipeline = async (sloId: string, sloRevision: number) => { try { return await esClient.ingest.getPipeline({ id: getSLOSummaryPipelineId(sloId, sloRevision), @@ -55,6 +52,7 @@ export default function ({ getService }: FtrProviderContext) { const DATA_VIEW_ID = 'data-view-id'; let infraDataIndex: string; let sloId: string; + let roleAuthc: RoleCredentials; before(async () => { await sloApi.deleteAllSLOs(); @@ -70,6 +68,7 @@ export default function ({ getService }: FtrProviderContext) { title: DATE_VIEW, }); await kibanaServer.savedObjects.cleanStandardList(); + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); }); after(async () => { @@ -79,34 +78,38 @@ export default function ({ getService }: FtrProviderContext) { await sloApi.deleteAllSLOs(); await esDeleteAllIndices([infraDataIndex]); await cleanup({ esClient, logger }); + await svlUserManager.invalidateApiKeyForRole(roleAuthc); }); describe('non partition by SLO', () => { it('deletes the SLO definition, transforms, ingest pipeline and data', async () => { - const createdSlo = await sloApi.create({ - name: 'my custom name', - description: 'my custom description', - indicator: { - type: 'sli.kql.custom', - params: { - index: infraDataIndex, - good: 'system.cpu.total.norm.pct > 1', - total: 'system.cpu.total.norm.pct: *', - timestampField: '@timestamp', + const createdSlo = await sloApi.create( + { + name: 'my custom name', + description: 'my custom description', + indicator: { + type: 'sli.kql.custom', + params: { + index: infraDataIndex, + good: 'system.cpu.total.norm.pct > 1', + total: 'system.cpu.total.norm.pct: *', + timestampField: '@timestamp', + }, }, + timeWindow: { + duration: '7d', + type: 'rolling', + }, + budgetingMethod: 'occurrences', + objective: { + target: 0.999, + }, + groupBy: ALL_VALUE, }, - timeWindow: { - duration: '7d', - type: 'rolling', - }, - budgetingMethod: 'occurrences', - objective: { - target: 0.999, - }, - groupBy: ALL_VALUE, - }); + roleAuthc + ); sloId = createdSlo.id; - await sloApi.waitForSloCreated({ sloId }); + await sloApi.waitForSloCreated({ sloId, roleAuthc }); // Saved Object const savedObject = await kibanaServer.savedObjects.find({ @@ -123,7 +126,7 @@ export default function ({ getService }: FtrProviderContext) { await transform.api.waitForTransformToExist(sloSummaryTransformId); // Ingest pipeline - const pipelineResponse = await fetchSloSummaryPipeline(esClient, sloId, sloRevision); + const pipelineResponse = await fetchSloSummaryPipeline(sloId, sloRevision); expect(pipelineResponse[getSLOSummaryPipelineId(sloId, sloRevision)]).not.to.be(undefined); // RollUp and Summary data @@ -140,7 +143,10 @@ export default function ({ getService }: FtrProviderContext) { expect(sloSummaryData.hits.hits.length > 0).to.be(true); // Delete the SLO - const response = await sloApi.waitForSloToBeDeleted(sloId); + const response = await sloApi.waitForSloToBeDeleted({ + sloId, + roleAuthc, + }); expect(response.status).to.be(204); // Saved object definition diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/slos/fetch_historical_summary.ts b/x-pack/test_serverless/api_integration/test_suites/observability/slos/fetch_historical_summary.ts index 75d8ae3af1f3c..7ce23be8fb4fc 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/slos/fetch_historical_summary.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/slos/fetch_historical_summary.ts @@ -13,22 +13,26 @@ import { import { ALL_VALUE } from '@kbn/slo-schema'; import moment from 'moment'; +import { RoleCredentials } from '../../../../shared/services'; import { FtrProviderContext } from '../../../ftr_provider_context'; export default function ({ getService }: FtrProviderContext) { const esClient = getService('es'); const esDeleteAllIndices = getService('esDeleteAllIndices'); const sloApi = getService('sloApi'); + const svlUserManager = getService('svlUserManager'); const SLO_ID = 'slo-fake-1'; - // Failing: See https://github.com/elastic/kibana/issues/183748 - describe.skip('fetch historical summary', () => { + describe('fetch historical summary', () => { + let roleAuthc: RoleCredentials; + before(async () => { const now = moment().startOf('minute'); const curr = now.clone().subtract(30, 'days'); const end = now.clone().add(5, 'minutes'); const batchOperations = []; + while (curr.isSameOrBefore(end)) { batchOperations.push([ { index: { _index: SLO_DESTINATION_INDEX_NAME } }, @@ -55,31 +59,36 @@ export default function ({ getService }: FtrProviderContext) { }); await esClient.indices.refresh({ index: SLO_DESTINATION_INDEX_NAME }); + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); }); after(async () => { await esDeleteAllIndices(SLO_DESTINATION_INDEX_PATTERN); + await svlUserManager.invalidateApiKeyForRole(roleAuthc); }); it('computes the historical summary for a rolling occurrences SLO', async () => { - const response = await sloApi.fetchHistoricalSummary({ - list: [ - { - sloId: SLO_ID, - instanceId: ALL_VALUE, - timeWindow: { - duration: '7d', - type: 'rolling', - }, - budgetingMethod: 'occurrences', - objective: { - target: 0.9, + const response = await sloApi.fetchHistoricalSummary( + { + list: [ + { + sloId: SLO_ID, + instanceId: ALL_VALUE, + timeWindow: { + duration: '7d', + type: 'rolling', + }, + budgetingMethod: 'occurrences', + objective: { + target: 0.9, + }, + groupBy: ALL_VALUE, + revision: 1, }, - groupBy: ALL_VALUE, - revision: 1, - }, - ], - }); + ], + }, + roleAuthc + ); expect(response[0].sloId).to.eql(SLO_ID); expect(response[0].instanceId).to.eql(ALL_VALUE); const numberOfBuckets = response[0].data.length; @@ -96,26 +105,29 @@ export default function ({ getService }: FtrProviderContext) { }); it('computes the historical summary for a rolling timeslices SLO', async () => { - const response = await sloApi.fetchHistoricalSummary({ - list: [ - { - sloId: SLO_ID, - instanceId: ALL_VALUE, - timeWindow: { - duration: '7d', - type: 'rolling', - }, - budgetingMethod: 'timeslices', - objective: { - target: 0.9, - timesliceTarget: 0.8, - timesliceWindow: '1m', + const response = await sloApi.fetchHistoricalSummary( + { + list: [ + { + sloId: SLO_ID, + instanceId: ALL_VALUE, + timeWindow: { + duration: '7d', + type: 'rolling', + }, + budgetingMethod: 'timeslices', + objective: { + target: 0.9, + timesliceTarget: 0.8, + timesliceWindow: '1m', + }, + groupBy: ALL_VALUE, + revision: 1, }, - groupBy: ALL_VALUE, - revision: 1, - }, - ], - }); + ], + }, + roleAuthc + ); expect(response[0].sloId).to.eql(SLO_ID); expect(response[0].instanceId).to.eql(ALL_VALUE); const numberOfBuckets = response[0].data.length; diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/telemetry/snapshot_telemetry.ts b/x-pack/test_serverless/api_integration/test_suites/observability/telemetry/snapshot_telemetry.ts index f0fc2a357156e..d0986e1b6d7ae 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/telemetry/snapshot_telemetry.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/telemetry/snapshot_telemetry.ts @@ -12,19 +12,29 @@ import xpackRootTelemetrySchema from '@kbn/telemetry-collection-xpack-plugin/sch import ossPluginsTelemetrySchema from '@kbn/telemetry-plugin/schema/oss_plugins.json'; import xpackPluginsTelemetrySchema from '@kbn/telemetry-collection-xpack-plugin/schema/xpack_plugins.json'; import { assertTelemetryPayload } from '@kbn/telemetry-tools'; +import type { RoleCredentials } from '../../../../shared/services'; import { FtrProviderContext } from '../../../ftr_provider_context'; import type { UsageStatsPayloadTestFriendly } from '../../../../../test/api_integration/services/usage_api'; export default function ({ getService }: FtrProviderContext) { const usageApi = getService('usageAPI'); + const svlUserManager = getService('svlUserManager'); describe('Snapshot telemetry', function () { let stats: UsageStatsPayloadTestFriendly; + let roleAuthc: RoleCredentials; before(async () => { - const [unencryptedPayload] = await usageApi.getTelemetryStats({ unencrypted: true }); + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + const [unencryptedPayload] = await usageApi.getTelemetryStats( + { unencrypted: true }, + { authHeader: roleAuthc.apiKeyHeader } + ); stats = unencryptedPayload.stats; }); + after(async () => { + await svlUserManager.invalidateApiKeyForRole(roleAuthc); + }); it('should pass the schema validation (ensures BWC with Classic offering)', () => { const root = deepmerge(ossRootTelemetrySchema, xpackRootTelemetrySchema); @@ -39,7 +49,10 @@ export default function ({ getService }: FtrProviderContext) { }); it('includes the serverless info in the body', async () => { - const [unencryptedPayload] = await usageApi.getTelemetryStats({ unencrypted: true }); + const [unencryptedPayload] = await usageApi.getTelemetryStats( + { unencrypted: true }, + { authHeader: roleAuthc.apiKeyHeader } + ); expect( unencryptedPayload.stats.stack_stats.kibana?.plugins?.telemetry?.labels?.serverless diff --git a/x-pack/test_serverless/api_integration/test_suites/observability/telemetry/telemetry_config.ts b/x-pack/test_serverless/api_integration/test_suites/observability/telemetry/telemetry_config.ts index 8fdeb64ac1c19..1d9b29ee48f10 100644 --- a/x-pack/test_serverless/api_integration/test_suites/observability/telemetry/telemetry_config.ts +++ b/x-pack/test_serverless/api_integration/test_suites/observability/telemetry/telemetry_config.ts @@ -6,15 +6,15 @@ */ import { expect } from 'expect'; +import type { InternalRequestHeader, RoleCredentials } from '../../../../shared/services'; import { FtrProviderContext } from '../../../ftr_provider_context'; export default function telemetryConfigTest({ getService }: FtrProviderContext) { const svlCommonApi = getService('svlCommonApi'); - const supertest = getService('supertest'); + const svlUserManager = getService('svlUserManager'); + const supertestWithoutAuth = getService('supertestWithoutAuth'); - // failsOnMKI, see https://github.com/elastic/kibana/issues/180348 describe('/api/telemetry/v2/config API Telemetry config', function () { - this.tags(['failsOnMKI']); const baseConfig = { allowChangingOptInStatus: false, optIn: true, @@ -24,33 +24,49 @@ export default function telemetryConfigTest({ getService }: FtrProviderContext) serverless: 'observability', }, }; + let roleAuthc: RoleCredentials; + let internalReqHeader: InternalRequestHeader; + + before(async () => { + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + internalReqHeader = svlCommonApi.getInternalRequestHeader(); + }); + + after(async () => { + await svlUserManager.invalidateApiKeyForRole(roleAuthc); + }); it('GET should get the default config', async () => { - const { body } = await supertest + const { body } = await supertestWithoutAuth .get('/api/telemetry/v2/config') - .set(svlCommonApi.getCommonRequestHeader()) + .set(internalReqHeader) + .set(roleAuthc.apiKeyHeader) .expect(200); expect(body).toMatchObject(baseConfig); }); - it('GET should get updated labels after dynamically updating them', async () => { - await supertest + it.skip('GET should get updated labels after dynamically updating them', async () => { + await supertestWithoutAuth .put('/internal/core/_settings') - .set(svlCommonApi.getInternalRequestHeader()) + .set(internalReqHeader) + .set(roleAuthc.apiKeyHeader) .set('elastic-api-version', '1') .send({ 'telemetry.labels.journeyName': 'my-ftr-test' }) .expect(200, { ok: true }); - await supertest + const response = await supertestWithoutAuth .get('/api/telemetry/v2/config') - .set(svlCommonApi.getCommonRequestHeader()) - .expect(200, { - ...baseConfig, - labels: { - ...baseConfig.labels, - journeyName: 'my-ftr-test', - }, - }); + .set(internalReqHeader) + .set(roleAuthc.apiKeyHeader); + + expect(response.status).toBe(200); + expect(response.body).toEqual({ + ...baseConfig, + labels: expect.objectContaining({ + ...baseConfig.labels, + journeyName: 'my-ftr-test', + }), + }); }); }); } diff --git a/x-pack/test_serverless/api_integration/test_suites/search/telemetry/telemetry_config.ts b/x-pack/test_serverless/api_integration/test_suites/search/telemetry/telemetry_config.ts index ad523c6be982f..c1533aad727da 100644 --- a/x-pack/test_serverless/api_integration/test_suites/search/telemetry/telemetry_config.ts +++ b/x-pack/test_serverless/api_integration/test_suites/search/telemetry/telemetry_config.ts @@ -32,7 +32,8 @@ export default function telemetryConfigTest({ getService }: FtrProviderContext) expect(body).toMatchObject(baseConfig); }); - it('GET should get updated labels after dynamically updating them', async () => { + // coreApp.allowDynamicConfigOverrides is disabled + it.skip('GET should get updated labels after dynamically updating them', async () => { const uniqueJourneyName = `my-ftr-test-${new Date().getMilliseconds()}`; await supertest .put('/internal/core/_settings') diff --git a/x-pack/test_serverless/api_integration/test_suites/security/cases/find_cases.ts b/x-pack/test_serverless/api_integration/test_suites/security/cases/find_cases.ts index ee44874a67fac..a42e3204c11d3 100644 --- a/x-pack/test_serverless/api_integration/test_suites/security/cases/find_cases.ts +++ b/x-pack/test_serverless/api_integration/test_suites/security/cases/find_cases.ts @@ -6,19 +6,23 @@ */ import expect from '@kbn/expect'; +import { RoleCredentials } from '../../../../shared/services'; import { FtrProviderContext } from '../../../ftr_provider_context'; export default ({ getService }: FtrProviderContext): void => { const svlCases = getService('svlCases'); + const svlUserManager = getService('svlUserManager'); let findCasesResp: any; let postCaseReq: any; describe('find_cases', () => { + let roleAuthc: RoleCredentials; describe('basic tests', () => { before(async () => { findCasesResp = svlCases.api.getFindCasesResp(); postCaseReq = svlCases.api.getPostCaseReq('securitySolution'); + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); }); afterEach(async () => { @@ -26,16 +30,16 @@ export default ({ getService }: FtrProviderContext): void => { }); it('should return empty response', async () => { - const cases = await svlCases.api.findCases({}); + const cases = await svlCases.api.findCases({}, roleAuthc); expect(cases).to.eql(findCasesResp); }); it('should return cases', async () => { - const a = await svlCases.api.createCase(postCaseReq); - const b = await svlCases.api.createCase(postCaseReq); - const c = await svlCases.api.createCase(postCaseReq); + const a = await svlCases.api.createCase(postCaseReq, roleAuthc); + const b = await svlCases.api.createCase(postCaseReq, roleAuthc); + const c = await svlCases.api.createCase(postCaseReq, roleAuthc); - const cases = await svlCases.api.findCases({}); + const cases = await svlCases.api.findCases({}, roleAuthc); expect(cases).to.eql({ ...findCasesResp, @@ -46,14 +50,17 @@ export default ({ getService }: FtrProviderContext): void => { }); it('returns empty response when trying to find cases with owner as cases', async () => { - const cases = await svlCases.api.findCases({ query: { owner: 'cases' } }); + const cases = await svlCases.api.findCases({ query: { owner: 'cases' } }, roleAuthc); expect(cases).to.eql(findCasesResp); }); it('returns empty response when trying to find cases with owner as observability', async () => { - const cases = await svlCases.api.findCases({ - query: { owner: 'observability' }, - }); + const cases = await svlCases.api.findCases( + { + query: { owner: 'observability' }, + }, + roleAuthc + ); expect(cases).to.eql(findCasesResp); }); }); diff --git a/x-pack/test_serverless/api_integration/test_suites/security/cases/get_case.ts b/x-pack/test_serverless/api_integration/test_suites/security/cases/get_case.ts index fe3c02a7342a9..a5aaca18dae62 100644 --- a/x-pack/test_serverless/api_integration/test_suites/security/cases/get_case.ts +++ b/x-pack/test_serverless/api_integration/test_suites/security/cases/get_case.ts @@ -6,27 +6,41 @@ */ import expect from '@kbn/expect'; +import type { RoleCredentials } from '../../../../shared/services'; import { FtrProviderContext } from '../../../ftr_provider_context'; export default ({ getService }: FtrProviderContext): void => { const svlCases = getService('svlCases'); + const svlUserManager = getService('svlUserManager'); describe('get_case', () => { + let roleAuthc: RoleCredentials; + before(async () => { + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + }); + afterEach(async () => { await svlCases.api.deleteCases(); }); it('should return a case', async () => { const postedCase = await svlCases.api.createCase( - svlCases.api.getPostCaseRequest('securitySolution') + svlCases.api.getPostCaseRequest('securitySolution'), + roleAuthc + ); + const theCase = await svlCases.api.getCase( + { + caseId: postedCase.id, + includeComments: true, + }, + roleAuthc ); - const theCase = await svlCases.api.getCase({ - caseId: postedCase.id, - includeComments: true, - }); - const data = svlCases.omit.removeServerGeneratedPropertiesFromCase(theCase); - expect(data).to.eql(svlCases.api.postCaseResp('securitySolution')); + const { created_by: createdBy, ...data } = + svlCases.omit.removeServerGeneratedPropertiesFromCase(theCase); + const { created_by: _, ...expectedData } = svlCases.api.postCaseResp('securitySolution'); + expect(data).to.eql(expectedData); + expect(createdBy).to.have.keys('full_name', 'email', 'username'); expect(data.comments?.length).to.eql(0); }); }); diff --git a/x-pack/test_serverless/api_integration/test_suites/security/cases/post_case.ts b/x-pack/test_serverless/api_integration/test_suites/security/cases/post_case.ts index db5967654de85..5b26ab4f3d313 100644 --- a/x-pack/test_serverless/api_integration/test_suites/security/cases/post_case.ts +++ b/x-pack/test_serverless/api_integration/test_suites/security/cases/post_case.ts @@ -7,44 +7,44 @@ import expect from '@kbn/expect'; import { ConnectorTypes } from '@kbn/cases-plugin/common/types/domain'; - +import type { RoleCredentials } from '../../../../shared/services'; import { FtrProviderContext } from '../../../ftr_provider_context'; export default ({ getService }: FtrProviderContext): void => { const svlCases = getService('svlCases'); + const svlUserManager = getService('svlUserManager'); describe('post_case', () => { + let roleAuthc: RoleCredentials; + before(async () => { + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); + }); + afterEach(async () => { await svlCases.api.deleteCases(); }); it('should create a case', async () => { - const postedCase = await svlCases.api.createCase( - svlCases.api.getPostCaseRequest('securitySolution', { - connector: { - id: '123', - name: 'Jira', - type: ConnectorTypes.jira, - fields: { issueType: 'Task', priority: 'High', parent: null }, - }, - }) - ); - const data = svlCases.omit.removeServerGeneratedPropertiesFromCase(postedCase); + const payload = svlCases.api.getPostCaseRequest('securitySolution', { + connector: { + id: '123', + name: 'Jira', + type: ConnectorTypes.jira, + fields: { issueType: 'Task', priority: 'High', parent: null }, + }, + }); + const postedCase = await svlCases.api.createCase(payload, roleAuthc); - expect(data).to.eql( - svlCases.api.postCaseResp( - 'securitySolution', - null, - svlCases.api.getPostCaseRequest('securitySolution', { - connector: { - id: '123', - name: 'Jira', - type: ConnectorTypes.jira, - fields: { issueType: 'Task', priority: 'High', parent: null }, - }, - }) - ) + const { created_by: createdBy, ...data } = + svlCases.omit.removeServerGeneratedPropertiesFromCase(postedCase); + const { created_by: _, ...expected } = svlCases.api.postCaseResp( + 'securitySolution', + null, + payload ); + + expect(data).to.eql(expected); + expect(createdBy).to.have.keys('full_name', 'email', 'username'); }); it('should throw 403 when trying to create a case with observability as owner', async () => { @@ -53,6 +53,7 @@ export default ({ getService }: FtrProviderContext): void => { svlCases.api.getPostCaseRequest('securitySolution', { owner: 'observability', }), + roleAuthc, 403 ) ); @@ -64,6 +65,7 @@ export default ({ getService }: FtrProviderContext): void => { svlCases.api.getPostCaseRequest('securitySolution', { owner: 'cases', }), + roleAuthc, 403 ) ); diff --git a/x-pack/test_serverless/api_integration/test_suites/security/telemetry/telemetry_config.ts b/x-pack/test_serverless/api_integration/test_suites/security/telemetry/telemetry_config.ts index 6701fc93a506a..66f76ac669a81 100644 --- a/x-pack/test_serverless/api_integration/test_suites/security/telemetry/telemetry_config.ts +++ b/x-pack/test_serverless/api_integration/test_suites/security/telemetry/telemetry_config.ts @@ -34,7 +34,8 @@ export default function telemetryConfigTest({ getService }: FtrProviderContext) expect(body).toMatchObject(baseConfig); }); - it('GET should get updated labels after dynamically updating them', async () => { + // coreApp.allowDynamicConfigOverrides is disabled + it.skip('GET should get updated labels after dynamically updating them', async () => { await supertest .put('/internal/core/_settings') .set(svlCommonApi.getInternalRequestHeader()) diff --git a/x-pack/test_serverless/functional/test_suites/common/management/ingest_pipelines.ts b/x-pack/test_serverless/functional/test_suites/common/management/ingest_pipelines.ts index 3b0c9b01907da..aa1cb5eee16a7 100644 --- a/x-pack/test_serverless/functional/test_suites/common/management/ingest_pipelines.ts +++ b/x-pack/test_serverless/functional/test_suites/common/management/ingest_pipelines.ts @@ -75,9 +75,17 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { }); describe('Create pipeline', () => { + beforeEach(async () => { + await pageObjects.common.navigateToApp('ingestPipelines'); + }); + afterEach(async () => { - // Delete the pipeline that was created - await es.ingest.deletePipeline({ id: TEST_PIPELINE_NAME }); + const pipeline = await es.ingest.getPipeline({ id: TEST_PIPELINE_NAME }); + + // Only if the pipeline exists between runs, we delete it + if (pipeline) { + await es.ingest.deletePipeline({ id: TEST_PIPELINE_NAME }); + } }); it('Creates a pipeline', async () => { diff --git a/x-pack/test_serverless/functional/test_suites/observability/advanced_settings.ts b/x-pack/test_serverless/functional/test_suites/observability/advanced_settings.ts index d6f2ef6502f2d..0e3c4d65349c9 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/advanced_settings.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/advanced_settings.ts @@ -18,7 +18,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { describe('Observability advanced settings', function () { before(async () => { - await pageObjects.svlCommonPage.login(); + await pageObjects.svlCommonPage.loginWithRole('admin'); await pageObjects.common.navigateToApp('settings'); }); diff --git a/x-pack/test_serverless/functional/test_suites/observability/cases/attachment_framework.ts b/x-pack/test_serverless/functional/test_suites/observability/cases/attachment_framework.ts index 2dda21ca85215..7719ba01ce8ea 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/cases/attachment_framework.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/cases/attachment_framework.ts @@ -26,7 +26,7 @@ export default ({ getPageObject, getService }: FtrProviderContext) => { describe('Cases persistable attachments', function () { describe('lens visualization', () => { before(async () => { - await svlCommonPage.login(); + await svlCommonPage.loginWithRole('admin'); await kibanaServer.savedObjects.cleanStandardList(); await esArchiver.loadIfNeeded('x-pack/test/functional/es_archives/logstash_functional'); await kibanaServer.importExport.load( diff --git a/x-pack/test_serverless/functional/test_suites/observability/cases/configure.ts b/x-pack/test_serverless/functional/test_suites/observability/cases/configure.ts index 7b56c069fec5d..8a966c6b7d135 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/cases/configure.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/cases/configure.ts @@ -23,7 +23,7 @@ export default ({ getPageObject, getService }: FtrProviderContext) => { describe('Configure Case', function () { before(async () => { - await svlCommonPage.login(); + await svlCommonPage.loginWithRole('admin'); await svlObltNavigation.navigateToLandingPage(); await svlCommonNavigation.sidenav.clickLink({ deepLinkId: 'observability-overview:cases' }); await header.waitUntilLoadingHasFinished(); diff --git a/x-pack/test_serverless/functional/test_suites/observability/cases/create_case_form.ts b/x-pack/test_serverless/functional/test_suites/observability/cases/create_case_form.ts index c1b2f1e0068a5..88f2663a10749 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/cases/create_case_form.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/cases/create_case_form.ts @@ -25,7 +25,7 @@ export default ({ getService, getPageObject }: FtrProviderContext) => { const header = getPageObject('header'); before(async () => { - await svlCommonPage.login(); + await svlCommonPage.loginWithRole('admin'); }); beforeEach(async () => { diff --git a/x-pack/test_serverless/functional/test_suites/observability/cases/list_view.ts b/x-pack/test_serverless/functional/test_suites/observability/cases/list_view.ts index 6009c4557bed6..e98cc99bdec5b 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/cases/list_view.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/cases/list_view.ts @@ -21,7 +21,7 @@ export default ({ getPageObject, getService }: FtrProviderContext) => { describe('Cases list', function () { before(async () => { - await svlCommonPage.login(); + await svlCommonPage.loginWithRole('admin'); await svlObltNavigation.navigateToLandingPage(); await svlCommonNavigation.sidenav.clickLink({ deepLinkId: 'observability-overview:cases' }); }); diff --git a/x-pack/test_serverless/functional/test_suites/observability/cases/view_case.ts b/x-pack/test_serverless/functional/test_suites/observability/cases/view_case.ts index a4bc060062ad7..5962a5f7c4195 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/cases/view_case.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/cases/view_case.ts @@ -36,7 +36,7 @@ export default ({ getPageObject, getService }: FtrProviderContext) => { describe('Case View', function () { before(async () => { - await svlCommonPage.login(); + await svlCommonPage.loginWithRole('admin'); }); after(async () => { diff --git a/x-pack/test_serverless/functional/test_suites/observability/infra/header_menu.ts b/x-pack/test_serverless/functional/test_suites/observability/infra/header_menu.ts index 0f9ed330c3ad4..e59021dbd7e1a 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/infra/header_menu.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/infra/header_menu.ts @@ -16,7 +16,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { describe('Header menu', () => { before(async () => { await esArchiver.load('x-pack/test/functional/es_archives/infra/metrics_and_logs'); - await pageObjects.svlCommonPage.login(); + await pageObjects.svlCommonPage.loginWithRole('viewer'); }); after(async () => { diff --git a/x-pack/test_serverless/functional/test_suites/observability/infra/hosts_page.ts b/x-pack/test_serverless/functional/test_suites/observability/infra/hosts_page.ts index 22757855e02f8..45aa622281312 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/infra/hosts_page.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/infra/hosts_page.ts @@ -45,7 +45,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { await Promise.all([ esArchiver.load('x-pack/test/functional/es_archives/infra/metrics_and_logs'), ]); - await pageObjects.svlCommonPage.login(); + await pageObjects.svlCommonPage.loginWithRole('viewer'); await browser.setWindowSize(1600, 1200); }); diff --git a/x-pack/test_serverless/functional/test_suites/observability/infra/infra.ts b/x-pack/test_serverless/functional/test_suites/observability/infra/infra.ts index 677611b3e4ef7..0f9ddcef05db6 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/infra/infra.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/infra/infra.ts @@ -31,7 +31,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { describe('Infra pages', function () { before(async () => { - await pageObjects.svlCommonPage.login(); + await pageObjects.svlCommonPage.loginWithRole('viewer'); }); after(async () => { diff --git a/x-pack/test_serverless/functional/test_suites/observability/infra/navigation.ts b/x-pack/test_serverless/functional/test_suites/observability/infra/navigation.ts index 6f03c8831ce85..6bbb746eb65a6 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/infra/navigation.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/infra/navigation.ts @@ -26,7 +26,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { describe('Infra Side Navigation', () => { before(async () => { - await pageObjects.svlCommonPage.login(); + await pageObjects.svlCommonPage.loginWithRole('viewer'); await svlObltNavigation.navigateToLandingPage(); }); diff --git a/x-pack/test_serverless/functional/test_suites/observability/infra/node_details.ts b/x-pack/test_serverless/functional/test_suites/observability/infra/node_details.ts index 4decf638741f0..bd56244eb12ba 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/infra/node_details.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/infra/node_details.ts @@ -35,7 +35,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { before(async () => { await esArchiver.load('x-pack/test/functional/es_archives/infra/metrics_and_logs'); - await pageObjects.svlCommonPage.login(); + await pageObjects.svlCommonPage.loginWithRole('viewer'); await pageObjects.common.navigateToApp( `metrics/${NODE_DETAILS_PATH}/demo-stack-kubernetes-01` ); diff --git a/x-pack/test_serverless/functional/test_suites/observability/ml/anomaly_detection_jobs_list.ts b/x-pack/test_serverless/functional/test_suites/observability/ml/anomaly_detection_jobs_list.ts index f4d0077f6b73c..e8dddef3eb35a 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/ml/anomaly_detection_jobs_list.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/ml/anomaly_detection_jobs_list.ts @@ -19,7 +19,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { // Error: Failed to delete all indices with pattern [.ml-*] this.tags(['failsOnMKI']); before(async () => { - await PageObjects.svlCommonPage.login(); + await PageObjects.svlCommonPage.loginWithRole('admin'); // Load logstash* data and create dataview for logstash*, logstash-2015.09.22 await esArchiver.loadIfNeeded('x-pack/test/functional/es_archives/logstash_functional'); diff --git a/x-pack/test_serverless/functional/test_suites/observability/ml/search_bar_features.ts b/x-pack/test_serverless/functional/test_suites/observability/ml/search_bar_features.ts index fec1fbd9d3646..15b7d3d76c61a 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/ml/search_bar_features.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/ml/search_bar_features.ts @@ -10,80 +10,90 @@ import { FtrProviderContext } from '../../../ftr_provider_context'; export default function ({ getPageObjects }: FtrProviderContext) { const PageObjects = getPageObjects(['header', 'svlCommonPage', 'svlCommonNavigation']); - const allLabels = [ - { label: 'Machine Learning', expected: true }, - { label: 'Machine Learning / Overview', expected: true }, - { label: 'Machine Learning / Anomaly Detection', expected: true }, - { label: 'Machine Learning / Anomaly Detection / Anomaly explorer', expected: true }, - { label: 'Machine Learning / Anomaly Detection / Single metric viewer', expected: true }, - { label: 'Machine Learning / Data Frame Analytics', expected: false }, - { label: 'Machine Learning / Data Frame Analytics / Results explorer', expected: false }, - { label: 'Machine Learning / Data Frame Analytics / Analytics map', expected: false }, - { label: 'Machine Learning / Model Management', expected: true }, - { label: 'Machine Learning / Model Management / Trained Models', expected: true }, - { label: 'Machine Learning / Model Management / Nodes', expected: false }, - { label: 'Machine Learning / Memory Usage', expected: true }, - { label: 'Machine Learning / Settings', expected: true }, - { label: 'Machine Learning / Settings / Calendars', expected: true }, - { label: 'Machine Learning / Settings / Filter Lists', expected: true }, - { label: 'Machine Learning / AIOps', expected: true }, - { label: 'Machine Learning / AIOps / Log Rate Analysis', expected: true }, - { label: 'Machine Learning / AIOps / Log Pattern Analysis', expected: true }, - { label: 'Machine Learning / AIOps / Change Point Detection', expected: true }, - { label: 'Machine Learning / Notifications', expected: true }, - { label: 'Machine Learning / Data Visualizer', expected: true }, - { label: 'Machine Learning / File Upload', expected: true }, - { label: 'Machine Learning / Index Data Visualizer', expected: true }, - { label: 'Machine Learning / ES|QL Data Visualizer', expected: true }, - { label: 'Machine Learning / Data Drift', expected: true }, - { label: 'Alerts and Insights / Machine Learning', expected: true }, - ]; + const allLabels = { + viewer: [ + { label: 'Machine Learning', expected: true }, + { label: 'Machine Learning / Overview', expected: true }, + { label: 'Machine Learning / Anomaly Detection', expected: true }, + { label: 'Machine Learning / Anomaly Detection / Anomaly explorer', expected: true }, + { label: 'Machine Learning / Anomaly Detection / Single metric viewer', expected: true }, + { label: 'Machine Learning / Data Frame Analytics', expected: false }, + { label: 'Machine Learning / Data Frame Analytics / Results explorer', expected: false }, + { label: 'Machine Learning / Data Frame Analytics / Analytics map', expected: false }, + { label: 'Machine Learning / Model Management', expected: true }, + { label: 'Machine Learning / Model Management / Trained Models', expected: true }, + { label: 'Machine Learning / Model Management / Nodes', expected: false }, + { label: 'Machine Learning / Memory Usage', expected: true }, + { label: 'Machine Learning / Settings', expected: true }, + { label: 'Machine Learning / Settings / Calendars', expected: true }, + { label: 'Machine Learning / Settings / Filter Lists', expected: true }, + { label: 'Machine Learning / AIOps', expected: true }, + { label: 'Machine Learning / AIOps / Log Rate Analysis', expected: true }, + { label: 'Machine Learning / AIOps / Log Pattern Analysis', expected: true }, + { label: 'Machine Learning / AIOps / Change Point Detection', expected: true }, + { label: 'Machine Learning / Notifications', expected: true }, + { label: 'Machine Learning / Data Visualizer', expected: true }, + { label: 'Machine Learning / File Upload', expected: true }, + { label: 'Machine Learning / Index Data Visualizer', expected: true }, + { label: 'Machine Learning / ES|QL Data Visualizer', expected: true }, + { label: 'Machine Learning / Data Drift', expected: true }, + ], + admin: [{ label: 'Alerts and Insights / Machine Learning', expected: true }], + }; describe('Search bar features', () => { - before(async () => { - await PageObjects.svlCommonPage.login(); - }); + ([{ role: 'viewer' }, { role: 'admin' }] as Array<{ role: keyof typeof allLabels }>).forEach( + ({ role }) => { + describe(`user role: ${role}`, () => { + before(async () => { + await PageObjects.svlCommonPage.loginWithRole(role); + }); - after(async () => { - await PageObjects.svlCommonPage.forceLogout(); - }); + after(async () => { + await PageObjects.svlCommonPage.forceLogout(); + }); - describe('list features', () => { - it('has the correct features enabled', async () => { - await PageObjects.header.waitUntilLoadingHasFinished(); - await PageObjects.svlCommonNavigation.search.showSearch(); + describe('list features', () => { + it('has the correct features enabled', async () => { + await PageObjects.header.waitUntilLoadingHasFinished(); + await PageObjects.svlCommonNavigation.search.showSearch(); - const expectedLabels = allLabels.filter((l) => l.expected).map((l) => l.label); + const expectedLabels = allLabels[role].filter((l) => l.expected).map((l) => l.label); - for (const expectedLabel of expectedLabels) { - await PageObjects.svlCommonNavigation.search.searchFor(expectedLabel); - const [result] = await PageObjects.svlCommonNavigation.search.getDisplayedResults(); - const label = result?.label; - expect(label).to.eql( - expectedLabel, - `First result should be ${expectedLabel} (got matching items '${label}')` - ); - } - await PageObjects.svlCommonNavigation.search.hideSearch(); - }); + for (const expectedLabel of expectedLabels) { + await PageObjects.svlCommonNavigation.search.searchFor(expectedLabel); + const [result] = await PageObjects.svlCommonNavigation.search.getDisplayedResults(); + const label = result?.label; + expect(label).to.eql( + expectedLabel, + `First result should be ${expectedLabel} (got matching items '${label}')` + ); + } + await PageObjects.svlCommonNavigation.search.hideSearch(); + }); - it('has the correct features disabled', async () => { - await PageObjects.header.waitUntilLoadingHasFinished(); - await PageObjects.svlCommonNavigation.search.showSearch(); + it('has the correct features disabled', async () => { + await PageObjects.header.waitUntilLoadingHasFinished(); + await PageObjects.svlCommonNavigation.search.showSearch(); - const notExpectedLabels = allLabels.filter((l) => !l.expected).map((l) => l.label); + const notExpectedLabels = allLabels[role] + .filter((l) => !l.expected) + .map((l) => l.label); - for (const notExpectedLabel of notExpectedLabels) { - await PageObjects.svlCommonNavigation.search.searchFor(notExpectedLabel); - const [result] = await PageObjects.svlCommonNavigation.search.getDisplayedResults(); - const label = result?.label; - expect(label).to.not.eql( - notExpectedLabel, - `First result should not be ${notExpectedLabel} (got matching items '${label}')` - ); - } - await PageObjects.svlCommonNavigation.search.hideSearch(); - }); - }); + for (const notExpectedLabel of notExpectedLabels) { + await PageObjects.svlCommonNavigation.search.searchFor(notExpectedLabel); + const [result] = await PageObjects.svlCommonNavigation.search.getDisplayedResults(); + const label = result?.label; + expect(label).to.not.eql( + notExpectedLabel, + `First result should not be ${notExpectedLabel} (got matching items '${label}')` + ); + } + await PageObjects.svlCommonNavigation.search.hideSearch(); + }); + }); + }); + } + ); }); } diff --git a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/columns_selection.ts b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/columns_selection.ts index d32f3aff208b0..14c5de7185310 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/columns_selection.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/columns_selection.ts @@ -35,7 +35,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('When the logs explorer loads', () => { before(async () => { await synthtrace.index(generateLogsData({ to })); - await PageObjects.svlCommonPage.login(); + await PageObjects.svlCommonPage.loginWithRole('viewer'); await navigateToLogsExplorer(); }); @@ -87,7 +87,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('render content virtual column properly', async () => { it('should render log level and log message when present', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 3); + const cellElement = await dataGrid.getCellElement(0, 4); const cellValue = await cellElement.getVisibleText(); expect(cellValue.includes('info')).to.be(true); expect(cellValue.includes('A sample log')).to.be(true); @@ -96,7 +96,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render log message when present and skip log level when missing', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(1, 3); + const cellElement = await dataGrid.getCellElement(1, 4); const cellValue = await cellElement.getVisibleText(); expect(cellValue.includes('info')).to.be(false); expect(cellValue.includes('A sample log')).to.be(true); @@ -105,7 +105,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render message from error object when top level message not present', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(2, 3); + const cellElement = await dataGrid.getCellElement(2, 4); const cellValue = await cellElement.getVisibleText(); expect(cellValue.includes('info')).to.be(true); expect(cellValue.includes('error.message')).to.be(true); @@ -115,7 +115,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render message from event.original when top level message and error.message not present', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(3, 3); + const cellElement = await dataGrid.getCellElement(3, 4); const cellValue = await cellElement.getVisibleText(); expect(cellValue.includes('info')).to.be(true); expect(cellValue.includes('event.original')).to.be(true); @@ -125,7 +125,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render the whole JSON when neither message, error.message and event.original are present', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(4, 3); + const cellElement = await dataGrid.getCellElement(4, 4); const cellValue = await cellElement.getVisibleText(); expect(cellValue.includes('info')).to.be(true); @@ -139,7 +139,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('on cell expansion with no message field should open JSON Viewer', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - await dataGrid.clickCellExpandButton(4, 3); + await dataGrid.clickCellExpandButton(4, 4); await testSubjects.existOrFail('dataTableExpandCellActionJsonPopover'); }); }); @@ -147,7 +147,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('on cell expansion with message field should open regular popover', async () => { await navigateToLogsExplorer(); await retry.tryForTime(TEST_TIMEOUT, async () => { - await dataGrid.clickCellExpandButton(3, 3); + await dataGrid.clickCellExpandButton(3, 4); await testSubjects.existOrFail('euiDataGridExpansionPopover'); }); }); @@ -156,7 +156,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('render resource virtual column properly', async () => { it('should render service name and host name when present', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 2); + const cellElement = await dataGrid.getCellElement(0, 3); const cellValue = await cellElement.getVisibleText(); expect(cellValue.includes('synth-service')).to.be(true); expect(cellValue.includes('synth-host')).to.be(true); @@ -170,7 +170,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { }); it('should render a popover with cell actions when a chip on content column is clicked', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 3); + const cellElement = await dataGrid.getCellElement(0, 4); const logLevelChip = await cellElement.findByTestSubject( 'dataTablePopoverChip_log.level' ); @@ -186,7 +186,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render the table filtered where log.level value is info when filter in action is clicked', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 3); + const cellElement = await dataGrid.getCellElement(0, 4); const logLevelChip = await cellElement.findByTestSubject( 'dataTablePopoverChip_log.level' ); @@ -206,7 +206,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render the table filtered where log.level value is not info when filter out action is clicked', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 3); + const cellElement = await dataGrid.getCellElement(0, 4); const logLevelChip = await cellElement.findByTestSubject( 'dataTablePopoverChip_log.level' ); @@ -224,7 +224,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('should render the table filtered where service.name value is selected', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 2); + const cellElement = await dataGrid.getCellElement(0, 3); const serviceNameChip = await cellElement.findByTestSubject( 'dataTablePopoverChip_service.name' ); diff --git a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/custom_control_columns.ts b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/custom_control_columns.ts index 993d4ab3bc4d5..6e836f00cc3f2 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/custom_control_columns.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/custom_control_columns.ts @@ -36,7 +36,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('When the logs explorer loads', () => { before(async () => { await synthtrace.index(generateLogsData({ to })); - await PageObjects.svlCommonPage.login(); + await PageObjects.svlCommonPage.loginWithRole('viewer'); await navigateToLogsExplorer(); }); @@ -48,30 +48,30 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('should render custom control columns properly', async () => { it('should render control column with proper header', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - // First control column has no title, so empty string, last control column has title + // First control column has no title, so empty string, leading control column has title expect(await dataGrid.getControlColumnHeaderFields()).to.eql(['', 'actions']); }); }); - it('should render the expand icon in the last control column', async () => { + it('should render the expand icon in the leading control column', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 4); + const cellElement = await dataGrid.getCellElement(0, 1); const expandButton = await cellElement.findByTestSubject('docTableExpandToggleColumn'); expect(expandButton).to.not.be.empty(); }); }); - it('should render the malformed icon in the last control column if malformed doc exists', async () => { + it('should render the malformed icon in the leading control column if malformed doc exists', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(1, 4); + const cellElement = await dataGrid.getCellElement(1, 1); const malformedButton = await cellElement.findByTestSubject('docTableDegradedDocExist'); expect(malformedButton).to.not.be.empty(); }); }); - it('should render the disabled malformed icon in the last control column when malformed doc does not exists', async () => { + it('should render the disabled malformed icon in the leading control column when malformed doc does not exists', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(0, 4); + const cellElement = await dataGrid.getCellElement(0, 1); const malformedDisableButton = await cellElement.findByTestSubject( 'docTableDegradedDocDoesNotExist' ); @@ -79,17 +79,17 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { }); }); - it('should render the stacktrace icon in the last control column when stacktrace exists', async () => { + it('should render the stacktrace icon in the leading control column when stacktrace exists', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(4, 4); + const cellElement = await dataGrid.getCellElement(4, 1); const stacktraceButton = await cellElement.findByTestSubject('docTableStacktraceExist'); expect(stacktraceButton).to.not.be.empty(); }); }); - it('should render the stacktrace icon disabled in the last control column when stacktrace does not exists', async () => { + it('should render the stacktrace icon disabled in the leading control column when stacktrace does not exists', async () => { await retry.tryForTime(TEST_TIMEOUT, async () => { - const cellElement = await dataGrid.getCellElement(1, 4); + const cellElement = await dataGrid.getCellElement(1, 1); const stacktraceButton = await cellElement.findByTestSubject( 'docTableStacktraceDoesNotExist' ); diff --git a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/data_source_selection_state.ts b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/data_source_selection_state.ts index 5fe928c5d3d5e..871c0151432a2 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/data_source_selection_state.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/data_source_selection_state.ts @@ -34,7 +34,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('dataSourceSelection initialization and update', () => { before(async () => { - await PageObjects.svlCommonPage.login(); + await PageObjects.svlCommonPage.loginWithRole('viewer'); }); after(async () => { diff --git a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/data_source_selector.ts b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/data_source_selector.ts index df749f2d4f9dd..3bb012c81311f 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/data_source_selector.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/data_source_selector.ts @@ -40,7 +40,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { // TimeoutError: Waiting for element to be located By(css selector, [data-test-subj="dataSourceSelectorPopoverButton"]) this.tags(['failsOnMKI']); before(async () => { - await PageObjects.svlCommonPage.login(); + await PageObjects.svlCommonPage.loginWithRole('viewer'); await PageObjects.observabilityLogsExplorer.removeInstalledPackages(); }); diff --git a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/field_list.ts b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/field_list.ts index 828c4d4c61dd1..5c5cd85f624a4 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/field_list.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/field_list.ts @@ -35,7 +35,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('When virtual columns loads', () => { before(async () => { await synthtrace.index(generateLogsData({ from, to })); - await PageObjects.svlCommonPage.login(); + await PageObjects.svlCommonPage.loginWithRole('viewer'); await navigateToLogsExplorer(); }); diff --git a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/filter_controls.ts b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/filter_controls.ts index 9cf4629e89a90..0dc479b391800 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/filter_controls.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/filter_controls.ts @@ -14,7 +14,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('Filter controls customization', () => { before('initialize tests', async () => { await kibanaServer.importExport.load('test/functional/fixtures/kbn_archiver/discover'); - await PageObjects.svlCommonPage.login(); + await PageObjects.svlCommonPage.loginWithRole('viewer'); }); after('clean up archives', async () => { diff --git a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/flyout.ts b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/flyout.ts index 8758ca590a515..2e181f1a7d9b4 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/flyout.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/flyout.ts @@ -45,7 +45,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { NAMESPACE ); await PageObjects.observabilityLogsExplorer.ingestLogEntries(DATA_STREAM_NAME, docs); - await PageObjects.svlCommonPage.login(); + await PageObjects.svlCommonPage.loginWithRole('viewer'); }); beforeEach(async () => { @@ -68,7 +68,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { }); it('should display the logs overview tab', async () => { - await dataGrid.clickRowToggle({ columnIndex: 4 }); + await dataGrid.clickRowToggle({ columnIndex: 1 }); await testSubjects.existOrFail('docViewerTab-doc_view_logs_overview'); }); }); diff --git a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/header_menu.ts b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/header_menu.ts index 23d2e7729e2f4..a61c1afbfb618 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/header_menu.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/header_menu.ts @@ -31,7 +31,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { 'x-pack/test/functional/es_archives/observability_logs_explorer/data_streams' ); await esArchiver.loadIfNeeded('test/functional/fixtures/es_archiver/logstash_functional'); - await PageObjects.svlCommonPage.login(); + await PageObjects.svlCommonPage.loginWithRole('viewer'); await PageObjects.observabilityLogsExplorer.navigateTo(); await PageObjects.header.waitUntilLoadingHasFinished(); }); diff --git a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/navigation.ts b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/navigation.ts index 88852f1f7b5b7..076e4701c91fc 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/navigation.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/observability_logs_explorer/navigation.ts @@ -34,7 +34,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { before(async () => { await kibanaServer.importExport.load('test/functional/fixtures/kbn_archiver/discover'); await synthtrace.index(generateLogsData({ to })); - await PageObjects.svlCommonPage.login(); + await PageObjects.svlCommonPage.loginWithRole('viewer'); await navigateToLogsExplorer(); }); diff --git a/x-pack/test_serverless/functional/test_suites/observability/rules/rules_list.ts b/x-pack/test_serverless/functional/test_suites/observability/rules/rules_list.ts index 0e486b4947d80..aa2ba3ff72fda 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/rules/rules_list.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/rules/rules_list.ts @@ -84,7 +84,7 @@ export default ({ getPageObject, getService }: FtrProviderContext) => { before(async () => { roleAuthc = await svlUserManager.createApiKeyForRole('admin'); internalReqHeader = svlCommonApi.getInternalRequestHeader(); - await svlCommonPage.login(); + await svlCommonPage.loginWithRole('admin'); await svlObltNavigation.navigateToLandingPage(); await svlCommonNavigation.sidenav.clickLink({ text: 'Alerts' }); await testSubjects.click('manageRulesPageButton'); diff --git a/x-pack/test_serverless/functional/test_suites/observability/screenshot_creation/response_ops_docs/cases/list_view.ts b/x-pack/test_serverless/functional/test_suites/observability/screenshot_creation/response_ops_docs/cases/list_view.ts index e20029f5ebce1..b4666e7807342 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/screenshot_creation/response_ops_docs/cases/list_view.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/screenshot_creation/response_ops_docs/cases/list_view.ts @@ -6,6 +6,7 @@ */ import { OBSERVABILITY_OWNER } from '@kbn/cases-plugin/common'; +import type { RoleCredentials } from '../../../../../../shared/services'; import { FtrProviderContext } from '../../../../../ftr_provider_context'; import { navigateToCasesApp } from '../../../../../../shared/lib/cases'; @@ -16,18 +17,22 @@ export default function ({ getPageObject, getPageObjects, getService }: FtrProvi const svlCommonScreenshots = getService('svlCommonScreenshots'); const screenshotDirectories = ['response_ops_docs', 'observability_cases']; const testSubjects = getService('testSubjects'); + const svlUserManager = getService('svlUserManager'); const owner = OBSERVABILITY_OWNER; let caseIdMonitoring: string; describe('list view', function () { + let roleAuthc: RoleCredentials; before(async () => { + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); await svlCases.api.createCase( svlCases.api.getPostCaseRequest(owner, { title: 'Metrics inventory', tags: ['IBM resilient'], description: 'Test.', owner, - }) + }), + roleAuthc ); await svlCases.api.createCase( @@ -36,7 +41,8 @@ export default function ({ getPageObject, getPageObjects, getService }: FtrProvi tags: ['jira'], description: 'Test.', owner, - }) + }), + roleAuthc ); const caseMonitoring = await svlCases.api.createCase( @@ -45,7 +51,8 @@ export default function ({ getPageObject, getPageObjects, getService }: FtrProvi tags: ['swimlane'], description: 'Test.', owner, - }) + }), + roleAuthc ); caseIdMonitoring = caseMonitoring.id; }); @@ -56,7 +63,7 @@ export default function ({ getPageObject, getPageObjects, getService }: FtrProvi }); beforeEach(async () => { - await pageObjects.svlCommonPage.login(); + await pageObjects.svlCommonPage.loginWithRole('admin'); }); it('cases list screenshot', async () => { diff --git a/x-pack/test_serverless/functional/test_suites/observability/screenshot_creation/response_ops_docs/connectors/server_log_connector.ts b/x-pack/test_serverless/functional/test_suites/observability/screenshot_creation/response_ops_docs/connectors/server_log_connector.ts index 7eed7d5cbbd26..a38807f4537ca 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/screenshot_creation/response_ops_docs/connectors/server_log_connector.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/screenshot_creation/response_ops_docs/connectors/server_log_connector.ts @@ -15,7 +15,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { describe('server log connector', function () { beforeEach(async () => { - await pageObjects.svlCommonPage.login(); + await pageObjects.svlCommonPage.loginWithRole('admin'); }); after(async () => { diff --git a/x-pack/test_serverless/functional/test_suites/observability/screenshot_creation/response_ops_docs/maintenance_windows/create_window.ts b/x-pack/test_serverless/functional/test_suites/observability/screenshot_creation/response_ops_docs/maintenance_windows/create_window.ts index db43127a0adcf..73f431eeb6ccb 100644 --- a/x-pack/test_serverless/functional/test_suites/observability/screenshot_creation/response_ops_docs/maintenance_windows/create_window.ts +++ b/x-pack/test_serverless/functional/test_suites/observability/screenshot_creation/response_ops_docs/maintenance_windows/create_window.ts @@ -16,7 +16,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) { describe('create window', function () { beforeEach(async () => { - await pageObjects.svlCommonPage.login(); + await pageObjects.svlCommonPage.loginWithRole('admin'); }); after(async () => { diff --git a/x-pack/test_serverless/functional/test_suites/security/screenshot_creation/response_ops_docs/cases/list_view.ts b/x-pack/test_serverless/functional/test_suites/security/screenshot_creation/response_ops_docs/cases/list_view.ts index b7de775a9a7ce..7b9200b3b747b 100644 --- a/x-pack/test_serverless/functional/test_suites/security/screenshot_creation/response_ops_docs/cases/list_view.ts +++ b/x-pack/test_serverless/functional/test_suites/security/screenshot_creation/response_ops_docs/cases/list_view.ts @@ -7,6 +7,7 @@ import { SECURITY_SOLUTION_OWNER } from '@kbn/cases-plugin/common'; import { CaseSeverity } from '@kbn/cases-plugin/common/types/domain'; +import type { RoleCredentials } from '../../../../../../shared/services'; import { FtrProviderContext } from '../../../../../ftr_provider_context'; import { navigateToCasesApp } from '../../../../../../shared/lib/cases'; @@ -17,11 +18,14 @@ export default function ({ getPageObject, getPageObjects, getService }: FtrProvi const svlCommonScreenshots = getService('svlCommonScreenshots'); const screenshotDirectories = ['response_ops_docs', 'security_cases']; const testSubjects = getService('testSubjects'); + const svlUserManager = getService('svlUserManager'); const owner = SECURITY_SOLUTION_OWNER; let caseIdSuspiciousEmail: string; describe('list view', function () { + let roleAuthc: RoleCredentials; before(async () => { + roleAuthc = await svlUserManager.createApiKeyForRole('admin'); await svlCases.api.createCase( svlCases.api.getPostCaseRequest(owner, { title: 'Unusual processes identified', @@ -29,7 +33,8 @@ export default function ({ getPageObject, getPageObjects, getService }: FtrProvi description: 'Test.', owner, severity: CaseSeverity.HIGH, - }) + }), + roleAuthc ); const caseSuspiciousEmail = await svlCases.api.createCase( @@ -38,7 +43,8 @@ export default function ({ getPageObject, getPageObjects, getService }: FtrProvi tags: ['email', 'phishing'], description: 'Several employees have received suspicious emails from an unknown address.', owner, - }) + }), + roleAuthc ); caseIdSuspiciousEmail = caseSuspiciousEmail.id; @@ -49,7 +55,8 @@ export default function ({ getPageObject, getPageObjects, getService }: FtrProvi description: 'Test.', owner, severity: CaseSeverity.MEDIUM, - }) + }), + roleAuthc ); }); diff --git a/yarn.lock b/yarn.lock index e6ad3ab361898..b2c096ed6f9ad 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5180,6 +5180,10 @@ version "0.0.0" uid "" +"@kbn/investigate-plugin@link:x-pack/plugins/observability_solution/investigate": + version "0.0.0" + uid "" + "@kbn/io-ts-utils@link:packages/kbn-io-ts-utils": version "0.0.0" uid "" @@ -6724,6 +6728,10 @@ version "0.0.0" uid "" +"@kbn/unsaved-changes-prompt@link:packages/kbn-unsaved-changes-prompt": + version "0.0.0" + uid "" + "@kbn/upgrade-assistant-plugin@link:x-pack/plugins/upgrade_assistant": version "0.0.0" uid "" @@ -15047,10 +15055,10 @@ d3-collection@^1.0.7: resolved "https://registry.yarnpkg.com/d3-collection/-/d3-collection-1.0.7.tgz#349bd2aa9977db071091c13144d5e4f16b5b310e" integrity sha512-ii0/r5f4sjKNTfh84Di+DpztYwqKhEyUlKoPrzUFfeSkWxjW49xU2QzO9qrPrNkpdI0XJkfzvmTu8V2Zylln6A== -"d3-color@1 - 2": - version "2.0.0" - resolved "https://registry.yarnpkg.com/d3-color/-/d3-color-2.0.0.tgz#8d625cab42ed9b8f601a1760a389f7ea9189d62e" - integrity sha512-SPXi0TSKPD4g9tw0NMZFnR95XVgUZiBH+uUTqQuDu1OsE2zomHU7ho0FISciaPvosimixwHFl3WHLGabv6dDgQ== +"d3-color@1 - 2", "d3-color@npm:@elastic/d3-color@2.0.1": + version "2.0.1" + resolved "https://registry.yarnpkg.com/@elastic/d3-color/-/d3-color-2.0.1.tgz#afb7f58ace7e5ebcdbeddeb06d5e0b16aad5e7c0" + integrity sha512-XIZ+7nbjdjwpdBQLFEE+THVyDAlBGxjvNt8CDGos1f/apkdRHzOiZNgp/LtLdpfG+z3zYApDP9enWCaWCVvHSQ== "d3-color@1 - 3", d3-color@^3.1.0: version "3.1.0" @@ -21791,9 +21799,9 @@ lilconfig@^2.0.3, lilconfig@^2.0.4: integrity sha512-bfTIN7lEsiooCocSISTWXkiWJkRqtL9wYtYy+8EK3Y41qh3mpwPU0ycTOgjdY9ErwXCc8QyrQp82bdL0Xkm9yA== lines-and-columns@^1.1.6: - version "1.1.6" - resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.1.6.tgz#1c00c743b433cd0a4e80758f7b64a57440d9ff00" - integrity sha1-HADHQ7QzzQpOgHWPe2SldEDZ/wA= + version "1.2.4" + resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632" + integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== linkify-it@^5.0.0: version "5.0.0"