diff --git a/.buildkite/ftr_configs.yml b/.buildkite/ftr_configs.yml index c83af688ed47f..fcba384a9844d 100644 --- a/.buildkite/ftr_configs.yml +++ b/.buildkite/ftr_configs.yml @@ -28,7 +28,6 @@ disabled: - x-pack/test/defend_workflows_cypress/cli_config.ts - x-pack/test/defend_workflows_cypress/config.ts - x-pack/test/defend_workflows_cypress/endpoint_config.ts - - x-pack/test/defend_workflows_cypress/visual_config.ts - x-pack/plugins/observability_onboarding/e2e/ftr_config_open.ts - x-pack/plugins/observability_onboarding/e2e/ftr_config_runner.ts - x-pack/plugins/observability_onboarding/e2e/ftr_config.ts @@ -49,6 +48,8 @@ disabled: - x-pack/plugins/apm/ftr_e2e/ftr_config_open.ts - x-pack/plugins/apm/ftr_e2e/ftr_config_run.ts - x-pack/plugins/apm/ftr_e2e/ftr_config.ts + - x-pack/test_serverless/functional/test_suites/observability/cypress/config_headless.ts + - x-pack/test_serverless/functional/test_suites/observability/cypress/config_runner.ts - x-pack/plugins/profiling/e2e/ftr_config_open.ts - x-pack/plugins/profiling/e2e/ftr_config_runner.ts - x-pack/plugins/profiling/e2e/ftr_config.ts @@ -232,6 +233,9 @@ enabled: - x-pack/test/detection_engine_api_integration/security_and_spaces/group9/config.ts - x-pack/test/detection_engine_api_integration/security_and_spaces/group10/config.ts - x-pack/test/detection_engine_api_integration/security_and_spaces/rule_execution_logic/config.ts + - x-pack/test/detection_engine_api_integration/security_and_spaces/prebuilt_rules/config.ts + - x-pack/test/detection_engine_api_integration/security_and_spaces/bundled_prebuilt_rules_package/config.ts + - x-pack/test/detection_engine_api_integration/security_and_spaces/large_prebuilt_rules_package/config.ts - x-pack/test/encrypted_saved_objects_api_integration/config.ts - x-pack/test/examples/config.ts - x-pack/test/fleet_api_integration/config.agent.ts diff --git a/.buildkite/pipelines/pull_request/defend_workflows.yml b/.buildkite/pipelines/pull_request/defend_workflows.yml index 06a4c386b472a..22be5122727bf 100644 --- a/.buildkite/pipelines/pull_request/defend_workflows.yml +++ b/.buildkite/pipelines/pull_request/defend_workflows.yml @@ -14,3 +14,19 @@ steps: limit: 1 artifact_paths: - "target/kibana-security-solution/**/*" + + - command: .buildkite/scripts/steps/functional/defend_workflows_vagrant.sh + label: 'Defend Workflows Endpoint Cypress Tests' + agents: + queue: n2-16-virt + depends_on: build + timeout_in_minutes: 120 + parallelism: 6 + retry: + automatic: + - exit_status: '-1' + limit: 3 + - exit_status: '*' + limit: 1 + artifact_paths: + - "target/kibana-security-solution/**/*" diff --git a/.buildkite/pipelines/serverless.yml b/.buildkite/pipelines/serverless.yml index ec09f77e751ec..f4d7d0d49469b 100644 --- a/.buildkite/pipelines/serverless.yml +++ b/.buildkite/pipelines/serverless.yml @@ -21,19 +21,6 @@ steps: - exit_status: '-1' limit: 3 - - command: SERVERLESS_ENVIRONMENT=common .buildkite/scripts/steps/functional/serverless_ftr.sh - label: 'Serverless Common Tests' - agents: - queue: n2-4-spot - depends_on: build - timeout_in_minutes: 40 - retry: - automatic: - - exit_status: '-1' - limit: 3 - - exit_status: '*' - limit: 1 - - command: SERVERLESS_ENVIRONMENT=observability .buildkite/scripts/steps/functional/serverless_ftr.sh label: 'Serverless Observability Tests' agents: diff --git a/.buildkite/scripts/build_kibana.sh b/.buildkite/scripts/build_kibana.sh index 01810d26758c2..252daa79e0ea8 100755 --- a/.buildkite/scripts/build_kibana.sh +++ b/.buildkite/scripts/build_kibana.sh @@ -41,6 +41,32 @@ if is_pr_with_label "ci:build-cloud-image"; then EOF fi +if is_pr_with_label "ci:build-serverless-image"; then + echo "$KIBANA_DOCKER_PASSWORD" | docker login -u "$KIBANA_DOCKER_USERNAME" --password-stdin docker.elastic.co + GIT_ABBREV_COMMIT=${BUILDKITE_COMMIT:0:12} + node scripts/build \ + --skip-initialize \ + --skip-generic-folders \ + --skip-platform-folders \ + --skip-archives \ + --docker-images \ + --docker-namespace="kibana-ci" \ + --docker-tag="pr-$BUILDKITE_PULL_REQUEST-$GIT_ABBREV_COMMIT" \ + --docker-push \ + --skip-docker-ubi \ + --skip-docker-ubuntu \ + --skip-docker-cloud \ + --skip-docker-contexts + docker logout docker.elastic.co + + SERVERLESS_IMAGE=$(docker images --format "{{.Repository}}:{{.Tag}}" docker.elastic.co/kibana-ci/kibana-serverless) + buildkite-agent meta-data set pr_comment:deploy_cloud:head "* Kibana Serverless Image: \`$SERVERLESS_IMAGE\`" + cat << EOF | buildkite-agent annotate --style "info" --context kibana-serverless-image + + Kibana Serverless Image: \`$SERVERLESS_IMAGE\` +EOF +fi + echo "--- Archive Kibana Distribution" linuxBuild="$(find "$KIBANA_DIR/target" -name 'kibana-*-linux-x86_64.tar.gz')" installDir="$KIBANA_DIR/install/kibana" diff --git a/.buildkite/scripts/pipelines/pull_request/pipeline.ts b/.buildkite/scripts/pipelines/pull_request/pipeline.ts index 70a06d1d97e8d..8ee5588b64330 100644 --- a/.buildkite/scripts/pipelines/pull_request/pipeline.ts +++ b/.buildkite/scripts/pipelines/pull_request/pipeline.ts @@ -60,11 +60,13 @@ const uploadPipeline = (pipelineContent: string | object) => { if ( (await doAnyChangesMatch([ + /^src\/plugins\/controls/, /^packages\/kbn-securitysolution-.*/, /^x-pack\/plugins\/lists/, /^x-pack\/plugins\/security_solution/, /^x-pack\/plugins\/timelines/, /^x-pack\/plugins\/triggers_actions_ui\/public\/application\/sections\/action_connector_form/, + /^x-pack\/plugins\/triggers_actions_ui\/public\/application\/sections\/alerts_table/, /^x-pack\/plugins\/triggers_actions_ui\/public\/application\/context\/actions_connectors_context\.tsx/, /^x-pack\/test\/defend_workflows_cypress/, /^x-pack\/test\/security_solution_cypress/, diff --git a/.buildkite/scripts/steps/artifacts/docker_image.sh b/.buildkite/scripts/steps/artifacts/docker_image.sh index aa75a2b1422cd..6c68f616c23c6 100755 --- a/.buildkite/scripts/steps/artifacts/docker_image.sh +++ b/.buildkite/scripts/steps/artifacts/docker_image.sh @@ -83,17 +83,15 @@ echo "--- Trigger image tag update" if [[ "$BUILDKITE_BRANCH" == "$KIBANA_BASE_BRANCH" ]]; then cat << EOF | buildkite-agent pipeline upload steps: - - trigger: serverless-gitops-update-stack-image-tag + - label: ":argo: Update kibana image tag for kibana-controller using gpctl" async: true - label: ":argo: Update image tag for Kibana" branches: main + trigger: gpctl-promote build: env: - IMAGE_TAG: "git-$GIT_ABBREV_COMMIT" - SERVICE: kibana-controller - NAMESPACE: kibana-ci - IMAGE_NAME: kibana-serverless - COMMIT_MESSAGE: "gitops: update kibana tag to elastic/kibana@$GIT_ABBREV_COMMIT" + SERVICE_COMMIT_HASH: "$GIT_ABBREV_COMMIT" + REMOTE_SERVICE_CONFIG: https://raw.githubusercontent.com/elastic/serverless-gitops/main/gen/gpctl/kibana/config.yaml + EOF else diff --git a/.buildkite/scripts/steps/functional/apm_cypress.sh b/.buildkite/scripts/steps/functional/apm_cypress.sh index 987d9de577c8b..36b6cb3f1ea2f 100755 --- a/.buildkite/scripts/steps/functional/apm_cypress.sh +++ b/.buildkite/scripts/steps/functional/apm_cypress.sh @@ -11,9 +11,16 @@ APM_CYPRESS_RECORD_KEY="$(retry 5 5 vault read -field=CYPRESS_RECORD_KEY secret/ export JOB=kibana-apm-cypress IS_FLAKY_TEST_RUNNER=${CLI_COUNT:-0} +GH_APM_TEAM_LABEL="Team:APM" -#Enabling cypress dashboard recording when PR is labeled with `apm:cypress-record` and we are not using the flaky test runner -if [[ "$IS_FLAKY_TEST_RUNNER" -ne 1 ]] && is_pr_with_label "apm:cypress-record"; then +if (! is_pr); then + echo "--- Add GH labels to buildkite metadata" + ts-node .buildkite/scripts/steps/add_gh_labels_to_bk_metadata.ts BUILDKITE_MESSAGE true + GH_ON_MERGE_LABELS="$(buildkite-agent meta-data get gh_labels)" +fi + +# Enabling cypress dashboard recording when PR is labeled with `apm:cypress-record` and we are not using the flaky test runner OR on merge with Team:APM label applied +if ([[ "$IS_FLAKY_TEST_RUNNER" -ne 1 ]] && is_pr_with_label "apm:cypress-record") || ([[ $GH_ON_MERGE_LABELS == *"$GH_APM_TEAM_LABEL"* ]]); then CYPRESS_ARGS="--record --key "$APM_CYPRESS_RECORD_KEY" --parallel --ci-build-id "${BUILDKITE_BUILD_ID}"" else CYPRESS_ARGS="" diff --git a/.buildkite/scripts/steps/functional/common_cypress.sh b/.buildkite/scripts/steps/functional/common_cypress.sh new file mode 100644 index 0000000000000..4f92cfb683eab --- /dev/null +++ b/.buildkite/scripts/steps/functional/common_cypress.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env bash + +Xvfb -screen 0 1680x946x24 :99 & +export DISPLAY=:99 diff --git a/.buildkite/scripts/steps/functional/defend_workflows.sh b/.buildkite/scripts/steps/functional/defend_workflows.sh index d2a06a1932b8a..039d25d2ed8a8 100755 --- a/.buildkite/scripts/steps/functional/defend_workflows.sh +++ b/.buildkite/scripts/steps/functional/defend_workflows.sh @@ -3,14 +3,11 @@ set -euo pipefail source .buildkite/scripts/steps/functional/common.sh +source .buildkite/scripts/steps/functional/common_cypress.sh export JOB=kibana-defend-workflows-cypress export KIBANA_INSTALL_DIR=${KIBANA_BUILD_LOCATION} -Xvfb -screen 0 1680x946x24 :99 & - -export DISPLAY=:99 - echo "--- Defend Workflows Cypress tests" yarn --cwd x-pack/plugins/security_solution cypress:dw:run diff --git a/.buildkite/scripts/steps/functional/defend_workflows_vagrant.sh b/.buildkite/scripts/steps/functional/defend_workflows_vagrant.sh new file mode 100755 index 0000000000000..a99cf0e86f4ec --- /dev/null +++ b/.buildkite/scripts/steps/functional/defend_workflows_vagrant.sh @@ -0,0 +1,14 @@ +#!/usr/bin/env bash + +set -euo pipefail + +source .buildkite/scripts/steps/functional/common.sh +source .buildkite/scripts/steps/functional/common_cypress.sh + +export JOB=kibana-defend-workflows-endpoint-cypress +export KIBANA_INSTALL_DIR=${KIBANA_BUILD_LOCATION} + + +echo "--- Defend Workflows Endpoint Cypress tests" + +yarn --cwd x-pack/plugins/security_solution cypress:dw:endpoint:run diff --git a/.buildkite/scripts/steps/functional/osquery_cypress.sh b/.buildkite/scripts/steps/functional/osquery_cypress.sh index ecabf52e3c14d..c6cc98d71ce07 100755 --- a/.buildkite/scripts/steps/functional/osquery_cypress.sh +++ b/.buildkite/scripts/steps/functional/osquery_cypress.sh @@ -3,14 +3,11 @@ set -euo pipefail source .buildkite/scripts/common/util.sh +source .buildkite/scripts/steps/functional/common_cypress.sh .buildkite/scripts/bootstrap.sh node scripts/build_kibana_platform_plugins.js -Xvfb :99 -screen 0 1600x1200x24 & - -export DISPLAY=:99 - export JOB=kibana-osquery-cypress echo "--- Osquery Cypress tests" diff --git a/.buildkite/scripts/steps/functional/response_ops.sh b/.buildkite/scripts/steps/functional/response_ops.sh index 066a1b599fd93..6e61ac3b65ed9 100755 --- a/.buildkite/scripts/steps/functional/response_ops.sh +++ b/.buildkite/scripts/steps/functional/response_ops.sh @@ -3,14 +3,11 @@ set -euo pipefail source .buildkite/scripts/steps/functional/common.sh +source .buildkite/scripts/steps/functional/common_cypress.sh export JOB=kibana-security-solution-chrome export KIBANA_INSTALL_DIR=${KIBANA_BUILD_LOCATION} -Xvfb -screen 0 1680x946x24 :99 & - -export DISPLAY=:99 - echo "--- Response Ops Cypress Tests on Security Solution" yarn --cwd x-pack/plugins/security_solution cypress:run:respops diff --git a/.buildkite/scripts/steps/functional/response_ops_cases.sh b/.buildkite/scripts/steps/functional/response_ops_cases.sh index d838307af63c7..07a736d0c2342 100755 --- a/.buildkite/scripts/steps/functional/response_ops_cases.sh +++ b/.buildkite/scripts/steps/functional/response_ops_cases.sh @@ -3,14 +3,11 @@ set -euo pipefail source .buildkite/scripts/steps/functional/common.sh +source .buildkite/scripts/steps/functional/common_cypress.sh export JOB=kibana-security-solution-chrome export KIBANA_INSTALL_DIR=${KIBANA_BUILD_LOCATION} -Xvfb -screen 0 1680x946x24 :99 & - -export DISPLAY=:99 - echo "--- Response Ops Cases Cypress Tests on Security Solution" yarn --cwd x-pack/plugins/security_solution cypress:run:cases diff --git a/.buildkite/scripts/steps/functional/security_solution.sh b/.buildkite/scripts/steps/functional/security_solution.sh index 078c9af1363c6..f021cdc7c8fc3 100755 --- a/.buildkite/scripts/steps/functional/security_solution.sh +++ b/.buildkite/scripts/steps/functional/security_solution.sh @@ -3,14 +3,11 @@ set -euo pipefail source .buildkite/scripts/steps/functional/common.sh +source .buildkite/scripts/steps/functional/common_cypress.sh export JOB=kibana-security-solution-chrome export KIBANA_INSTALL_DIR=${KIBANA_BUILD_LOCATION} -Xvfb :99 -screen 0 1600x1200x24 & - -export DISPLAY=:99 - echo "--- Security Solution tests (Chrome)" yarn --cwd x-pack/plugins/security_solution cypress:run diff --git a/.buildkite/scripts/steps/functional/security_solution_explore.sh b/.buildkite/scripts/steps/functional/security_solution_explore.sh index cc5010602e6fc..6a13b09d15167 100644 --- a/.buildkite/scripts/steps/functional/security_solution_explore.sh +++ b/.buildkite/scripts/steps/functional/security_solution_explore.sh @@ -3,15 +3,11 @@ set -euo pipefail source .buildkite/scripts/steps/functional/common.sh +source .buildkite/scripts/steps/functional/common_cypress.sh export JOB=kibana-security-solution-chrome export KIBANA_INSTALL_DIR=${KIBANA_BUILD_LOCATION} - -Xvfb :99 -screen 0 1600x1200x24 & - -export DISPLAY=:99 - echo "--- Explore Cypress Tests on Security Solution" yarn --cwd x-pack/plugins/security_solution cypress:explore:run diff --git a/.buildkite/scripts/steps/functional/security_solution_investigations.sh b/.buildkite/scripts/steps/functional/security_solution_investigations.sh index 9c6138d335405..e5685ac9dcb51 100644 --- a/.buildkite/scripts/steps/functional/security_solution_investigations.sh +++ b/.buildkite/scripts/steps/functional/security_solution_investigations.sh @@ -3,15 +3,11 @@ set -euo pipefail source .buildkite/scripts/steps/functional/common.sh +source .buildkite/scripts/steps/functional/common_cypress.sh export JOB=kibana-security-solution-chrome export KIBANA_INSTALL_DIR=${KIBANA_BUILD_LOCATION} - -Xvfb :99 -screen 0 1600x1200x24 & - -export DISPLAY=:99 - echo "--- Investigations Cypress Tests on Security Solution" yarn --cwd x-pack/plugins/security_solution cypress:investigations:run diff --git a/.buildkite/scripts/steps/functional/serverless_ftr.sh b/.buildkite/scripts/steps/functional/serverless_ftr.sh index 80b32dddfbd23..f584ce33d6599 100755 --- a/.buildkite/scripts/steps/functional/serverless_ftr.sh +++ b/.buildkite/scripts/steps/functional/serverless_ftr.sh @@ -15,11 +15,13 @@ elif [[ "$SERVERLESS_ENVIRONMENT" == "observability" ]]; then SERVERLESS_CONFIGS=( "x-pack/test_serverless/api_integration/test_suites/observability/config.ts" "x-pack/test_serverless/functional/test_suites/observability/config.ts" + "x-pack/test_serverless/functional/test_suites/observability/cypress/config_headless.ts" ) elif [[ "$SERVERLESS_ENVIRONMENT" == "security" ]]; then SERVERLESS_CONFIGS=( "x-pack/test_serverless/api_integration/test_suites/security/config.ts" "x-pack/test_serverless/functional/test_suites/security/config.ts" + "x-pack/test_serverless/functional/test_suites/security/cypress/config_headless.ts" ) fi diff --git a/.buildkite/scripts/steps/functional/threat_intelligence.sh b/.buildkite/scripts/steps/functional/threat_intelligence.sh index 7da06f7ed9331..c07ea8605c2d0 100755 --- a/.buildkite/scripts/steps/functional/threat_intelligence.sh +++ b/.buildkite/scripts/steps/functional/threat_intelligence.sh @@ -3,14 +3,11 @@ set -euo pipefail source .buildkite/scripts/steps/functional/common.sh +source .buildkite/scripts/steps/functional/common_cypress.sh export JOB=kibana-threat-intelligence-chrome export KIBANA_INSTALL_DIR=${KIBANA_BUILD_LOCATION} -Xvfb :99 -screen 0 1600x1200x24 & - -export DISPLAY=:99 - echo "--- Threat Intelligence tests (Chrome)" yarn --cwd x-pack/plugins/threat_intelligence cypress:run diff --git a/.eslintrc.js b/.eslintrc.js index be80d7550253a..dacfa2d470e05 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -986,7 +986,11 @@ module.exports = { 'x-pack/packages/kbn-elastic-assistant/**/*.{js,mjs,ts,tsx}', 'x-pack/packages/security-solution/**/*.{js,mjs,ts,tsx}', 'x-pack/plugins/security_solution/public/**/*.{js,mjs,ts,tsx}', + 'x-pack/plugins/security_solution_ess/public/**/*.{js,mjs,ts,tsx}', + 'x-pack/plugins/security_solution_serverless/public/**/*.{js,mjs,ts,tsx}', 'x-pack/plugins/security_solution/common/**/*.{js,mjs,ts,tsx}', + 'x-pack/plugins/security_solution_ess/common/**/*.{js,mjs,ts,tsx}', + 'x-pack/plugins/security_solution_serverless/common/**/*.{js,mjs,ts,tsx}', 'x-pack/plugins/timelines/public/**/*.{js,mjs,ts,tsx}', 'x-pack/plugins/timelines/common/**/*.{js,mjs,ts,tsx}', 'x-pack/plugins/cases/public/**/*.{js,mjs,ts,tsx}', @@ -1014,6 +1018,8 @@ module.exports = { 'x-pack/packages/kbn-elastic-assistant/**/*.{ts,tsx}', 'x-pack/packages/security-solution/**/*.{ts,tsx}', 'x-pack/plugins/security_solution/**/*.{ts,tsx}', + 'x-pack/plugins/security_solution_ess/**/*.{ts,tsx}', + 'x-pack/plugins/security_solution_serverless/**/*.{ts,tsx}', 'x-pack/plugins/timelines/**/*.{ts,tsx}', 'x-pack/plugins/cases/**/*.{ts,tsx}', ], @@ -1022,6 +1028,8 @@ module.exports = { 'x-pack/packages/kbn-elastic-assistant/**/*.{test,mock,test_helper}.{ts,tsx}', 'x-pack/packages/security-solution/**/*.{test,mock,test_helper}.{ts,tsx}', 'x-pack/plugins/security_solution/**/*.{test,mock,test_helper}.{ts,tsx}', + 'x-pack/plugins/security_solution_ess/**/*.{test,mock,test_helper}.{ts,tsx}', + 'x-pack/plugins/security_solution_serverless/**/*.{test,mock,test_helper}.{ts,tsx}', 'x-pack/plugins/timelines/**/*.{test,mock,test_helper}.{ts,tsx}', 'x-pack/plugins/cases/**/*.{test,mock,test_helper}.{ts,tsx}', ], @@ -1036,6 +1044,8 @@ module.exports = { 'x-pack/packages/kbn-elastic-assistant/**/*.{ts,tsx}', 'x-pack/packages/security-solution/**/*.{ts,tsx}', 'x-pack/plugins/security_solution/**/*.{ts,tsx}', + 'x-pack/plugins/security_solution_ess/**/*.{ts,tsx}', + 'x-pack/plugins/security_solution_serverless/**/*.{ts,tsx}', 'x-pack/plugins/timelines/**/*.{ts,tsx}', 'x-pack/plugins/cases/**/*.{ts,tsx}', ], @@ -1069,6 +1079,8 @@ module.exports = { 'x-pack/packages/kbn-elastic-assistant/**/*.{js,mjs,ts,tsx}', 'x-pack/packages/security-solution/**/*.{js,mjs,ts,tsx}', 'x-pack/plugins/security_solution/**/*.{js,mjs,ts,tsx}', + 'x-pack/plugins/security_solution_ess/**/*.{js,mjs,ts,tsx}', + 'x-pack/plugins/security_solution_serverless/**/*.{js,mjs,ts,tsx}', 'x-pack/plugins/timelines/**/*.{js,mjs,ts,tsx}', 'x-pack/plugins/cases/**/*.{js,mjs,ts,tsx}', ], @@ -1163,6 +1175,8 @@ module.exports = { { files: [ 'x-pack/plugins/security_solution/**/*.{js,mjs,ts,tsx}', + 'x-pack/plugins/security_solution_ess/**/*.{js,mjs,ts,tsx}', + 'x-pack/plugins/security_solution_serverless/**/*.{js,mjs,ts,tsx}', 'x-pack/plugins/cases/**/*.{js,mjs,ts,tsx}', ], rules: { diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index bfe7bdb251c60..f80c87ff4058b 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -359,7 +359,6 @@ packages/kbn-eslint-plugin-eslint @elastic/kibana-operations packages/kbn-eslint-plugin-imports @elastic/kibana-operations packages/kbn-eslint-plugin-telemetry @elastic/actionable-observability x-pack/test/encrypted_saved_objects_api_integration/plugins/api_consumer_plugin @elastic/kibana-security -x-pack/plugins/ess_security @elastic/security-solution src/plugins/event_annotation @elastic/kibana-visualizations x-pack/test/plugin_api_integration/plugins/event_log @elastic/response-ops x-pack/plugins/event_log @elastic/response-ops @@ -401,6 +400,7 @@ src/plugins/ftr_apis @elastic/kibana-core packages/kbn-ftr-common-functional-services @elastic/kibana-operations @elastic/appex-qa packages/kbn-ftr-screenshot-filename @elastic/kibana-operations @elastic/appex-qa x-pack/test/functional_with_es_ssl/plugins/cases @elastic/response-ops +x-pack/examples/gen_ai_streaming_response_example @elastic/response-ops packages/kbn-generate @elastic/kibana-operations packages/kbn-generate-console-definitions @elastic/platform-deployment-management packages/kbn-generate-csv @elastic/appex-sharedux @@ -468,6 +468,7 @@ examples/locator_examples @elastic/kibana-app-services examples/locator_explorer @elastic/kibana-app-services packages/kbn-logging @elastic/kibana-core packages/kbn-logging-mocks @elastic/kibana-core +x-pack/plugins/logs_shared @elastic/infra-monitoring-ui x-pack/plugins/logstash @elastic/logstash packages/kbn-managed-vscode-config @elastic/kibana-operations packages/kbn-managed-vscode-config-cli @elastic/kibana-operations @@ -552,6 +553,7 @@ examples/response_stream @elastic/ml-ui packages/kbn-rison @elastic/kibana-operations x-pack/plugins/rollup @elastic/platform-deployment-management examples/routing_example @elastic/kibana-core +packages/kbn-rrule @elastic/response-ops packages/kbn-rule-data-utils @elastic/security-detections-response @elastic/actionable-observability @elastic/response-ops x-pack/plugins/rule_registry @elastic/response-ops @elastic/actionable-observability x-pack/plugins/runtime_fields @elastic/platform-deployment-management @@ -578,8 +580,10 @@ examples/search_examples @elastic/kibana-data-discovery x-pack/plugins/searchprofiler @elastic/platform-deployment-management x-pack/test/security_api_integration/packages/helpers @elastic/kibana-core x-pack/plugins/security @elastic/kibana-security +x-pack/plugins/security_solution_ess @elastic/security-solution x-pack/test/cases_api_integration/common/plugins/security_solution @elastic/response-ops x-pack/plugins/security_solution @elastic/security-solution +x-pack/plugins/security_solution_serverless @elastic/security-solution x-pack/packages/security-solution/side_nav @elastic/security-threat-hunting-explore x-pack/packages/security-solution/storybook/config @elastic/security-threat-hunting-explore x-pack/test/security_functional/plugins/test_endpoints @elastic/kibana-security @@ -607,7 +611,6 @@ x-pack/plugins/serverless @elastic/appex-sharedux x-pack/plugins/serverless_observability @elastic/appex-sharedux @elastic/apm-ui packages/serverless/project_switcher @elastic/appex-sharedux x-pack/plugins/serverless_search @elastic/enterprise-search-frontend -x-pack/plugins/serverless_security @elastic/security-solution packages/serverless/storybook/config @elastic/appex-sharedux packages/serverless/types @elastic/appex-sharedux test/plugin_functional/plugins/session_notifications @elastic/kibana-core @@ -822,7 +825,7 @@ packages/kbn-yarn-lock-validator @elastic/kibana-operations #CC# /src/plugins/home/server/services/ @elastic/appex-sharedux #CC# /src/plugins/home/ @elastic/appex-sharedux #CC# /x-pack/plugins/reporting/ @elastic/appex-sharedux -#CC# /x-pack/plugins/serverless_security/ @elastic/appex-sharedux +#CC# /x-pack/plugins/security_solution_serverless/ @elastic/appex-sharedux ### Observability Plugins @@ -869,6 +872,8 @@ x-pack/plugins/infra/server/lib/alerting @elastic/actionable-observability /x-pack/test/functional/services/uptime @elastic/uptime /x-pack/test/api_integration/apis/uptime @elastic/uptime /x-pack/test/api_integration/apis/synthetics @elastic/uptime +/x-pack/test/alerting_api_integration/observability/synthetics_rule.ts @elastic/uptime +/x-pack/test/alerting_api_integration/observability/index.ts @elastic/uptime # Client Side Monitoring / Uptime (lives in APM directories but owned by Uptime) /x-pack/plugins/apm/public/application/uxApp.tsx @elastic/uptime @@ -879,6 +884,9 @@ x-pack/plugins/infra/server/lib/alerting @elastic/actionable-observability /x-pack/plugins/observability_shared/public/components/tour @elastic/platform-onboarding /x-pack/test/functional/apps/infra/tour.ts @elastic/platform-onboarding +# Observability settings +/x-pack/plugins/observability/server/ui_settings.ts @elastic/obs-docs + ### END Observability Plugins # Presentation @@ -890,7 +898,6 @@ x-pack/plugins/infra/server/lib/alerting @elastic/actionable-observability #CC# /src/plugins/kibana_react/public/code_editor/ @elastic/kibana-presentation # Machine Learning -/x-pack/plugins/ml/common/openapi/ @elastic/mlr-docs /x-pack/test/accessibility/apps/ml.ts @elastic/ml-ui /x-pack/test/accessibility/apps/ml_embeddables_in_dashboard.ts @elastic/ml-ui /x-pack/test/api_integration/apis/ml/ @elastic/ml-ui @@ -904,10 +911,10 @@ x-pack/plugins/infra/server/lib/alerting @elastic/actionable-observability /x-pack/test/alerting_api_integration/spaces_only/tests/alerting/transform_rule_types/ @elastic/ml-ui /x-pack/test/screenshot_creation/apps/ml_docs @elastic/ml-ui /x-pack/test/screenshot_creation/services/ml_screenshots.ts @elastic/ml-ui -/docs/api/machine-learning/ @elastic/mlr-docs # Additional plugins and packages maintained by the ML team. /x-pack/test/accessibility/apps/transform.ts @elastic/ml-ui +/x-pack/test/api_integration/apis/aiops/ @elastic/ml-ui /x-pack/test/api_integration/apis/transform/ @elastic/ml-ui /x-pack/test/api_integration_basic/apis/transform/ @elastic/ml-ui /x-pack/test/functional/apps/transform/ @elastic/ml-ui @@ -1012,10 +1019,6 @@ x-pack/plugins/cloud_integrations/cloud_full_story/server/config.ts @elastic/kib /x-pack/test/functional/services/cases/ @elastic/response-ops /x-pack/test/functional_with_es_ssl/apps/cases/ @elastic/response-ops /x-pack/test/api_integration/apis/cases/ @elastic/response-ops -/docs/api/actions-and-connectors @elastic/mlr-docs -/docs/api/alerting @elastic/mlr-docs -/docs/api/cases @elastic/mlr-docs -/x-pack/plugins/cases/docs/openapi @elastic/mlr-docs # Enterprise Search /x-pack/test/functional_enterprise_search/ @elastic/enterprise-search-frontend @@ -1032,6 +1035,11 @@ x-pack/plugins/cloud_integrations/cloud_full_story/server/config.ts @elastic/kib /x-pack/test/api_integration/apis/security_solution @elastic/security-solution #CC# /x-pack/plugins/security_solution/ @elastic/security-solution +# Security Solution Offering plugins +# TODO: assign sub directories to sub teams +/x-pack/plugins/security_solution_ess/ @elastic/security-solution +/x-pack/plugins/security_solution_serverless/ @elastic/security-solution + # Security Solution sub teams ## Security Solution sub teams - Threat Hunting Investigations @@ -1102,14 +1110,19 @@ x-pack/plugins/cloud_integrations/cloud_full_story/server/config.ts @elastic/kib /x-pack/plugins/stack_connectors/common/gen_ai @elastic/security-threat-hunting-explore ## Security Solution sub teams - Detection Rule Management +/x-pack/plugins/security_solution/common/api/detection_engine/fleet_integrations @elastic/security-detection-rule-management +/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules @elastic/security-detection-rule-management +/x-pack/plugins/security_solution/common/api/detection_engine/rule_management @elastic/security-detection-rule-management +/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring @elastic/security-detection-rule-management +/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema @elastic/security-detection-rule-management @elastic/security-detection-engine + /x-pack/plugins/security_solution/common/detection_engine/fleet_integrations @elastic/security-detection-rule-management /x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules @elastic/security-detection-rule-management /x-pack/plugins/security_solution/common/detection_engine/rule_management @elastic/security-detection-rule-management /x-pack/plugins/security_solution/common/detection_engine/rule_monitoring @elastic/security-detection-rule-management -/x-pack/plugins/security_solution/common/detection_engine/rule_schema @elastic/security-detection-rule-management @elastic/security-detection-engine -/x-pack/plugins/security_solution/cypress/test_plans/detection_response/prebuilt_rules @elastic/security-detection-rule-management -/x-pack/plugins/security_solution/cypress/test_plans/detection_response/rule_management @elastic/security-detection-rule-management +/x-pack/plugins/security_solution/docs/testing/test_plans/detection_response/prebuilt_rules @elastic/security-detection-rule-management +/x-pack/plugins/security_solution/docs/testing/test_plans/detection_response/rule_management @elastic/security-detection-rule-management /x-pack/plugins/security_solution/public/common/components/health_truncate_text @elastic/security-detection-rule-management /x-pack/plugins/security_solution/public/common/components/links_to_docs @elastic/security-detection-rule-management @@ -1128,6 +1141,8 @@ x-pack/plugins/cloud_integrations/cloud_full_story/server/config.ts @elastic/kib /x-pack/plugins/security_solution/public/detections/mitre @elastic/security-detection-rule-management /x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules @elastic/security-detection-rule-management /x-pack/plugins/security_solution/public/rules @elastic/security-detection-rule-management +/x-pack/plugins/security_solution/public/entity_analytics @elastic/security-detection-engine + /x-pack/plugins/security_solution/server/lib/detection_engine/fleet_integrations @elastic/security-detection-rule-management /x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules @elastic/security-detection-rule-management @@ -1139,7 +1154,7 @@ x-pack/plugins/cloud_integrations/cloud_full_story/server/config.ts @elastic/kib ## Security Solution sub teams - Detection Engine -/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts @elastic/security-detection-engine +/x-pack/plugins/security_solution/common/api/detection_engine @elastic/security-detection-engine /x-pack/plugins/security_solution/common/field_maps @elastic/security-detection-engine /x-pack/plugins/security_solution/public/detection_engine/rule_creation_ui @elastic/security-detection-engine @@ -1154,6 +1169,7 @@ x-pack/plugins/cloud_integrations/cloud_full_story/server/config.ts @elastic/kib /x-pack/plugins/security_solution/cypress/e2e/data_sources @elastic/security-detection-engine /x-pack/plugins/security_solution/cypress/e2e/exceptions @elastic/security-detection-engine /x-pack/plugins/security_solution/cypress/e2e/value_lists @elastic/security-detection-engine +/x-pack/plugins/security_solution/cypress/e2e/entity_analytics @elastic/security-detection-engine /x-pack/plugins/security_solution/common/detection_engine/rule_exceptions @elastic/security-detection-engine @@ -1257,6 +1273,8 @@ x-pack/test/threat_intelligence_cypress @elastic/protections-experience # Security design /x-pack/plugins/endpoint/**/*.scss @elastic/security-design /x-pack/plugins/security_solution/**/*.scss @elastic/security-design +/x-pack/plugins/security_solution_ess/**/*.scss @elastic/security-design +/x-pack/plugins/security_solution_serverless/**/*.scss @elastic/security-design # Logstash #CC# /x-pack/plugins/logstash/ @elastic/logstash diff --git a/.gitignore b/.gitignore index 4999eb2fb5a17..86a789a1cfb5f 100644 --- a/.gitignore +++ b/.gitignore @@ -99,6 +99,12 @@ x-pack/plugins/fleet/cypress.config.d.ts x-pack/plugins/fleet/cypress.config.js x-pack/plugins/osquery/cypress.config.d.ts x-pack/plugins/osquery/cypress.config.js +x-pack/plugins/enterprise_search/cypress.config.d.ts +x-pack/plugins/enterprise_search/cypress.config.js +x-pack/plugins/security_solution/public/management/cypress.config.d.ts +x-pack/plugins/security_solution/public/management/cypress.config.js +x-pack/plugins/security_solution/public/management/cypress_endpoint.config.d.ts +x-pack/plugins/security_solution/public/management/cypress_endpoint.config.js # release notes script output report.csv diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json index cf8e0ca6a5155..77efc367450b5 100644 --- a/api_docs/actions.devdocs.json +++ b/api_docs/actions.devdocs.json @@ -2412,6 +2412,17 @@ "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "actions", + "id": "def-server.ActionResult.isSystemAction", + "type": "boolean", + "tags": [], + "label": "isSystemAction", + "description": [], + "path": "x-pack/plugins/actions/server/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -2651,6 +2662,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "actions", + "id": "def-server.ActionType.isSystemActionType", + "type": "CompoundType", + "tags": [], + "label": "isSystemActionType", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/actions/server/types.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "actions", "id": "def-server.ActionType.renderParameterTemplates", @@ -2937,6 +2962,66 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "actions", + "id": "def-server.InMemoryConnector", + "type": "Interface", + "tags": [], + "label": "InMemoryConnector", + "description": [], + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.InMemoryConnector", + "text": "InMemoryConnector" + }, + " extends ", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ActionResult", + "text": "ActionResult" + }, + "" + ], + "path": "x-pack/plugins/actions/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.InMemoryConnector.secrets", + "type": "Uncategorized", + "tags": [], + "label": "secrets", + "description": [], + "signature": [ + "Secrets" + ], + "path": "x-pack/plugins/actions/server/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "actions", + "id": "def-server.InMemoryConnector.config", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Config" + ], + "path": "x-pack/plugins/actions/server/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "actions", "id": "def-server.IUnsecuredActionsClient", @@ -3001,52 +3086,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "actions", - "id": "def-server.PreConfiguredAction", - "type": "Interface", - "tags": [], - "label": "PreConfiguredAction", - "description": [], - "signature": [ - { - "pluginId": "actions", - "scope": "server", - "docId": "kibActionsPluginApi", - "section": "def-server.PreConfiguredAction", - "text": "PreConfiguredAction" - }, - " extends ", - { - "pluginId": "actions", - "scope": "server", - "docId": "kibActionsPluginApi", - "section": "def-server.ActionResult", - "text": "ActionResult" - }, - "" - ], - "path": "x-pack/plugins/actions/server/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "actions", - "id": "def-server.PreConfiguredAction.secrets", - "type": "Uncategorized", - "tags": [], - "label": "secrets", - "description": [], - "signature": [ - "Secrets" - ], - "path": "x-pack/plugins/actions/server/types.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "actions", "id": "def-server.ServiceParams", @@ -3290,7 +3329,7 @@ "section": "def-common.ActionType", "text": "ActionType" }, - "[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; isPreconfigured: (connectorId: string) => boolean; getGlobalExecutionLogWithAuth: ({ dateStart, dateEnd, filter, page, perPage, sort, namespaces, }: ", + "[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; isPreconfigured: (connectorId: string) => boolean; isSystemAction: (connectorId: string) => boolean; getGlobalExecutionLogWithAuth: ({ dateStart, dateEnd, filter, page, perPage, sort, namespaces, }: ", { "pluginId": "actions", "scope": "common", @@ -3823,18 +3862,18 @@ }, { "parentPluginId": "actions", - "id": "def-server.PluginStartContract.preconfiguredActions", + "id": "def-server.PluginStartContract.inMemoryConnectors", "type": "Array", "tags": [], - "label": "preconfiguredActions", + "label": "inMemoryConnectors", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", - "section": "def-server.PreConfiguredAction", - "text": "PreConfiguredAction" + "section": "def-server.InMemoryConnector", + "text": "InMemoryConnector" }, "<", "ActionTypeConfig", @@ -4490,6 +4529,17 @@ "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "actions", + "id": "def-common.ActionType.isSystemActionType", + "type": "boolean", + "tags": [], + "label": "isSystemActionType", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index e4059a185d67f..8c6e45948f685 100644 --- a/api_docs/actions.mdx +++ b/api_docs/actions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions title: "actions" image: https://source.unsplash.com/400x175/?github description: API docs for the actions plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] --- import actionsObj from './actions.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 268 | 10 | 263 | 27 | +| 272 | 10 | 267 | 27 | ## Client diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index c66454a419263..659ffa48f82e7 100644 --- a/api_docs/advanced_settings.mdx +++ b/api_docs/advanced_settings.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings title: "advancedSettings" image: https://source.unsplash.com/400x175/?github description: API docs for the advancedSettings plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] --- import advancedSettingsObj from './advanced_settings.devdocs.json'; diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx index 79d62cf6f7adf..d925a18321c60 100644 --- a/api_docs/aiops.mdx +++ b/api_docs/aiops.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops title: "aiops" image: https://source.unsplash.com/400x175/?github description: API docs for the aiops plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] --- import aiopsObj from './aiops.devdocs.json'; diff --git a/api_docs/alerting.devdocs.json b/api_docs/alerting.devdocs.json index bff251325f574..4a5ed373058a6 100644 --- a/api_docs/alerting.devdocs.json +++ b/api_docs/alerting.devdocs.json @@ -2406,59 +2406,125 @@ }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorOptions", + "id": "def-server.Rule", "type": "Interface", "tags": [], - "label": "RuleExecutorOptions", + "label": "Rule", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", - "section": "def-server.RuleExecutorOptions", - "text": "RuleExecutorOptions" + "section": "def-server.Rule", + "text": "Rule" }, - "" + "" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorOptions.executionId", + "id": "def-server.Rule.id", "type": "string", "tags": [], - "label": "executionId", + "label": "id", "description": [], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorOptions.logger", + "id": "def-server.Rule.enabled", + "type": "boolean", + "tags": [], + "label": "enabled", + "description": [], + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.Rule.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.Rule.tags", + "type": "Array", + "tags": [], + "label": "tags", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.Rule.alertTypeId", + "type": "string", + "tags": [], + "label": "alertTypeId", + "description": [], + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.Rule.consumer", + "type": "string", + "tags": [], + "label": "consumer", + "description": [], + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.Rule.schedule", "type": "Object", "tags": [], - "label": "logger", + "label": "schedule", "description": [], "signature": [ - { - "pluginId": "@kbn/logging", - "scope": "common", - "docId": "kibKbnLoggingPluginApi", - "section": "def-common.Logger", - "text": "Logger" - } + "{ readonly interval: string; }" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorOptions.params", + "id": "def-server.Rule.actions", + "type": "Array", + "tags": [], + "label": "actions", + "description": [], + "signature": [ + "Readonly<{ frequency?: Readonly<{} & { throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"; summary: boolean; }> | undefined; alertsFilter?: Readonly<{ query?: Readonly<{ dsl?: string | undefined; } & { kql: string; filters: Readonly<{ query?: Record | undefined; state$?: Readonly<{} & { store: string; }> | undefined; } & { meta: Record; }>[]; }> | undefined; timeframe?: Readonly<{} & { days: (2 | 7 | 6 | 5 | 4 | 3 | 1)[]; hours: Readonly<{} & { start: string; end: string; }>; timezone: string; }> | undefined; } & {}> | undefined; uuid?: string | undefined; } & { id: string; params: Record; actionTypeId: string; group: string; }>[]" + ], + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.Rule.params", "type": "Uncategorized", "tags": [], "label": "params", @@ -2466,758 +2532,309 @@ "signature": [ "Params" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorOptions.previousStartedAt", - "type": "CompoundType", + "id": "def-server.Rule.mapped_params", + "type": "Object", "tags": [], - "label": "previousStartedAt", + "label": "mapped_params", "description": [], "signature": [ - "Date | null" + "Record | undefined" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorOptions.rule", - "type": "CompoundType", + "id": "def-server.Rule.scheduledTaskId", + "type": "string", "tags": [], - "label": "rule", + "label": "scheduledTaskId", "description": [], "signature": [ - "Pick<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.SanitizedRule", - "text": "SanitizedRule" - }, - ", \"id\" | \"consumer\" | \"name\" | \"actions\" | \"tags\" | \"enabled\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"muteAll\" | \"notifyWhen\" | \"snoozeSchedule\" | \"revision\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" + "string | undefined" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorOptions.services", - "type": "Object", + "id": "def-server.Rule.createdBy", + "type": "CompoundType", "tags": [], - "label": "services", + "label": "createdBy", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.RuleExecutorServices", - "text": "RuleExecutorServices" - }, - "" + "string | null" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorOptions.spaceId", - "type": "string", + "id": "def-server.Rule.updatedBy", + "type": "CompoundType", "tags": [], - "label": "spaceId", + "label": "updatedBy", "description": [], - "path": "x-pack/plugins/alerting/server/types.ts", + "signature": [ + "string | null" + ], + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorOptions.startedAt", + "id": "def-server.Rule.createdAt", "type": "Object", "tags": [], - "label": "startedAt", + "label": "createdAt", "description": [], "signature": [ "Date" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorOptions.state", - "type": "Uncategorized", + "id": "def-server.Rule.updatedAt", + "type": "Object", "tags": [], - "label": "state", + "label": "updatedAt", "description": [], "signature": [ - "State" + "Date" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorOptions.namespace", - "type": "string", + "id": "def-server.Rule.apiKeyOwner", + "type": "CompoundType", "tags": [], - "label": "namespace", + "label": "apiKeyOwner", "description": [], "signature": [ - "string | undefined" + "string | null" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorOptions.flappingSettings", - "type": "Object", + "id": "def-server.Rule.apiKeyCreatedByUser", + "type": "CompoundType", "tags": [], - "label": "flappingSettings", + "label": "apiKeyCreatedByUser", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RulesSettingsFlappingProperties", - "text": "RulesSettingsFlappingProperties" - } + "boolean | null | undefined" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorOptions.maintenanceWindowIds", - "type": "Array", + "id": "def-server.Rule.throttle", + "type": "CompoundType", "tags": [], - "label": "maintenanceWindowIds", + "label": "throttle", "description": [], "signature": [ - "string[] | undefined" + "string | null | undefined" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.RuleExecutorServices", - "type": "Interface", - "tags": [], - "label": "RuleExecutorServices", - "description": [], - "signature": [ + }, { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.RuleExecutorServices", - "text": "RuleExecutorServices" + "parentPluginId": "alerting", + "id": "def-server.Rule.muteAll", + "type": "boolean", + "tags": [], + "label": "muteAll", + "description": [], + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", + "deprecated": false, + "trackAdoption": false }, - "" - ], - "path": "x-pack/plugins/alerting/server/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorServices.searchSourceClient", - "type": "Object", + "id": "def-server.Rule.notifyWhen", + "type": "CompoundType", "tags": [], - "label": "searchSourceClient", + "label": "notifyWhen", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchStartSearchSource", - "text": "ISearchStartSearchSource" - } + "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorServices.savedObjectsClient", - "type": "Object", + "id": "def-server.Rule.mutedInstanceIds", + "type": "Array", "tags": [], - "label": "savedObjectsClient", + "label": "mutedInstanceIds", "description": [], "signature": [ - { - "pluginId": "@kbn/core-saved-objects-api-server", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", - "section": "def-common.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "string[]" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorServices.uiSettingsClient", + "id": "def-server.Rule.executionStatus", "type": "Object", "tags": [], - "label": "uiSettingsClient", + "label": "executionStatus", "description": [], "signature": [ - { - "pluginId": "@kbn/core-ui-settings-server", - "scope": "common", - "docId": "kibKbnCoreUiSettingsServerPluginApi", - "section": "def-common.IUiSettingsClient", - "text": "IUiSettingsClient" - } + "RuleExecutionStatus" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorServices.scopedClusterClient", + "id": "def-server.Rule.monitoring", "type": "Object", "tags": [], - "label": "scopedClusterClient", + "label": "monitoring", "description": [], "signature": [ - { - "pluginId": "@kbn/core-elasticsearch-server", - "scope": "common", - "docId": "kibKbnCoreElasticsearchServerPluginApi", - "section": "def-common.IScopedClusterClient", - "text": "IScopedClusterClient" - } + "Readonly<{} & { run: Readonly<{} & { history: Readonly<{ outcome?: Readonly<{ warning?: \"execute\" | \"license\" | \"validate\" | \"timeout\" | \"unknown\" | \"read\" | \"decrypt\" | \"disabled\" | \"maxExecutableActions\" | \"maxAlerts\" | null | undefined; outcomeOrder?: number | undefined; outcomeMsg?: string[] | null | undefined; } & { outcome: \"warning\" | \"succeeded\" | \"failed\"; alertsCount: Readonly<{ recovered?: number | null | undefined; active?: number | null | undefined; new?: number | null | undefined; ignored?: number | null | undefined; } & {}>; }> | undefined; duration?: number | undefined; } & { timestamp: number; success: boolean; }>[]; calculated_metrics: Readonly<{ p50?: number | undefined; p95?: number | undefined; p99?: number | undefined; } & { success_ratio: number; }>; last_run: Readonly<{} & { timestamp: string; metrics: Readonly<{ duration?: number | undefined; total_search_duration_ms?: number | null | undefined; total_indexing_duration_ms?: number | null | undefined; total_alerts_detected?: number | null | undefined; total_alerts_created?: number | null | undefined; gap_duration_s?: number | null | undefined; } & {}>; }>; }>; }> | undefined" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorServices.alertFactory", - "type": "CompoundType", - "tags": [ - "deprecated" - ], - "label": "alertFactory", - "description": [ - "\nDeprecate alertFactory and remove when all rules are onboarded to\nthe alertsClient" - ], + "id": "def-server.Rule.snoozeSchedule", + "type": "Array", + "tags": [], + "label": "snoozeSchedule", + "description": [], "signature": [ - "Pick<", - "AlertFactory", - ", \"create\" | \"done\"> & { alertLimit: Pick<{ getValue: () => number; setLimitReached: (reached: boolean) => void; checkLimitUsage: () => void; }, \"getValue\" | \"setLimitReached\">; }" + "Readonly<{ id?: string | undefined; skipRecurrences?: string[] | undefined; } & { duration: number; rRule: Readonly<{ count?: number | undefined; interval?: number | undefined; freq?: 0 | 2 | 6 | 5 | 4 | 3 | 1 | undefined; until?: string | undefined; wkst?: \"MO\" | \"TU\" | \"WE\" | \"TH\" | \"FR\" | \"SA\" | \"SU\" | undefined; byweekday?: (string | number)[] | undefined; bymonth?: number[] | undefined; bysetpos?: number[] | undefined; } & { dtstart: string; tzid: string; bymonthday: number[]; byyearday: number[]; byweekno: number[]; byhour: number[]; byminute: number[]; bysecond: number[]; }>; }>[] | undefined" ], - "path": "x-pack/plugins/alerting/server/types.ts", - "deprecated": true, - "trackAdoption": false, - "references": [ - { - "plugin": "ruleRegistry", - "path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts" - }, - { - "plugin": "ruleRegistry", - "path": "x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_wrapper.ts" - }, - { - "plugin": "ruleRegistry", - "path": "x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_wrapper.ts" - }, - { - "plugin": "observability", - "path": "x-pack/plugins/observability/server/lib/rules/slo_burn_rate/executor.ts" - }, - { - "plugin": "observability", - "path": "x-pack/plugins/observability/server/lib/rules/threshold/threshold_executor.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/lib/alerts/register_jobs_monitoring_rule_type.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/lib/alerts/register_jobs_monitoring_rule_type.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/lib/alerts/register_anomaly_detection_alert_type.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/lib/alerts/register_anomaly_detection_alert_type.ts" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/server/lib/alerting/metric_threshold/metric_threshold_executor.ts" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/server/lib/alerting/inventory_metric_threshold/inventory_metric_threshold_executor.ts" - }, - { - "plugin": "infra", - "path": "x-pack/plugins/infra/server/lib/alerting/metric_anomaly/metric_anomaly_executor.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/notifications/legacy_rules_notification_alert_type.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/server/alerts/base_rule.ts" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/server/rule_types/index_threshold/rule_type.ts" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/server/rule_types/index_threshold/rule_type.ts" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/server/rule_types/geo_containment/lib/get_entities_and_generate_alerts.ts" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/server/rule_types/geo_containment/executor.ts" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/server/rule_types/geo_containment/executor.ts" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/server/rule_types/es_query/executor.ts" - }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/alert_rules/tls_rule/message_utils.ts" - }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/alert_rules/common.ts" - }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/alert_rules/tls_rule/tls_rule.ts" - }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/alert_rules/status_rule/monitor_status_rule.ts" - }, - { - "plugin": "transform", - "path": "x-pack/plugins/transform/server/lib/alerting/transform_health_rule_type/register_transform_health_rule_type.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/server/legacy_uptime/lib/alerts/common.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/server/legacy_uptime/lib/alerts/status_check.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/server/legacy_uptime/lib/alerts/tls.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/server/legacy_uptime/lib/alerts/tls_legacy.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/server/legacy_uptime/lib/alerts/duration_anomaly.ts" - }, - { - "plugin": "ruleRegistry", - "path": "x-pack/plugins/rule_registry/server/utils/rule_executor.test_helpers.ts" - }, - { - "plugin": "observability", - "path": "x-pack/plugins/observability/server/lib/rules/slo_burn_rate/executor.test.ts" - } - ] + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", + "deprecated": false, + "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorServices.alertsClient", - "type": "CompoundType", + "id": "def-server.Rule.activeSnoozes", + "type": "Array", "tags": [], - "label": "alertsClient", - "description": [ - "\nOnly available when framework alerts are enabled and rule\ntype has registered alert context with the framework with shouldWrite set to true" - ], + "label": "activeSnoozes", + "description": [], "signature": [ - "PublicAlertsClient", - " | null" + "string[] | undefined" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorServices.shouldWriteAlerts", - "type": "Function", + "id": "def-server.Rule.isSnoozedUntil", + "type": "CompoundType", "tags": [], - "label": "shouldWriteAlerts", + "label": "isSnoozedUntil", "description": [], "signature": [ - "() => boolean" + "Date | null | undefined" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorServices.shouldStopExecution", - "type": "Function", + "id": "def-server.Rule.lastRun", + "type": "CompoundType", "tags": [], - "label": "shouldStopExecution", + "label": "lastRun", "description": [], "signature": [ - "() => boolean" + "Readonly<{ warning?: \"execute\" | \"license\" | \"validate\" | \"timeout\" | \"unknown\" | \"read\" | \"decrypt\" | \"disabled\" | \"maxExecutableActions\" | \"maxAlerts\" | null | undefined; outcomeOrder?: number | undefined; outcomeMsg?: string[] | null | undefined; } & { outcome: \"warning\" | \"succeeded\" | \"failed\"; alertsCount: Readonly<{ recovered?: number | null | undefined; active?: number | null | undefined; new?: number | null | undefined; ignored?: number | null | undefined; } & {}>; }> | null | undefined" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorServices.ruleMonitoringService", - "type": "Object", + "id": "def-server.Rule.nextRun", + "type": "CompoundType", "tags": [], - "label": "ruleMonitoringService", + "label": "nextRun", "description": [], "signature": [ - "PublicMetricsSetters", - " | undefined" + "Date | null | undefined" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorServices.share", - "type": "Object", + "id": "def-server.Rule.revision", + "type": "number", "tags": [], - "label": "share", + "label": "revision", + "description": [], + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.Rule.running", + "type": "CompoundType", + "tags": [], + "label": "running", "description": [], "signature": [ - { - "pluginId": "share", - "scope": "server", - "docId": "kibSharePluginApi", - "section": "def-server.SharePluginStart", - "text": "SharePluginStart" - } + "boolean | null | undefined" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleExecutorServices.dataViews", - "type": "Object", + "id": "def-server.Rule.viewInAppRelativeUrl", + "type": "CompoundType", "tags": [], - "label": "dataViews", + "label": "viewInAppRelativeUrl", "description": [], "signature": [ - "{ create: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; get: (id: string, displayErrors?: boolean, refreshFields?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; delete: (indexPatternId: string) => Promise; find: (search: string, size?: number) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]>; getCanSave: () => Promise; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewListItem", - "text": "DataViewListItem" - }, - "[]>; clearCache: () => void; clearInstanceCache: (id?: string | undefined) => void; getCache: () => Promise<", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSavedObjectAttrs", - "text": "DataViewSavedObjectAttrs" - }, - ">[] | null | undefined>; getDefault: (displayErrors?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; getFieldsForIndexPattern: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", options?: Omit<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ", \"allowNoIndex\"> | undefined) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]>; refreshFields: (dataView: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", displayErrors?: boolean) => Promise; fieldArrayToMap: (fields: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], fieldAttrs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - "; savedObjectToSpec: (savedObject: ", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - "; createAndSave: (spec: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ", override?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; createSavedObject: (dataView: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", override?: boolean, displayErrors?: boolean) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ">; updateSavedObject: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - ", saveAttempts?: number, ignoreErrors?: boolean, displayErrors?: boolean) => Promise; getDefaultDataView: (options?: { displayErrors?: boolean | undefined; refreshFields?: boolean | undefined; }) => Promise<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - " | null>; }" - ], - "path": "x-pack/plugins/alerting/server/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.RuleExecutorServices.ruleResultService", - "type": "Object", - "tags": [], - "label": "ruleResultService", - "description": [], - "signature": [ - "PublicLastRunSetters", - " | undefined" + "string | null | undefined" ], - "path": "x-pack/plugins/alerting/server/types.ts", + "path": "x-pack/plugins/alerting/server/application/rule/types/rule.ts", "deprecated": false, "trackAdoption": false } @@ -3226,20 +2843,20 @@ }, { "parentPluginId": "alerting", - "id": "def-server.RuleParamsAndRefs", + "id": "def-server.RuleExecutorOptions", "type": "Interface", "tags": [], - "label": "RuleParamsAndRefs", + "label": "RuleExecutorOptions", "description": [], "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", - "section": "def-server.RuleParamsAndRefs", - "text": "RuleParamsAndRefs" + "section": "def-server.RuleExecutorOptions", + "text": "RuleExecutorOptions" }, - "" + "" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -3247,96 +2864,80 @@ "children": [ { "parentPluginId": "alerting", - "id": "def-server.RuleParamsAndRefs.references", - "type": "Array", + "id": "def-server.RuleExecutorOptions.executionId", + "type": "string", "tags": [], - "label": "references", + "label": "executionId", "description": [], - "signature": [ - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, - "[]" - ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleParamsAndRefs.params", - "type": "Uncategorized", + "id": "def-server.RuleExecutorOptions.logger", + "type": "Object", "tags": [], - "label": "params", + "label": "logger", "description": [], "signature": [ - "Params" + { + "pluginId": "@kbn/logging", + "scope": "common", + "docId": "kibKbnLoggingPluginApi", + "section": "def-common.Logger", + "text": "Logger" + } ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.RuleType", - "type": "Interface", - "tags": [], - "label": "RuleType", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.RuleType", - "text": "RuleType" }, - "" - ], - "path": "x-pack/plugins/alerting/server/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "alerting", - "id": "def-server.RuleType.id", - "type": "string", + "id": "def-server.RuleExecutorOptions.params", + "type": "Uncategorized", "tags": [], - "label": "id", + "label": "params", "description": [], + "signature": [ + "Params" + ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.name", - "type": "string", + "id": "def-server.RuleExecutorOptions.previousStartedAt", + "type": "CompoundType", "tags": [], - "label": "name", + "label": "previousStartedAt", "description": [], + "signature": [ + "Date | null" + ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.validate", - "type": "Object", + "id": "def-server.RuleExecutorOptions.rule", + "type": "CompoundType", "tags": [], - "label": "validate", + "label": "rule", "description": [], "signature": [ - "{ params: ", - "RuleTypeParamsValidator", - "; }" + "Pick<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.SanitizedRule", + "text": "SanitizedRule" + }, + ", \"id\" | \"consumer\" | \"name\" | \"actions\" | \"tags\" | \"enabled\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"muteAll\" | \"notifyWhen\" | \"snoozeSchedule\" | \"revision\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -3344,20 +2945,20 @@ }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.actionGroups", - "type": "Array", + "id": "def-server.RuleExecutorOptions.services", + "type": "Object", "tags": [], - "label": "actionGroups", + "label": "services", "description": [], "signature": [ { "pluginId": "alerting", - "scope": "common", + "scope": "server", "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" + "section": "def-server.RuleExecutorServices", + "text": "RuleExecutorServices" }, - "[]" + "" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -3365,34 +2966,24 @@ }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.defaultActionGroupId", - "type": "Uncategorized", + "id": "def-server.RuleExecutorOptions.spaceId", + "type": "string", "tags": [], - "label": "defaultActionGroupId", + "label": "spaceId", "description": [], - "signature": [ - "ActionGroupIds" - ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.recoveryActionGroup", + "id": "def-server.RuleExecutorOptions.startedAt", "type": "Object", "tags": [], - "label": "recoveryActionGroup", + "label": "startedAt", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" - }, - " | undefined" + "Date" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -3400,102 +2991,47 @@ }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.executor", - "type": "Function", + "id": "def-server.RuleExecutorOptions.state", + "type": "Uncategorized", "tags": [], - "label": "executor", + "label": "state", "description": [], "signature": [ - "(options: ", - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.RuleExecutorOptions", - "text": "RuleExecutorOptions" - }, - ", AlertData>) => Promise<{ state: State; }>" + "State" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "alerting", - "id": "def-server.RuleType.executor.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.RuleExecutorOptions", - "text": "RuleExecutorOptions" - }, - "" - ], - "path": "x-pack/plugins/alerting/server/types.ts", - "deprecated": false, - "trackAdoption": false - } - ] + "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.producer", + "id": "def-server.RuleExecutorOptions.namespace", "type": "string", "tags": [], - "label": "producer", + "label": "namespace", "description": [], + "signature": [ + "string | undefined" + ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.actionVariables", + "id": "def-server.RuleExecutorOptions.flappingSettings", "type": "Object", "tags": [], - "label": "actionVariables", + "label": "flappingSettings", "description": [], "signature": [ - "{ context?: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionVariable", - "text": "ActionVariable" - }, - "[] | undefined; state?: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionVariable", - "text": "ActionVariable" - }, - "[] | undefined; params?: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.ActionVariable", - "text": "ActionVariable" - }, - "[] | undefined; } | undefined" + "section": "def-common.RulesSettingsFlappingProperties", + "text": "RulesSettingsFlappingProperties" + } ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -3503,43 +3039,57 @@ }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.minimumLicenseRequired", - "type": "CompoundType", + "id": "def-server.RuleExecutorOptions.maintenanceWindowIds", + "type": "Array", "tags": [], - "label": "minimumLicenseRequired", + "label": "maintenanceWindowIds", "description": [], "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + "string[] | undefined" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.RuleExecutorServices", + "type": "Interface", + "tags": [], + "label": "RuleExecutorServices", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.RuleExecutorServices", + "text": "RuleExecutorServices" }, + "" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-server.RuleType.useSavedObjectReferences", + "id": "def-server.RuleExecutorServices.searchSourceClient", "type": "Object", "tags": [], - "label": "useSavedObjectReferences", + "label": "searchSourceClient", "description": [], "signature": [ - "{ extractReferences: (params: Params) => ", - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.RuleParamsAndRefs", - "text": "RuleParamsAndRefs" - }, - "; injectReferences: (params: ExtractedParams, references: ", { - "pluginId": "@kbn/core-saved-objects-common", + "pluginId": "data", "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, - "[]) => Params; } | undefined" + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchStartSearchSource", + "text": "ISearchStartSearchSource" + } ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -3547,24 +3097,19 @@ }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.isExportable", - "type": "boolean", + "id": "def-server.RuleExecutorServices.savedObjectsClient", + "type": "Object", "tags": [], - "label": "isExportable", - "description": [], - "path": "x-pack/plugins/alerting/server/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.RuleType.defaultScheduleInterval", - "type": "string", - "tags": [], - "label": "defaultScheduleInterval", + "label": "savedObjectsClient", "description": [], "signature": [ - "string | undefined" + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + } ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -3572,13 +3117,19 @@ }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.ruleTaskTimeout", - "type": "string", + "id": "def-server.RuleExecutorServices.uiSettingsClient", + "type": "Object", "tags": [], - "label": "ruleTaskTimeout", + "label": "uiSettingsClient", "description": [], "signature": [ - "string | undefined" + { + "pluginId": "@kbn/core-ui-settings-server", + "scope": "common", + "docId": "kibKbnCoreUiSettingsServerPluginApi", + "section": "def-common.IUiSettingsClient", + "text": "IUiSettingsClient" + } ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -3586,13 +3137,19 @@ }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.cancelAlertsOnRuleTimeout", - "type": "CompoundType", + "id": "def-server.RuleExecutorServices.scopedClusterClient", + "type": "Object", "tags": [], - "label": "cancelAlertsOnRuleTimeout", + "label": "scopedClusterClient", "description": [], "signature": [ - "boolean | undefined" + { + "pluginId": "@kbn/core-elasticsearch-server", + "scope": "common", + "docId": "kibKbnCoreElasticsearchServerPluginApi", + "section": "def-common.IScopedClusterClient", + "text": "IScopedClusterClient" + } ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -3600,28 +3157,182 @@ }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.doesSetRecoveryContext", + "id": "def-server.RuleExecutorServices.alertFactory", "type": "CompoundType", - "tags": [], - "label": "doesSetRecoveryContext", - "description": [], + "tags": [ + "deprecated" + ], + "label": "alertFactory", + "description": [ + "\nDeprecate alertFactory and remove when all rules are onboarded to\nthe alertsClient" + ], "signature": [ - "boolean | undefined" + "Pick<", + "AlertFactory", + ", \"create\" | \"done\"> & { alertLimit: Pick<{ getValue: () => number; setLimitReached: (reached: boolean) => void; checkLimitUsage: () => void; }, \"getValue\" | \"setLimitReached\">; }" ], "path": "x-pack/plugins/alerting/server/types.ts", - "deprecated": false, - "trackAdoption": false + "deprecated": true, + "trackAdoption": false, + "references": [ + { + "plugin": "ruleRegistry", + "path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts" + }, + { + "plugin": "ruleRegistry", + "path": "x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_wrapper.ts" + }, + { + "plugin": "ruleRegistry", + "path": "x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_wrapper.ts" + }, + { + "plugin": "observability", + "path": "x-pack/plugins/observability/server/lib/rules/slo_burn_rate/executor.ts" + }, + { + "plugin": "observability", + "path": "x-pack/plugins/observability/server/lib/rules/threshold/threshold_executor.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/server/lib/alerts/register_jobs_monitoring_rule_type.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/server/lib/alerts/register_jobs_monitoring_rule_type.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/server/lib/alerts/register_anomaly_detection_alert_type.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/server/lib/alerts/register_anomaly_detection_alert_type.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/server/lib/alerting/metric_threshold/metric_threshold_executor.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/server/lib/alerting/inventory_metric_threshold/inventory_metric_threshold_executor.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/server/lib/alerting/metric_anomaly/metric_anomaly_executor.ts" + }, + { + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/server/alerts/base_rule.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/notifications/legacy_rules_notification_alert_type.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/server/rule_types/index_threshold/rule_type.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/server/rule_types/index_threshold/rule_type.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/server/rule_types/geo_containment/lib/get_entities_and_generate_alerts.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/server/rule_types/geo_containment/executor.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/server/rule_types/geo_containment/executor.ts" + }, + { + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/server/rule_types/es_query/executor.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/server/alert_rules/common.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/server/alert_rules/tls_rule/message_utils.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/server/alert_rules/tls_rule/tls_rule.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/server/alert_rules/status_rule/monitor_status_rule.ts" + }, + { + "plugin": "transform", + "path": "x-pack/plugins/transform/server/lib/alerting/transform_health_rule_type/register_transform_health_rule_type.ts" + }, + { + "plugin": "uptime", + "path": "x-pack/plugins/uptime/server/legacy_uptime/lib/alerts/common.ts" + }, + { + "plugin": "uptime", + "path": "x-pack/plugins/uptime/server/legacy_uptime/lib/alerts/status_check.ts" + }, + { + "plugin": "uptime", + "path": "x-pack/plugins/uptime/server/legacy_uptime/lib/alerts/tls.ts" + }, + { + "plugin": "uptime", + "path": "x-pack/plugins/uptime/server/legacy_uptime/lib/alerts/tls_legacy.ts" + }, + { + "plugin": "uptime", + "path": "x-pack/plugins/uptime/server/legacy_uptime/lib/alerts/duration_anomaly.ts" + }, + { + "plugin": "ruleRegistry", + "path": "x-pack/plugins/rule_registry/server/utils/rule_executor.test_helpers.ts" + }, + { + "plugin": "observability", + "path": "x-pack/plugins/observability/server/lib/rules/slo_burn_rate/executor.test.ts" + } + ] }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.getSummarizedAlerts", - "type": "Function", + "id": "def-server.RuleExecutorServices.alertsClient", + "type": "CompoundType", "tags": [], - "label": "getSummarizedAlerts", - "description": [], + "label": "alertsClient", + "description": [ + "\nOnly available when framework alerts are enabled and rule\ntype has registered alert context with the framework with shouldWrite set to true" + ], "signature": [ - "GetSummarizedAlertsFn", - " | undefined" + "PublicAlertsClient", + " | null" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -3629,51 +3340,46 @@ }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.alerts", - "type": "Object", + "id": "def-server.RuleExecutorServices.shouldWriteAlerts", + "type": "Function", "tags": [], - "label": "alerts", + "label": "shouldWriteAlerts", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.IRuleTypeAlerts", - "text": "IRuleTypeAlerts" - }, - " | undefined" + "() => boolean" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.autoRecoverAlerts", - "type": "CompoundType", + "id": "def-server.RuleExecutorServices.shouldStopExecution", + "type": "Function", "tags": [], - "label": "autoRecoverAlerts", - "description": [ - "\nDetermines whether framework should\nautomatically make recovery determination. Defaults to true." - ], + "label": "shouldStopExecution", + "description": [], "signature": [ - "boolean | undefined" + "() => boolean" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.getViewInAppRelativeUrl", - "type": "Function", + "id": "def-server.RuleExecutorServices.ruleMonitoringService", + "type": "Object", "tags": [], - "label": "getViewInAppRelativeUrl", + "label": "ruleMonitoringService", "description": [], "signature": [ - "GetViewInAppRelativeUrlFn", - " | undefined" + "PublicMetricsSetters", + " | undefined" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -3681,362 +3387,331 @@ }, { "parentPluginId": "alerting", - "id": "def-server.RuleType.fieldsForAAD", - "type": "Array", + "id": "def-server.RuleExecutorServices.share", + "type": "Object", "tags": [], - "label": "fieldsForAAD", + "label": "share", "description": [], "signature": [ - "string[] | undefined" + { + "pluginId": "share", + "scope": "server", + "docId": "kibSharePluginApi", + "section": "def-server.SharePluginStart", + "text": "SharePluginStart" + } ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.SummarizedAlertsChunk", - "type": "Interface", - "tags": [], - "label": "SummarizedAlertsChunk", - "description": [], - "path": "x-pack/plugins/alerting/server/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-server.SummarizedAlertsChunk.count", - "type": "number", - "tags": [], - "label": "count", - "description": [], - "path": "x-pack/plugins/alerting/server/types.ts", - "deprecated": false, - "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-server.SummarizedAlertsChunk.data", - "type": "Array", + "id": "def-server.RuleExecutorServices.dataViews", + "type": "Object", "tags": [], - "label": "data", + "label": "dataViews", "description": [], "signature": [ - "AlertHit", - "[]" - ], - "path": "x-pack/plugins/alerting/server/types.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - } - ], - "enums": [ - { - "parentPluginId": "alerting", - "id": "def-server.AlertingAuthorizationEntity", - "type": "Enum", - "tags": [], - "label": "AlertingAuthorizationEntity", - "description": [], - "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.AlertingAuthorizationFilterType", - "type": "Enum", - "tags": [], - "label": "AlertingAuthorizationFilterType", - "description": [], - "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization_kuery.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.ReadOperations", - "type": "Enum", - "tags": [], - "label": "ReadOperations", - "description": [], - "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.RuleNotifyWhen", - "type": "Enum", - "tags": [], - "label": "RuleNotifyWhen", - "description": [], - "path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.WriteOperations", - "type": "Enum", - "tags": [], - "label": "WriteOperations", - "description": [], - "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "alerting", - "id": "def-server.ActionGroupIdsOf", - "type": "Type", - "tags": [], - "label": "ActionGroupIdsOf", - "description": [], - "signature": [ - "T extends ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" - }, - " ? groups : T extends Readonly<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" - }, - "> ? groups : never" - ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.AlertingRulesConfig", - "type": "Type", - "tags": [], - "label": "AlertingRulesConfig", - "description": [], - "signature": [ - "Pick; run: Readonly<{ timeout?: string | undefined; ruleTypeOverrides?: Readonly<{ timeout?: string | undefined; } & { id: string; }>[] | undefined; } & { actions: Readonly<{ connectorTypeOverrides?: Readonly<{ max?: number | undefined; } & { id: string; }>[] | undefined; } & { max: number; }>; alerts: Readonly<{} & { max: number; }>; }>; }>, \"minimumScheduleInterval\"> & { isUsingSecurity: boolean; }" - ], - "path": "x-pack/plugins/alerting/server/config.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.AlertInstanceContext", - "type": "Type", - "tags": [], - "label": "AlertInstanceContext", - "description": [], - "signature": [ - "{ [x: string]: unknown; }" - ], - "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.AlertInstanceState", - "type": "Type", - "tags": [], - "label": "AlertInstanceState", - "description": [], - "signature": [ - "{ [x: string]: unknown; }" - ], - "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.BulkEditOperation", - "type": "Type", - "tags": [], - "label": "BulkEditOperation", - "description": [], - "signature": [ - "{ operation: \"delete\" | \"add\" | \"set\"; field: \"tags\"; value: string[]; } | { operation: \"add\" | \"set\"; field: \"actions\"; value: ", - "NormalizedAlertAction", - "[]; } | { operation: \"set\"; field: \"schedule\"; value: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.IntervalSchedule", - "text": "IntervalSchedule" - }, - "; } | { operation: \"set\"; field: \"throttle\"; value: string | null | undefined; } | { operation: \"set\"; field: \"notifyWhen\"; value: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined; } | { operation: \"set\"; field: \"snoozeSchedule\"; value: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleSnoozeSchedule", - "text": "RuleSnoozeSchedule" - }, - "; } | { operation: \"delete\"; field: \"snoozeSchedule\"; value?: string[] | undefined; } | { operation: \"set\"; field: \"apiKey\"; value?: undefined; }" - ], - "path": "x-pack/plugins/alerting/server/rules_client/methods/bulk_edit.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.BulkEditOptions", - "type": "Type", - "tags": [], - "label": "BulkEditOptions", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.BulkEditOptionsFilter", - "text": "BulkEditOptionsFilter" - }, - " | ", - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.BulkEditOptionsIds", - "text": "BulkEditOptionsIds" + "{ create: (spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">; get: (id: string, displayErrors?: boolean, refreshFields?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">; delete: (indexPatternId: string) => Promise; find: (search: string, size?: number) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[]>; getCanSave: () => Promise; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewListItem", + "text": "DataViewListItem" + }, + "[]>; clearCache: () => void; clearInstanceCache: (id?: string | undefined) => void; getCache: () => Promise<", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSavedObjectAttrs", + "text": "DataViewSavedObjectAttrs" + }, + ">[] | null | undefined>; getDefault: (displayErrors?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>; getDefaultId: () => Promise; setDefault: (id: string | null, force?: boolean) => Promise; hasUserDataView: () => Promise; getFieldsForWildcard: (options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>; getFieldsForIndexPattern: (indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", options?: Omit<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ", \"allowNoIndex\"> | undefined) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]>; refreshFields: (dataView: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", displayErrors?: boolean) => Promise; fieldArrayToMap: (fields: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + }, + "; savedObjectToSpec: (savedObject: ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + "; createAndSave: (spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ", overwrite?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">; createSavedObject: (dataView: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", overwrite?: boolean, displayErrors?: boolean) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">; updateSavedObject: (indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ", saveAttempts?: number, ignoreErrors?: boolean, displayErrors?: boolean) => Promise; getDefaultDataView: (options?: { displayErrors?: boolean | undefined; refreshFields?: boolean | undefined; }) => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | null>; }" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - "" + { + "parentPluginId": "alerting", + "id": "def-server.RuleExecutorServices.ruleResultService", + "type": "Object", + "tags": [], + "label": "ruleResultService", + "description": [], + "signature": [ + "PublicLastRunSetters", + " | undefined" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false + } ], - "path": "x-pack/plugins/alerting/server/rules_client/methods/bulk_edit.ts", - "deprecated": false, - "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY_NAME", - "type": "string", + "id": "def-server.RuleParamsAndRefs", + "type": "Interface", "tags": [], - "label": "DEFAULT_ALERTS_ILM_POLICY_NAME", - "description": [ - "\nDefault alert index ILM policy\n- _meta.managed: notify users this is a managed policy and should be modified\n at their own risk\n- no delete phase as we want to keep these indices around indefinitely\n\nThis should be used by all alerts-as-data indices" - ], - "signature": [ - "\".alerts-ilm-policy\"" - ], - "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT", - "type": "number", - "tags": [], - "label": "DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT", - "description": [], - "signature": [ - "10" - ], - "path": "x-pack/plugins/alerting/server/config.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.ECS_COMPONENT_TEMPLATE_NAME", - "type": "string", - "tags": [], - "label": "ECS_COMPONENT_TEMPLATE_NAME", - "description": [], - "path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.ECS_CONTEXT", - "type": "string", - "tags": [], - "label": "ECS_CONTEXT", - "description": [], - "signature": [ - "\"ecs\"" - ], - "path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.ExecutorType", - "type": "Type", - "tags": [], - "label": "ExecutorType", + "label": "RuleParamsAndRefs", "description": [], "signature": [ - "(options: ", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", - "section": "def-server.RuleExecutorOptions", - "text": "RuleExecutorOptions" + "section": "def-server.RuleParamsAndRefs", + "text": "RuleParamsAndRefs" }, - ") => Promise<{ state: State; }>" + "" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false, - "returnComment": [], "children": [ { "parentPluginId": "alerting", - "id": "def-server.ExecutorType.$1", - "type": "Object", + "id": "def-server.RuleParamsAndRefs.references", + "type": "Array", "tags": [], - "label": "options", + "label": "references", "description": [], "signature": [ { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.RuleExecutorOptions", - "text": "RuleExecutorOptions" + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" }, - "" + "[]" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.RuleParamsAndRefs.params", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Params" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -4047,2361 +3722,2175 @@ }, { "parentPluginId": "alerting", - "id": "def-server.PartialRule", - "type": "Type", + "id": "def-server.RuleType", + "type": "Interface", "tags": [], - "label": "PartialRule", + "label": "RuleType", "description": [], "signature": [ - "Pick<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.Rule", - "text": "Rule" - }, - ", \"id\"> & Partial, \"id\">>" + "" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.PublicAlert", - "type": "Type", - "tags": [], - "label": "PublicAlert", - "description": [], - "signature": [ - "{ getContext: () => Context; getState: () => State; getUuid: () => string; getStart: () => string | null; hasContext: () => boolean; replaceState: (state: State) => ", - "Alert", - "; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => ", - "Alert", - "; setContext: (context: Context) => ", - "Alert", - "; }" - ], - "path": "x-pack/plugins/alerting/server/alert/alert.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.PublicFrameworkAlertsService", - "type": "Type", - "tags": [], - "label": "PublicFrameworkAlertsService", - "description": [], - "signature": [ - "PublicAlertsService", - " & { enabled: () => boolean; }" - ], - "path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.RuleActionParams", - "type": "Type", - "tags": [], - "label": "RuleActionParams", - "description": [], - "signature": [ - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.RulesClient", - "type": "Type", - "tags": [], - "label": "RulesClient", - "description": [], - "signature": [ - "{ create: (params: ", - "CreateOptions", - ") => Promise<", + "children": [ { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.SanitizedRule", - "text": "SanitizedRule" + "parentPluginId": "alerting", + "id": "def-server.RuleType.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - ">; update: (params: ", - "UpdateOptions", - ") => Promise<", { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.PartialRule", - "text": "PartialRule" + "parentPluginId": "alerting", + "id": "def-server.RuleType.validate", + "type": "Object", + "tags": [], + "label": "validate", + "description": [], + "signature": [ + "{ params: ", + "RuleTypeParamsValidator", + "; }" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - ">; get: []" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - " = never>(params: ", - "GetParams", - ") => Promise<", { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.SanitizedRule", - "text": "SanitizedRule" + "parentPluginId": "alerting", + "id": "def-server.RuleType.defaultActionGroupId", + "type": "Uncategorized", + "tags": [], + "label": "defaultActionGroupId", + "description": [], + "signature": [ + "ActionGroupIds" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - " | ", - "SanitizedRuleWithLegacyId", - ">; delete: (params: { id: string; }) => Promise<{}>; getGlobalExecutionLogWithAuth: (params: ", - "GetGlobalExecutionLogParams", - ") => Promise<", { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.IExecutionLogResult", - "text": "IExecutionLogResult" + "parentPluginId": "alerting", + "id": "def-server.RuleType.recoveryActionGroup", + "type": "Object", + "tags": [], + "label": "recoveryActionGroup", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + " | undefined" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - ">; getGlobalExecutionKpiWithAuth: (params: ", - "GetGlobalExecutionKPIParams", - ") => Promise<{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }>; find: , AlertData>) => Promise<{ state: State; }>" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.RuleType.executor.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.RuleExecutorOptions", + "text": "RuleExecutorOptions" + }, + "" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, - " = never>(params?: ", - "FindParams", - " | undefined) => Promise<", { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.FindResult", - "text": "FindResult" + "parentPluginId": "alerting", + "id": "def-server.RuleType.producer", + "type": "string", + "tags": [], + "label": "producer", + "description": [], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - ">; muteAll: (options: { id: string; }) => Promise; aggregate: >(params: ", - "AggregateParams", - ") => Promise; clone: (args_0: string, args_1: { newId?: string | undefined; }) => Promise<", { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.SanitizedRule", - "text": "SanitizedRule" + "parentPluginId": "alerting", + "id": "def-server.RuleType.minimumLicenseRequired", + "type": "CompoundType", + "tags": [], + "label": "minimumLicenseRequired", + "description": [], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - ">; resolve: ", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.RuleParamsAndRefs", + "text": "RuleParamsAndRefs" + }, + "; injectReferences: (params: ExtractedParams, references: ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]) => Params; } | undefined" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - " = never>(params: ", - "ResolveParams", - ") => Promise<", { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ResolvedSanitizedRule", - "text": "ResolvedSanitizedRule" - }, - ">; getAlertState: (params: ", - "GetAlertStateParams", - ") => Promise; getAlertSummary: (params: ", - "GetAlertSummaryParams", - ") => Promise<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertSummary", - "text": "AlertSummary" - }, - ">; getExecutionLogForRule: (params: ", - "GetExecutionLogByIdParams", - ") => Promise<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.IExecutionLogResult", - "text": "IExecutionLogResult" - }, - ">; getRuleExecutionKPI: (params: ", - "GetRuleExecutionKPIParams", - ") => Promise<{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }>; getActionErrorLog: (params: ", - "GetActionErrorLogByIdParams", - ") => Promise<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.IExecutionErrorsResult", - "text": "IExecutionErrorsResult" + "parentPluginId": "alerting", + "id": "def-server.RuleType.isExportable", + "type": "boolean", + "tags": [], + "label": "isExportable", + "description": [], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - ">; getActionErrorLogWithAuth: (params: ", - "GetActionErrorLogByIdParams", - ") => Promise<", { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.IExecutionErrorsResult", - "text": "IExecutionErrorsResult" + "parentPluginId": "alerting", + "id": "def-server.RuleType.defaultScheduleInterval", + "type": "string", + "tags": [], + "label": "defaultScheduleInterval", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - ">; bulkDeleteRules: (options: ", - "BulkOptions", - ") => Promise<{ errors: ", { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.BulkOperationError", - "text": "BulkOperationError" + "parentPluginId": "alerting", + "id": "def-server.RuleType.ruleTaskTimeout", + "type": "string", + "tags": [], + "label": "ruleTaskTimeout", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - "[]; total: number; rules: (", { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.Rule", - "text": "Rule" + "parentPluginId": "alerting", + "id": "def-server.RuleType.cancelAlertsOnRuleTimeout", + "type": "CompoundType", + "tags": [], + "label": "cancelAlertsOnRuleTimeout", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - " | ", - "RuleWithLegacyId", - ")[]; taskIdsFailedToBeDeleted: string[]; }>; bulkEdit: (options: ", { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.BulkEditOptions", - "text": "BulkEditOptions" + "parentPluginId": "alerting", + "id": "def-server.RuleType.getSummarizedAlerts", + "type": "Function", + "tags": [], + "label": "getSummarizedAlerts", + "description": [], + "signature": [ + "GetSummarizedAlertsFn", + " | undefined" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - ") => Promise<{ rules: ", { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.SanitizedRule", - "text": "SanitizedRule" + "parentPluginId": "alerting", + "id": "def-server.RuleType.alerts", + "type": "Object", + "tags": [], + "label": "alerts", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.IRuleTypeAlerts", + "text": "IRuleTypeAlerts" + }, + " | undefined" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - "[]; skipped: ", { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.BulkActionSkipResult", - "text": "BulkActionSkipResult" + "parentPluginId": "alerting", + "id": "def-server.RuleType.autoRecoverAlerts", + "type": "CompoundType", + "tags": [], + "label": "autoRecoverAlerts", + "description": [ + "\nDetermines whether framework should\nautomatically make recovery determination. Defaults to true." + ], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - "[]; errors: ", { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.BulkOperationError", - "text": "BulkOperationError" + "parentPluginId": "alerting", + "id": "def-server.RuleType.getViewInAppRelativeUrl", + "type": "Function", + "tags": [], + "label": "getViewInAppRelativeUrl", + "description": [], + "signature": [ + "GetViewInAppRelativeUrlFn", + " | undefined" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - "[]; total: number; }>; bulkEnableRules: (options: ", - "BulkOptions", - ") => Promise<{ errors: ", { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.BulkOperationError", - "text": "BulkOperationError" - }, - "[]; rules: (", + "parentPluginId": "alerting", + "id": "def-server.RuleType.fieldsForAAD", + "type": "Array", + "tags": [], + "label": "fieldsForAAD", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.SummarizedAlertsChunk", + "type": "Interface", + "tags": [], + "label": "SummarizedAlertsChunk", + "description": [], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.Rule", - "text": "Rule" + "parentPluginId": "alerting", + "id": "def-server.SummarizedAlertsChunk.count", + "type": "number", + "tags": [], + "label": "count", + "description": [], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false }, - " | ", - "RuleWithLegacyId", - ")[]; total: number; taskIdsFailedToBeEnabled: string[]; }>; bulkDisableRules: (options: ", - "BulkOptions", - ") => Promise<{ errors: ", { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.BulkOperationError", - "text": "BulkOperationError" - }, - "[]; rules: (", + "parentPluginId": "alerting", + "id": "def-server.SummarizedAlertsChunk.data", + "type": "Array", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "AlertHit", + "[]" + ], + "path": "x-pack/plugins/alerting/server/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "alerting", + "id": "def-server.AlertingAuthorizationEntity", + "type": "Enum", + "tags": [], + "label": "AlertingAuthorizationEntity", + "description": [], + "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.AlertingAuthorizationFilterType", + "type": "Enum", + "tags": [], + "label": "AlertingAuthorizationFilterType", + "description": [], + "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization_kuery.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.ReadOperations", + "type": "Enum", + "tags": [], + "label": "ReadOperations", + "description": [], + "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.RuleNotifyWhen", + "type": "Enum", + "tags": [], + "label": "RuleNotifyWhen", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.WriteOperations", + "type": "Enum", + "tags": [], + "label": "WriteOperations", + "description": [], + "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "alerting", + "id": "def-server.ActionGroupIdsOf", + "type": "Type", + "tags": [], + "label": "ActionGroupIdsOf", + "description": [], + "signature": [ + "T extends ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.Rule", - "text": "Rule" + "section": "def-common.ActionGroup", + "text": "ActionGroup" }, - " | ", - "RuleWithLegacyId", - ")[]; total: number; }>; updateApiKey: (options: { id: string; }) => Promise; enable: (options: { id: string; }) => Promise; disable: (options: { id: string; }) => Promise; snooze: (options: ", - "SnoozeParams", - ") => Promise; unsnooze: (options: ", - "UnsnoozeParams", - ") => Promise; clearExpiredSnoozes: (options: { rule: Pick<", + " ? groups : T extends Readonly<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.SanitizedRule", - "text": "SanitizedRule" + "section": "def-common.ActionGroup", + "text": "ActionGroup" }, - "<", + "> ? groups : never" + ], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.AlertingRulesConfig", + "type": "Type", + "tags": [], + "label": "AlertingRulesConfig", + "description": [], + "signature": [ + "Pick; run: Readonly<{ timeout?: string | undefined; ruleTypeOverrides?: Readonly<{ timeout?: string | undefined; } & { id: string; }>[] | undefined; } & { actions: Readonly<{ connectorTypeOverrides?: Readonly<{ max?: number | undefined; } & { id: string; }>[] | undefined; } & { max: number; }>; alerts: Readonly<{} & { max: number; }>; }>; }>, \"minimumScheduleInterval\"> & { isUsingSecurity: boolean; }" + ], + "path": "x-pack/plugins/alerting/server/config.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.AlertInstanceContext", + "type": "Type", + "tags": [], + "label": "AlertInstanceContext", + "description": [], + "signature": [ + "{ [x: string]: unknown; }" + ], + "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.AlertInstanceState", + "type": "Type", + "tags": [], + "label": "AlertInstanceState", + "description": [], + "signature": [ + "{ [x: string]: unknown; }" + ], + "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditOperation", + "type": "Type", + "tags": [], + "label": "BulkEditOperation", + "description": [], + "signature": [ + "{ operation: \"delete\" | \"add\" | \"set\"; field: \"tags\"; value: string[]; } | { operation: \"add\" | \"set\"; field: \"actions\"; value: ", + "NormalizedAlertAction", + "[]; } | { operation: \"set\"; field: \"schedule\"; value: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.RuleTypeParams", - "text": "RuleTypeParams" + "section": "def-common.IntervalSchedule", + "text": "IntervalSchedule" }, - ">, \"id\" | \"snoozeSchedule\">; version?: string | undefined; }) => Promise; unmuteAll: (options: { id: string; }) => Promise; muteInstance: (options: ", - "MuteOptions", - ") => Promise; unmuteInstance: (options: ", - "MuteOptions", - ") => Promise; runSoon: (options: { id: string; }) => Promise; listRuleTypes: () => Promise>; getSpaceId: () => string | undefined; getTags: (params: Readonly<{ search?: string | undefined; perPage?: number | undefined; } & { page: number; }>) => Promise<", - "GetTagsResult", - ">; getAlertFromRaw: (params: ", - "GetAlertFromRawParams", - ") => ", + "; } | { operation: \"set\"; field: \"throttle\"; value: string | null | undefined; } | { operation: \"set\"; field: \"notifyWhen\"; value: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined; } | { operation: \"set\"; field: \"snoozeSchedule\"; value: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.Rule", - "text": "Rule" + "section": "def-common.RuleSnoozeSchedule", + "text": "RuleSnoozeSchedule" }, - " | ", - "RuleWithLegacyId", - "; }" + "; } | { operation: \"delete\"; field: \"snoozeSchedule\"; value?: string[] | undefined; } | { operation: \"set\"; field: \"apiKey\"; value?: undefined; }" ], - "path": "x-pack/plugins/alerting/server/index.ts", + "path": "x-pack/plugins/alerting/server/rules_client/methods/bulk_edit.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleTypeParams", + "id": "def-server.BulkEditOptions", "type": "Type", "tags": [], - "label": "RuleTypeParams", + "label": "BulkEditOptions", "description": [], "signature": [ - "{ [x: string]: unknown; }" + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkEditOptionsFilter", + "text": "BulkEditOptionsFilter" + }, + " | ", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkEditOptionsIds", + "text": "BulkEditOptionsIds" + }, + "" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/server/rules_client/methods/bulk_edit.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-server.RuleTypeState", - "type": "Type", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY_NAME", + "type": "string", "tags": [], - "label": "RuleTypeState", - "description": [], + "label": "DEFAULT_ALERTS_ILM_POLICY_NAME", + "description": [ + "\nDefault alert index ILM policy\n- _meta.managed: notify users this is a managed policy and should be modified\n at their own risk\n- no delete phase as we want to keep these indices around indefinitely\n\nThis should be used by all alerts-as-data indices" + ], "signature": [ - "{ [x: string]: unknown; }" + "\".alerts-ilm-policy\"" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-server.TOTAL_FIELDS_LIMIT", + "id": "def-server.DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT", "type": "number", "tags": [], - "label": "TOTAL_FIELDS_LIMIT", + "label": "DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT", "description": [], "signature": [ - "2500" + "10" ], - "path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts", + "path": "x-pack/plugins/alerting/server/config.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false - } - ], - "objects": [ + }, { "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY", - "type": "Object", + "id": "def-server.ECS_COMPONENT_TEMPLATE_NAME", + "type": "string", "tags": [], - "label": "DEFAULT_ALERTS_ILM_POLICY", + "label": "ECS_COMPONENT_TEMPLATE_NAME", "description": [], - "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", + "path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY._meta", - "type": "Object", - "tags": [], - "label": "_meta", - "description": [], - "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY._meta.managed", - "type": "boolean", - "tags": [], - "label": "managed", - "description": [], - "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", - "deprecated": false, - "trackAdoption": false - } - ] - }, - { - "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases", - "type": "Object", - "tags": [], - "label": "phases", - "description": [], - "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot", - "type": "Object", - "tags": [], - "label": "hot", - "description": [], - "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions", - "type": "Object", - "tags": [], - "label": "actions", - "description": [], - "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions.rollover", - "type": "Object", - "tags": [], - "label": "rollover", - "description": [], - "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions.rollover.max_age", - "type": "string", - "tags": [], - "label": "max_age", - "description": [], - "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions.rollover.max_primary_shard_size", - "type": "string", - "tags": [], - "label": "max_primary_shard_size", - "description": [], - "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", - "deprecated": false, - "trackAdoption": false - } - ] - } - ] - } - ] - } - ] - } - ], "initialIsOpen": false - } - ] - }, - "common": { - "classes": [], - "functions": [ + }, { "parentPluginId": "alerting", - "id": "def-common.contextToSchemaName", - "type": "Function", + "id": "def-server.ECS_CONTEXT", + "type": "string", "tags": [], - "label": "contextToSchemaName", + "label": "ECS_CONTEXT", "description": [], "signature": [ - "(context: string) => string" + "\"ecs\"" ], - "path": "x-pack/plugins/alerting/common/alert_schema/context_to_schema_name.ts", + "path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-common.contextToSchemaName.$1", - "type": "string", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/alerting/common/alert_schema/context_to_schema_name.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.formatDefaultAggregationResult", - "type": "Function", + "id": "def-server.ExecutorType", + "type": "Type", "tags": [], - "label": "formatDefaultAggregationResult", + "label": "ExecutorType", "description": [], "signature": [ - "(aggregations: ", + "(options: ", { "pluginId": "alerting", - "scope": "common", + "scope": "server", "docId": "kibAlertingPluginApi", - "section": "def-common.DefaultRuleAggregationResult", - "text": "DefaultRuleAggregationResult" + "section": "def-server.RuleExecutorOptions", + "text": "RuleExecutorOptions" }, - ") => ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleAggregationFormattedResult", - "text": "RuleAggregationFormattedResult" - } + ") => Promise<{ state: State; }>" ], - "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", + "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false, + "returnComment": [], "children": [ { "parentPluginId": "alerting", - "id": "def-common.formatDefaultAggregationResult.$1", + "id": "def-server.ExecutorType.$1", "type": "Object", "tags": [], - "label": "aggregations", + "label": "options", "description": [], "signature": [ { "pluginId": "alerting", - "scope": "common", + "scope": "server", "docId": "kibAlertingPluginApi", - "section": "def-common.DefaultRuleAggregationResult", - "text": "DefaultRuleAggregationResult" - } - ], - "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.formatDuration", - "type": "Function", - "tags": [], - "label": "formatDuration", - "description": [], - "signature": [ - "(duration: string, fullUnit: boolean | undefined) => string" - ], - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-common.formatDuration.$1", - "type": "string", - "tags": [], - "label": "duration", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "alerting", - "id": "def-common.formatDuration.$2", - "type": "CompoundType", - "tags": [], - "label": "fullUnit", - "description": [], - "signature": [ - "boolean | undefined" + "section": "def-server.RuleExecutorOptions", + "text": "RuleExecutorOptions" + }, + "" ], - "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, - "trackAdoption": false, - "isRequired": false + "trackAdoption": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.formatRuleTagsAggregationResult", - "type": "Function", + "id": "def-server.PartialRule", + "type": "Type", "tags": [], - "label": "formatRuleTagsAggregationResult", + "label": "PartialRule", "description": [], "signature": [ - "(aggregations: ", + "Pick<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.RuleTagsAggregationResult", - "text": "RuleTagsAggregationResult" + "section": "def-common.Rule", + "text": "Rule" }, - ") => ", + ", \"id\"> & Partial, \"id\">>" ], - "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", + "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-common.formatRuleTagsAggregationResult.$1", - "type": "Object", - "tags": [], - "label": "aggregations", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleTagsAggregationResult", - "text": "RuleTagsAggregationResult" - } - ], - "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.getBuiltinActionGroups", - "type": "Function", + "id": "def-server.PublicAlert", + "type": "Type", "tags": [], - "label": "getBuiltinActionGroups", + "label": "PublicAlert", "description": [], "signature": [ - "(customRecoveryGroup: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" - }, - " | undefined) => [", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" - }, - "<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ReservedActionGroups", - "text": "ReservedActionGroups" - }, - ">]" + "{ getContext: () => Context; getState: () => State; getUuid: () => string; getStart: () => string | null; hasContext: () => boolean; replaceState: (state: State) => ", + "Alert", + "; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => ", + "Alert", + "; setContext: (context: Context) => ", + "Alert", + "; }" ], - "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", + "path": "x-pack/plugins/alerting/server/alert/alert.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-common.getBuiltinActionGroups.$1", - "type": "Object", - "tags": [], - "label": "customRecoveryGroup", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" - }, - " | undefined" - ], - "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.getComponentTemplateFromFieldMap", - "type": "Function", + "id": "def-server.PublicFrameworkAlertsService", + "type": "Type", "tags": [], - "label": "getComponentTemplateFromFieldMap", + "label": "PublicFrameworkAlertsService", "description": [], "signature": [ - "({ name, fieldMap, dynamic, includeSettings, }: ", - "GetComponentTemplateFromFieldMapOpts", - ") => ", - "ClusterPutComponentTemplateRequest" + "PublicAlertsService", + " & { enabled: () => boolean; }" ], - "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/component_template_from_field_map.ts", + "path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-common.getComponentTemplateFromFieldMap.$1", - "type": "Object", - "tags": [], - "label": "{\n name,\n fieldMap,\n dynamic,\n includeSettings,\n}", - "description": [], - "signature": [ - "GetComponentTemplateFromFieldMapOpts" - ], - "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/component_template_from_field_map.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.getDefaultRuleAggregation", - "type": "Function", + "id": "def-server.RuleActionParams", + "type": "Type", "tags": [], - "label": "getDefaultRuleAggregation", + "label": "RuleActionParams", "description": [], "signature": [ - "(params?: GetDefaultRuleAggregationParams | undefined) => Record" - ], - "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { - "parentPluginId": "alerting", - "id": "def-common.getDefaultRuleAggregation.$1", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "GetDefaultRuleAggregationParams | undefined" - ], - "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" } ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.getDurationNumberInItsUnit", - "type": "Function", - "tags": [], - "label": "getDurationNumberInItsUnit", - "description": [], - "signature": [ - "(duration: string) => number" - ], - "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-common.getDurationNumberInItsUnit.$1", - "type": "string", - "tags": [], - "label": "duration", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.getDurationUnitValue", - "type": "Function", + "id": "def-server.RulesClient", + "type": "Type", "tags": [], - "label": "getDurationUnitValue", + "label": "RulesClient", "description": [], "signature": [ - "(duration: string) => string" - ], - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + "{ create: Record" - ], - "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleTypeParams", + "text": "RuleTypeParams" + }, + " = never>(params: ", + "CreateRuleParams", + ") => Promise<", { - "parentPluginId": "alerting", - "id": "def-common.getRuleTagsAggregation.$1", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "GetRuleTagsAggregationParams | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.isActionGroupDisabledForActionTypeId", - "type": "Function", - "tags": [], - "label": "isActionGroupDisabledForActionTypeId", - "description": [], - "signature": [ - "(actionGroup: string, actionTypeId: string) => boolean" - ], - "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.SanitizedRule", + "text": "SanitizedRule" + }, + ">; update: (params: ", + "UpdateOptions", + ") => Promise<", { - "parentPluginId": "alerting", - "id": "def-common.isActionGroupDisabledForActionTypeId.$2", - "type": "string", - "tags": [], - "label": "actionTypeId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.mappingFromFieldMap", - "type": "Function", - "tags": [], - "label": "mappingFromFieldMap", - "description": [], - "signature": [ - "(fieldMap: ", + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.PartialRule", + "text": "PartialRule" + }, + ">; get: ", - "MappingTypeMapping" - ], - "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/mapping_from_field_map.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + " = never>(params: ", + "GetParams", + ") => Promise<", { - "parentPluginId": "alerting", - "id": "def-common.mappingFromFieldMap.$1", - "type": "Object", - "tags": [], - "label": "fieldMap", - "description": [], - "signature": [ - { - "pluginId": "@kbn/alerts-as-data-utils", - "scope": "common", - "docId": "kibKbnAlertsAsDataUtilsPluginApi", - "section": "def-common.FieldMap", - "text": "FieldMap" - } - ], - "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/mapping_from_field_map.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.SanitizedRule", + "text": "SanitizedRule" }, + " | ", + "SanitizedRuleWithLegacyId", + ">; delete: (params: { id: string; }) => Promise<{}>; getGlobalExecutionLogWithAuth: (params: ", + "GetGlobalExecutionLogParams", + ") => Promise<", { - "parentPluginId": "alerting", - "id": "def-common.mappingFromFieldMap.$2", - "type": "CompoundType", - "tags": [], - "label": "dynamic", - "description": [], - "signature": [ - "boolean | \"strict\"" - ], - "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/mapping_from_field_map.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.parseDuration", - "type": "Function", - "tags": [], - "label": "parseDuration", - "description": [], - "signature": [ - "(duration: string) => number" - ], - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IExecutionLogResult", + "text": "IExecutionLogResult" + }, + ">; getGlobalExecutionKpiWithAuth: (params: ", + "GetGlobalExecutionKPIParams", + ") => Promise<{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }>; find: string | undefined" - ], - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleTypeParams", + "text": "RuleTypeParams" + }, + " = never>(params?: ", + "FindParams", + " | undefined) => Promise<", { - "parentPluginId": "alerting", - "id": "def-common.validateDurationSchema.$1", - "type": "string", - "tags": [], - "label": "duration", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.validateNotifyWhenType", - "type": "Function", - "tags": [], - "label": "validateNotifyWhenType", - "description": [], - "signature": [ - "(notifyWhen: string) => string | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-common.validateNotifyWhenType.$1", - "type": "string", - "tags": [], - "label": "notifyWhen", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.wrappedStateRt", - "type": "Function", - "tags": [], - "label": "wrappedStateRt", - "description": [], - "signature": [ - "() => ", - "TypeC", - "<{ wrapped: ", - "Type", - "; trackedAlerts: ", - "RecordC", - "<", - "StringC", - ", ", - "TypeC", - "<{ alertId: ", - "StringC", - "; alertUuid: ", - "StringC", - "; started: ", - "StringC", - "; flappingHistory: ", - "ArrayC", - "<", - "BooleanC", - ">; flapping: ", - "BooleanC", - "; pendingRecoveredCount: ", - "NumberC", - "; }>>; trackedAlertsRecovered: ", - "RecordC", - "<", - "StringC", - ", ", - "TypeC", - "<{ alertId: ", - "StringC", - "; alertUuid: ", - "StringC", - "; started: ", - "StringC", - "; flappingHistory: ", - "ArrayC", - "<", - "BooleanC", - ">; flapping: ", - "BooleanC", - "; pendingRecoveredCount: ", - "NumberC", - "; }>>; }>" - ], - "path": "x-pack/packages/kbn-alerting-state-types/src/lifecycle_state.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "parentPluginId": "alerting", - "id": "def-common.ActionGroup", - "type": "Interface", - "tags": [], - "label": "ActionGroup", - "description": [], - "signature": [ + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.FindResult", + "text": "FindResult" + }, + ">; muteAll: (options: { id: string; }) => Promise; aggregate: >(params: ", + "AggregateParams", + ") => Promise; clone: " - ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + " = never>(args_0: string, args_1: { newId?: string | undefined; }) => Promise<", { - "parentPluginId": "alerting", - "id": "def-common.ActionGroup.id", - "type": "Uncategorized", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "ActionGroupIds" - ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.SanitizedRule", + "text": "SanitizedRule" }, + ">; resolve: (params: ", + "ResolveParams", + ") => Promise<", { - "parentPluginId": "alerting", - "id": "def-common.ActionVariable.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ResolvedSanitizedRule", + "text": "ResolvedSanitizedRule" }, + ">; getAlertState: (params: ", + "GetAlertStateParams", + ") => Promise; getAlertSummary: (params: ", + "GetAlertSummaryParams", + ") => Promise<", { - "parentPluginId": "alerting", - "id": "def-common.ActionVariable.description", - "type": "string", - "tags": [], - "label": "description", - "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertSummary", + "text": "AlertSummary" }, + ">; getExecutionLogForRule: (params: ", + "GetExecutionLogByIdParams", + ") => Promise<", { - "parentPluginId": "alerting", - "id": "def-common.ActionVariable.deprecated", - "type": "CompoundType", - "tags": [], - "label": "deprecated", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IExecutionLogResult", + "text": "IExecutionLogResult" }, + ">; getRuleExecutionKPI: (params: ", + "GetRuleExecutionKPIParams", + ") => Promise<{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }>; getActionErrorLog: (params: ", + "GetActionErrorLogByIdParams", + ") => Promise<", { - "parentPluginId": "alerting", - "id": "def-common.ActionVariable.useWithTripleBracesInTemplates", - "type": "CompoundType", - "tags": [], - "label": "useWithTripleBracesInTemplates", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IExecutionErrorsResult", + "text": "IExecutionErrorsResult" }, + ">; getActionErrorLogWithAuth: (params: ", + "GetActionErrorLogByIdParams", + ") => Promise<", { - "parentPluginId": "alerting", - "id": "def-common.ActionVariable.usesPublicBaseUrl", - "type": "CompoundType", - "tags": [], - "label": "usesPublicBaseUrl", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.AggregateOptions", - "type": "Interface", - "tags": [], - "label": "AggregateOptions", - "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IExecutionErrorsResult", + "text": "IExecutionErrorsResult" + }, + ">; bulkDeleteRules: (options: ", + "BulkOptions", + ") => Promise<{ errors: ", { - "parentPluginId": "alerting", - "id": "def-common.AggregateOptions.search", - "type": "string", - "tags": [], - "label": "search", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkOperationError", + "text": "BulkOperationError" }, + "[]; total: number; rules: (", { - "parentPluginId": "alerting", - "id": "def-common.AggregateOptions.defaultSearchOperator", - "type": "CompoundType", - "tags": [], - "label": "defaultSearchOperator", - "description": [], - "signature": [ - "\"AND\" | \"OR\" | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.Rule", + "text": "Rule" }, + " | ", + "RuleWithLegacyId", + ")[]; taskIdsFailedToBeDeleted: string[]; }>; bulkEdit: (options: ", { - "parentPluginId": "alerting", - "id": "def-common.AggregateOptions.hasReference", - "type": "Object", - "tags": [], - "label": "hasReference", - "description": [], - "signature": [ - "{ type: string; id: string; } | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkEditOptions", + "text": "BulkEditOptions" }, + ") => Promise<{ rules: ", { - "parentPluginId": "alerting", - "id": "def-common.AggregateOptions.filter", - "type": "CompoundType", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "string | ", - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.KueryNode", - "text": "KueryNode" - }, - " | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.SanitizedRule", + "text": "SanitizedRule" }, + "[]; skipped: ", { - "parentPluginId": "alerting", - "id": "def-common.AggregateOptions.page", - "type": "number", - "tags": [], - "label": "page", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.BulkActionSkipResult", + "text": "BulkActionSkipResult" }, + "[]; errors: ", { - "parentPluginId": "alerting", - "id": "def-common.AggregateOptions.perPage", - "type": "number", - "tags": [], - "label": "perPage", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.AlertingFrameworkHealth", - "type": "Interface", - "tags": [], - "label": "AlertingFrameworkHealth", - "description": [], - "path": "x-pack/plugins/alerting/common/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkOperationError", + "text": "BulkOperationError" + }, + "[]; total: number; }>; bulkEnableRules: (options: ", + "BulkOptions", + ") => Promise<{ errors: ", { - "parentPluginId": "alerting", - "id": "def-common.AlertingFrameworkHealth.isSufficientlySecure", - "type": "boolean", - "tags": [], - "label": "isSufficientlySecure", - "description": [], - "path": "x-pack/plugins/alerting/common/index.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkOperationError", + "text": "BulkOperationError" }, + "[]; rules: (", { - "parentPluginId": "alerting", - "id": "def-common.AlertingFrameworkHealth.hasPermanentEncryptionKey", - "type": "boolean", - "tags": [], - "label": "hasPermanentEncryptionKey", - "description": [], - "path": "x-pack/plugins/alerting/common/index.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.Rule", + "text": "Rule" }, + " | ", + "RuleWithLegacyId", + ")[]; total: number; taskIdsFailedToBeEnabled: string[]; }>; bulkDisableRules: (options: ", + "BulkOptions", + ") => Promise<{ errors: ", { - "parentPluginId": "alerting", - "id": "def-common.AlertingFrameworkHealth.alertingFrameworkHealth", - "type": "Object", - "tags": [], - "label": "alertingFrameworkHealth", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertsHealth", - "text": "AlertsHealth" - } - ], - "path": "x-pack/plugins/alerting/common/index.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.AlertsFilter", - "type": "Interface", - "tags": [], - "label": "AlertsFilter", - "description": [], - "signature": [ + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkOperationError", + "text": "BulkOperationError" + }, + "[]; rules: (", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.AlertsFilter", - "text": "AlertsFilter" + "section": "def-common.Rule", + "text": "Rule" }, - " extends ", + " | ", + "RuleWithLegacyId", + ")[]; total: number; }>; updateApiKey: (options: { id: string; }) => Promise; enable: (options: { id: string; }) => Promise; disable: (options: { id: string; }) => Promise; snooze: (options: ", + "SnoozeParams", + ") => Promise; unsnooze: (options: ", + "UnsnoozeParams", + ") => Promise; clearExpiredSnoozes: (options: { rule: Pick<", { - "pluginId": "@kbn/core-saved-objects-common", + "pluginId": "alerting", "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + "docId": "kibAlertingPluginApi", + "section": "def-common.SanitizedRule", + "text": "SanitizedRule" + }, + "<", { - "parentPluginId": "alerting", - "id": "def-common.AlertsFilter.query", - "type": "Object", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "{ kql: string; filters: ", - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]; dsl?: string | undefined; } | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleTypeParams", + "text": "RuleTypeParams" }, + ">, \"id\" | \"snoozeSchedule\">; version?: string | undefined; }) => Promise; unmuteAll: (options: { id: string; }) => Promise; muteInstance: (options: ", + "MuteOptions", + ") => Promise; unmuteInstance: (options: ", + "MuteOptions", + ") => Promise; runSoon: (options: { id: string; }) => Promise; listRuleTypes: () => Promise>; getSpaceId: () => string | undefined; getAuthorization: () => ", { - "parentPluginId": "alerting", - "id": "def-common.AlertsFilter.timeframe", - "type": "Object", - "tags": [], - "label": "timeframe", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertsFilterTimeframe", - "text": "AlertsFilterTimeframe" - }, - " | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false - } + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.AlertingAuthorization", + "text": "AlertingAuthorization" + }, + "; getAuditLogger: () => ", + { + "pluginId": "security", + "scope": "server", + "docId": "kibSecurityPluginApi", + "section": "def-server.AuditLogger", + "text": "AuditLogger" + }, + " | undefined; getTags: (params: Readonly<{ search?: string | undefined; perPage?: number | undefined; } & { page: number; }>) => Promise<", + "GetTagsResult", + ">; getAlertFromRaw: (params: ", + "GetAlertFromRawParams", + ") => ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.Rule", + "text": "Rule" + }, + " | ", + "RuleWithLegacyId", + "; }" ], + "path": "x-pack/plugins/alerting/server/index.ts", + "deprecated": false, + "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.AlertsFilterTimeframe", - "type": "Interface", + "id": "def-server.RuleTypeParams", + "type": "Type", "tags": [], - "label": "AlertsFilterTimeframe", + "label": "RuleTypeParams", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertsFilterTimeframe", - "text": "AlertsFilterTimeframe" - }, - " extends ", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } + "{ [x: string]: unknown; }" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-common.AlertsFilterTimeframe.days", - "type": "Array", - "tags": [], - "label": "days", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.IsoWeekday", - "text": "IsoWeekday" - }, - "[]" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.AlertsFilterTimeframe.timezone", - "type": "string", - "tags": [], - "label": "timezone", - "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.AlertsFilterTimeframe.hours", - "type": "Object", - "tags": [], - "label": "hours", - "description": [], - "signature": [ - "{ start: string; end: string; }" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false - } - ], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.AlertsHealth", - "type": "Interface", + "id": "def-server.RuleTypeState", + "type": "Type", "tags": [], - "label": "AlertsHealth", + "label": "RuleTypeState", "description": [], + "signature": [ + "{ [x: string]: unknown; }" + ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.TOTAL_FIELDS_LIMIT", + "type": "number", + "tags": [], + "label": "TOTAL_FIELDS_LIMIT", + "description": [], + "signature": [ + "2500" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/alerts_service.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "alerting", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY", + "type": "Object", + "tags": [], + "label": "DEFAULT_ALERTS_ILM_POLICY", + "description": [], + "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", + "deprecated": false, + "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.AlertsHealth.decryptionHealth", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY._meta", "type": "Object", "tags": [], - "label": "decryptionHealth", + "label": "_meta", "description": [], - "signature": [ - "{ status: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.HealthStatus", - "text": "HealthStatus" - }, - "; timestamp: string; }" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.AlertsHealth.executionHealth", - "type": "Object", - "tags": [], - "label": "executionHealth", - "description": [], - "signature": [ - "{ status: ", + "trackAdoption": false, + "children": [ { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.HealthStatus", - "text": "HealthStatus" - }, - "; timestamp: string; }" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false + "parentPluginId": "alerting", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY._meta.managed", + "type": "boolean", + "tags": [], + "label": "managed", + "description": [], + "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "alerting", - "id": "def-common.AlertsHealth.readHealth", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases", "type": "Object", "tags": [], - "label": "readHealth", + "label": "phases", "description": [], - "signature": [ - "{ status: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.HealthStatus", - "text": "HealthStatus" - }, - "; timestamp: string; }" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.AlertStatus", - "type": "Interface", + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot", + "type": "Object", + "tags": [], + "label": "hot", + "description": [], + "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions", + "type": "Object", + "tags": [], + "label": "actions", + "description": [], + "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions.rollover", + "type": "Object", + "tags": [], + "label": "rollover", + "description": [], + "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions.rollover.max_age", + "type": "string", + "tags": [], + "label": "max_age", + "description": [], + "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions.rollover.max_primary_shard_size", + "type": "string", + "tags": [], + "label": "max_primary_shard_size", + "description": [], + "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ] + } + ] + } + ] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "alerting", + "id": "def-common.contextToSchemaName", + "type": "Function", "tags": [], - "label": "AlertStatus", + "label": "contextToSchemaName", "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "signature": [ + "(context: string) => string" + ], + "path": "x-pack/plugins/alerting/common/alert_schema/context_to_schema_name.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.AlertStatus.uuid", + "id": "def-common.contextToSchemaName.$1", "type": "string", "tags": [], - "label": "uuid", + "label": "context", "description": [], "signature": [ - "string | undefined" + "string" ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/alert_schema/context_to_schema_name.ts", "deprecated": false, - "trackAdoption": false - }, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.formatDefaultAggregationResult", + "type": "Function", + "tags": [], + "label": "formatDefaultAggregationResult", + "description": [], + "signature": [ + "(aggregations: ", { - "parentPluginId": "alerting", - "id": "def-common.AlertStatus.status", - "type": "CompoundType", - "tags": [], - "label": "status", - "description": [], - "signature": [ - "\"OK\" | \"Active\"" - ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.DefaultRuleAggregationResult", + "text": "DefaultRuleAggregationResult" }, + ") => ", { - "parentPluginId": "alerting", - "id": "def-common.AlertStatus.muted", - "type": "boolean", - "tags": [], - "label": "muted", - "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", - "deprecated": false, - "trackAdoption": false - }, + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleAggregationFormattedResult", + "text": "RuleAggregationFormattedResult" + } + ], + "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.AlertStatus.actionGroupId", - "type": "string", + "id": "def-common.formatDefaultAggregationResult.$1", + "type": "Object", "tags": [], - "label": "actionGroupId", + "label": "aggregations", "description": [], "signature": [ - "string | undefined" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.DefaultRuleAggregationResult", + "text": "DefaultRuleAggregationResult" + } ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", "deprecated": false, - "trackAdoption": false - }, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.formatDuration", + "type": "Function", + "tags": [], + "label": "formatDuration", + "description": [], + "signature": [ + "(duration: string, fullUnit: boolean | undefined) => string" + ], + "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.AlertStatus.activeStartDate", + "id": "def-common.formatDuration.$1", "type": "string", "tags": [], - "label": "activeStartDate", + "label": "duration", "description": [], "signature": [ - "string | undefined" + "string" ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.AlertStatus.flapping", - "type": "boolean", - "tags": [], - "label": "flapping", - "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "isRequired": true }, { "parentPluginId": "alerting", - "id": "def-common.AlertStatus.maintenanceWindowIds", - "type": "Array", + "id": "def-common.formatDuration.$2", + "type": "CompoundType", "tags": [], - "label": "maintenanceWindowIds", + "label": "fullUnit", "description": [], "signature": [ - "string[] | undefined" + "boolean | undefined" ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "isRequired": false } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.AlertSummary", - "type": "Interface", + "id": "def-common.formatRuleTagsAggregationResult", + "type": "Function", "tags": [], - "label": "AlertSummary", + "label": "formatRuleTagsAggregationResult", "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "signature": [ + "(aggregations: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleTagsAggregationResult", + "text": "RuleTagsAggregationResult" + }, + ") => ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleTagsAggregationFormattedResult", + "text": "RuleTagsAggregationFormattedResult" + } + ], + "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.AlertSummary.id", - "type": "string", + "id": "def-common.formatRuleTagsAggregationResult.$1", + "type": "Object", "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.AlertSummary.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.AlertSummary.tags", - "type": "Array", - "tags": [], - "label": "tags", + "label": "aggregations", "description": [], "signature": [ - "string[]" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleTagsAggregationResult", + "text": "RuleTagsAggregationResult" + } ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", "deprecated": false, - "trackAdoption": false - }, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.getBuiltinActionGroups", + "type": "Function", + "tags": [], + "label": "getBuiltinActionGroups", + "description": [], + "signature": [ + "(customRecoveryGroup: ", { - "parentPluginId": "alerting", - "id": "def-common.AlertSummary.ruleTypeId", - "type": "string", - "tags": [], - "label": "ruleTypeId", - "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" }, + " | undefined) => [", { - "parentPluginId": "alerting", - "id": "def-common.AlertSummary.consumer", - "type": "string", - "tags": [], - "label": "consumer", - "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" }, + "<", { - "parentPluginId": "alerting", - "id": "def-common.AlertSummary.muteAll", - "type": "boolean", - "tags": [], - "label": "muteAll", - "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", - "deprecated": false, - "trackAdoption": false + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ReservedActionGroups", + "text": "ReservedActionGroups" }, + ">]" + ], + "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.AlertSummary.throttle", - "type": "CompoundType", + "id": "def-common.getBuiltinActionGroups.$1", + "type": "Object", "tags": [], - "label": "throttle", + "label": "customRecoveryGroup", "description": [], "signature": [ - "string | null | undefined" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + " | undefined" ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "deprecated": false, - "trackAdoption": false - }, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.getComponentTemplateFromFieldMap", + "type": "Function", + "tags": [], + "label": "getComponentTemplateFromFieldMap", + "description": [], + "signature": [ + "({ name, fieldMap, dynamic, includeSettings, }: ", + "GetComponentTemplateFromFieldMapOpts", + ") => ", + "ClusterPutComponentTemplateRequest" + ], + "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/component_template_from_field_map.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.AlertSummary.enabled", - "type": "boolean", + "id": "def-common.getComponentTemplateFromFieldMap.$1", + "type": "Object", "tags": [], - "label": "enabled", + "label": "{\n name,\n fieldMap,\n dynamic,\n includeSettings,\n}", "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "signature": [ + "GetComponentTemplateFromFieldMapOpts" + ], + "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/component_template_from_field_map.ts", "deprecated": false, - "trackAdoption": false - }, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.getDefaultRuleAggregation", + "type": "Function", + "tags": [], + "label": "getDefaultRuleAggregation", + "description": [], + "signature": [ + "(params?: GetDefaultRuleAggregationParams | undefined) => Record" + ], + "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.AlertSummary.statusStartDate", - "type": "string", + "id": "def-common.getDefaultRuleAggregation.$1", + "type": "Object", "tags": [], - "label": "statusStartDate", + "label": "params", "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "signature": [ + "GetDefaultRuleAggregationParams | undefined" + ], + "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", "deprecated": false, - "trackAdoption": false - }, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.getDurationNumberInItsUnit", + "type": "Function", + "tags": [], + "label": "getDurationNumberInItsUnit", + "description": [], + "signature": [ + "(duration: string) => number" + ], + "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.AlertSummary.statusEndDate", + "id": "def-common.getDurationNumberInItsUnit.$1", "type": "string", "tags": [], - "label": "statusEndDate", + "label": "duration", "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "signature": [ + "string" + ], + "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, - "trackAdoption": false - }, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.getDurationUnitValue", + "type": "Function", + "tags": [], + "label": "getDurationUnitValue", + "description": [], + "signature": [ + "(duration: string) => string" + ], + "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.AlertSummary.status", - "type": "CompoundType", + "id": "def-common.getDurationUnitValue.$1", + "type": "string", "tags": [], - "label": "status", + "label": "duration", "description": [], "signature": [ - "\"OK\" | \"Active\" | \"Error\"" + "string" ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, - "trackAdoption": false - }, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.getRuleTagsAggregation", + "type": "Function", + "tags": [], + "label": "getRuleTagsAggregation", + "description": [], + "signature": [ + "(params?: GetRuleTagsAggregationParams | undefined) => Record" + ], + "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.AlertSummary.lastRun", - "type": "string", + "id": "def-common.getRuleTagsAggregation.$1", + "type": "Object", "tags": [], - "label": "lastRun", + "label": "params", "description": [], "signature": [ - "string | undefined" + "GetRuleTagsAggregationParams | undefined" ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", "deprecated": false, - "trackAdoption": false - }, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.isActionGroupDisabledForActionTypeId", + "type": "Function", + "tags": [], + "label": "isActionGroupDisabledForActionTypeId", + "description": [], + "signature": [ + "(actionGroup: string, actionTypeId: string) => boolean" + ], + "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.AlertSummary.errorMessages", - "type": "Array", + "id": "def-common.isActionGroupDisabledForActionTypeId.$1", + "type": "string", "tags": [], - "label": "errorMessages", + "label": "actionGroup", "description": [], "signature": [ - "{ date: string; message: string; }[]" + "string" ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "isRequired": true }, { "parentPluginId": "alerting", - "id": "def-common.AlertSummary.alerts", - "type": "Object", + "id": "def-common.isActionGroupDisabledForActionTypeId.$2", + "type": "string", "tags": [], - "label": "alerts", + "label": "actionTypeId", "description": [], "signature": [ - "{ [x: string]: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertStatus", - "text": "AlertStatus" - }, - "; }" + "string" ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.mappingFromFieldMap", + "type": "Function", + "tags": [], + "label": "mappingFromFieldMap", + "description": [], + "signature": [ + "(fieldMap: ", + { + "pluginId": "@kbn/alerts-as-data-utils", + "scope": "common", + "docId": "kibKbnAlertsAsDataUtilsPluginApi", + "section": "def-common.FieldMap", + "text": "FieldMap" }, + ", dynamic: boolean | \"strict\") => ", + "MappingTypeMapping" + ], + "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/mapping_from_field_map.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.AlertSummary.executionDuration", + "id": "def-common.mappingFromFieldMap.$1", "type": "Object", "tags": [], - "label": "executionDuration", + "label": "fieldMap", "description": [], "signature": [ { - "pluginId": "alerting", + "pluginId": "@kbn/alerts-as-data-utils", "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ExecutionDuration", - "text": "ExecutionDuration" + "docId": "kibKbnAlertsAsDataUtilsPluginApi", + "section": "def-common.FieldMap", + "text": "FieldMap" } ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/mapping_from_field_map.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "isRequired": true }, { "parentPluginId": "alerting", - "id": "def-common.AlertSummary.revision", - "type": "number", + "id": "def-common.mappingFromFieldMap.$2", + "type": "CompoundType", "tags": [], - "label": "revision", + "label": "dynamic", "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "signature": [ + "boolean | \"strict\"" + ], + "path": "x-pack/plugins/alerting/common/alert_schema/field_maps/mapping_from_field_map.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.BulkActionSkipResult", - "type": "Interface", + "id": "def-common.parseDuration", + "type": "Function", "tags": [], - "label": "BulkActionSkipResult", + "label": "parseDuration", "description": [], - "path": "x-pack/plugins/alerting/common/bulk_edit.ts", + "signature": [ + "(duration: string) => number" + ], + "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.BulkActionSkipResult.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/alerting/common/bulk_edit.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.BulkActionSkipResult.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/alerting/common/bulk_edit.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.BulkActionSkipResult.skip_reason", + "id": "def-common.parseDuration.$1", "type": "string", "tags": [], - "label": "skip_reason", + "label": "duration", "description": [], "signature": [ - "\"RULE_NOT_MODIFIED\"" + "string" ], - "path": "x-pack/plugins/alerting/common/bulk_edit.ts", + "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.DateRange", - "type": "Interface", + "id": "def-common.validateDurationSchema", + "type": "Function", "tags": [], - "label": "DateRange", + "label": "validateDurationSchema", "description": [], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "signature": [ + "(duration: string) => string | undefined" + ], + "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.DateRange.gte", - "type": "string", - "tags": [], - "label": "gte", - "description": [], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.DateRange.lte", + "id": "def-common.validateDurationSchema.$1", "type": "string", "tags": [], - "label": "lte", + "label": "duration", "description": [], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "signature": [ + "string" + ], + "path": "x-pack/plugins/alerting/common/parse_duration.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.DefaultRuleAggregationResult", - "type": "Interface", + "id": "def-common.validateNotifyWhenType", + "type": "Function", "tags": [], - "label": "DefaultRuleAggregationResult", + "label": "validateNotifyWhenType", "description": [], - "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", + "signature": [ + "(notifyWhen: string) => string | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.DefaultRuleAggregationResult.status", - "type": "Object", + "id": "def-common.validateNotifyWhenType.$1", + "type": "string", "tags": [], - "label": "status", + "label": "notifyWhen", "description": [], "signature": [ - "{ buckets: { key: string; doc_count: number; }[]; }" + "string" ], - "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", + "path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.wrappedStateRt", + "type": "Function", + "tags": [], + "label": "wrappedStateRt", + "description": [], + "signature": [ + "() => ", + "TypeC", + "<{ wrapped: ", + "Type", + "; trackedAlerts: ", + "RecordC", + "<", + "StringC", + ", ", + "TypeC", + "<{ alertId: ", + "StringC", + "; alertUuid: ", + "StringC", + "; started: ", + "StringC", + "; flappingHistory: ", + "ArrayC", + "<", + "BooleanC", + ">; flapping: ", + "BooleanC", + "; pendingRecoveredCount: ", + "NumberC", + "; }>>; trackedAlertsRecovered: ", + "RecordC", + "<", + "StringC", + ", ", + "TypeC", + "<{ alertId: ", + "StringC", + "; alertUuid: ", + "StringC", + "; started: ", + "StringC", + "; flappingHistory: ", + "ArrayC", + "<", + "BooleanC", + ">; flapping: ", + "BooleanC", + "; pendingRecoveredCount: ", + "NumberC", + "; }>>; }>" + ], + "path": "x-pack/packages/kbn-alerting-state-types/src/lifecycle_state.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "alerting", + "id": "def-common.ActionGroup", + "type": "Interface", + "tags": [], + "label": "ActionGroup", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" }, + "" + ], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.DefaultRuleAggregationResult.outcome", - "type": "Object", + "id": "def-common.ActionGroup.id", + "type": "Uncategorized", "tags": [], - "label": "outcome", + "label": "id", "description": [], "signature": [ - "{ buckets: { key: string; doc_count: number; }[]; }" + "ActionGroupIds" ], - "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", + "path": "x-pack/plugins/alerting/common/rule_type.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.DefaultRuleAggregationResult.muted", - "type": "Object", + "id": "def-common.ActionGroup.name", + "type": "string", "tags": [], - "label": "muted", + "label": "name", "description": [], - "signature": [ - "{ buckets: { key: number; key_as_string: string; doc_count: number; }[]; }" - ], - "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", + "path": "x-pack/plugins/alerting/common/rule_type.ts", "deprecated": false, "trackAdoption": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.ActionVariable", + "type": "Interface", + "tags": [], + "label": "ActionVariable", + "description": [], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.DefaultRuleAggregationResult.enabled", - "type": "Object", + "id": "def-common.ActionVariable.name", + "type": "string", "tags": [], - "label": "enabled", + "label": "name", "description": [], - "signature": [ - "{ buckets: { key: number; key_as_string: string; doc_count: number; }[]; }" - ], - "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.DefaultRuleAggregationResult.snoozed", - "type": "Object", + "id": "def-common.ActionVariable.description", + "type": "string", "tags": [], - "label": "snoozed", + "label": "description", "description": [], - "signature": [ - "{ count: { doc_count: number; }; }" - ], - "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.DefaultRuleAggregationResult.tags", - "type": "Object", + "id": "def-common.ActionVariable.deprecated", + "type": "CompoundType", "tags": [], - "label": "tags", + "label": "deprecated", "description": [], "signature": [ - "{ buckets: { key: string; doc_count: number; }[]; }" + "boolean | undefined" ], - "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.ExecutionDuration", - "type": "Interface", - "tags": [], - "label": "ExecutionDuration", - "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + }, { "parentPluginId": "alerting", - "id": "def-common.ExecutionDuration.average", - "type": "number", + "id": "def-common.ActionVariable.useWithTripleBracesInTemplates", + "type": "CompoundType", "tags": [], - "label": "average", + "label": "useWithTripleBracesInTemplates", "description": [], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.ExecutionDuration.valuesWithTimestamp", - "type": "Object", + "id": "def-common.ActionVariable.usesPublicBaseUrl", + "type": "CompoundType", "tags": [], - "label": "valuesWithTimestamp", + "label": "usesPublicBaseUrl", "description": [], "signature": [ - "{ [x: string]: number; }" + "boolean | undefined" ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false } @@ -6410,102 +5899,118 @@ }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionErrors", + "id": "def-common.AggregateOptions", "type": "Interface", "tags": [], - "label": "IExecutionErrors", + "label": "AggregateOptions", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.IExecutionErrors.id", + "id": "def-common.AggregateOptions.search", "type": "string", "tags": [], - "label": "id", + "label": "search", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionErrors.timestamp", - "type": "string", + "id": "def-common.AggregateOptions.defaultSearchOperator", + "type": "CompoundType", "tags": [], - "label": "timestamp", + "label": "defaultSearchOperator", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + "\"AND\" | \"OR\" | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionErrors.type", - "type": "string", + "id": "def-common.AggregateOptions.searchFields", + "type": "Array", "tags": [], - "label": "type", + "label": "searchFields", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionErrors.message", - "type": "string", + "id": "def-common.AggregateOptions.hasReference", + "type": "Object", "tags": [], - "label": "message", + "label": "hasReference", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + "{ type: string; id: string; } | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.IExecutionErrorsResult", - "type": "Interface", - "tags": [], - "label": "IExecutionErrorsResult", - "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionErrorsResult.totalErrors", + "id": "def-common.AggregateOptions.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + }, + " | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.AggregateOptions.page", "type": "number", "tags": [], - "label": "totalErrors", + "label": "page", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionErrorsResult.errors", - "type": "Array", + "id": "def-common.AggregateOptions.perPage", + "type": "number", "tags": [], - "label": "errors", + "label": "perPage", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.IExecutionErrors", - "text": "IExecutionErrors" - }, - "[]" + "number | undefined" ], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false } @@ -6514,249 +6019,391 @@ }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog", + "id": "def-common.AlertingFrameworkHealth", "type": "Interface", "tags": [], - "label": "IExecutionLog", + "label": "AlertingFrameworkHealth", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.id", - "type": "string", + "id": "def-common.AlertingFrameworkHealth.isSufficientlySecure", + "type": "boolean", "tags": [], - "label": "id", + "label": "isSufficientlySecure", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.timestamp", - "type": "string", + "id": "def-common.AlertingFrameworkHealth.hasPermanentEncryptionKey", + "type": "boolean", "tags": [], - "label": "timestamp", + "label": "hasPermanentEncryptionKey", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.duration_ms", - "type": "number", + "id": "def-common.AlertingFrameworkHealth.alertingFrameworkHealth", + "type": "Object", "tags": [], - "label": "duration_ms", + "label": "alertingFrameworkHealth", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertsHealth", + "text": "AlertsHealth" + } + ], + "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.AlertsFilter", + "type": "Interface", + "tags": [], + "label": "AlertsFilter", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertsFilter", + "text": "AlertsFilter" }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + } + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.status", - "type": "string", + "id": "def-common.AlertsFilter.query", + "type": "Object", "tags": [], - "label": "status", + "label": "query", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + "{ kql: string; filters: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; dsl?: string | undefined; } | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.message", - "type": "string", + "id": "def-common.AlertsFilter.timeframe", + "type": "Object", "tags": [], - "label": "message", + "label": "timeframe", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertsFilterTimeframe", + "text": "AlertsFilterTimeframe" + }, + " | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.AlertsFilterTimeframe", + "type": "Interface", + "tags": [], + "label": "AlertsFilterTimeframe", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertsFilterTimeframe", + "text": "AlertsFilterTimeframe" }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + } + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.version", - "type": "string", + "id": "def-common.AlertsFilterTimeframe.days", + "type": "Array", "tags": [], - "label": "version", + "label": "days", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IsoWeekday", + "text": "IsoWeekday" + }, + "[]" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.num_active_alerts", - "type": "number", + "id": "def-common.AlertsFilterTimeframe.timezone", + "type": "string", "tags": [], - "label": "num_active_alerts", + "label": "timezone", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.num_new_alerts", - "type": "number", + "id": "def-common.AlertsFilterTimeframe.hours", + "type": "Object", "tags": [], - "label": "num_new_alerts", + "label": "hours", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + "{ start: string; end: string; }" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.AlertsHealth", + "type": "Interface", + "tags": [], + "label": "AlertsHealth", + "description": [], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.num_recovered_alerts", - "type": "number", + "id": "def-common.AlertsHealth.decryptionHealth", + "type": "Object", "tags": [], - "label": "num_recovered_alerts", + "label": "decryptionHealth", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.num_triggered_actions", - "type": "number", - "tags": [], - "label": "num_triggered_actions", - "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.num_generated_actions", - "type": "number", - "tags": [], - "label": "num_generated_actions", - "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.num_succeeded_actions", - "type": "number", - "tags": [], - "label": "num_succeeded_actions", - "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + "{ status: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.HealthStatus", + "text": "HealthStatus" + }, + "; timestamp: string; }" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.num_errored_actions", - "type": "number", + "id": "def-common.AlertsHealth.executionHealth", + "type": "Object", "tags": [], - "label": "num_errored_actions", + "label": "executionHealth", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + "{ status: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.HealthStatus", + "text": "HealthStatus" + }, + "; timestamp: string; }" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.total_search_duration_ms", - "type": "number", + "id": "def-common.AlertsHealth.readHealth", + "type": "Object", "tags": [], - "label": "total_search_duration_ms", + "label": "readHealth", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + "{ status: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.HealthStatus", + "text": "HealthStatus" + }, + "; timestamp: string; }" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.AlertStatus", + "type": "Interface", + "tags": [], + "label": "AlertStatus", + "description": [], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.es_search_duration_ms", - "type": "number", + "id": "def-common.AlertStatus.uuid", + "type": "string", "tags": [], - "label": "es_search_duration_ms", + "label": "uuid", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.schedule_delay_ms", - "type": "number", + "id": "def-common.AlertStatus.status", + "type": "CompoundType", "tags": [], - "label": "schedule_delay_ms", + "label": "status", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + "\"OK\" | \"Active\"" + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.timed_out", + "id": "def-common.AlertStatus.muted", "type": "boolean", "tags": [], - "label": "timed_out", + "label": "muted", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.rule_id", + "id": "def-common.AlertStatus.actionGroupId", "type": "string", "tags": [], - "label": "rule_id", + "label": "actionGroupId", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.space_ids", - "type": "Array", + "id": "def-common.AlertStatus.activeStartDate", + "type": "string", "tags": [], - "label": "space_ids", + "label": "activeStartDate", "description": [], "signature": [ - "string[]" + "string | undefined" ], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.rule_name", - "type": "string", + "id": "def-common.AlertStatus.flapping", + "type": "boolean", "tags": [], - "label": "rule_name", + "label": "flapping", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.maintenance_window_ids", + "id": "def-common.AlertStatus.maintenanceWindowIds", "type": "Array", "tags": [], - "label": "maintenance_window_ids", + "label": "maintenanceWindowIds", "description": [], "signature": [ - "string[]" + "string[] | undefined" ], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false } @@ -6765,337 +6412,223 @@ }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLogResult", + "id": "def-common.AlertSummary", "type": "Interface", "tags": [], - "label": "IExecutionLogResult", + "label": "AlertSummary", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.IExecutionLogResult.total", - "type": "number", + "id": "def-common.AlertSummary.id", + "type": "string", "tags": [], - "label": "total", + "label": "id", "description": [], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLogResult.data", + "id": "def-common.AlertSummary.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.AlertSummary.tags", "type": "Array", "tags": [], - "label": "data", + "label": "tags", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.IExecutionLog", - "text": "IExecutionLog" - }, - "[]" + "string[]" ], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.IntervalSchedule", - "type": "Interface", - "tags": [], - "label": "IntervalSchedule", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.IntervalSchedule", - "text": "IntervalSchedule" }, - " extends ", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "alerting", - "id": "def-common.IntervalSchedule.interval", + "id": "def-common.AlertSummary.ruleTypeId", "type": "string", "tags": [], - "label": "interval", + "label": "ruleTypeId", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowClientContext", - "type": "Interface", - "tags": [], - "label": "MaintenanceWindowClientContext", - "description": [], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowClientContext.getModificationMetadata", - "type": "Function", + "id": "def-common.AlertSummary.consumer", + "type": "string", "tags": [], - "label": "getModificationMetadata", + "label": "consumer", "description": [], - "signature": [ - "() => Promise<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.MaintenanceWindowModificationMetadata", - "text": "MaintenanceWindowModificationMetadata" - }, - ">" - ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowClientContext.savedObjectsClient", - "type": "Object", - "tags": [], - "label": "savedObjectsClient", - "description": [], - "signature": [ - { - "pluginId": "@kbn/core-saved-objects-api-server", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", - "section": "def-common.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } - ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowClientContext.logger", - "type": "Object", - "tags": [], - "label": "logger", - "description": [], - "signature": [ - { - "pluginId": "@kbn/logging", - "scope": "common", - "docId": "kibKbnLoggingPluginApi", - "section": "def-common.Logger", - "text": "Logger" - } - ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowModificationMetadata", - "type": "Interface", - "tags": [], - "label": "MaintenanceWindowModificationMetadata", - "description": [], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowModificationMetadata.createdBy", - "type": "CompoundType", + "id": "def-common.AlertSummary.muteAll", + "type": "boolean", "tags": [], - "label": "createdBy", + "label": "muteAll", "description": [], - "signature": [ - "string | null" - ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowModificationMetadata.updatedBy", + "id": "def-common.AlertSummary.throttle", "type": "CompoundType", "tags": [], - "label": "updatedBy", + "label": "throttle", "description": [], "signature": [ - "string | null" + "string | null | undefined" ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowModificationMetadata.createdAt", - "type": "string", + "id": "def-common.AlertSummary.enabled", + "type": "boolean", "tags": [], - "label": "createdAt", + "label": "enabled", "description": [], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowModificationMetadata.updatedAt", + "id": "def-common.AlertSummary.statusStartDate", "type": "string", "tags": [], - "label": "updatedAt", + "label": "statusStartDate", "description": [], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowSOProperties", - "type": "Interface", - "tags": [], - "label": "MaintenanceWindowSOProperties", - "description": [], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowSOProperties.title", + "id": "def-common.AlertSummary.statusEndDate", "type": "string", "tags": [], - "label": "title", + "label": "statusEndDate", "description": [], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowSOProperties.enabled", - "type": "boolean", + "id": "def-common.AlertSummary.status", + "type": "CompoundType", "tags": [], - "label": "enabled", + "label": "status", "description": [], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "signature": [ + "\"OK\" | \"Active\" | \"Error\"" + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowSOProperties.duration", - "type": "number", + "id": "def-common.AlertSummary.lastRun", + "type": "string", "tags": [], - "label": "duration", + "label": "lastRun", "description": [], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowSOProperties.expirationDate", - "type": "string", + "id": "def-common.AlertSummary.errorMessages", + "type": "Array", "tags": [], - "label": "expirationDate", + "label": "errorMessages", "description": [], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "signature": [ + "{ date: string; message: string; }[]" + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowSOProperties.events", - "type": "Array", + "id": "def-common.AlertSummary.alerts", + "type": "Object", "tags": [], - "label": "events", + "label": "alerts", "description": [], "signature": [ + "{ [x: string]: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.DateRange", - "text": "DateRange" + "section": "def-common.AlertStatus", + "text": "AlertStatus" }, - "[]" + "; }" ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowSOProperties.rRule", - "type": "CompoundType", + "id": "def-common.AlertSummary.executionDuration", + "type": "Object", "tags": [], - "label": "rRule", + "label": "executionDuration", "description": [], "signature": [ - "Partial<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RRuleRecord", - "text": "RRuleRecord" - }, - "> & Pick<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.RRuleRecord", - "text": "RRuleRecord" - }, - ", \"dtstart\" | \"tzid\">" + "section": "def-common.ExecutionDuration", + "text": "ExecutionDuration" + } ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.AlertSummary.revision", + "type": "number", + "tags": [], + "label": "revision", + "description": [], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false } @@ -7104,40 +6637,51 @@ }, { "parentPluginId": "alerting", - "id": "def-common.MappedParamsProperties", + "id": "def-common.BulkActionSkipResult", "type": "Interface", "tags": [], - "label": "MappedParamsProperties", + "label": "BulkActionSkipResult", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/bulk_edit.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.MappedParamsProperties.risk_score", - "type": "number", + "id": "def-common.BulkActionSkipResult.id", + "type": "string", "tags": [], - "label": "risk_score", + "label": "id", + "description": [], + "path": "x-pack/plugins/alerting/common/bulk_edit.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.BulkActionSkipResult.name", + "type": "string", + "tags": [], + "label": "name", "description": [], "signature": [ - "number | undefined" + "string | undefined" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/bulk_edit.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.MappedParamsProperties.severity", + "id": "def-common.BulkActionSkipResult.skip_reason", "type": "string", "tags": [], - "label": "severity", + "label": "skip_reason", "description": [], "signature": [ - "string | undefined" + "\"RULE_NOT_MODIFIED\"" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/bulk_edit.ts", "deprecated": false, "trackAdoption": false } @@ -7146,231 +6690,275 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord", + "id": "def-common.DateRange", "type": "Interface", "tags": [], - "label": "RRuleRecord", + "label": "DateRange", "description": [], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.dtstart", + "id": "def-common.DateRange.gte", "type": "string", "tags": [], - "label": "dtstart", + "label": "gte", "description": [], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.tzid", + "id": "def-common.DateRange.lte", "type": "string", "tags": [], - "label": "tzid", + "label": "lte", "description": [], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false - }, - { + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.DefaultRuleAggregationResult", + "type": "Interface", + "tags": [], + "label": "DefaultRuleAggregationResult", + "description": [], + "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.freq", - "type": "CompoundType", + "id": "def-common.DefaultRuleAggregationResult.status", + "type": "Object", "tags": [], - "label": "freq", + "label": "status", "description": [], "signature": [ - "0 | 2 | 6 | 5 | 4 | 3 | 1 | undefined" + "{ buckets: { key: string; doc_count: number; }[]; }" ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.until", - "type": "string", + "id": "def-common.DefaultRuleAggregationResult.outcome", + "type": "Object", "tags": [], - "label": "until", + "label": "outcome", "description": [], "signature": [ - "string | undefined" + "{ buckets: { key: string; doc_count: number; }[]; }" ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.count", - "type": "number", + "id": "def-common.DefaultRuleAggregationResult.muted", + "type": "Object", "tags": [], - "label": "count", + "label": "muted", "description": [], "signature": [ - "number | undefined" + "{ buckets: { key: number; key_as_string: string; doc_count: number; }[]; }" ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.interval", - "type": "number", + "id": "def-common.DefaultRuleAggregationResult.enabled", + "type": "Object", "tags": [], - "label": "interval", + "label": "enabled", "description": [], "signature": [ - "number | undefined" + "{ buckets: { key: number; key_as_string: string; doc_count: number; }[]; }" ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.wkst", - "type": "CompoundType", + "id": "def-common.DefaultRuleAggregationResult.snoozed", + "type": "Object", "tags": [], - "label": "wkst", + "label": "snoozed", "description": [], "signature": [ - "WeekdayStr", - " | undefined" + "{ count: { doc_count: number; }; }" ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.byweekday", - "type": "Array", + "id": "def-common.DefaultRuleAggregationResult.tags", + "type": "Object", "tags": [], - "label": "byweekday", + "label": "tags", "description": [], "signature": [ - "(string | number)[] | undefined" + "{ buckets: { key: string; doc_count: number; }[]; }" ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/default_rule_aggregation.ts", "deprecated": false, "trackAdoption": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.ExecutionDuration", + "type": "Interface", + "tags": [], + "label": "ExecutionDuration", + "description": [], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.bymonth", - "type": "Array", + "id": "def-common.ExecutionDuration.average", + "type": "number", "tags": [], - "label": "bymonth", + "label": "average", "description": [], - "signature": [ - "number[] | undefined" - ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.bysetpos", - "type": "Array", + "id": "def-common.ExecutionDuration.valuesWithTimestamp", + "type": "Object", "tags": [], - "label": "bysetpos", + "label": "valuesWithTimestamp", "description": [], "signature": [ - "number[] | undefined" + "{ [x: string]: number; }" ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.IExecutionErrors", + "type": "Interface", + "tags": [], + "label": "IExecutionErrors", + "description": [], + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.bymonthday", - "type": "Array", + "id": "def-common.IExecutionErrors.id", + "type": "string", "tags": [], - "label": "bymonthday", + "label": "id", "description": [], - "signature": [ - "number[]" - ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.byyearday", - "type": "Array", + "id": "def-common.IExecutionErrors.timestamp", + "type": "string", "tags": [], - "label": "byyearday", + "label": "timestamp", "description": [], - "signature": [ - "number[]" - ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.byweekno", - "type": "Array", + "id": "def-common.IExecutionErrors.type", + "type": "string", "tags": [], - "label": "byweekno", + "label": "type", "description": [], - "signature": [ - "number[]" - ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.byhour", - "type": "Array", + "id": "def-common.IExecutionErrors.message", + "type": "string", "tags": [], - "label": "byhour", + "label": "message", "description": [], - "signature": [ - "number[]" - ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.IExecutionErrorsResult", + "type": "Interface", + "tags": [], + "label": "IExecutionErrorsResult", + "description": [], + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.byminute", - "type": "Array", + "id": "def-common.IExecutionErrorsResult.totalErrors", + "type": "number", "tags": [], - "label": "byminute", + "label": "totalErrors", "description": [], - "signature": [ - "number[]" - ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RRuleRecord.bysecond", + "id": "def-common.IExecutionErrorsResult.errors", "type": "Array", "tags": [], - "label": "bysecond", + "label": "errors", "description": [], "signature": [ - "number[]" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IExecutionErrors", + "text": "IExecutionErrors" + }, + "[]" ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false } @@ -7379,496 +6967,479 @@ }, { "parentPluginId": "alerting", - "id": "def-common.Rule", + "id": "def-common.IExecutionLog", "type": "Interface", "tags": [], - "label": "Rule", + "label": "IExecutionLog", "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.Rule", - "text": "Rule" - }, - "" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.Rule.id", + "id": "def-common.IExecutionLog.id", "type": "string", "tags": [], "label": "id", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.enabled", - "type": "boolean", + "id": "def-common.IExecutionLog.timestamp", + "type": "string", "tags": [], - "label": "enabled", + "label": "timestamp", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.name", - "type": "string", + "id": "def-common.IExecutionLog.duration_ms", + "type": "number", "tags": [], - "label": "name", + "label": "duration_ms", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.tags", - "type": "Array", + "id": "def-common.IExecutionLog.status", + "type": "string", "tags": [], - "label": "tags", + "label": "status", "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.alertTypeId", + "id": "def-common.IExecutionLog.message", "type": "string", "tags": [], - "label": "alertTypeId", + "label": "message", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.consumer", + "id": "def-common.IExecutionLog.version", "type": "string", "tags": [], - "label": "consumer", + "label": "version", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.schedule", - "type": "Object", + "id": "def-common.IExecutionLog.num_active_alerts", + "type": "number", "tags": [], - "label": "schedule", + "label": "num_active_alerts", "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.IntervalSchedule", - "text": "IntervalSchedule" - } - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.actions", - "type": "Array", + "id": "def-common.IExecutionLog.num_new_alerts", + "type": "number", "tags": [], - "label": "actions", + "label": "num_new_alerts", "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleAction", - "text": "RuleAction" - }, - "[]" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.params", - "type": "Uncategorized", + "id": "def-common.IExecutionLog.num_recovered_alerts", + "type": "number", "tags": [], - "label": "params", + "label": "num_recovered_alerts", "description": [], - "signature": [ - "Params" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.mapped_params", - "type": "CompoundType", + "id": "def-common.IExecutionLog.num_triggered_actions", + "type": "number", "tags": [], - "label": "mapped_params", + "label": "num_triggered_actions", "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.MappedParams", - "text": "MappedParams" - }, - " | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.scheduledTaskId", - "type": "string", + "id": "def-common.IExecutionLog.num_generated_actions", + "type": "number", "tags": [], - "label": "scheduledTaskId", + "label": "num_generated_actions", "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.createdBy", - "type": "CompoundType", + "id": "def-common.IExecutionLog.num_succeeded_actions", + "type": "number", "tags": [], - "label": "createdBy", + "label": "num_succeeded_actions", "description": [], - "signature": [ - "string | null" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.updatedBy", - "type": "CompoundType", + "id": "def-common.IExecutionLog.num_errored_actions", + "type": "number", "tags": [], - "label": "updatedBy", + "label": "num_errored_actions", "description": [], - "signature": [ - "string | null" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.createdAt", - "type": "Object", + "id": "def-common.IExecutionLog.total_search_duration_ms", + "type": "number", "tags": [], - "label": "createdAt", + "label": "total_search_duration_ms", "description": [], - "signature": [ - "Date" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.updatedAt", - "type": "Object", + "id": "def-common.IExecutionLog.es_search_duration_ms", + "type": "number", "tags": [], - "label": "updatedAt", + "label": "es_search_duration_ms", "description": [], - "signature": [ - "Date" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.apiKey", - "type": "CompoundType", + "id": "def-common.IExecutionLog.schedule_delay_ms", + "type": "number", "tags": [], - "label": "apiKey", + "label": "schedule_delay_ms", "description": [], - "signature": [ - "string | null" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.apiKeyOwner", - "type": "CompoundType", + "id": "def-common.IExecutionLog.timed_out", + "type": "boolean", "tags": [], - "label": "apiKeyOwner", + "label": "timed_out", "description": [], - "signature": [ - "string | null" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.apiKeyCreatedByUser", - "type": "CompoundType", + "id": "def-common.IExecutionLog.rule_id", + "type": "string", "tags": [], - "label": "apiKeyCreatedByUser", + "label": "rule_id", "description": [], - "signature": [ - "boolean | null | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.throttle", - "type": "CompoundType", + "id": "def-common.IExecutionLog.space_ids", + "type": "Array", "tags": [], - "label": "throttle", + "label": "space_ids", "description": [], "signature": [ - "string | null | undefined" + "string[]" ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.Rule.muteAll", - "type": "boolean", - "tags": [], - "label": "muteAll", - "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.notifyWhen", - "type": "CompoundType", + "id": "def-common.IExecutionLog.rule_name", + "type": "string", "tags": [], - "label": "notifyWhen", + "label": "rule_name", "description": [], - "signature": [ - "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.mutedInstanceIds", + "id": "def-common.IExecutionLog.maintenance_window_ids", "type": "Array", "tags": [], - "label": "mutedInstanceIds", + "label": "maintenance_window_ids", "description": [], "signature": [ "string[]" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.IExecutionLogResult", + "type": "Interface", + "tags": [], + "label": "IExecutionLogResult", + "description": [], + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.Rule.executionStatus", - "type": "Object", + "id": "def-common.IExecutionLogResult.total", + "type": "number", "tags": [], - "label": "executionStatus", + "label": "total", "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleExecutionStatus", - "text": "RuleExecutionStatus" - } - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.monitoring", - "type": "Object", + "id": "def-common.IExecutionLogResult.data", + "type": "Array", "tags": [], - "label": "monitoring", + "label": "data", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.RuleMonitoring", - "text": "RuleMonitoring" + "section": "def-common.IExecutionLog", + "text": "IExecutionLog" }, - " | undefined" + "[]" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.IntervalSchedule", + "type": "Interface", + "tags": [], + "label": "IntervalSchedule", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IntervalSchedule", + "text": "IntervalSchedule" }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + } + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.Rule.snoozeSchedule", - "type": "Array", + "id": "def-common.IntervalSchedule.interval", + "type": "string", "tags": [], - "label": "snoozeSchedule", + "label": "interval", "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleSnooze", - "text": "RuleSnooze" - }, - " | undefined" - ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.Rule.activeSnoozes", - "type": "Array", + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.MaintenanceWindowClientContext", + "type": "Interface", + "tags": [], + "label": "MaintenanceWindowClientContext", + "description": [], + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.MaintenanceWindowClientContext.getModificationMetadata", + "type": "Function", "tags": [], - "label": "activeSnoozes", + "label": "getModificationMetadata", "description": [], "signature": [ - "string[] | undefined" + "() => Promise<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.MaintenanceWindowModificationMetadata", + "text": "MaintenanceWindowModificationMetadata" + }, + ">" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "alerting", - "id": "def-common.Rule.isSnoozedUntil", - "type": "CompoundType", + "id": "def-common.MaintenanceWindowClientContext.savedObjectsClient", + "type": "Object", "tags": [], - "label": "isSnoozedUntil", + "label": "savedObjectsClient", "description": [], "signature": [ - "Date | null | undefined" + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + } ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.lastRun", - "type": "CompoundType", + "id": "def-common.MaintenanceWindowClientContext.logger", + "type": "Object", "tags": [], - "label": "lastRun", + "label": "logger", "description": [], "signature": [ { - "pluginId": "alerting", + "pluginId": "@kbn/logging", "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleLastRun", - "text": "RuleLastRun" - }, - " | null | undefined" + "docId": "kibKbnLoggingPluginApi", + "section": "def-common.Logger", + "text": "Logger" + } ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.MaintenanceWindowModificationMetadata", + "type": "Interface", + "tags": [], + "label": "MaintenanceWindowModificationMetadata", + "description": [], + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.Rule.nextRun", + "id": "def-common.MaintenanceWindowModificationMetadata.createdBy", "type": "CompoundType", "tags": [], - "label": "nextRun", + "label": "createdBy", "description": [], "signature": [ - "Date | null | undefined" + "string | null" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.revision", - "type": "number", + "id": "def-common.MaintenanceWindowModificationMetadata.updatedBy", + "type": "CompoundType", "tags": [], - "label": "revision", + "label": "updatedBy", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "signature": [ + "string | null" + ], + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.running", - "type": "CompoundType", + "id": "def-common.MaintenanceWindowModificationMetadata.createdAt", + "type": "string", "tags": [], - "label": "running", + "label": "createdAt", "description": [], - "signature": [ - "boolean | null | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.viewInAppRelativeUrl", + "id": "def-common.MaintenanceWindowModificationMetadata.updatedAt", "type": "string", "tags": [], - "label": "viewInAppRelativeUrl", + "label": "updatedAt", "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false } @@ -7877,121 +7448,107 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleAction", + "id": "def-common.MaintenanceWindowSOProperties", "type": "Interface", "tags": [], - "label": "RuleAction", + "label": "MaintenanceWindowSOProperties", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.RuleAction.uuid", + "id": "def-common.MaintenanceWindowSOProperties.title", "type": "string", "tags": [], - "label": "uuid", + "label": "title", "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleAction.group", - "type": "string", + "id": "def-common.MaintenanceWindowSOProperties.enabled", + "type": "boolean", "tags": [], - "label": "group", + "label": "enabled", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleAction.id", - "type": "string", + "id": "def-common.MaintenanceWindowSOProperties.duration", + "type": "number", "tags": [], - "label": "id", + "label": "duration", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleAction.actionTypeId", + "id": "def-common.MaintenanceWindowSOProperties.expirationDate", "type": "string", "tags": [], - "label": "actionTypeId", + "label": "expirationDate", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleAction.params", - "type": "Object", + "id": "def-common.MaintenanceWindowSOProperties.events", + "type": "Array", "tags": [], - "label": "params", + "label": "events", "description": [], "signature": [ { - "pluginId": "@kbn/core-saved-objects-common", + "pluginId": "alerting", "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } + "docId": "kibAlertingPluginApi", + "section": "def-common.DateRange", + "text": "DateRange" + }, + "[]" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleAction.frequency", - "type": "Object", + "id": "def-common.MaintenanceWindowSOProperties.rRule", + "type": "CompoundType", "tags": [], - "label": "frequency", + "label": "rRule", "description": [], "signature": [ + "Partial<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.RuleActionFrequency", - "text": "RuleActionFrequency" + "section": "def-common.RRuleRecord", + "text": "RRuleRecord" }, - " | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleAction.alertsFilter", - "type": "Object", - "tags": [], - "label": "alertsFilter", - "description": [], - "signature": [ + "> & Pick<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.AlertsFilter", - "text": "AlertsFilter" + "section": "def-common.RRuleRecord", + "text": "RRuleRecord" }, - " | undefined" + ", \"dtstart\" | \"tzid\">" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false } @@ -8000,66 +7557,38 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleActionFrequency", + "id": "def-common.MappedParamsProperties", "type": "Interface", "tags": [], - "label": "RuleActionFrequency", + "label": "MappedParamsProperties", "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleActionFrequency", - "text": "RuleActionFrequency" - }, - " extends ", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } - ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.RuleActionFrequency.summary", - "type": "boolean", + "id": "def-common.MappedParamsProperties.risk_score", + "type": "number", "tags": [], - "label": "summary", + "label": "risk_score", "description": [], + "signature": [ + "number | undefined" + ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleActionFrequency.notifyWhen", - "type": "CompoundType", + "id": "def-common.MappedParamsProperties.severity", + "type": "string", "tags": [], - "label": "notifyWhen", + "label": "severity", "description": [], "signature": [ - "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleActionFrequency.throttle", - "type": "CompoundType", - "tags": [], - "label": "throttle", - "description": [], - "signature": [ - "string | null" + "string | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8070,66 +7599,67 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleAggregationFormattedResult", + "id": "def-common.Rule", "type": "Interface", "tags": [], - "label": "RuleAggregationFormattedResult", + "label": "Rule", "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.Rule", + "text": "Rule" + }, + "" + ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.RuleAggregationFormattedResult.ruleExecutionStatus", - "type": "Object", + "id": "def-common.Rule.id", + "type": "string", "tags": [], - "label": "ruleExecutionStatus", + "label": "id", "description": [], - "signature": [ - "{ [status: string]: number; }" - ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleAggregationFormattedResult.ruleLastRunOutcome", - "type": "Object", + "id": "def-common.Rule.enabled", + "type": "boolean", "tags": [], - "label": "ruleLastRunOutcome", + "label": "enabled", "description": [], - "signature": [ - "{ [status: string]: number; }" - ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleAggregationFormattedResult.ruleEnabledStatus", - "type": "Object", + "id": "def-common.Rule.name", + "type": "string", "tags": [], - "label": "ruleEnabledStatus", + "label": "name", "description": [], - "signature": [ - "{ enabled: number; disabled: number; }" - ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleAggregationFormattedResult.ruleMutedStatus", - "type": "Object", + "id": "def-common.Rule.tags", + "type": "Array", "tags": [], - "label": "ruleMutedStatus", + "label": "tags", "description": [], "signature": [ - "{ muted: number; unmuted: number; }" + "string[]" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8137,55 +7667,41 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleAggregationFormattedResult.ruleSnoozedStatus", - "type": "Object", + "id": "def-common.Rule.alertTypeId", + "type": "string", "tags": [], - "label": "ruleSnoozedStatus", + "label": "alertTypeId", "description": [], - "signature": [ - "{ snoozed: number; }" - ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleAggregationFormattedResult.ruleTags", - "type": "Array", + "id": "def-common.Rule.consumer", + "type": "string", "tags": [], - "label": "ruleTags", + "label": "consumer", "description": [], - "signature": [ - "string[]" - ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleExecutionStatus", - "type": "Interface", - "tags": [], - "label": "RuleExecutionStatus", - "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + }, { "parentPluginId": "alerting", - "id": "def-common.RuleExecutionStatus.status", - "type": "CompoundType", + "id": "def-common.Rule.schedule", + "type": "Object", "tags": [], - "label": "status", + "label": "schedule", "description": [], "signature": [ - "\"ok\" | \"error\" | \"active\" | \"pending\" | \"unknown\" | \"warning\"" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IntervalSchedule", + "text": "IntervalSchedule" + } ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8193,13 +7709,20 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleExecutionStatus.lastExecutionDate", - "type": "Object", + "id": "def-common.Rule.actions", + "type": "Array", "tags": [], - "label": "lastExecutionDate", + "label": "actions", "description": [], "signature": [ - "Date" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleAction", + "text": "RuleAction" + }, + "[]" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8207,13 +7730,13 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleExecutionStatus.lastDuration", - "type": "number", + "id": "def-common.Rule.params", + "type": "Uncategorized", "tags": [], - "label": "lastDuration", + "label": "params", "description": [], "signature": [ - "number | undefined" + "Params" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8221,21 +7744,20 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleExecutionStatus.error", - "type": "Object", + "id": "def-common.Rule.mapped_params", + "type": "CompoundType", "tags": [], - "label": "error", + "label": "mapped_params", "description": [], "signature": [ - "{ reason: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.RuleExecutionStatusErrorReasons", - "text": "RuleExecutionStatusErrorReasons" + "section": "def-common.MappedParams", + "text": "MappedParams" }, - "; message: string; } | undefined" + " | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8243,49 +7765,27 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleExecutionStatus.warning", - "type": "Object", + "id": "def-common.Rule.scheduledTaskId", + "type": "CompoundType", "tags": [], - "label": "warning", + "label": "scheduledTaskId", "description": [], "signature": [ - "{ reason: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleExecutionStatusWarningReasons", - "text": "RuleExecutionStatusWarningReasons" - }, - "; message: string; } | undefined" + "string | null | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleLastRun", - "type": "Interface", - "tags": [], - "label": "RuleLastRun", - "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + }, { "parentPluginId": "alerting", - "id": "def-common.RuleLastRun.outcome", + "id": "def-common.Rule.createdBy", "type": "CompoundType", "tags": [], - "label": "outcome", + "label": "createdBy", "description": [], "signature": [ - "\"warning\" | \"succeeded\" | \"failed\"" + "string | null" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8293,13 +7793,13 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleLastRun.outcomeOrder", - "type": "number", + "id": "def-common.Rule.updatedBy", + "type": "CompoundType", "tags": [], - "label": "outcomeOrder", + "label": "updatedBy", "description": [], "signature": [ - "number | undefined" + "string | null" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8307,28 +7807,13 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleLastRun.warning", - "type": "CompoundType", + "id": "def-common.Rule.createdAt", + "type": "Object", "tags": [], - "label": "warning", + "label": "createdAt", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleExecutionStatusErrorReasons", - "text": "RuleExecutionStatusErrorReasons" - }, - " | ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleExecutionStatusWarningReasons", - "text": "RuleExecutionStatusWarningReasons" - }, - " | null | undefined" + "Date" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8336,13 +7821,13 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleLastRun.outcomeMsg", - "type": "CompoundType", + "id": "def-common.Rule.updatedAt", + "type": "Object", "tags": [], - "label": "outcomeMsg", + "label": "updatedAt", "description": [], "signature": [ - "string[] | null | undefined" + "Date" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8350,110 +7835,41 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleLastRun.alertsCount", - "type": "Object", + "id": "def-common.Rule.apiKey", + "type": "CompoundType", "tags": [], - "label": "alertsCount", + "label": "apiKey", "description": [], "signature": [ - "{ active?: number | null | undefined; new?: number | null | undefined; recovered?: number | null | undefined; ignored?: number | null | undefined; }" + "string | null" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleMonitoring", - "type": "Interface", - "tags": [], - "label": "RuleMonitoring", - "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + }, { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoring.run", - "type": "Object", + "id": "def-common.Rule.apiKeyOwner", + "type": "CompoundType", "tags": [], - "label": "run", + "label": "apiKeyOwner", "description": [], "signature": [ - "{ history: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleMonitoringHistory", - "text": "RuleMonitoringHistory" - }, - "[]; calculated_metrics: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleMonitoringCalculatedMetrics", - "text": "RuleMonitoringCalculatedMetrics" - }, - "; last_run: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleMonitoringLastRun", - "text": "RuleMonitoringLastRun" - }, - "; }" + "string | null" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringCalculatedMetrics", - "type": "Interface", - "tags": [], - "label": "RuleMonitoringCalculatedMetrics", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleMonitoringCalculatedMetrics", - "text": "RuleMonitoringCalculatedMetrics" }, - " extends ", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringCalculatedMetrics.p50", - "type": "number", + "id": "def-common.Rule.apiKeyCreatedByUser", + "type": "CompoundType", "tags": [], - "label": "p50", + "label": "apiKeyCreatedByUser", "description": [], "signature": [ - "number | undefined" + "boolean | null | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8461,13 +7877,13 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringCalculatedMetrics.p95", - "type": "number", + "id": "def-common.Rule.throttle", + "type": "CompoundType", "tags": [], - "label": "p95", + "label": "throttle", "description": [], "signature": [ - "number | undefined" + "string | null | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8475,13 +7891,24 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringCalculatedMetrics.p99", - "type": "number", + "id": "def-common.Rule.muteAll", + "type": "boolean", "tags": [], - "label": "p99", + "label": "muteAll", + "description": [], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.Rule.notifyWhen", + "type": "CompoundType", + "tags": [], + "label": "notifyWhen", "description": [], "signature": [ - "number | undefined" + "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8489,77 +7916,75 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringCalculatedMetrics.success_ratio", - "type": "number", + "id": "def-common.Rule.mutedInstanceIds", + "type": "Array", "tags": [], - "label": "success_ratio", + "label": "mutedInstanceIds", "description": [], + "signature": [ + "string[]" + ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringHistory", - "type": "Interface", - "tags": [], - "label": "RuleMonitoringHistory", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleMonitoringHistory", - "text": "RuleMonitoringHistory" }, - " extends ", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringHistory.success", - "type": "boolean", + "id": "def-common.Rule.executionStatus", + "type": "Object", "tags": [], - "label": "success", + "label": "executionStatus", "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleExecutionStatus", + "text": "RuleExecutionStatus" + } + ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringHistory.timestamp", - "type": "number", + "id": "def-common.Rule.monitoring", + "type": "Object", "tags": [], - "label": "timestamp", + "label": "monitoring", "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleMonitoring", + "text": "RuleMonitoring" + }, + " | undefined" + ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringHistory.duration", - "type": "number", + "id": "def-common.Rule.snoozeSchedule", + "type": "Array", "tags": [], - "label": "duration", + "label": "snoozeSchedule", "description": [], "signature": [ - "number | undefined" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleSnooze", + "text": "RuleSnooze" + }, + " | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8567,134 +7992,48 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringHistory.outcome", - "type": "CompoundType", + "id": "def-common.Rule.activeSnoozes", + "type": "Array", "tags": [], - "label": "outcome", + "label": "activeSnoozes", "description": [], "signature": [ - "\"warning\" | \"succeeded\" | \"failed\" | undefined" + "string[] | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringLastRun", - "type": "Interface", - "tags": [], - "label": "RuleMonitoringLastRun", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleMonitoringLastRun", - "text": "RuleMonitoringLastRun" }, - " extends ", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringLastRun.timestamp", - "type": "string", + "id": "def-common.Rule.isSnoozedUntil", + "type": "CompoundType", "tags": [], - "label": "timestamp", + "label": "isSnoozedUntil", "description": [], + "signature": [ + "Date | null | undefined" + ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringLastRun.metrics", - "type": "Object", + "id": "def-common.Rule.lastRun", + "type": "CompoundType", "tags": [], - "label": "metrics", + "label": "lastRun", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.RuleMonitoringLastRunMetrics", - "text": "RuleMonitoringLastRunMetrics" - } - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringLastRunMetrics", - "type": "Interface", - "tags": [], - "label": "RuleMonitoringLastRunMetrics", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleMonitoringLastRunMetrics", - "text": "RuleMonitoringLastRunMetrics" - }, - " extends ", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringLastRunMetrics.duration", - "type": "number", - "tags": [], - "label": "duration", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringLastRunMetrics.total_search_duration_ms", - "type": "CompoundType", - "tags": [], - "label": "total_search_duration_ms", - "description": [], - "signature": [ - "number | null | undefined" + "section": "def-common.RuleLastRun", + "text": "RuleLastRun" + }, + " | null | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8702,13 +8041,13 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringLastRunMetrics.total_indexing_duration_ms", + "id": "def-common.Rule.nextRun", "type": "CompoundType", "tags": [], - "label": "total_indexing_duration_ms", + "label": "nextRun", "description": [], "signature": [ - "number | null | undefined" + "Date | null | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8716,27 +8055,24 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringLastRunMetrics.total_alerts_detected", - "type": "CompoundType", + "id": "def-common.Rule.revision", + "type": "number", "tags": [], - "label": "total_alerts_detected", + "label": "revision", "description": [], - "signature": [ - "number | null | undefined" - ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringLastRunMetrics.total_alerts_created", + "id": "def-common.Rule.running", "type": "CompoundType", "tags": [], - "label": "total_alerts_created", + "label": "running", "description": [], "signature": [ - "number | null | undefined" + "boolean | null | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8744,13 +8080,13 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleMonitoringLastRunMetrics.gap_duration_s", - "type": "CompoundType", + "id": "def-common.Rule.viewInAppRelativeUrl", + "type": "string", "tags": [], - "label": "gap_duration_s", + "label": "viewInAppRelativeUrl", "description": [], "signature": [ - "number | null | undefined" + "string | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -8761,123 +8097,121 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleSnoozeSchedule", + "id": "def-common.RuleAction", "type": "Interface", "tags": [], - "label": "RuleSnoozeSchedule", + "label": "RuleAction", "description": [], - "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.RuleSnoozeSchedule.duration", - "type": "number", + "id": "def-common.RuleAction.uuid", + "type": "string", "tags": [], - "label": "duration", + "label": "uuid", "description": [], - "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleSnoozeSchedule.rRule", - "type": "CompoundType", + "id": "def-common.RuleAction.group", + "type": "string", "tags": [], - "label": "rRule", + "label": "group", "description": [], - "signature": [ - "Partial<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RRuleRecord", - "text": "RRuleRecord" - }, - "> & Pick<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RRuleRecord", - "text": "RRuleRecord" - }, - ", \"dtstart\" | \"tzid\">" - ], - "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleSnoozeSchedule.id", + "id": "def-common.RuleAction.id", "type": "string", "tags": [], "label": "id", "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleSnoozeSchedule.skipRecurrences", - "type": "Array", + "id": "def-common.RuleAction.actionTypeId", + "type": "string", "tags": [], - "label": "skipRecurrences", + "label": "actionTypeId", + "description": [], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleAction.params", + "type": "Object", + "tags": [], + "label": "params", "description": [], "signature": [ - "string[] | undefined" + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + } ], - "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RulesSettings", - "type": "Interface", - "tags": [], - "label": "RulesSettings", - "description": [], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + }, { "parentPluginId": "alerting", - "id": "def-common.RulesSettings.flapping", - "type": "CompoundType", + "id": "def-common.RuleAction.frequency", + "type": "Object", "tags": [], - "label": "flapping", + "label": "frequency", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.RulesSettingsFlappingProperties", - "text": "RulesSettingsFlappingProperties" + "section": "def-common.RuleActionFrequency", + "text": "RuleActionFrequency" }, - " & ", + " | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleAction.alertsFilter", + "type": "Object", + "tags": [], + "label": "alertsFilter", + "description": [], + "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.RulesSettingsModificationMetadata", - "text": "RulesSettingsModificationMetadata" - } + "section": "def-common.AlertsFilter", + "text": "AlertsFilter" + }, + " | undefined" ], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false } @@ -8886,45 +8220,68 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RulesSettingsFlappingProperties", + "id": "def-common.RuleActionFrequency", "type": "Interface", "tags": [], - "label": "RulesSettingsFlappingProperties", + "label": "RuleActionFrequency", "description": [], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleActionFrequency", + "text": "RuleActionFrequency" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + } + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.RulesSettingsFlappingProperties.enabled", + "id": "def-common.RuleActionFrequency.summary", "type": "boolean", "tags": [], - "label": "enabled", + "label": "summary", "description": [], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RulesSettingsFlappingProperties.lookBackWindow", - "type": "number", + "id": "def-common.RuleActionFrequency.notifyWhen", + "type": "CompoundType", "tags": [], - "label": "lookBackWindow", + "label": "notifyWhen", "description": [], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "signature": [ + "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RulesSettingsFlappingProperties.statusChangeThreshold", - "type": "number", + "id": "def-common.RuleActionFrequency.throttle", + "type": "CompoundType", "tags": [], - "label": "statusChangeThreshold", + "label": "throttle", "description": [], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "signature": [ + "string | null" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false } @@ -8933,82 +8290,88 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RulesSettingsModificationMetadata", + "id": "def-common.RuleAggregationFormattedResult", "type": "Interface", "tags": [], - "label": "RulesSettingsModificationMetadata", + "label": "RuleAggregationFormattedResult", "description": [], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.RulesSettingsModificationMetadata.createdBy", - "type": "CompoundType", - "tags": [], - "label": "createdBy", + "id": "def-common.RuleAggregationFormattedResult.ruleExecutionStatus", + "type": "Object", + "tags": [], + "label": "ruleExecutionStatus", "description": [], "signature": [ - "string | null" + "{ [status: string]: number; }" ], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RulesSettingsModificationMetadata.updatedBy", - "type": "CompoundType", + "id": "def-common.RuleAggregationFormattedResult.ruleLastRunOutcome", + "type": "Object", "tags": [], - "label": "updatedBy", + "label": "ruleLastRunOutcome", "description": [], "signature": [ - "string | null" + "{ [status: string]: number; }" ], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RulesSettingsModificationMetadata.createdAt", - "type": "string", + "id": "def-common.RuleAggregationFormattedResult.ruleEnabledStatus", + "type": "Object", "tags": [], - "label": "createdAt", + "label": "ruleEnabledStatus", "description": [], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "signature": [ + "{ enabled: number; disabled: number; }" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RulesSettingsModificationMetadata.updatedAt", - "type": "string", + "id": "def-common.RuleAggregationFormattedResult.ruleMutedStatus", + "type": "Object", "tags": [], - "label": "updatedAt", + "label": "ruleMutedStatus", "description": [], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "signature": [ + "{ muted: number; unmuted: number; }" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleTagsAggregationFormattedResult", - "type": "Interface", - "tags": [], - "label": "RuleTagsAggregationFormattedResult", - "description": [], - "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + }, { "parentPluginId": "alerting", - "id": "def-common.RuleTagsAggregationFormattedResult.ruleTags", + "id": "def-common.RuleAggregationFormattedResult.ruleSnoozedStatus", + "type": "Object", + "tags": [], + "label": "ruleSnoozedStatus", + "description": [], + "signature": [ + "{ snoozed: number; }" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleAggregationFormattedResult.ruleTags", "type": "Array", "tags": [], "label": "ruleTags", @@ -9016,7 +8379,7 @@ "signature": [ "string[]" ], - "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false } @@ -9025,245 +8388,333 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleTagsAggregationResult", + "id": "def-common.RuleExecutionStatus", "type": "Interface", "tags": [], - "label": "RuleTagsAggregationResult", + "label": "RuleExecutionStatus", "description": [], - "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "alerting", - "id": "def-common.RuleTagsAggregationResult.tags", - "type": "Object", + "id": "def-common.RuleExecutionStatus.status", + "type": "CompoundType", "tags": [], - "label": "tags", + "label": "status", "description": [], "signature": [ - "{ buckets: { key: { tags: string; }; doc_count: number; }[]; }" + "\"ok\" | \"error\" | \"active\" | \"warning\" | \"pending\" | \"unknown\"" ], - "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleType", - "type": "Interface", - "tags": [], - "label": "RuleType", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleType", - "text": "RuleType" }, - "" - ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "alerting", - "id": "def-common.RuleType.id", - "type": "string", + "id": "def-common.RuleExecutionStatus.lastExecutionDate", + "type": "Object", "tags": [], - "label": "id", + "label": "lastExecutionDate", "description": [], - "path": "x-pack/plugins/alerting/common/rule_type.ts", + "signature": [ + "Date" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleType.name", - "type": "string", + "id": "def-common.RuleExecutionStatus.lastDuration", + "type": "number", "tags": [], - "label": "name", + "label": "lastDuration", "description": [], - "path": "x-pack/plugins/alerting/common/rule_type.ts", + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleType.actionGroups", - "type": "Array", + "id": "def-common.RuleExecutionStatus.error", + "type": "Object", "tags": [], - "label": "actionGroups", + "label": "error", "description": [], "signature": [ + "{ reason: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" + "section": "def-common.RuleExecutionStatusErrorReasons", + "text": "RuleExecutionStatusErrorReasons" }, - "[]" + "; message: string; } | undefined" ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleType.recoveryActionGroup", + "id": "def-common.RuleExecutionStatus.warning", "type": "Object", "tags": [], - "label": "recoveryActionGroup", + "label": "warning", "description": [], "signature": [ + "{ reason: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" + "section": "def-common.RuleExecutionStatusWarningReasons", + "text": "RuleExecutionStatusWarningReasons" }, - "" + "; message: string; } | undefined" ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleLastRun", + "type": "Interface", + "tags": [], + "label": "RuleLastRun", + "description": [], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.RuleType.actionVariables", - "type": "Object", + "id": "def-common.RuleLastRun.outcome", + "type": "CompoundType", "tags": [], - "label": "actionVariables", + "label": "outcome", "description": [], "signature": [ - "{ context: ActionVariable[]; state: ActionVariable[]; params: ActionVariable[]; }" + "\"warning\" | \"succeeded\" | \"failed\"" ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleType.defaultActionGroupId", - "type": "Uncategorized", + "id": "def-common.RuleLastRun.outcomeOrder", + "type": "number", "tags": [], - "label": "defaultActionGroupId", + "label": "outcomeOrder", "description": [], "signature": [ - "ActionGroupIds" + "number | undefined" ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleType.producer", - "type": "string", - "tags": [], - "label": "producer", - "description": [], - "path": "x-pack/plugins/alerting/common/rule_type.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleType.minimumLicenseRequired", + "id": "def-common.RuleLastRun.warning", "type": "CompoundType", "tags": [], - "label": "minimumLicenseRequired", + "label": "warning", "description": [], "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleExecutionStatusErrorReasons", + "text": "RuleExecutionStatusErrorReasons" + }, + " | ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleExecutionStatusWarningReasons", + "text": "RuleExecutionStatusWarningReasons" + }, + " | null | undefined" ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleType.isExportable", - "type": "boolean", + "id": "def-common.RuleLastRun.outcomeMsg", + "type": "CompoundType", "tags": [], - "label": "isExportable", + "label": "outcomeMsg", "description": [], - "path": "x-pack/plugins/alerting/common/rule_type.ts", + "signature": [ + "string[] | null | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleType.ruleTaskTimeout", - "type": "string", + "id": "def-common.RuleLastRun.alertsCount", + "type": "Object", "tags": [], - "label": "ruleTaskTimeout", + "label": "alertsCount", "description": [], "signature": [ - "string | undefined" + "{ active?: number | null | undefined; new?: number | null | undefined; recovered?: number | null | undefined; ignored?: number | null | undefined; }" ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleMonitoring", + "type": "Interface", + "tags": [], + "label": "RuleMonitoring", + "description": [], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.RuleType.defaultScheduleInterval", - "type": "string", + "id": "def-common.RuleMonitoring.run", + "type": "Object", "tags": [], - "label": "defaultScheduleInterval", + "label": "run", "description": [], "signature": [ - "string | undefined" + "{ history: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleMonitoringHistory", + "text": "RuleMonitoringHistory" + }, + "[]; calculated_metrics: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleMonitoringCalculatedMetrics", + "text": "RuleMonitoringCalculatedMetrics" + }, + "; last_run: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleMonitoringLastRun", + "text": "RuleMonitoringLastRun" + }, + "; }" ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleMonitoringCalculatedMetrics", + "type": "Interface", + "tags": [], + "label": "RuleMonitoringCalculatedMetrics", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleMonitoringCalculatedMetrics", + "text": "RuleMonitoringCalculatedMetrics" }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + } + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "alerting", - "id": "def-common.RuleType.doesSetRecoveryContext", - "type": "CompoundType", + "id": "def-common.RuleMonitoringCalculatedMetrics.p50", + "type": "number", "tags": [], - "label": "doesSetRecoveryContext", + "label": "p50", "description": [], "signature": [ - "boolean | undefined" + "number | undefined" ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleType.enabledInLicense", - "type": "boolean", + "id": "def-common.RuleMonitoringCalculatedMetrics.p95", + "type": "number", "tags": [], - "label": "enabledInLicense", + "label": "p95", "description": [], - "path": "x-pack/plugins/alerting/common/rule_type.ts", + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleType.authorizedConsumers", - "type": "Object", + "id": "def-common.RuleMonitoringCalculatedMetrics.p99", + "type": "number", "tags": [], - "label": "authorizedConsumers", + "label": "p99", "description": [], "signature": [ - "{ [x: string]: ConsumerPrivileges; }" + "number | undefined" ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleMonitoringCalculatedMetrics.success_ratio", + "type": "number", + "tags": [], + "label": "success_ratio", + "description": [], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false } @@ -9272,26 +8723,26 @@ }, { "parentPluginId": "alerting", - "id": "def-common.SanitizedAlertsFilter", + "id": "def-common.RuleMonitoringHistory", "type": "Interface", "tags": [], - "label": "SanitizedAlertsFilter", + "label": "RuleMonitoringHistory", "description": [], "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.SanitizedAlertsFilter", - "text": "SanitizedAlertsFilter" + "section": "def-common.RuleMonitoringHistory", + "text": "RuleMonitoringHistory" }, " extends ", { - "pluginId": "alerting", + "pluginId": "@kbn/core-saved-objects-common", "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertsFilter", - "text": "AlertsFilter" + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" } ], "path": "x-pack/plugins/alerting/common/rule.ts", @@ -9300,21 +8751,35 @@ "children": [ { "parentPluginId": "alerting", - "id": "def-common.SanitizedAlertsFilter.query", - "type": "Object", + "id": "def-common.RuleMonitoringHistory.success", + "type": "boolean", "tags": [], - "label": "query", + "label": "success", + "description": [], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleMonitoringHistory.timestamp", + "type": "number", + "tags": [], + "label": "timestamp", + "description": [], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleMonitoringHistory.duration", + "type": "number", + "tags": [], + "label": "duration", "description": [], "signature": [ - "{ kql: string; filters: ", - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]; } | undefined" + "number | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -9322,20 +8787,13 @@ }, { "parentPluginId": "alerting", - "id": "def-common.SanitizedAlertsFilter.timeframe", - "type": "Object", + "id": "def-common.RuleMonitoringHistory.outcome", + "type": "CompoundType", "tags": [], - "label": "timeframe", + "label": "outcome", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertsFilterTimeframe", - "text": "AlertsFilterTimeframe" - }, - " | undefined" + "\"warning\" | \"succeeded\" | \"failed\" | undefined" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -9343,475 +8801,930 @@ } ], "initialIsOpen": false - } - ], - "enums": [ + }, { "parentPluginId": "alerting", - "id": "def-common.ActionsCompletion", - "type": "Enum", + "id": "def-common.RuleMonitoringLastRun", + "type": "Interface", "tags": [], - "label": "ActionsCompletion", + "label": "RuleMonitoringLastRun", "description": [], - "path": "x-pack/packages/kbn-alerting-state-types/src/rule_task_instance.ts", + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleMonitoringLastRun", + "text": "RuleMonitoringLastRun" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + } + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.RuleMonitoringLastRun.timestamp", + "type": "string", + "tags": [], + "label": "timestamp", + "description": [], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleMonitoringLastRun.metrics", + "type": "Object", + "tags": [], + "label": "metrics", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleMonitoringLastRunMetrics", + "text": "RuleMonitoringLastRunMetrics" + } + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + } + ], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.HealthStatus", - "type": "Enum", - "tags": [], - "label": "HealthStatus", - "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowStatus", - "type": "Enum", + "id": "def-common.RuleMonitoringLastRunMetrics", + "type": "Interface", "tags": [], - "label": "MaintenanceWindowStatus", + "label": "RuleMonitoringLastRunMetrics", "description": [], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleMonitoringLastRunMetrics", + "text": "RuleMonitoringLastRunMetrics" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + } + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.RuleMonitoringLastRunMetrics.duration", + "type": "number", + "tags": [], + "label": "duration", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleMonitoringLastRunMetrics.total_search_duration_ms", + "type": "CompoundType", + "tags": [], + "label": "total_search_duration_ms", + "description": [], + "signature": [ + "number | null | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleMonitoringLastRunMetrics.total_indexing_duration_ms", + "type": "CompoundType", + "tags": [], + "label": "total_indexing_duration_ms", + "description": [], + "signature": [ + "number | null | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleMonitoringLastRunMetrics.total_alerts_detected", + "type": "CompoundType", + "tags": [], + "label": "total_alerts_detected", + "description": [], + "signature": [ + "number | null | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleMonitoringLastRunMetrics.total_alerts_created", + "type": "CompoundType", + "tags": [], + "label": "total_alerts_created", + "description": [], + "signature": [ + "number | null | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleMonitoringLastRunMetrics.gap_duration_s", + "type": "CompoundType", + "tags": [], + "label": "gap_duration_s", + "description": [], + "signature": [ + "number | null | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + } + ], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleExecutionStatusErrorReasons", - "type": "Enum", + "id": "def-common.RuleSnoozeSchedule", + "type": "Interface", "tags": [], - "label": "RuleExecutionStatusErrorReasons", + "label": "RuleSnoozeSchedule", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", "deprecated": false, "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.RuleSnoozeSchedule.duration", + "type": "number", + "tags": [], + "label": "duration", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleSnoozeSchedule.rRule", + "type": "CompoundType", + "tags": [], + "label": "rRule", + "description": [], + "signature": [ + "Partial<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RRuleRecord", + "text": "RRuleRecord" + }, + "> & Pick<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RRuleRecord", + "text": "RRuleRecord" + }, + ", \"dtstart\" | \"tzid\">" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleSnoozeSchedule.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleSnoozeSchedule.skipRecurrences", + "type": "Array", + "tags": [], + "label": "skipRecurrences", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false, + "trackAdoption": false + } + ], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleExecutionStatusWarningReasons", - "type": "Enum", + "id": "def-common.RulesSettings", + "type": "Interface", "tags": [], - "label": "RuleExecutionStatusWarningReasons", + "label": "RulesSettings", "description": [], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.RulesSettings.flapping", + "type": "CompoundType", + "tags": [], + "label": "flapping", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RulesSettingsFlappingProperties", + "text": "RulesSettingsFlappingProperties" + }, + " & ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RulesSettingsModificationMetadata", + "text": "RulesSettingsModificationMetadata" + } + ], + "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "deprecated": false, + "trackAdoption": false + } + ], "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleNotifyWhen", - "type": "Enum", + "id": "def-common.RulesSettingsFlappingProperties", + "type": "Interface", "tags": [], - "label": "RuleNotifyWhen", + "label": "RulesSettingsFlappingProperties", "description": [], - "path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts", + "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "alerting", - "id": "def-common.actionErrorLogSortableColumns", - "type": "Array", - "tags": [], - "label": "actionErrorLogSortableColumns", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.ActionErrorLogSortFields", - "type": "Type", - "tags": [], - "label": "ActionErrorLogSortFields", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.ActionGroupIdsOf", - "type": "Type", - "tags": [], - "label": "ActionGroupIdsOf", - "description": [], - "signature": [ - "T extends ", + "children": [ { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" + "parentPluginId": "alerting", + "id": "def-common.RulesSettingsFlappingProperties.enabled", + "type": "boolean", + "tags": [], + "label": "enabled", + "description": [], + "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "deprecated": false, + "trackAdoption": false }, - " ? groups : T extends Readonly<", { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" + "parentPluginId": "alerting", + "id": "def-common.RulesSettingsFlappingProperties.lookBackWindow", + "type": "number", + "tags": [], + "label": "lookBackWindow", + "description": [], + "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "deprecated": false, + "trackAdoption": false }, - "> ? groups : never" + { + "parentPluginId": "alerting", + "id": "def-common.RulesSettingsFlappingProperties.statusChangeThreshold", + "type": "number", + "tags": [], + "label": "statusChangeThreshold", + "description": [], + "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "deprecated": false, + "trackAdoption": false + } ], - "path": "x-pack/plugins/alerting/common/rule_type.ts", - "deprecated": false, - "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.AlertInstanceContext", - "type": "Type", + "id": "def-common.RulesSettingsModificationMetadata", + "type": "Interface", "tags": [], - "label": "AlertInstanceContext", + "label": "RulesSettingsModificationMetadata", "description": [], - "signature": [ - "{ [x: string]: unknown; }" - ], - "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", + "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.AlertInstanceMeta", - "type": "Type", - "tags": [], - "label": "AlertInstanceMeta", - "description": [], - "signature": [ - "{ lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }) | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; uuid?: string | undefined; }" + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.RulesSettingsModificationMetadata.createdBy", + "type": "CompoundType", + "tags": [], + "label": "createdBy", + "description": [], + "signature": [ + "string | null" + ], + "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RulesSettingsModificationMetadata.updatedBy", + "type": "CompoundType", + "tags": [], + "label": "updatedBy", + "description": [], + "signature": [ + "string | null" + ], + "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RulesSettingsModificationMetadata.createdAt", + "type": "string", + "tags": [], + "label": "createdAt", + "description": [], + "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RulesSettingsModificationMetadata.updatedAt", + "type": "string", + "tags": [], + "label": "updatedAt", + "description": [], + "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "deprecated": false, + "trackAdoption": false + } ], - "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", - "deprecated": false, - "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.AlertInstanceState", - "type": "Type", + "id": "def-common.RuleTagsAggregationFormattedResult", + "type": "Interface", "tags": [], - "label": "AlertInstanceState", + "label": "RuleTagsAggregationFormattedResult", "description": [], - "signature": [ - "{ [x: string]: unknown; }" - ], - "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", + "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", "deprecated": false, "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.ALERTS_FEATURE_ID", - "type": "string", - "tags": [], - "label": "ALERTS_FEATURE_ID", - "description": [], - "signature": [ - "\"alerts\"" + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.RuleTagsAggregationFormattedResult.ruleTags", + "type": "Array", + "tags": [], + "label": "ruleTags", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", + "deprecated": false, + "trackAdoption": false + } ], - "path": "x-pack/plugins/alerting/common/index.ts", - "deprecated": false, - "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.AlertStatusValues", - "type": "Type", + "id": "def-common.RuleTagsAggregationResult", + "type": "Interface", "tags": [], - "label": "AlertStatusValues", + "label": "RuleTagsAggregationResult", "description": [], - "signature": [ - "\"OK\" | \"Active\"" - ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", "deprecated": false, "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.ALL_FLAPPING_SETTINGS_SUB_FEATURE_ID", - "type": "string", - "tags": [], - "label": "ALL_FLAPPING_SETTINGS_SUB_FEATURE_ID", - "description": [], - "signature": [ - "\"allFlappingSettings\"" + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.RuleTagsAggregationResult.tags", + "type": "Object", + "tags": [], + "label": "tags", + "description": [], + "signature": [ + "{ buckets: { key: { tags: string; }; doc_count: number; }[]; }" + ], + "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", + "deprecated": false, + "trackAdoption": false + } ], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", - "deprecated": false, - "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.BASE_ALERTING_API_PATH", - "type": "string", + "id": "def-common.RuleType", + "type": "Interface", "tags": [], - "label": "BASE_ALERTING_API_PATH", + "label": "RuleType", "description": [], "signature": [ - "\"/api/alerting\"" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleType", + "text": "RuleType" + }, + "" ], - "path": "x-pack/plugins/alerting/common/index.ts", + "path": "x-pack/plugins/alerting/common/rule_type.ts", "deprecated": false, "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.BulkEditSkipReason", - "type": "Type", - "tags": [], - "label": "BulkEditSkipReason", - "description": [], - "signature": [ - "\"RULE_NOT_MODIFIED\"" - ], - "path": "x-pack/plugins/alerting/common/bulk_edit.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.DEFAULT_LOOK_BACK_WINDOW", - "type": "number", - "tags": [], - "label": "DEFAULT_LOOK_BACK_WINDOW", - "description": [], - "signature": [ - "20" + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.actionGroups", + "type": "Array", + "tags": [], + "label": "actionGroups", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "[]" + ], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.recoveryActionGroup", + "type": "Object", + "tags": [], + "label": "recoveryActionGroup", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "" + ], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.actionVariables", + "type": "Object", + "tags": [], + "label": "actionVariables", + "description": [], + "signature": [ + "{ context: ActionVariable[]; state: ActionVariable[]; params: ActionVariable[]; }" + ], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.defaultActionGroupId", + "type": "Uncategorized", + "tags": [], + "label": "defaultActionGroupId", + "description": [], + "signature": [ + "ActionGroupIds" + ], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.producer", + "type": "string", + "tags": [], + "label": "producer", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.minimumLicenseRequired", + "type": "CompoundType", + "tags": [], + "label": "minimumLicenseRequired", + "description": [], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.isExportable", + "type": "boolean", + "tags": [], + "label": "isExportable", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.ruleTaskTimeout", + "type": "string", + "tags": [], + "label": "ruleTaskTimeout", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.defaultScheduleInterval", + "type": "string", + "tags": [], + "label": "defaultScheduleInterval", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.doesSetRecoveryContext", + "type": "CompoundType", + "tags": [], + "label": "doesSetRecoveryContext", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.enabledInLicense", + "type": "boolean", + "tags": [], + "label": "enabledInLicense", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleType.authorizedConsumers", + "type": "Object", + "tags": [], + "label": "authorizedConsumers", + "description": [], + "signature": [ + "{ [x: string]: ConsumerPrivileges; }" + ], + "path": "x-pack/plugins/alerting/common/rule_type.ts", + "deprecated": false, + "trackAdoption": false + } ], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", - "deprecated": false, - "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.DEFAULT_STATUS_CHANGE_THRESHOLD", - "type": "number", + "id": "def-common.SanitizedAlertsFilter", + "type": "Interface", "tags": [], - "label": "DEFAULT_STATUS_CHANGE_THRESHOLD", + "label": "SanitizedAlertsFilter", "description": [], "signature": [ - "4" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.SanitizedAlertsFilter", + "text": "SanitizedAlertsFilter" + }, + " extends ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertsFilter", + "text": "AlertsFilter" + } ], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.DefaultActionGroupId", - "type": "Type", - "tags": [], - "label": "DefaultActionGroupId", - "description": [], - "signature": [ - "\"default\"" - ], - "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.SanitizedAlertsFilter.query", + "type": "Object", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "{ kql: string; filters: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]; } | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.SanitizedAlertsFilter.timeframe", + "type": "Object", + "tags": [], + "label": "timeframe", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertsFilterTimeframe", + "text": "AlertsFilterTimeframe" + }, + " | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + } + ], "initialIsOpen": false - }, + } + ], + "enums": [ { "parentPluginId": "alerting", - "id": "def-common.ENABLE_MAINTENANCE_WINDOWS", - "type": "boolean", + "id": "def-common.ActionsCompletion", + "type": "Enum", "tags": [], - "label": "ENABLE_MAINTENANCE_WINDOWS", + "label": "ActionsCompletion", "description": [], - "signature": [ - "true" - ], - "path": "x-pack/plugins/alerting/common/index.ts", + "path": "x-pack/packages/kbn-alerting-state-types/src/rule_task_instance.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.ExecutionLogSortFields", - "type": "Type", + "id": "def-common.HealthStatus", + "type": "Enum", "tags": [], - "label": "ExecutionLogSortFields", + "label": "HealthStatus", "description": [], - "signature": [ - "\"timestamp\" | \"execution_duration\" | \"schedule_delay\" | \"total_search_duration\" | \"es_search_duration\" | \"num_triggered_actions\" | \"num_generated_actions\" | \"num_active_alerts\" | \"num_recovered_alerts\" | \"num_new_alerts\"" - ], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionKPIResult", - "type": "Type", + "id": "def-common.MaintenanceWindowStatus", + "type": "Enum", "tags": [], - "label": "IExecutionKPIResult", + "label": "MaintenanceWindowStatus", "description": [], - "signature": [ - "{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }" - ], - "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.INTERNAL_ALERTING_API_FIND_RULES_PATH", - "type": "string", + "id": "def-common.RuleExecutionStatusErrorReasons", + "type": "Enum", "tags": [], - "label": "INTERNAL_ALERTING_API_FIND_RULES_PATH", + "label": "RuleExecutionStatusErrorReasons", "description": [], - "signature": [ - "\"/internal/alerting/rules/_find\"" - ], - "path": "x-pack/plugins/alerting/common/index.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.INTERNAL_ALERTING_API_GET_ACTIVE_MAINTENANCE_WINDOWS_PATH", - "type": "string", + "id": "def-common.RuleExecutionStatusWarningReasons", + "type": "Enum", "tags": [], - "label": "INTERNAL_ALERTING_API_GET_ACTIVE_MAINTENANCE_WINDOWS_PATH", + "label": "RuleExecutionStatusWarningReasons", "description": [], - "signature": [ - "\"/internal/alerting/rules/maintenance_window/_active\"" - ], - "path": "x-pack/plugins/alerting/common/index.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH", - "type": "string", + "id": "def-common.RuleNotifyWhen", + "type": "Enum", "tags": [], - "label": "INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH", + "label": "RuleNotifyWhen", "description": [], - "signature": [ - "\"/internal/alerting/rules/maintenance_window\"" - ], - "path": "x-pack/plugins/alerting/common/index.ts", + "path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false - }, + } + ], + "misc": [ { "parentPluginId": "alerting", - "id": "def-common.INTERNAL_ALERTING_SNOOZE_RULE", - "type": "string", + "id": "def-common.actionErrorLogSortableColumns", + "type": "Array", "tags": [], - "label": "INTERNAL_ALERTING_SNOOZE_RULE", + "label": "actionErrorLogSortableColumns", "description": [], "signature": [ - "\"/internal/alerting/rule/{id}/_snooze\"" + "string[]" ], - "path": "x-pack/plugins/alerting/common/index.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.INTERNAL_BASE_ALERTING_API_PATH", - "type": "string", + "id": "def-common.ActionErrorLogSortFields", + "type": "Type", "tags": [], - "label": "INTERNAL_BASE_ALERTING_API_PATH", + "label": "ActionErrorLogSortFields", "description": [], "signature": [ - "\"/internal/alerting\"" + "string" ], - "path": "x-pack/plugins/alerting/common/index.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.ISO_WEEKDAYS", - "type": "Array", + "id": "def-common.ActionGroupIdsOf", + "type": "Type", "tags": [], - "label": "ISO_WEEKDAYS", + "label": "ActionGroupIdsOf", "description": [], "signature": [ + "T extends ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.IsoWeekday", - "text": "IsoWeekday" + "section": "def-common.ActionGroup", + "text": "ActionGroup" }, - "[]" + " ? groups : T extends Readonly<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "> ? groups : never" ], - "path": "x-pack/plugins/alerting/common/iso_weekdays.ts", + "path": "x-pack/plugins/alerting/common/rule_type.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.IsoWeekday", + "id": "def-common.AlertInstanceContext", "type": "Type", "tags": [], - "label": "IsoWeekday", + "label": "AlertInstanceContext", "description": [], "signature": [ - "2 | 7 | 6 | 5 | 4 | 3 | 1" + "{ [x: string]: unknown; }" ], - "path": "x-pack/plugins/alerting/common/iso_weekdays.ts", + "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.LastScheduledActions", + "id": "def-common.AlertInstanceMeta", "type": "Type", "tags": [], - "label": "LastScheduledActions", + "label": "AlertInstanceMeta", "description": [], "signature": [ - "{ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }" + "{ lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }) | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; uuid?: string | undefined; }" ], "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", "deprecated": false, @@ -9820,297 +9733,238 @@ }, { "parentPluginId": "alerting", - "id": "def-common.LEGACY_BASE_ALERT_API_PATH", - "type": "string", + "id": "def-common.AlertInstanceState", + "type": "Type", "tags": [], - "label": "LEGACY_BASE_ALERT_API_PATH", + "label": "AlertInstanceState", "description": [], "signature": [ - "\"/api/alerts\"" + "{ [x: string]: unknown; }" ], - "path": "x-pack/plugins/alerting/common/index.ts", + "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MAINTENANCE_WINDOW_DATE_FORMAT", + "id": "def-common.ALERTS_FEATURE_ID", "type": "string", "tags": [], - "label": "MAINTENANCE_WINDOW_DATE_FORMAT", + "label": "ALERTS_FEATURE_ID", "description": [], "signature": [ - "\"MM/DD/YY hh:mm A\"" + "\"alerts\"" ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MAINTENANCE_WINDOW_FEATURE_ID", - "type": "string", + "id": "def-common.AlertStatusValues", + "type": "Type", "tags": [], - "label": "MAINTENANCE_WINDOW_FEATURE_ID", + "label": "AlertStatusValues", "description": [], "signature": [ - "\"maintenanceWindow\"" + "\"OK\" | \"Active\"" ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MAINTENANCE_WINDOW_SAVED_OBJECT_TYPE", + "id": "def-common.ALL_FLAPPING_SETTINGS_SUB_FEATURE_ID", "type": "string", "tags": [], - "label": "MAINTENANCE_WINDOW_SAVED_OBJECT_TYPE", + "label": "ALL_FLAPPING_SETTINGS_SUB_FEATURE_ID", "description": [], "signature": [ - "\"maintenance-window\"" + "\"allFlappingSettings\"" ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MAINTENANCE_WINDOWS_APP_ID", + "id": "def-common.BASE_ALERTING_API_PATH", "type": "string", "tags": [], - "label": "MAINTENANCE_WINDOWS_APP_ID", + "label": "BASE_ALERTING_API_PATH", "description": [], "signature": [ - "\"maintenanceWindows\"" + "\"/api/alerting\"" ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindow", + "id": "def-common.BulkEditSkipReason", "type": "Type", "tags": [], - "label": "MaintenanceWindow", + "label": "BulkEditSkipReason", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.MaintenanceWindowSOProperties", - "text": "MaintenanceWindowSOProperties" - }, - " & ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.MaintenanceWindowModificationMetadata", - "text": "MaintenanceWindowModificationMetadata" - }, - " & { status: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.MaintenanceWindowStatus", - "text": "MaintenanceWindowStatus" - }, - "; eventStartTime: string | null; eventEndTime: string | null; id: string; }" + "\"RULE_NOT_MODIFIED\"" ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/bulk_edit.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowCreateBody", - "type": "Type", - "tags": [], - "label": "MaintenanceWindowCreateBody", + "id": "def-common.DEFAULT_LOOK_BACK_WINDOW", + "type": "number", + "tags": [], + "label": "DEFAULT_LOOK_BACK_WINDOW", "description": [], "signature": [ - "{ title: string; duration: number; rRule: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RRuleParams", - "text": "RRuleParams" - }, - "; }" + "20" ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowDeepLinkIds", - "type": "Type", + "id": "def-common.DEFAULT_STATUS_CHANGE_THRESHOLD", + "type": "number", "tags": [], - "label": "MaintenanceWindowDeepLinkIds", + "label": "DEFAULT_STATUS_CHANGE_THRESHOLD", "description": [], "signature": [ - "string" + "4" ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MaintenanceWindowSOAttributes", + "id": "def-common.DefaultActionGroupId", "type": "Type", "tags": [], - "label": "MaintenanceWindowSOAttributes", + "label": "DefaultActionGroupId", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.MaintenanceWindowSOProperties", - "text": "MaintenanceWindowSOProperties" - }, - " & ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.MaintenanceWindowModificationMetadata", - "text": "MaintenanceWindowModificationMetadata" - } + "\"default\"" ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MANAGEMENT_APP_ID", - "type": "string", + "id": "def-common.ENABLE_MAINTENANCE_WINDOWS", + "type": "boolean", "tags": [], - "label": "MANAGEMENT_APP_ID", + "label": "ENABLE_MAINTENANCE_WINDOWS", "description": [], "signature": [ - "\"management\"" + "true" ], - "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MappedParams", + "id": "def-common.ExecutionLogSortFields", "type": "Type", "tags": [], - "label": "MappedParams", + "label": "ExecutionLogSortFields", "description": [], "signature": [ - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - }, - " & ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.MappedParamsProperties", - "text": "MappedParamsProperties" - } + "\"timestamp\" | \"execution_duration\" | \"schedule_delay\" | \"total_search_duration\" | \"es_search_duration\" | \"num_triggered_actions\" | \"num_generated_actions\" | \"num_active_alerts\" | \"num_recovered_alerts\" | \"num_new_alerts\"" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MAX_LOOK_BACK_WINDOW", - "type": "number", + "id": "def-common.IExecutionKPIResult", + "type": "Type", "tags": [], - "label": "MAX_LOOK_BACK_WINDOW", + "label": "IExecutionKPIResult", "description": [], "signature": [ - "20" + "{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }" ], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MAX_STATUS_CHANGE_THRESHOLD", - "type": "number", + "id": "def-common.INTERNAL_ALERTING_API_FIND_RULES_PATH", + "type": "string", "tags": [], - "label": "MAX_STATUS_CHANGE_THRESHOLD", + "label": "INTERNAL_ALERTING_API_FIND_RULES_PATH", "description": [], "signature": [ - "20" + "\"/internal/alerting/rules/_find\"" ], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MIN_LOOK_BACK_WINDOW", - "type": "number", + "id": "def-common.INTERNAL_ALERTING_API_GET_ACTIVE_MAINTENANCE_WINDOWS_PATH", + "type": "string", "tags": [], - "label": "MIN_LOOK_BACK_WINDOW", + "label": "INTERNAL_ALERTING_API_GET_ACTIVE_MAINTENANCE_WINDOWS_PATH", "description": [], "signature": [ - "2" + "\"/internal/alerting/rules/maintenance_window/_active\"" ], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MIN_STATUS_CHANGE_THRESHOLD", - "type": "number", + "id": "def-common.INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH", + "type": "string", "tags": [], - "label": "MIN_STATUS_CHANGE_THRESHOLD", + "label": "INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH", "description": [], "signature": [ - "2" + "\"/internal/alerting/rules/maintenance_window\"" ], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.MONITORING_HISTORY_LIMIT", - "type": "number", + "id": "def-common.INTERNAL_ALERTING_SNOOZE_RULE", + "type": "string", "tags": [], - "label": "MONITORING_HISTORY_LIMIT", + "label": "INTERNAL_ALERTING_SNOOZE_RULE", "description": [], "signature": [ - "200" + "\"/internal/alerting/rule/{id}/_snooze\"" ], "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, @@ -10119,268 +9973,289 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RawAlertInstance", - "type": "Type", + "id": "def-common.INTERNAL_BASE_ALERTING_API_PATH", + "type": "string", "tags": [], - "label": "RawAlertInstance", + "label": "INTERNAL_BASE_ALERTING_API_PATH", "description": [], "signature": [ - "{ state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }) | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; uuid?: string | undefined; } | undefined; }" + "\"/internal/alerting\"" ], - "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", + "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.READ_FLAPPING_SETTINGS_SUB_FEATURE_ID", - "type": "string", + "id": "def-common.ISO_WEEKDAYS", + "type": "Array", "tags": [], - "label": "READ_FLAPPING_SETTINGS_SUB_FEATURE_ID", + "label": "ISO_WEEKDAYS", "description": [], "signature": [ - "\"readFlappingSettings\"" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IsoWeekday", + "text": "IsoWeekday" + }, + "[]" ], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "path": "x-pack/plugins/alerting/common/iso_weekdays.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RecoveredActionGroupId", + "id": "def-common.IsoWeekday", "type": "Type", "tags": [], - "label": "RecoveredActionGroupId", + "label": "IsoWeekday", "description": [], "signature": [ - "\"recovered\"" + "2 | 7 | 6 | 5 | 4 | 3 | 1" ], - "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", + "path": "x-pack/plugins/alerting/common/iso_weekdays.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.ReservedActionGroups", + "id": "def-common.LastScheduledActions", "type": "Type", "tags": [], - "label": "ReservedActionGroups", + "label": "LastScheduledActions", "description": [], "signature": [ - "RecoveryActionGroupId | \"recovered\"" + "{ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }" ], - "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", + "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.ResolvedSanitizedRule", - "type": "Type", + "id": "def-common.LEGACY_BASE_ALERT_API_PATH", + "type": "string", "tags": [], - "label": "ResolvedSanitizedRule", + "label": "LEGACY_BASE_ALERT_API_PATH", "description": [], "signature": [ - "Omit<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.Rule", - "text": "Rule" - }, - ", \"actions\" | \"apiKey\"> & { actions: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.SanitizedRuleAction", - "text": "SanitizedRuleAction" - }, - "[]; } & Omit<", - { - "pluginId": "@kbn/core-saved-objects-api-server", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", - "section": "def-common.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - ", \"saved_object\">" + "\"/api/alerts\"" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RRuleParams", - "type": "Type", + "id": "def-common.MAINTENANCE_WINDOW_DATE_FORMAT", + "type": "string", "tags": [], - "label": "RRuleParams", + "label": "MAINTENANCE_WINDOW_DATE_FORMAT", "description": [], "signature": [ - "Partial<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RRuleRecord", - "text": "RRuleRecord" - }, - "> & Pick<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RRuleRecord", - "text": "RRuleRecord" - }, - ", \"dtstart\" | \"tzid\">" + "\"MM/DD/YY hh:mm A\"" ], - "path": "x-pack/plugins/alerting/common/rrule_type.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleActionAlertsFilterProperty", - "type": "Type", + "id": "def-common.MAINTENANCE_WINDOW_FEATURE_ID", + "type": "string", "tags": [], - "label": "RuleActionAlertsFilterProperty", + "label": "MAINTENANCE_WINDOW_FEATURE_ID", "description": [], "signature": [ - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttribute", - "text": "SavedObjectAttribute" - }, - " | ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertsFilterTimeframe", - "text": "AlertsFilterTimeframe" - } + "\"maintenanceWindow\"" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleActionParam", + "id": "def-common.MAINTENANCE_WINDOW_SAVED_OBJECT_TYPE", + "type": "string", + "tags": [], + "label": "MAINTENANCE_WINDOW_SAVED_OBJECT_TYPE", + "description": [], + "signature": [ + "\"maintenance-window\"" + ], + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.MAINTENANCE_WINDOWS_APP_ID", + "type": "string", + "tags": [], + "label": "MAINTENANCE_WINDOWS_APP_ID", + "description": [], + "signature": [ + "\"maintenanceWindows\"" + ], + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.MaintenanceWindow", "type": "Type", "tags": [], - "label": "RuleActionParam", + "label": "MaintenanceWindow", "description": [], "signature": [ { - "pluginId": "@kbn/core-saved-objects-common", + "pluginId": "alerting", "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributeSingle", - "text": "SavedObjectAttributeSingle" + "docId": "kibAlertingPluginApi", + "section": "def-common.MaintenanceWindowSOProperties", + "text": "MaintenanceWindowSOProperties" }, - " | ", + " & ", { - "pluginId": "@kbn/core-saved-objects-common", + "pluginId": "alerting", "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributeSingle", - "text": "SavedObjectAttributeSingle" + "docId": "kibAlertingPluginApi", + "section": "def-common.MaintenanceWindowModificationMetadata", + "text": "MaintenanceWindowModificationMetadata" }, - "[]" + " & { status: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.MaintenanceWindowStatus", + "text": "MaintenanceWindowStatus" + }, + "; eventStartTime: string | null; eventEndTime: string | null; id: string; }" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleActionParams", + "id": "def-common.MaintenanceWindowCreateBody", "type": "Type", "tags": [], - "label": "RuleActionParams", + "label": "MaintenanceWindowCreateBody", "description": [], "signature": [ + "{ title: string; duration: number; rRule: ", { - "pluginId": "@kbn/core-saved-objects-common", + "pluginId": "alerting", "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } + "docId": "kibAlertingPluginApi", + "section": "def-common.RRuleParams", + "text": "RRuleParams" + }, + "; }" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleAlertData", + "id": "def-common.MaintenanceWindowDeepLinkIds", "type": "Type", "tags": [], - "label": "RuleAlertData", + "label": "MaintenanceWindowDeepLinkIds", "description": [], "signature": [ - "{ [x: string]: unknown; }" + "string" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleAlertingOutcome", + "id": "def-common.MaintenanceWindowSOAttributes", "type": "Type", "tags": [], - "label": "RuleAlertingOutcome", + "label": "MaintenanceWindowSOAttributes", "description": [], "signature": [ - "\"unknown\" | \"warning\" | \"failure\" | \"success\"" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.MaintenanceWindowSOProperties", + "text": "MaintenanceWindowSOProperties" + }, + " & ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.MaintenanceWindowModificationMetadata", + "text": "MaintenanceWindowModificationMetadata" + } ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleExecutionStatuses", - "type": "Type", + "id": "def-common.MANAGEMENT_APP_ID", + "type": "string", "tags": [], - "label": "RuleExecutionStatuses", + "label": "MANAGEMENT_APP_ID", "description": [], "signature": [ - "\"ok\" | \"error\" | \"active\" | \"pending\" | \"unknown\" | \"warning\"" + "\"management\"" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/maintenance_window.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleLastRunOutcomes", + "id": "def-common.MappedParams", "type": "Type", "tags": [], - "label": "RuleLastRunOutcomes", + "label": "MappedParams", "description": [], "signature": [ - "\"warning\" | \"succeeded\" | \"failed\"" + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + }, + " & ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.MappedParamsProperties", + "text": "MappedParamsProperties" + } ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -10389,28 +10264,28 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleNotifyWhenType", - "type": "Type", + "id": "def-common.MAX_LOOK_BACK_WINDOW", + "type": "number", "tags": [], - "label": "RuleNotifyWhenType", + "label": "MAX_LOOK_BACK_WINDOW", "description": [], "signature": [ - "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" + "20" ], - "path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts", + "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RULES_SETTINGS_FEATURE_ID", - "type": "string", + "id": "def-common.MAX_STATUS_CHANGE_THRESHOLD", + "type": "number", "tags": [], - "label": "RULES_SETTINGS_FEATURE_ID", + "label": "MAX_STATUS_CHANGE_THRESHOLD", "description": [], "signature": [ - "\"rulesSettings\"" + "20" ], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, @@ -10419,13 +10294,13 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RULES_SETTINGS_SAVED_OBJECT_ID", - "type": "string", + "id": "def-common.MIN_LOOK_BACK_WINDOW", + "type": "number", "tags": [], - "label": "RULES_SETTINGS_SAVED_OBJECT_ID", + "label": "MIN_LOOK_BACK_WINDOW", "description": [], "signature": [ - "\"rules-settings\"" + "2" ], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, @@ -10434,13 +10309,13 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RULES_SETTINGS_SAVED_OBJECT_TYPE", - "type": "string", + "id": "def-common.MIN_STATUS_CHANGE_THRESHOLD", + "type": "number", "tags": [], - "label": "RULES_SETTINGS_SAVED_OBJECT_TYPE", + "label": "MIN_STATUS_CHANGE_THRESHOLD", "description": [], "signature": [ - "\"rules-settings\"" + "2" ], "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, @@ -10449,181 +10324,197 @@ }, { "parentPluginId": "alerting", - "id": "def-common.RuleSnooze", - "type": "Type", + "id": "def-common.MONITORING_HISTORY_LIMIT", + "type": "number", "tags": [], - "label": "RuleSnooze", + "label": "MONITORING_HISTORY_LIMIT", "description": [], "signature": [ - "{ duration: number; rRule: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RRuleParams", - "text": "RRuleParams" - }, - "; id?: string | undefined; skipRecurrences?: string[] | undefined; }[]" + "200" ], - "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "path": "x-pack/plugins/alerting/common/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RulesSettingsFlapping", + "id": "def-common.RawAlertInstance", "type": "Type", "tags": [], - "label": "RulesSettingsFlapping", + "label": "RawAlertInstance", "description": [], "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RulesSettingsFlappingProperties", - "text": "RulesSettingsFlappingProperties" - }, - " & ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RulesSettingsModificationMetadata", - "text": "RulesSettingsModificationMetadata" - } + "{ state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }) | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; uuid?: string | undefined; } | undefined; }" ], - "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleStatusValues", - "type": "Type", + "id": "def-common.READ_FLAPPING_SETTINGS_SUB_FEATURE_ID", + "type": "string", "tags": [], - "label": "RuleStatusValues", + "label": "READ_FLAPPING_SETTINGS_SUB_FEATURE_ID", "description": [], "signature": [ - "\"OK\" | \"Active\" | \"Error\"" + "\"readFlappingSettings\"" ], - "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "path": "x-pack/plugins/alerting/common/rules_settings.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleTagsAggregationOptions", + "id": "def-common.RecoveredActionGroupId", "type": "Type", "tags": [], - "label": "RuleTagsAggregationOptions", + "label": "RecoveredActionGroupId", "description": [], "signature": [ - "Pick<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AggregateOptions", - "text": "AggregateOptions" - }, - ", \"search\" | \"filter\"> & { after?: ", - "AggregationsCompositeAggregateKey", - " | undefined; maxTags?: number | undefined; }" + "\"recovered\"" ], - "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", + "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleTaskParams", + "id": "def-common.ReservedActionGroups", "type": "Type", "tags": [], - "label": "RuleTaskParams", + "label": "ReservedActionGroups", "description": [], "signature": [ - "{ alertId: string; } & { spaceId?: string | undefined; }" + "RecoveryActionGroupId | \"recovered\"" ], - "path": "x-pack/packages/kbn-alerting-state-types/src/rule_task_instance.ts", + "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleTaskState", + "id": "def-common.ResolvedSanitizedRule", "type": "Type", "tags": [], - "label": "RuleTaskState", + "label": "ResolvedSanitizedRule", "description": [], "signature": [ - "{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }) | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; uuid?: string | undefined; } | undefined; }; } | undefined; alertRecoveredInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }) | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; uuid?: string | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; summaryActions?: { [x: string]: { date: Date; }; } | undefined; }" - ], - "path": "x-pack/packages/kbn-alerting-state-types/src/rule_task_instance.ts", + "Omit<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.Rule", + "text": "Rule" + }, + ", \"actions\" | \"apiKey\"> & { actions: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.SanitizedRuleAction", + "text": "SanitizedRuleAction" + }, + "[]; } & Omit<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-common.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + ", \"saved_object\">" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleTypeParams", + "id": "def-common.RRuleParams", "type": "Type", "tags": [], - "label": "RuleTypeParams", + "label": "RRuleParams", "description": [], "signature": [ - "{ [x: string]: unknown; }" + "Partial<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RRuleRecord", + "text": "RRuleRecord" + }, + "> & Pick<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RRuleRecord", + "text": "RRuleRecord" + }, + ", \"dtstart\" | \"tzid\">" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/rrule_type.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.RuleTypeState", + "id": "def-common.RRuleRecord", "type": "Type", "tags": [], - "label": "RuleTypeState", + "label": "RRuleRecord", "description": [], "signature": [ - "{ [x: string]: unknown; }" + "Omit<", + "Options", + ", \"dtstart\" | \"until\" | \"wkst\" | \"byweekday\"> & { dtstart: string; byweekday?: (string | number)[] | undefined; wkst?: ", + { + "pluginId": "@kbn/rrule", + "scope": "common", + "docId": "kibKbnRrulePluginApi", + "section": "def-common.WeekdayStr", + "text": "WeekdayStr" + }, + " | undefined; until?: string | undefined; }" ], - "path": "x-pack/plugins/alerting/common/rule.ts", + "path": "x-pack/plugins/alerting/common/rrule_type.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.SanitizedRule", + "id": "def-common.RuleActionAlertsFilterProperty", "type": "Type", "tags": [], - "label": "SanitizedRule", + "label": "RuleActionAlertsFilterProperty", "description": [], "signature": [ - "Omit<", { - "pluginId": "alerting", + "pluginId": "@kbn/core-saved-objects-common", "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.Rule", - "text": "Rule" + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttribute", + "text": "SavedObjectAttribute" }, - ", \"actions\" | \"apiKey\"> & { actions: ", + " | ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.SanitizedRuleAction", - "text": "SanitizedRuleAction" - }, - "[]; }" + "section": "def-common.AlertsFilterTimeframe", + "text": "AlertsFilterTimeframe" + } ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -10632,29 +10523,28 @@ }, { "parentPluginId": "alerting", - "id": "def-common.SanitizedRuleAction", + "id": "def-common.RuleActionParam", "type": "Type", "tags": [], - "label": "SanitizedRuleAction", + "label": "RuleActionParam", "description": [], "signature": [ - "Omit<", { - "pluginId": "alerting", + "pluginId": "@kbn/core-saved-objects-common", "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleAction", - "text": "RuleAction" + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributeSingle", + "text": "SavedObjectAttributeSingle" }, - ", \"alertsFilter\"> & { alertsFilter?: ", + " | ", { - "pluginId": "alerting", + "pluginId": "@kbn/core-saved-objects-common", "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.SanitizedAlertsFilter", - "text": "SanitizedAlertsFilter" + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributeSingle", + "text": "SavedObjectAttributeSingle" }, - " | undefined; }" + "[]" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -10663,21 +10553,19 @@ }, { "parentPluginId": "alerting", - "id": "def-common.SanitizedRuleConfig", + "id": "def-common.RuleActionParams", "type": "Type", "tags": [], - "label": "SanitizedRuleConfig", + "label": "RuleActionParams", "description": [], "signature": [ - "Pick<", { - "pluginId": "alerting", + "pluginId": "@kbn/core-saved-objects-common", "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.SanitizedRule", - "text": "SanitizedRule" - }, - ", \"id\" | \"consumer\" | \"name\" | \"actions\" | \"tags\" | \"enabled\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"muteAll\" | \"notifyWhen\" | \"snoozeSchedule\" | \"revision\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + } ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -10686,76 +10574,2369 @@ }, { "parentPluginId": "alerting", - "id": "def-common.ThrottledActions", + "id": "def-common.RuleAlertData", "type": "Type", "tags": [], - "label": "ThrottledActions", + "label": "RuleAlertData", "description": [], "signature": [ - "{ [x: string]: { date: Date; }; }" + "{ [x: string]: unknown; }" ], - "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.TrackedLifecycleAlertState", + "id": "def-common.RuleAlertingOutcome", "type": "Type", "tags": [], - "label": "TrackedLifecycleAlertState", + "label": "RuleAlertingOutcome", "description": [], "signature": [ - "{ alertId: string; alertUuid: string; started: string; flappingHistory: boolean[]; flapping: boolean; pendingRecoveredCount: number; }" + "\"warning\" | \"unknown\" | \"success\" | \"failure\"" ], - "path": "x-pack/packages/kbn-alerting-state-types/src/lifecycle_state.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.WithoutReservedActionGroups", + "id": "def-common.RuleExecutionStatuses", "type": "Type", "tags": [], - "label": "WithoutReservedActionGroups", + "label": "RuleExecutionStatuses", "description": [], "signature": [ - "ActionGroupIds extends ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ReservedActionGroups", - "text": "ReservedActionGroups" - }, - " ? never : ActionGroupIds" + "\"ok\" | \"error\" | \"active\" | \"warning\" | \"pending\" | \"unknown\"" ], - "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", + "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "alerting", - "id": "def-common.WrappedLifecycleRuleState", + "id": "def-common.RuleLastRunOutcomes", "type": "Type", "tags": [], - "label": "WrappedLifecycleRuleState", - "description": [ - "\nThis is redefined instead of derived from above `wrappedStateRt` because\nthere's no easy way to instantiate generic values such as the runtime type\nfactory function." + "label": "RuleLastRunOutcomes", + "description": [], + "signature": [ + "\"warning\" | \"succeeded\" | \"failed\"" ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleNotifyWhenType", + "type": "Type", + "tags": [], + "label": "RuleNotifyWhenType", + "description": [], "signature": [ - "RuleTypeState & { wrapped: State; trackedAlerts: Record; trackedAlertsRecovered: Record; }" + "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" ], - "path": "x-pack/packages/kbn-alerting-state-types/src/lifecycle_state.ts", + "path": "x-pack/plugins/alerting/common/rule_notify_when_type.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false - } - ], - "objects": [ + }, + { + "parentPluginId": "alerting", + "id": "def-common.RULES_SETTINGS_FEATURE_ID", + "type": "string", + "tags": [], + "label": "RULES_SETTINGS_FEATURE_ID", + "description": [], + "signature": [ + "\"rulesSettings\"" + ], + "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RULES_SETTINGS_SAVED_OBJECT_ID", + "type": "string", + "tags": [], + "label": "RULES_SETTINGS_SAVED_OBJECT_ID", + "description": [], + "signature": [ + "\"rules-settings\"" + ], + "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RULES_SETTINGS_SAVED_OBJECT_TYPE", + "type": "string", + "tags": [], + "label": "RULES_SETTINGS_SAVED_OBJECT_TYPE", + "description": [], + "signature": [ + "\"rules-settings\"" + ], + "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleSnooze", + "type": "Type", + "tags": [], + "label": "RuleSnooze", + "description": [], + "signature": [ + "{ duration: number; rRule: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RRuleParams", + "text": "RRuleParams" + }, + "; id?: string | undefined; skipRecurrences?: string[] | undefined; }[]" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RulesSettingsFlapping", + "type": "Type", + "tags": [], + "label": "RulesSettingsFlapping", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RulesSettingsFlappingProperties", + "text": "RulesSettingsFlappingProperties" + }, + " & ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RulesSettingsModificationMetadata", + "text": "RulesSettingsModificationMetadata" + } + ], + "path": "x-pack/plugins/alerting/common/rules_settings.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleStatusValues", + "type": "Type", + "tags": [], + "label": "RuleStatusValues", + "description": [], + "signature": [ + "\"OK\" | \"Active\" | \"Error\"" + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleTagsAggregationOptions", + "type": "Type", + "tags": [], + "label": "RuleTagsAggregationOptions", + "description": [], + "signature": [ + "Pick<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AggregateOptions", + "text": "AggregateOptions" + }, + ", \"search\" | \"filter\"> & { after?: ", + "AggregationsCompositeAggregateKey", + " | undefined; maxTags?: number | undefined; }" + ], + "path": "x-pack/plugins/alerting/common/rule_tags_aggregation.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleTaskParams", + "type": "Type", + "tags": [], + "label": "RuleTaskParams", + "description": [], + "signature": [ + "{ alertId: string; } & { spaceId?: string | undefined; }" + ], + "path": "x-pack/packages/kbn-alerting-state-types/src/rule_task_instance.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleTaskState", + "type": "Type", + "tags": [], + "label": "RuleTaskState", + "description": [], + "signature": [ + "{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }) | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; uuid?: string | undefined; } | undefined; }; } | undefined; alertRecoveredInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }) | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; maintenanceWindowIds?: string[] | undefined; pendingRecoveredCount?: number | undefined; uuid?: string | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; summaryActions?: { [x: string]: { date: Date; }; } | undefined; }" + ], + "path": "x-pack/packages/kbn-alerting-state-types/src/rule_task_instance.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleTypeParams", + "type": "Type", + "tags": [], + "label": "RuleTypeParams", + "description": [], + "signature": [ + "{ [x: string]: unknown; }" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleTypeState", + "type": "Type", + "tags": [], + "label": "RuleTypeState", + "description": [], + "signature": [ + "{ [x: string]: unknown; }" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.SanitizedRule", + "type": "Type", + "tags": [], + "label": "SanitizedRule", + "description": [], + "signature": [ + "Omit<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.Rule", + "text": "Rule" + }, + ", \"actions\" | \"apiKey\"> & { actions: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.SanitizedRuleAction", + "text": "SanitizedRuleAction" + }, + "[]; }" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.SanitizedRuleAction", + "type": "Type", + "tags": [], + "label": "SanitizedRuleAction", + "description": [], + "signature": [ + "Omit<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleAction", + "text": "RuleAction" + }, + ", \"alertsFilter\"> & { alertsFilter?: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.SanitizedAlertsFilter", + "text": "SanitizedAlertsFilter" + }, + " | undefined; }" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.SanitizedRuleConfig", + "type": "Type", + "tags": [], + "label": "SanitizedRuleConfig", + "description": [], + "signature": [ + "Pick<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.SanitizedRule", + "text": "SanitizedRule" + }, + ", \"id\" | \"consumer\" | \"name\" | \"actions\" | \"tags\" | \"enabled\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"muteAll\" | \"notifyWhen\" | \"snoozeSchedule\" | \"revision\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.ThrottledActions", + "type": "Type", + "tags": [], + "label": "ThrottledActions", + "description": [], + "signature": [ + "{ [x: string]: { date: Date; }; }" + ], + "path": "x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.TrackedLifecycleAlertState", + "type": "Type", + "tags": [], + "label": "TrackedLifecycleAlertState", + "description": [], + "signature": [ + "{ alertId: string; alertUuid: string; started: string; flappingHistory: boolean[]; flapping: boolean; pendingRecoveredCount: number; }" + ], + "path": "x-pack/packages/kbn-alerting-state-types/src/lifecycle_state.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.WithoutReservedActionGroups", + "type": "Type", + "tags": [], + "label": "WithoutReservedActionGroups", + "description": [], + "signature": [ + "ActionGroupIds extends ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ReservedActionGroups", + "text": "ReservedActionGroups" + }, + " ? never : ActionGroupIds" + ], + "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.WrappedLifecycleRuleState", + "type": "Type", + "tags": [], + "label": "WrappedLifecycleRuleState", + "description": [ + "\nThis is redefined instead of derived from above `wrappedStateRt` because\nthere's no easy way to instantiate generic values such as the runtime type\nfactory function." + ], + "signature": [ + "RuleTypeState & { wrapped: State; trackedAlerts: Record; trackedAlertsRecovered: Record; }" + ], + "path": "x-pack/packages/kbn-alerting-state-types/src/lifecycle_state.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings", + "type": "Object", + "tags": [], + "label": "alertMappings", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.dynamic", + "type": "boolean", + "tags": [], + "label": "dynamic", + "description": [], + "signature": [ + "false" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.enabled", + "type": "Object", + "tags": [], + "label": "enabled", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.enabled.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"boolean\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.name", + "type": "Object", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.name.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"text\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.name.fields", + "type": "Object", + "tags": [], + "label": "fields", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.name.fields.keyword", + "type": "Object", + "tags": [], + "label": "keyword", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.name.fields.keyword.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.name.fields.keyword.normalizer", + "type": "string", + "tags": [], + "label": "normalizer", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ] + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.tags", + "type": "Object", + "tags": [], + "label": "tags", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.tags.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.alertTypeId", + "type": "Object", + "tags": [], + "label": "alertTypeId", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.alertTypeId.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.schedule", + "type": "Object", + "tags": [], + "label": "schedule", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.schedule.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.schedule.properties.interval", + "type": "Object", + "tags": [], + "label": "interval", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.schedule.properties.interval.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ] + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.consumer", + "type": "Object", + "tags": [], + "label": "consumer", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.consumer.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.legacyId", + "type": "Object", + "tags": [], + "label": "legacyId", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.legacyId.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.actions", + "type": "Object", + "tags": [], + "label": "actions", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.actions.dynamic", + "type": "boolean", + "tags": [], + "label": "dynamic", + "description": [], + "signature": [ + "false" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.actions.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"nested\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.actions.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.actions.properties.group", + "type": "Object", + "tags": [], + "label": "group", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.actions.properties.group.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.actions.properties.actionRef", + "type": "Object", + "tags": [], + "label": "actionRef", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.actions.properties.actionRef.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.actions.properties.actionTypeId", + "type": "Object", + "tags": [], + "label": "actionTypeId", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.actions.properties.actionTypeId.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ] + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.params.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"flattened\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.params.ignore_above", + "type": "number", + "tags": [], + "label": "ignore_above", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.mapped_params", + "type": "Object", + "tags": [], + "label": "mapped_params", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.mapped_params.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.mapped_params.properties.risk_score", + "type": "Object", + "tags": [], + "label": "risk_score", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.mapped_params.properties.risk_score.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"float\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.mapped_params.properties.severity", + "type": "Object", + "tags": [], + "label": "severity", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.mapped_params.properties.severity.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ] + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.scheduledTaskId", + "type": "Object", + "tags": [], + "label": "scheduledTaskId", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.scheduledTaskId.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.createdBy", + "type": "Object", + "tags": [], + "label": "createdBy", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.createdBy.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.updatedBy", + "type": "Object", + "tags": [], + "label": "updatedBy", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.updatedBy.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.createdAt", + "type": "Object", + "tags": [], + "label": "createdAt", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.createdAt.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"date\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.updatedAt", + "type": "Object", + "tags": [], + "label": "updatedAt", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.updatedAt.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"date\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.throttle", + "type": "Object", + "tags": [], + "label": "throttle", + "description": [ + "// NEED TO CHECK WITH KIBANA SECURITY\n// apiKey: {\n// type: 'binary',\n// },\n// NO NEED TO BE INDEXED\n// apiKeyOwner: {\n// type: 'keyword',\n// }," + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.throttle.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.notifyWhen", + "type": "Object", + "tags": [], + "label": "notifyWhen", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.notifyWhen.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.muteAll", + "type": "Object", + "tags": [], + "label": "muteAll", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.muteAll.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"boolean\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.mutedInstanceIds", + "type": "Object", + "tags": [], + "label": "mutedInstanceIds", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.mutedInstanceIds.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring", + "type": "Object", + "tags": [], + "label": "monitoring", + "description": [ + "// NO NEED TO BE INDEXED\n// meta: {\n// properties: {\n// versionApiKeyLastmodified: {\n// type: 'keyword',\n// },\n// },\n// }," + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run", + "type": "Object", + "tags": [], + "label": "run", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics", + "type": "Object", + "tags": [], + "label": "calculated_metrics", + "description": [ + "// history: {\n// properties: {\n// duration: {\n// type: 'long',\n// },\n// success: {\n// type: 'boolean',\n// },\n// timestamp: {\n// type: 'date',\n// },\n// outcome: {\n// type: 'keyword',\n// },\n// },\n// }," + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.p50", + "type": "Object", + "tags": [], + "label": "p50", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.p50.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"long\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.p95", + "type": "Object", + "tags": [], + "label": "p95", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.p95.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"long\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.p99", + "type": "Object", + "tags": [], + "label": "p99", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.p99.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"long\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.success_ratio", + "type": "Object", + "tags": [], + "label": "success_ratio", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.calculated_metrics.properties.success_ratio.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"float\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ] + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run", + "type": "Object", + "tags": [], + "label": "last_run", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.timestamp", + "type": "Object", + "tags": [], + "label": "timestamp", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.timestamp.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"date\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics", + "type": "Object", + "tags": [], + "label": "metrics", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.duration", + "type": "Object", + "tags": [], + "label": "duration", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.duration.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"long\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_search_duration_ms", + "type": "Object", + "tags": [], + "label": "total_search_duration_ms", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_search_duration_ms.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"long\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_indexing_duration_ms", + "type": "Object", + "tags": [], + "label": "total_indexing_duration_ms", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_indexing_duration_ms.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"long\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_alerts_detected", + "type": "Object", + "tags": [], + "label": "total_alerts_detected", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_alerts_detected.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"float\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_alerts_created", + "type": "Object", + "tags": [], + "label": "total_alerts_created", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.total_alerts_created.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"float\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.gap_duration_s", + "type": "Object", + "tags": [], + "label": "gap_duration_s", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.monitoring.properties.run.properties.last_run.properties.metrics.properties.gap_duration_s.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"float\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.revision", + "type": "Object", + "tags": [], + "label": "revision", + "description": [ + "// There is need to query for a rule by a specific revision" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.revision.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"long\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.snoozeSchedule", + "type": "Object", + "tags": [], + "label": "snoozeSchedule", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.snoozeSchedule.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"nested\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.snoozeSchedule.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.snoozeSchedule.properties.id", + "type": "Object", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.snoozeSchedule.properties.id.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.snoozeSchedule.properties.duration", + "type": "Object", + "tags": [], + "label": "duration", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.snoozeSchedule.properties.duration.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"long\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.snoozeSchedule.properties.skipRecurrences", + "type": "Object", + "tags": [], + "label": "skipRecurrences", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.snoozeSchedule.properties.skipRecurrences.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"date\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.snoozeSchedule.properties.skipRecurrences.format", + "type": "string", + "tags": [], + "label": "format", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ] + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus", + "type": "Object", + "tags": [], + "label": "executionStatus", + "description": [ + "// NO NEED TO BE INDEXED\n// nextRun: {\n// type: 'date',\n// },\n// Deprecated, if you need to add new property please do it in `last_run`" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.numberOfTriggeredActions", + "type": "Object", + "tags": [], + "label": "numberOfTriggeredActions", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.numberOfTriggeredActions.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"long\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.status", + "type": "Object", + "tags": [], + "label": "status", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.status.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.lastExecutionDate", + "type": "Object", + "tags": [], + "label": "lastExecutionDate", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.lastExecutionDate.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"date\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.lastDuration", + "type": "Object", + "tags": [], + "label": "lastDuration", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.lastDuration.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"long\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.error.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.error.properties.reason", + "type": "Object", + "tags": [], + "label": "reason", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.error.properties.reason.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.error.properties.message", + "type": "Object", + "tags": [], + "label": "message", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.error.properties.message.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ] + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.warning", + "type": "Object", + "tags": [], + "label": "warning", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.warning.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.warning.properties.reason", + "type": "Object", + "tags": [], + "label": "reason", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.warning.properties.reason.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.warning.properties.message", + "type": "Object", + "tags": [], + "label": "message", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.executionStatus.properties.warning.properties.message.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun", + "type": "Object", + "tags": [], + "label": "lastRun", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.outcome", + "type": "Object", + "tags": [], + "label": "outcome", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.outcome.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"keyword\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.outcomeOrder", + "type": "Object", + "tags": [], + "label": "outcomeOrder", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.outcomeOrder.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"float\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.alertsCount", + "type": "Object", + "tags": [], + "label": "alertsCount", + "description": [ + "// NO NEED TO BE INDEXED\n// warning: {\n// type: 'text',\n// },\n// outcomeMsg: {\n// type: 'text',\n// }," + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.active", + "type": "Object", + "tags": [], + "label": "active", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.active.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"float\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.new", + "type": "Object", + "tags": [], + "label": "new", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.new.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"float\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.recovered", + "type": "Object", + "tags": [], + "label": "recovered", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.recovered.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"float\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.ignored", + "type": "Object", + "tags": [], + "label": "ignored", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.lastRun.properties.alertsCount.properties.ignored.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"float\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.running", + "type": "Object", + "tags": [], + "label": "running", + "description": [], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.alertMappings.properties.running.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"boolean\"" + ], + "path": "x-pack/plugins/alerting/common/saved_objects/rules/mappings.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "alerting", "id": "def-common.API_PRIVILEGES", diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index b0c136fe1f236..a4dcd2b8fba08 100644 --- a/api_docs/alerting.mdx +++ b/api_docs/alerting.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting title: "alerting" image: https://source.unsplash.com/400x175/?github description: API docs for the alerting plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] --- import alertingObj from './alerting.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 635 | 1 | 611 | 47 | +| 795 | 1 | 765 | 48 | ## Client diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json index add26e70b0bfc..da0788b5bd372 100644 --- a/api_docs/apm.devdocs.json +++ b/api_docs/apm.devdocs.json @@ -81,7 +81,7 @@ "label": "featureFlags", "description": [], "signature": [ - "{ agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }" + "{ agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }" ], "path": "x-pack/plugins/apm/public/index.ts", "deprecated": false, @@ -124,7 +124,7 @@ "section": "def-common.LocatorPublic", "text": "LocatorPublic" }, - "<{ serviceName: undefined; } | ({ serviceName: string; } & { serviceOverviewTab?: \"errors\" | \"traces\" | \"metrics\" | \"logs\" | undefined; } & { query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", + "<{ serviceName: undefined; } | ({ serviceName: string; } & { serviceOverviewTab?: \"errors\" | \"metrics\" | \"traces\" | \"logs\" | undefined; } & { query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ", "Branded", "; enabled: boolean; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; serviceMapTerminateAfter: number; serviceMapMaxTraces: number; ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverlessOnboarding: boolean; serverless: Readonly<{} & { enabled: true; }>; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }>; }>>; getApmIndices: () => Promise>; createApmEventClient: ({ request, context, debug, }: { debug?: boolean | undefined; request: ", + "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverlessOnboarding: boolean; serverless: Readonly<{} & { enabled: true; }>; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }>; }>>; getApmIndices: () => Promise>; createApmEventClient: ({ request, context, debug, }: { debug?: boolean | undefined; request: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -495,7 +495,7 @@ "label": "params", "description": [], "signature": [ - "{ query: { _inspect: boolean; start?: number | undefined; end?: number | undefined; }; }" + "{ query: { _inspect: boolean; }; }" ], "path": "x-pack/plugins/apm/server/routes/typings.ts", "deprecated": false, @@ -511,7 +511,7 @@ "signature": [ "{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; readonly enabled: boolean; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly serviceMapTerminateAfter: number; readonly serviceMapMaxTraces: number; readonly ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; readonly latestAgentVersionsUrl: string; readonly serverlessOnboarding: boolean; readonly serverless: Readonly<{} & { enabled: true; }>; readonly managedServiceUrl: string; readonly featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }>; }" + "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; readonly latestAgentVersionsUrl: string; readonly serverlessOnboarding: boolean; readonly serverless: Readonly<{} & { enabled: true; }>; readonly managedServiceUrl: string; readonly featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }>; }" ], "path": "x-pack/plugins/apm/server/routes/typings.ts", "deprecated": false, @@ -525,7 +525,7 @@ "label": "featureFlags", "description": [], "signature": [ - "{ agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }" + "{ agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }" ], "path": "x-pack/plugins/apm/server/routes/typings.ts", "deprecated": false, @@ -782,7 +782,13 @@ "text": "HomeServerPluginStart" }, ">; } | undefined; ml?: { setup: ", - "SharedServices", + { + "pluginId": "ml", + "scope": "server", + "docId": "kibMlPluginApi", + "section": "def-server.MlPluginSetup", + "text": "MlPluginSetup" + }, "; start: () => Promise; } | undefined; security?: { setup: ", { "pluginId": "security", @@ -959,7 +965,7 @@ "signature": [ "{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; readonly enabled: boolean; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly serviceMapTerminateAfter: number; readonly serviceMapMaxTraces: number; readonly ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; readonly latestAgentVersionsUrl: string; readonly serverlessOnboarding: boolean; readonly serverless: Readonly<{} & { enabled: true; }>; readonly managedServiceUrl: string; readonly featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }>; }" + "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; readonly latestAgentVersionsUrl: string; readonly serverlessOnboarding: boolean; readonly serverless: Readonly<{} & { enabled: true; }>; readonly managedServiceUrl: string; readonly featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }>; }" ], "path": "x-pack/plugins/apm/server/index.ts", "deprecated": false, @@ -5226,6 +5232,14 @@ "; spanId: ", "StringC", "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", "UnionC", "<[", "PartialC", @@ -5233,7 +5247,7 @@ "StringC", "; }>, ", "UndefinedC", - "]>; }> | undefined; handler: ({}: ", + "]>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5241,7 +5255,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - " & { params: { path: { traceId: string; spanId: string; }; query: { parentTransactionId?: string | undefined; } | undefined; }; }) => Promise<{ span?: ", + " & { params: { path: { traceId: string; spanId: string; }; query: { start: number; end: number; } & { parentTransactionId?: string | undefined; }; }; }) => Promise<{ span?: ", "Span", " | undefined; parentTransaction?: ", "Transaction", @@ -5255,7 +5269,13 @@ "StringC", "; transactionId: ", "StringC", - "; }>; }> | undefined; handler: ({}: ", + "; }>; query: ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5263,7 +5283,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - " & { params: { path: { traceId: string; transactionId: string; }; }; }) => Promise<", + " & { params: { path: { traceId: string; transactionId: string; }; query: { start: number; end: number; }; }; }) => Promise<", "Transaction", ">; } & ", "APMRouteCreateOptions", @@ -5421,7 +5441,13 @@ "TypeC", "<{ transactionId: ", "StringC", - "; }>; }> | undefined; handler: ({}: ", + "; }>; query: ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5429,7 +5455,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - " & { params: { path: { transactionId: string; }; }; }) => Promise<{ transaction: ", + " & { params: { path: { transactionId: string; }; query: { start: number; end: number; }; }; }) => Promise<{ transaction: ", "Transaction", "; }>; } & ", "APMRouteCreateOptions", @@ -5439,7 +5465,13 @@ "TypeC", "<{ traceId: ", "StringC", - "; }>; }> | undefined; handler: ({}: ", + "; }>; query: ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5447,7 +5479,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - " & { params: { path: { traceId: string; }; }; }) => Promise<{ transaction: ", + " & { params: { path: { traceId: string; }; query: { start: number; end: number; }; }; }) => Promise<{ transaction: ", "Transaction", "; }>; } & ", "APMRouteCreateOptions", @@ -8050,7 +8082,7 @@ "Observable", "; enabled: boolean; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; serviceMapTerminateAfter: number; serviceMapMaxTraces: number; ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverlessOnboarding: boolean; serverless: Readonly<{} & { enabled: true; }>; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }>; }>>" + "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverlessOnboarding: boolean; serverless: Readonly<{} & { enabled: true; }>; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }>; }>>" ], "path": "x-pack/plugins/apm/server/types.ts", "deprecated": false, diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index 9ff7b42cdc6b6..fdd912e335084 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm title: "apm" image: https://source.unsplash.com/400x175/?github description: API docs for the apm plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] --- import apmObj from './apm.devdocs.json'; diff --git a/api_docs/asset_manager.mdx b/api_docs/asset_manager.mdx index 6ce00c0fb8669..f0fdcc0c4d8b7 100644 --- a/api_docs/asset_manager.mdx +++ b/api_docs/asset_manager.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/assetManager title: "assetManager" image: https://source.unsplash.com/400x175/?github description: API docs for the assetManager plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager'] --- import assetManagerObj from './asset_manager.devdocs.json'; diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index fb9c9b73b8ae1..2b8d8dd38930d 100644 --- a/api_docs/banners.mdx +++ b/api_docs/banners.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners title: "banners" image: https://source.unsplash.com/400x175/?github description: API docs for the banners plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] --- import bannersObj from './banners.devdocs.json'; diff --git a/api_docs/bfetch.devdocs.json b/api_docs/bfetch.devdocs.json index a8de64ac0bb06..850bd68c79ed7 100644 --- a/api_docs/bfetch.devdocs.json +++ b/api_docs/bfetch.devdocs.json @@ -480,15 +480,7 @@ "section": "def-common.RequestHandlerContext", "text": "RequestHandlerContext" }, - "> | undefined, options?: ", - { - "pluginId": "@kbn/core-http-server", - "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.RouteConfigOptions", - "text": "RouteConfigOptions" - }, - "<\"get\" | \"delete\" | \"post\" | \"put\"> | undefined) => void" + "> | undefined) => void" ], "path": "src/plugins/bfetch/server/plugin.ts", "deprecated": false, @@ -592,28 +584,6 @@ "deprecated": false, "trackAdoption": false, "isRequired": false - }, - { - "parentPluginId": "bfetch", - "id": "def-server.BfetchServerSetup.addStreamingResponseRoute.$5", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "@kbn/core-http-server", - "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.RouteConfigOptions", - "text": "RouteConfigOptions" - }, - "<\"get\" | \"delete\" | \"post\" | \"put\"> | undefined" - ], - "path": "src/plugins/bfetch/server/plugin.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false } ], "returnComment": [] @@ -1695,6 +1665,21 @@ ], "enums": [], "misc": [ + { + "parentPluginId": "bfetch", + "id": "def-common.BFETCH_ROUTE_VERSION_LATEST", + "type": "string", + "tags": [], + "label": "BFETCH_ROUTE_VERSION_LATEST", + "description": [], + "signature": [ + "\"1\"" + ], + "path": "src/plugins/bfetch/common/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "bfetch", "id": "def-common.DISABLE_BFETCH", diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index 4844ba6bce50a..3c13787afe113 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch title: "bfetch" image: https://source.unsplash.com/400x175/?github description: API docs for the bfetch plugin -date: 2023-06-30 +date: 2023-07-18 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 c6f7616af2ace..f20752ef3ecb5 100644 --- a/api_docs/canvas.mdx +++ b/api_docs/canvas.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/canvas title: "canvas" image: https://source.unsplash.com/400x175/?github description: API docs for the canvas plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] --- import canvasObj from './canvas.devdocs.json'; diff --git a/api_docs/cases.devdocs.json b/api_docs/cases.devdocs.json index c43d16f9fc556..e7eb980f3c683 100644 --- a/api_docs/cases.devdocs.json +++ b/api_docs/cases.devdocs.json @@ -486,7 +486,9 @@ "section": "def-common.CaseSeverity", "text": "CaseSeverity" }, - " | undefined; assignees?: string | string[] | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; from?: string | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: \"description\" | \"title\" | \"closed_by.username\" | \"closed_by.full_name\" | \"closed_by.email\" | \"closed_by.profile_uid\" | \"created_by.username\" | \"created_by.full_name\" | \"created_by.email\" | \"created_by.profile_uid\" | \"connector.name\" | \"connector.type\" | \"external_service.pushed_by.username\" | \"external_service.pushed_by.full_name\" | \"external_service.pushed_by.email\" | \"external_service.pushed_by.profile_uid\" | \"external_service.connector_name\" | \"external_service.external_id\" | \"external_service.external_title\" | \"external_service.external_url\" | \"title.keyword\" | \"updated_by.username\" | \"updated_by.full_name\" | \"updated_by.email\" | \"updated_by.profile_uid\" | (\"description\" | \"title\" | \"closed_by.username\" | \"closed_by.full_name\" | \"closed_by.email\" | \"closed_by.profile_uid\" | \"created_by.username\" | \"created_by.full_name\" | \"created_by.email\" | \"created_by.profile_uid\" | \"connector.name\" | \"connector.type\" | \"external_service.pushed_by.username\" | \"external_service.pushed_by.full_name\" | \"external_service.pushed_by.email\" | \"external_service.pushed_by.profile_uid\" | \"external_service.connector_name\" | \"external_service.external_id\" | \"external_service.external_title\" | \"external_service.external_url\" | \"title.keyword\" | \"updated_by.username\" | \"updated_by.full_name\" | \"updated_by.email\" | \"updated_by.profile_uid\")[] | undefined; rootSearchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; to?: string | undefined; owner?: string | string[] | undefined; category?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<", + " | undefined; assignees?: string | string[] | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; from?: string | undefined; search?: string | undefined; searchFields?: \"description\" | \"title\" | \"closed_by.username\" | \"closed_by.full_name\" | \"closed_by.email\" | \"closed_by.profile_uid\" | \"created_by.username\" | \"created_by.full_name\" | \"created_by.email\" | \"created_by.profile_uid\" | \"connector.name\" | \"connector.type\" | \"external_service.pushed_by.username\" | \"external_service.pushed_by.full_name\" | \"external_service.pushed_by.email\" | \"external_service.pushed_by.profile_uid\" | \"external_service.connector_name\" | \"external_service.external_id\" | \"external_service.external_title\" | \"external_service.external_url\" | \"title.keyword\" | \"updated_by.username\" | \"updated_by.full_name\" | \"updated_by.email\" | \"updated_by.profile_uid\" | (\"description\" | \"title\" | \"closed_by.username\" | \"closed_by.full_name\" | \"closed_by.email\" | \"closed_by.profile_uid\" | \"created_by.username\" | \"created_by.full_name\" | \"created_by.email\" | \"created_by.profile_uid\" | \"connector.name\" | \"connector.type\" | \"external_service.pushed_by.username\" | \"external_service.pushed_by.full_name\" | \"external_service.pushed_by.email\" | \"external_service.pushed_by.profile_uid\" | \"external_service.connector_name\" | \"external_service.external_id\" | \"external_service.external_title\" | \"external_service.external_url\" | \"title.keyword\" | \"updated_by.username\" | \"updated_by.full_name\" | \"updated_by.email\" | \"updated_by.profile_uid\")[] | undefined; rootSearchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; to?: string | undefined; owner?: string | string[] | undefined; category?: string | string[] | undefined; } & Partial<", + "Pagination", + ">, signal?: AbortSignal | undefined) => Promise<", { "pluginId": "cases", "scope": "common", diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index e3c7e3cea6522..998df05731181 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases title: "cases" image: https://source.unsplash.com/400x175/?github description: API docs for the cases plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] --- import casesObj from './cases.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 80 | 0 | 65 | 26 | +| 80 | 0 | 65 | 27 | ## Client diff --git a/api_docs/charts.devdocs.json b/api_docs/charts.devdocs.json index c2c62ac98565d..abf1df8307859 100644 --- a/api_docs/charts.devdocs.json +++ b/api_docs/charts.devdocs.json @@ -1626,28 +1626,6 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false - }, - { - "parentPluginId": "charts", - "id": "def-public.truncatedColorSchemas", - "type": "Array", - "tags": [], - "label": "truncatedColorSchemas", - "description": [], - "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.ColorSchema", - "text": "ColorSchema" - }, - "[]" - ], - "path": "src/plugins/charts/common/static/color_maps/truncated_color_maps.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false } ], "objects": [ @@ -1834,19 +1812,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "charts", - "id": "def-public.truncatedColorMaps", - "type": "Object", - "tags": [], - "label": "truncatedColorMaps", - "description": [], - "path": "src/plugins/charts/common/static/color_maps/truncated_color_maps.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "initialIsOpen": false - }, { "parentPluginId": "charts", "id": "def-public.vislibColorMaps", @@ -3378,6 +3343,21 @@ } ], "misc": [ + { + "parentPluginId": "charts", + "id": "def-common.AllowedChartOverrides", + "type": "Type", + "tags": [], + "label": "AllowedChartOverrides", + "description": [], + "signature": [ + "{ chart?: { description?: string | undefined; title?: string | undefined; } | undefined; }" + ], + "path": "src/plugins/charts/common/static/overrides/settings.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "charts", "id": "def-common.AllowedSettingsOverrides", @@ -3609,28 +3589,6 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false - }, - { - "parentPluginId": "charts", - "id": "def-common.truncatedColorSchemas", - "type": "Array", - "tags": [], - "label": "truncatedColorSchemas", - "description": [], - "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.ColorSchema", - "text": "ColorSchema" - }, - "[]" - ], - "path": "src/plugins/charts/common/static/color_maps/truncated_color_maps.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false } ], "objects": [ @@ -3817,19 +3775,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "charts", - "id": "def-common.truncatedColorMaps", - "type": "Object", - "tags": [], - "label": "truncatedColorMaps", - "description": [], - "path": "src/plugins/charts/common/static/color_maps/truncated_color_maps.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "initialIsOpen": false - }, { "parentPluginId": "charts", "id": "def-common.vislibColorMaps", diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index 3425efc509454..b224d9d5250d5 100644 --- a/api_docs/charts.mdx +++ b/api_docs/charts.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts title: "charts" image: https://source.unsplash.com/400x175/?github description: API docs for the charts plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] --- import chartsObj from './charts.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 | |-------------------|-----------|------------------------|-----------------| -| 271 | 16 | 256 | 10 | +| 268 | 16 | 253 | 10 | ## Client diff --git a/api_docs/cloud.devdocs.json b/api_docs/cloud.devdocs.json index 3d9e7dd03898f..5309d0888559a 100644 --- a/api_docs/cloud.devdocs.json +++ b/api_docs/cloud.devdocs.json @@ -85,6 +85,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudConfigType.billing_url", + "type": "string", + "tags": [], + "label": "billing_url", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/cloud/public/plugin.tsx", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "cloud", "id": "def-public.CloudConfigType.organization_url", @@ -126,6 +140,20 @@ "path": "x-pack/plugins/cloud/public/plugin.tsx", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudConfigType.serverless", + "type": "Object", + "tags": [], + "label": "serverless", + "description": [], + "signature": [ + "{ project_id: string; } | undefined" + ], + "path": "x-pack/plugins/cloud/public/plugin.tsx", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -249,6 +277,22 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudStart.billingUrl", + "type": "string", + "tags": [], + "label": "billingUrl", + "description": [ + "\nThe full URL to the billing page on Elastic Cloud. Undefined if not running on Cloud." + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/cloud/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "cloud", "id": "def-public.CloudStart.organizationUrl", @@ -296,6 +340,35 @@ "path": "x-pack/plugins/cloud/public/types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudStart.isServerlessEnabled", + "type": "boolean", + "tags": [], + "label": "isServerlessEnabled", + "description": [ + "\n`true` when running on Serverless Elastic Cloud\nNote that `isCloudEnabled` will always be true when `isServerlessEnabled` is." + ], + "path": "x-pack/plugins/cloud/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudStart.serverless", + "type": "Object", + "tags": [], + "label": "serverless", + "description": [ + "\nServerless configuration" + ], + "signature": [ + "{ projectId?: string | undefined; }" + ], + "path": "x-pack/plugins/cloud/public/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -587,6 +660,35 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudSetup.isServerlessEnabled", + "type": "boolean", + "tags": [], + "label": "isServerlessEnabled", + "description": [ + "\n`true` when running on Serverless Elastic Cloud\nNote that `isCloudEnabled` will always be true when `isServerlessEnabled` is." + ], + "path": "x-pack/plugins/cloud/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudSetup.serverless", + "type": "Object", + "tags": [], + "label": "serverless", + "description": [ + "\nServerless configuration" + ], + "signature": [ + "{ projectId?: string | undefined; }" + ], + "path": "x-pack/plugins/cloud/public/types.ts", + "deprecated": false, + "trackAdoption": false } ], "lifecycle": "setup", @@ -785,6 +887,35 @@ "path": "x-pack/plugins/cloud/server/plugin.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-server.CloudSetup.isServerlessEnabled", + "type": "boolean", + "tags": [], + "label": "isServerlessEnabled", + "description": [ + "\n`true` when running on Serverless Elastic Cloud\nNote that `isCloudEnabled` will always be true when `isServerlessEnabled` is." + ], + "path": "x-pack/plugins/cloud/server/plugin.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-server.CloudSetup.serverless", + "type": "Object", + "tags": [], + "label": "serverless", + "description": [ + "\nServerless configuration" + ], + "signature": [ + "{ projectId?: string | undefined; }" + ], + "path": "x-pack/plugins/cloud/server/plugin.ts", + "deprecated": false, + "trackAdoption": false } ], "lifecycle": "setup", diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index eb31c684c9d3a..8c7af5f7ddfaa 100644 --- a/api_docs/cloud.mdx +++ b/api_docs/cloud.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud title: "cloud" image: https://source.unsplash.com/400x175/?github description: API docs for the cloud plugin -date: 2023-06-30 +date: 2023-07-18 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 | |-------------------|-----------|------------------------|-----------------| -| 52 | 0 | 11 | 0 | +| 61 | 0 | 13 | 0 | ## Client diff --git a/api_docs/cloud_chat.mdx b/api_docs/cloud_chat.mdx index da6d338953ea6..63527f1e10fc6 100644 --- a/api_docs/cloud_chat.mdx +++ b/api_docs/cloud_chat.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChat title: "cloudChat" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudChat plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat'] --- import cloudChatObj from './cloud_chat.devdocs.json'; diff --git a/api_docs/cloud_chat_provider.mdx b/api_docs/cloud_chat_provider.mdx index e89d26d4633d9..1e4be670d2916 100644 --- a/api_docs/cloud_chat_provider.mdx +++ b/api_docs/cloud_chat_provider.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChatProvider title: "cloudChatProvider" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudChatProvider plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChatProvider'] --- import cloudChatProviderObj from './cloud_chat_provider.devdocs.json'; diff --git a/api_docs/cloud_data_migration.mdx b/api_docs/cloud_data_migration.mdx index 85c3f9decab95..af60cd44b1c63 100644 --- a/api_docs/cloud_data_migration.mdx +++ b/api_docs/cloud_data_migration.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration title: "cloudDataMigration" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudDataMigration plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration'] --- import cloudDataMigrationObj from './cloud_data_migration.devdocs.json'; diff --git a/api_docs/cloud_defend.devdocs.json b/api_docs/cloud_defend.devdocs.json index a2aa026ef923c..77489db1f3f8c 100644 --- a/api_docs/cloud_defend.devdocs.json +++ b/api_docs/cloud_defend.devdocs.json @@ -335,6 +335,360 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Response", + "type": "Interface", + "tags": [], + "label": "Response", + "description": [], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "cloudDefend", + "id": "def-common.Response.match", + "type": "Array", + "tags": [], + "label": "match", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Response.exclude", + "type": "Array", + "tags": [], + "label": "exclude", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Response.actions", + "type": "Array", + "tags": [], + "label": "actions", + "description": [], + "signature": [ + { + "pluginId": "cloudDefend", + "scope": "common", + "docId": "kibCloudDefendPluginApi", + "section": "def-common.ResponseAction", + "text": "ResponseAction" + }, + "[]" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Response.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"file\" | \"process\"" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Response.hasErrors", + "type": "CompoundType", + "tags": [], + "label": "hasErrors", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector", + "type": "Interface", + "tags": [], + "label": "Selector", + "description": [], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.operation", + "type": "Array", + "tags": [], + "label": "operation", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.containerImageFullName", + "type": "Array", + "tags": [], + "label": "containerImageFullName", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.containerImageName", + "type": "Array", + "tags": [], + "label": "containerImageName", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.containerImageTag", + "type": "Array", + "tags": [], + "label": "containerImageTag", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.kubernetesClusterId", + "type": "Array", + "tags": [], + "label": "kubernetesClusterId", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.kubernetesClusterName", + "type": "Array", + "tags": [], + "label": "kubernetesClusterName", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.kubernetesNamespace", + "type": "Array", + "tags": [], + "label": "kubernetesNamespace", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.kubernetesPodLabel", + "type": "Array", + "tags": [], + "label": "kubernetesPodLabel", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.kubernetesPodName", + "type": "Array", + "tags": [], + "label": "kubernetesPodName", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.targetFilePath", + "type": "Array", + "tags": [], + "label": "targetFilePath", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.ignoreVolumeFiles", + "type": "CompoundType", + "tags": [], + "label": "ignoreVolumeFiles", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.ignoreVolumeMounts", + "type": "CompoundType", + "tags": [], + "label": "ignoreVolumeMounts", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.processExecutable", + "type": "Array", + "tags": [], + "label": "processExecutable", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.processName", + "type": "Array", + "tags": [], + "label": "processName", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.sessionLeaderInteractive", + "type": "CompoundType", + "tags": [], + "label": "sessionLeaderInteractive", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"file\" | \"process\"" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.hasErrors", + "type": "CompoundType", + "tags": [], + "label": "hasErrors", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false } ], "enums": [], @@ -421,6 +775,53 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.ResponseAction", + "type": "Type", + "tags": [], + "label": "ResponseAction", + "description": [], + "signature": [ + "\"log\" | \"alert\" | \"block\"" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.SelectorCondition", + "type": "Type", + "tags": [], + "label": "SelectorCondition", + "description": [], + "signature": [ + "\"containerImageFullName\" | \"containerImageName\" | \"containerImageTag\" | \"kubernetesClusterId\" | \"kubernetesClusterName\" | \"kubernetesNamespace\" | \"kubernetesPodLabel\" | \"kubernetesPodName\" | \"targetFilePath\" | \"ignoreVolumeFiles\" | \"ignoreVolumeMounts\" | \"operation\" | \"processExecutable\" | \"processName\" | \"sessionLeaderInteractive\"" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.SelectorType", + "type": "Type", + "tags": [], + "label": "SelectorType", + "description": [ + "\ncloud_defend/control types" + ], + "signature": [ + "\"file\" | \"process\"" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false } ], "objects": [ diff --git a/api_docs/cloud_defend.mdx b/api_docs/cloud_defend.mdx index 79333feecc9bb..f49cbd9c5a580 100644 --- a/api_docs/cloud_defend.mdx +++ b/api_docs/cloud_defend.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend title: "cloudDefend" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudDefend plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend'] --- import cloudDefendObj from './cloud_defend.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/ | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 24 | 0 | 16 | 2 | +| 52 | 0 | 43 | 2 | ## Client diff --git a/api_docs/cloud_experiments.mdx b/api_docs/cloud_experiments.mdx index fe046ab8337ad..761b0051c62c0 100644 --- a/api_docs/cloud_experiments.mdx +++ b/api_docs/cloud_experiments.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudExperiments title: "cloudExperiments" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudExperiments plugin -date: 2023-06-30 +date: 2023-07-18 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 a62a0e8209dff..caea84b083d56 100644 --- a/api_docs/cloud_security_posture.mdx +++ b/api_docs/cloud_security_posture.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture title: "cloudSecurityPosture" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudSecurityPosture plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] --- import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json'; diff --git a/api_docs/console.devdocs.json b/api_docs/console.devdocs.json index 7deaeedae3f87..35dfc2c7cf34a 100644 --- a/api_docs/console.devdocs.json +++ b/api_docs/console.devdocs.json @@ -265,22 +265,6 @@ "enums": [], "misc": [], "objects": [], - "setup": { - "parentPluginId": "console", - "id": "def-server.ConsoleSetup", - "type": "Type", - "tags": [], - "label": "ConsoleSetup", - "description": [], - "signature": [ - "{ addExtensionSpecFilePath: (path: string) => void; }" - ], - "path": "src/plugins/console/server/types.ts", - "deprecated": false, - "trackAdoption": false, - "lifecycle": "setup", - "initialIsOpen": true - }, "start": { "parentPluginId": "console", "id": "def-server.ConsoleStart", diff --git a/api_docs/console.mdx b/api_docs/console.mdx index e04d9ceb461b5..99f1d94d1f45a 100644 --- a/api_docs/console.mdx +++ b/api_docs/console.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/console title: "console" image: https://source.unsplash.com/400x175/?github description: API docs for the console plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] --- import consoleObj from './console.devdocs.json'; @@ -33,9 +33,6 @@ Contact [@elastic/platform-deployment-management](https://github.com/orgs/elasti ## Server -### Setup - - ### Start diff --git a/api_docs/content_management.mdx b/api_docs/content_management.mdx index cb6873c7ab74c..35253cc69fbea 100644 --- a/api_docs/content_management.mdx +++ b/api_docs/content_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement title: "contentManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the contentManagement plugin -date: 2023-06-30 +date: 2023-07-18 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 af0579a61f942..1793513b2e37b 100644 --- a/api_docs/controls.mdx +++ b/api_docs/controls.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/controls title: "controls" image: https://source.unsplash.com/400x175/?github description: API docs for the controls plugin -date: 2023-06-30 +date: 2023-07-18 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 0af4c903bec62..9cc5f9e7ed895 100644 --- a/api_docs/custom_integrations.mdx +++ b/api_docs/custom_integrations.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations title: "customIntegrations" image: https://source.unsplash.com/400x175/?github description: API docs for the customIntegrations plugin -date: 2023-06-30 +date: 2023-07-18 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 954acf956d942..41d2c52b9dc61 100644 --- a/api_docs/dashboard.devdocs.json +++ b/api_docs/dashboard.devdocs.json @@ -344,7 +344,7 @@ "signature": [ "((result: ", "LoadDashboardReturn", - ") => boolean) | undefined" + ") => \"valid\" | \"invalid\" | \"redirected\") | undefined" ], "path": "src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container_factory.tsx", "deprecated": false, @@ -1838,14 +1838,6 @@ "section": "def-common.Query", "text": "Query" }, - " | undefined; refreshInterval?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.RefreshInterval", - "text": "RefreshInterval" - }, " | undefined; filters?: ", { "pluginId": "@kbn/es-query", @@ -1854,7 +1846,15 @@ "section": "def-common.Filter", "text": "Filter" }, - "[] | undefined; executionContext?: ", + "[] | undefined; refreshInterval?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + " | undefined; executionContext?: ", { "pluginId": "@kbn/core-execution-context-common", "scope": "common", diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index e360eded64ab8..5c9a505e9c793 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard title: "dashboard" image: https://source.unsplash.com/400x175/?github description: API docs for the dashboard plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] --- import dashboardObj from './dashboard.devdocs.json'; diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index c5ce53d1f8b66..9086b04d9d596 100644 --- a/api_docs/dashboard_enhanced.mdx +++ b/api_docs/dashboard_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced title: "dashboardEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the dashboardEnhanced plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] --- import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json'; diff --git a/api_docs/data.devdocs.json b/api_docs/data.devdocs.json index 6e1ba8e0ec9f5..fa7e3933f6883 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -8815,6 +8815,26 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/logs.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/ecommerce.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/flights.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts" + }, { "plugin": "osquery", "path": "x-pack/plugins/osquery/server/routes/pack/read_pack_route.ts" @@ -8903,22 +8923,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/user_risk_score_dashboards.ts" }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/logs.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/ecommerce.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/flights.ts" - }, - { - "plugin": "lists", - "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts" - }, { "plugin": "alerting", "path": "x-pack/plugins/alerting/server/rules_client/lib/siem_legacy_actions/retrieve_migrated_legacy_actions.mock.ts" @@ -10589,7 +10593,9 @@ "SearchResponse", ">>; setField: >>; history: ", + "SearchRequest", + "[]; setField: void; removeField: void; removeField: Promise<", + ", overwrite?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -16864,10 +16876,8 @@ "id": "def-server.DataViewsService.createAndSave.$2", "type": "boolean", "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists." - ], + "label": "overwrite", + "description": [], "signature": [ "boolean" ], @@ -16931,7 +16941,7 @@ "section": "def-common.DataView", "text": "DataView" }, - ", override?: boolean, displayErrors?: boolean) => Promise<", + ", overwrite?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -16973,10 +16983,8 @@ "id": "def-server.DataViewsService.createSavedObject.$2", "type": "boolean", "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists" - ], + "label": "overwrite", + "description": [], "signature": [ "boolean" ], @@ -20929,7 +20937,7 @@ }, { "plugin": "observability", - "path": "x-pack/plugins/observability/public/components/threshold/components/expression.tsx" + "path": "x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx" }, { "plugin": "observability", @@ -20951,10 +20959,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/detections/containers/detection_engine/exceptions/get_es_query_filter.ts" }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/detections/components/alerts_table/alerts_sub_grouping.tsx" - }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/utils.ts" @@ -21031,6 +21035,18 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/detection_engine/rule_exceptions/components/flyout_components/alerts_actions/utils.test.ts" }, + { + "plugin": "savedSearch", + "path": "src/plugins/saved_search/common/expressions/kibana_context.test.ts" + }, + { + "plugin": "savedSearch", + "path": "src/plugins/saved_search/common/expressions/kibana_context.test.ts" + }, + { + "plugin": "savedSearch", + "path": "src/plugins/saved_search/common/expressions/kibana_context.test.ts" + }, { "plugin": "@kbn/es-query", "path": "packages/kbn-es-query/src/es_query/build_es_query.test.ts" @@ -21240,8 +21256,8 @@ "path": "x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts" }, { - "plugin": "infra", - "path": "x-pack/plugins/infra/common/log_views/resolved_log_view.ts" + "plugin": "logsShared", + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts" }, { "plugin": "visTypeTimeseries", @@ -21315,6 +21331,10 @@ "plugin": "stackAlerts", "path": "x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx" + }, { "plugin": "dataVisualizer", "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts" @@ -21419,10 +21439,6 @@ "plugin": "infra", "path": "x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts" }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx" - }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx" @@ -21467,6 +21483,18 @@ "plugin": "enterpriseSearch", "path": "x-pack/plugins/enterprise_search/public/applications/analytics/components/analytics_collection_view/analytics_collection_explore_table_formulas.ts" }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/containers/sourcerer/create_sourcerer_data_view.ts" @@ -21487,18 +21515,6 @@ "plugin": "timelines", "path": "x-pack/plugins/timelines/server/search_strategy/index_fields/index.ts" }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" - }, { "plugin": "transform", "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_term_form.tsx" @@ -25352,7 +25368,7 @@ "section": "def-common.DataViewSpec", "text": "DataViewSpec" }, - ", override?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", + ", overwrite?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -25394,10 +25410,8 @@ "id": "def-common.DataViewsService.createAndSave.$2", "type": "boolean", "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists." - ], + "label": "overwrite", + "description": [], "signature": [ "boolean" ], @@ -25461,7 +25475,7 @@ "section": "def-common.DataView", "text": "DataView" }, - ", override?: boolean, displayErrors?: boolean) => Promise<", + ", overwrite?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -25503,10 +25517,8 @@ "id": "def-common.DataViewsService.createSavedObject.$2", "type": "boolean", "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists" - ], + "label": "overwrite", + "description": [], "signature": [ "boolean" ], @@ -27641,6 +27653,26 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/logs.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/ecommerce.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/flights.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts" + }, { "plugin": "osquery", "path": "x-pack/plugins/osquery/server/routes/pack/read_pack_route.ts" @@ -27729,22 +27761,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/user_risk_score_dashboards.ts" }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/logs.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/ecommerce.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/flights.ts" - }, - { - "plugin": "lists", - "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts" - }, { "plugin": "alerting", "path": "x-pack/plugins/alerting/server/rules_client/lib/siem_legacy_actions/retrieve_migrated_legacy_actions.mock.ts" @@ -28342,7 +28358,7 @@ "section": "def-common.DataViewSpec", "text": "DataViewSpec" }, - ", override?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", + ", overwrite?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -28358,7 +28374,7 @@ "section": "def-common.DataView", "text": "DataView" }, - ", override?: boolean, displayErrors?: boolean) => Promise<", + ", overwrite?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", diff --git a/api_docs/data.mdx b/api_docs/data.mdx index 9ecf8580ab762..51db0fa099496 100644 --- a/api_docs/data.mdx +++ b/api_docs/data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data title: "data" image: https://source.unsplash.com/400x175/?github description: API docs for the data plugin -date: 2023-06-30 +date: 2023-07-18 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 | |-------------------|-----------|------------------------|-----------------| -| 3303 | 119 | 2579 | 27 | +| 3291 | 119 | 2571 | 27 | ## Client diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index ce841f73084a6..289d1bf61d346 100644 --- a/api_docs/data_query.mdx +++ b/api_docs/data_query.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query title: "data.query" image: https://source.unsplash.com/400x175/?github description: API docs for the data.query plugin -date: 2023-06-30 +date: 2023-07-18 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 | |-------------------|-----------|------------------------|-----------------| -| 3303 | 119 | 2579 | 27 | +| 3291 | 119 | 2571 | 27 | ## Client diff --git a/api_docs/data_search.devdocs.json b/api_docs/data_search.devdocs.json index 571061be8900e..1b61dd4313160 100644 --- a/api_docs/data_search.devdocs.json +++ b/api_docs/data_search.devdocs.json @@ -267,7 +267,7 @@ "\nCurrent session management\n{@link ISessionService}" ], "signature": [ - "{ start: () => string; save: () => Promise; clear: () => void; destroy: () => void; readonly state$: ", + "{ start: () => string; readonly state$: ", "Observable", "<", { @@ -277,7 +277,7 @@ "section": "def-public.SearchSessionState", "text": "SearchSessionState" }, - ">; readonly sessionMeta$: ", + ">; save: () => Promise; clear: () => void; destroy: () => void; readonly sessionMeta$: ", "Observable", "<", "SessionMeta", @@ -703,7 +703,7 @@ "\nCurrent session management\n{@link ISessionService}" ], "signature": [ - "{ start: () => string; save: () => Promise; clear: () => void; destroy: () => void; readonly state$: ", + "{ start: () => string; readonly state$: ", "Observable", "<", { @@ -713,7 +713,7 @@ "section": "def-public.SearchSessionState", "text": "SearchSessionState" }, - ">; readonly sessionMeta$: ", + ">; save: () => Promise; clear: () => void; destroy: () => void; readonly sessionMeta$: ", "Observable", "<", "SessionMeta", @@ -1360,7 +1360,7 @@ "label": "ISessionService", "description": [], "signature": [ - "{ start: () => string; save: () => Promise; clear: () => void; destroy: () => void; readonly state$: ", + "{ start: () => string; readonly state$: ", "Observable", "<", { @@ -1370,7 +1370,7 @@ "section": "def-public.SearchSessionState", "text": "SearchSessionState" }, - ">; readonly sessionMeta$: ", + ">; save: () => Promise; clear: () => void; destroy: () => void; readonly sessionMeta$: ", "Observable", "<", "SessionMeta", @@ -7229,7 +7229,9 @@ "SearchResponse", ">>; setField: >>; history: ", + "SearchRequest", + "[]; setField: void; removeField: void; removeField: ", - { - "pluginId": "@kbn/core-http-server", - "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.KibanaRequest", - "text": "KibanaRequest" - }, - ") | undefined) => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.KibanaContextStartDependencies", - "text": "KibanaContextStartDependencies" - }, - ">) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExpressionFunctionKibanaContext", - "text": "ExpressionFunctionKibanaContext" - } - ], - "path": "src/plugins/data/common/search/expressions/kibana_context.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.getKibanaContextFn.$1", - "type": "Function", - "tags": [], - "label": "getStartDependencies", - "description": [], - "signature": [ - "(getKibanaRequest: (() => ", - { - "pluginId": "@kbn/core-http-server", - "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.KibanaRequest", - "text": "KibanaRequest" - }, - ") | undefined) => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.KibanaContextStartDependencies", - "text": "KibanaContextStartDependencies" - }, - ">" - ], - "path": "src/plugins/data/common/search/expressions/kibana_context.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.getMaxMetricAgg", @@ -16712,7 +16640,7 @@ "\nThis method parses a string into a time shift duration.\nIf parsing fails, 'invalid' is returned.\nAllowed values are the string 'previous' and an integer followed by the units s,m,h,d,w,M,y" ], "signature": [ - "(val: string) => moment.Duration | \"previous\" | \"invalid\"" + "(val: string) => \"invalid\" | moment.Duration | \"previous\"" ], "path": "src/plugins/data/common/search/aggs/utils/parse_time_shift.ts", "deprecated": false, @@ -28748,40 +28676,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.KibanaContextStartDependencies", - "type": "Interface", - "tags": [], - "label": "KibanaContextStartDependencies", - "description": [], - "path": "src/plugins/data/common/search/expressions/kibana_context.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.KibanaContextStartDependencies.savedObjectsClient", - "type": "Object", - "tags": [], - "label": "savedObjectsClient", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommon", - "text": "SavedObjectsClientCommon" - } - ], - "path": "src/plugins/data/common/search/expressions/kibana_context.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.MetricAggParam", @@ -34678,7 +34572,9 @@ "SearchResponse", ">>; setField: >>; history: ", + "SearchRequest", + "[]; setField: void; removeField: void; removeField: { type: string; }" - ], - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] - } - ] - }, - { - "parentPluginId": "data", - "id": "def-common.kibanaContext.to", - "type": "Object", - "tags": [], - "label": "to", - "description": [], - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.kibanaContext.to.null", - "type": "Function", - "tags": [], - "label": "null", - "description": [], - "signature": [ - "() => { type: string; }" - ], - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-common.kibanaContext.to.filter", - "type": "Function", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "(input: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExpressionValueSearchContext", - "text": "ExpressionValueSearchContext" - }, - ") => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueFilter", - "text": "ExpressionValueFilter" - } - ], - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.kibanaContext.to.filter.$1", - "type": "CompoundType", - "tags": [], - "label": "input", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExpressionValueSearchContext", - "text": "ExpressionValueSearchContext" - } - ], - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - } - ] - } - ], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.kibanaFilterFunction", diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index 5eddd6d09b2ac..bb6fadd343fa0 100644 --- a/api_docs/data_search.mdx +++ b/api_docs/data_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search title: "data.search" image: https://source.unsplash.com/400x175/?github description: API docs for the data.search plugin -date: 2023-06-30 +date: 2023-07-18 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 | |-------------------|-----------|------------------------|-----------------| -| 3303 | 119 | 2579 | 27 | +| 3291 | 119 | 2571 | 27 | ## Client diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 2159e38e38468..ea6d8d385d049 100644 --- a/api_docs/data_view_editor.mdx +++ b/api_docs/data_view_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewEditor title: "dataViewEditor" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViewEditor plugin -date: 2023-06-30 +date: 2023-07-18 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 d69b6df539cd2..bce356484fb58 100644 --- a/api_docs/data_view_field_editor.mdx +++ b/api_docs/data_view_field_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor title: "dataViewFieldEditor" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViewFieldEditor plugin -date: 2023-06-30 +date: 2023-07-18 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 154f8b8cf5da3..117d88038bfd6 100644 --- a/api_docs/data_view_management.mdx +++ b/api_docs/data_view_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewManagement title: "dataViewManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViewManagement plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] --- import dataViewManagementObj from './data_view_management.devdocs.json'; diff --git a/api_docs/data_views.devdocs.json b/api_docs/data_views.devdocs.json index c88fad679a3bb..b7a3d99c3f65f 100644 --- a/api_docs/data_views.devdocs.json +++ b/api_docs/data_views.devdocs.json @@ -89,7 +89,7 @@ }, { "plugin": "observability", - "path": "x-pack/plugins/observability/public/components/threshold/components/expression.tsx" + "path": "x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx" }, { "plugin": "observability", @@ -111,10 +111,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/detections/containers/detection_engine/exceptions/get_es_query_filter.ts" }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/detections/components/alerts_table/alerts_sub_grouping.tsx" - }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/utils.ts" @@ -192,16 +188,16 @@ "path": "x-pack/plugins/security_solution/public/detection_engine/rule_exceptions/components/flyout_components/alerts_actions/utils.test.ts" }, { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context.test.ts" + "plugin": "savedSearch", + "path": "src/plugins/saved_search/common/expressions/kibana_context.test.ts" }, { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context.test.ts" + "plugin": "savedSearch", + "path": "src/plugins/saved_search/common/expressions/kibana_context.test.ts" }, { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context.test.ts" + "plugin": "savedSearch", + "path": "src/plugins/saved_search/common/expressions/kibana_context.test.ts" }, { "plugin": "@kbn/es-query", @@ -408,8 +404,8 @@ "path": "x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts" }, { - "plugin": "infra", - "path": "x-pack/plugins/infra/common/log_views/resolved_log_view.ts" + "plugin": "logsShared", + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts" }, { "plugin": "visTypeTimeseries", @@ -483,6 +479,10 @@ "plugin": "stackAlerts", "path": "x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx" + }, { "plugin": "dataVisualizer", "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts" @@ -587,10 +587,6 @@ "plugin": "infra", "path": "x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts" }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx" - }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx" @@ -635,6 +631,18 @@ "plugin": "enterpriseSearch", "path": "x-pack/plugins/enterprise_search/public/applications/analytics/components/analytics_collection_view/analytics_collection_explore_table_formulas.ts" }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/containers/sourcerer/create_sourcerer_data_view.ts" @@ -655,18 +663,6 @@ "plugin": "timelines", "path": "x-pack/plugins/timelines/server/search_strategy/index_fields/index.ts" }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" - }, { "plugin": "transform", "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_term_form.tsx" @@ -4926,7 +4922,7 @@ "section": "def-common.DataViewSpec", "text": "DataViewSpec" }, - ", override?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", + ", overwrite?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -4968,10 +4964,8 @@ "id": "def-public.DataViewsService.createAndSave.$2", "type": "boolean", "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists." - ], + "label": "overwrite", + "description": [], "signature": [ "boolean" ], @@ -5035,7 +5029,7 @@ "section": "def-common.DataView", "text": "DataView" }, - ", override?: boolean, displayErrors?: boolean) => Promise<", + ", overwrite?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -5077,10 +5071,8 @@ "id": "def-public.DataViewsService.createSavedObject.$2", "type": "boolean", "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists" - ], + "label": "overwrite", + "description": [], "signature": [ "boolean" ], @@ -5473,35 +5465,35 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon", + "id": "def-public.UiSettingsPublicToCommon", "type": "Class", "tags": [], - "label": "SavedObjectsClientPublicToCommon", + "label": "UiSettingsPublicToCommon", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "public", "docId": "kibDataViewsPluginApi", - "section": "def-public.SavedObjectsClientPublicToCommon", - "text": "SavedObjectsClientPublicToCommon" + "section": "def-public.UiSettingsPublicToCommon", + "text": "UiSettingsPublicToCommon" }, " implements ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommon", - "text": "SavedObjectsClientCommon" + "section": "def-common.UiSettingsCommon", + "text": "UiSettingsCommon" } ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.Unnamed", + "id": "def-public.UiSettingsPublicToCommon.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -5509,42 +5501,27 @@ "signature": [ "any" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.Unnamed.$1", + "id": "def-public.UiSettingsPublicToCommon.Unnamed.$1", "type": "Object", "tags": [], - "label": "contentManagementClient", + "label": "uiSettings", "description": [], "signature": [ { - "pluginId": "contentManagement", - "scope": "public", - "docId": "kibContentManagementPluginApi", - "section": "def-public.ContentClient", - "text": "ContentClient" + "pluginId": "@kbn/core-ui-settings-browser", + "scope": "common", + "docId": "kibKbnCoreUiSettingsBrowserPluginApi", + "section": "def-common.IUiSettingsClient", + "text": "IUiSettingsClient" } ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.Unnamed.$2", - "type": "Object", - "tags": [], - "label": "savedObjectClient", - "description": [], - "signature": [ - "SOClient" - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5554,59 +5531,29 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.find", + "id": "def-public.UiSettingsPublicToCommon.get", "type": "Function", "tags": [], - "label": "find", + "label": "get", "description": [], "signature": [ - "(options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommonFindArgs", - "text": "SavedObjectsClientCommonFindArgs" - }, - ") => Promise<", - { - "pluginId": "@kbn/content-management-utils", - "scope": "common", - "docId": "kibKbnContentManagementUtilsPluginApi", - "section": "def-common.SOWithMetadata", - "text": "SOWithMetadata" - }, - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">[]>" + "(key: string) => Promise" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.find.$1", - "type": "Object", + "id": "def-public.UiSettingsPublicToCommon.get.$1", + "type": "string", "tags": [], - "label": "options", + "label": "key", "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommonFindArgs", - "text": "SavedObjectsClientCommonFindArgs" - } + "string" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5616,85 +5563,76 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.get", + "id": "def-public.UiSettingsPublicToCommon.getAll", "type": "Function", "tags": [], - "label": "get", + "label": "getAll", "description": [], "signature": [ - "(id: string) => Promise<", + "() => Promise>" + ") | undefined>>" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.get.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.getSavedSearch", + "id": "def-public.UiSettingsPublicToCommon.set", "type": "Function", "tags": [], - "label": "getSavedSearch", + "label": "set", "description": [], "signature": [ - "(id: string) => Promise<", - { - "pluginId": "@kbn/core-saved-objects-api-browser", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", - "section": "def-common.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">" + "(key: string, value: unknown) => Promise" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.getSavedSearch.$1", + "id": "def-public.UiSettingsPublicToCommon.set.$1", "type": "string", "tags": [], - "label": "id", + "label": "key", "description": [], "signature": [ "string" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-public.UiSettingsPublicToCommon.set.$2", + "type": "Unknown", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "unknown" + ], + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5704,547 +5642,166 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.update", + "id": "def-public.UiSettingsPublicToCommon.remove", "type": "Function", "tags": [], - "label": "update", + "label": "remove", "description": [], "signature": [ - "(id: string, attributes: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ", options: DataViewUpdateOptions) => Promise<", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">>" + "(key: string) => Promise" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.update.$1", + "id": "def-public.UiSettingsPublicToCommon.remove.$1", "type": "string", "tags": [], - "label": "id", + "label": "key", "description": [], "signature": [ "string" ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.update.$2", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - } - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.update.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "DataViewUpdateOptions" - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.create", - "type": "Function", - "tags": [], - "label": "create", - "description": [], - "signature": [ - "(attributes: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ", options: DataViewCreateOptions) => Promise<", - { - "pluginId": "@kbn/content-management-utils", - "scope": "common", - "docId": "kibKbnContentManagementUtilsPluginApi", - "section": "def-common.SOWithMetadata", - "text": "SOWithMetadata" - }, - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">>" - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.create.$1", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - } - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.create.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "DataViewCreateOptions" - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", + "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "dataViews", + "id": "def-public.getFieldSubtypeMulti", + "type": "Function", + "tags": [], + "label": "getFieldSubtypeMulti", + "description": [], + "signature": [ + "(field: HasSubtype) => ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.IFieldSubTypeMulti", + "text": "IFieldSubTypeMulti" }, + " | undefined" + ], + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.delete", - "type": "Function", + "id": "def-public.getFieldSubtypeMulti.$1", + "type": "Object", "tags": [], - "label": "delete", + "label": "field", "description": [], "signature": [ - "(id: string) => Promise" - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + "{ subType?: ", { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientPublicToCommon.delete.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined; }" ], - "returnComment": [] + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon", - "type": "Class", + "id": "def-public.getFieldSubtypeNested", + "type": "Function", "tags": [], - "label": "UiSettingsPublicToCommon", + "label": "getFieldSubtypeNested", "description": [], "signature": [ + "(field: HasSubtype) => ", { - "pluginId": "dataViews", - "scope": "public", - "docId": "kibDataViewsPluginApi", - "section": "def-public.UiSettingsPublicToCommon", - "text": "UiSettingsPublicToCommon" - }, - " implements ", - { - "pluginId": "dataViews", + "pluginId": "@kbn/es-query", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.UiSettingsCommon", - "text": "UiSettingsCommon" - } + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.IFieldSubTypeNested", + "text": "IFieldSubTypeNested" + }, + " | undefined" ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", + "path": "src/plugins/data_views/common/fields/utils.ts", "deprecated": false, "trackAdoption": false, + "returnComment": [], "children": [ { "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.Unnamed", - "type": "Function", + "id": "def-public.getFieldSubtypeNested.$1", + "type": "Object", "tags": [], - "label": "Constructor", + "label": "field", "description": [], "signature": [ - "any" - ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + "{ subType?: ", { - "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "uiSettings", - "description": [], - "signature": [ - { - "pluginId": "@kbn/core-ui-settings-browser", - "scope": "common", - "docId": "kibKbnCoreUiSettingsBrowserPluginApi", - "section": "def-common.IUiSettingsClient", - "text": "IUiSettingsClient" - } - ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined; }" ], - "returnComment": [] - }, + "path": "src/plugins/data_views/common/fields/utils.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.validateDataView", + "type": "Function", + "tags": [], + "label": "validateDataView", + "description": [ + "\nValidate index pattern strings" + ], + "signature": [ + "(indexPattern: string) => { ILLEGAL_CHARACTERS?: string[] | undefined; CONTAINS_SPACES?: boolean | undefined; }" + ], + "path": "src/plugins/data_views/common/lib/validate_data_view.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.get", - "type": "Function", + "id": "def-public.validateDataView.$1", + "type": "string", "tags": [], - "label": "get", - "description": [], + "label": "indexPattern", + "description": [ + "string to validate" + ], "signature": [ - "(key: string) => Promise" + "string" ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.get.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.getAll", - "type": "Function", - "tags": [], - "label": "getAll", - "description": [], - "signature": [ - "() => Promise) | undefined>>" - ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.set", - "type": "Function", - "tags": [], - "label": "set", - "description": [], - "signature": [ - "(key: string, value: unknown) => Promise" - ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.set.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.set.$2", - "type": "Unknown", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "unknown" - ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.remove", - "type": "Function", - "tags": [], - "label": "remove", - "description": [], - "signature": [ - "(key: string) => Promise" - ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.UiSettingsPublicToCommon.remove.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/public/ui_settings_wrapper.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [ - { - "parentPluginId": "dataViews", - "id": "def-public.getFieldSubtypeMulti", - "type": "Function", - "tags": [], - "label": "getFieldSubtypeMulti", - "description": [], - "signature": [ - "(field: HasSubtype) => ", - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.IFieldSubTypeMulti", - "text": "IFieldSubTypeMulti" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.getFieldSubtypeMulti.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ subType?: ", - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.IFieldSubType", - "text": "IFieldSubType" - }, - " | undefined; }" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.getFieldSubtypeNested", - "type": "Function", - "tags": [], - "label": "getFieldSubtypeNested", - "description": [], - "signature": [ - "(field: HasSubtype) => ", - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.IFieldSubTypeNested", - "text": "IFieldSubTypeNested" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.getFieldSubtypeNested.$1", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - "{ subType?: ", - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.IFieldSubType", - "text": "IFieldSubType" - }, - " | undefined; }" - ], - "path": "src/plugins/data_views/common/fields/utils.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.validateDataView", - "type": "Function", - "tags": [], - "label": "validateDataView", - "description": [ - "\nValidate index pattern strings" - ], - "signature": [ - "(indexPattern: string) => { ILLEGAL_CHARACTERS?: string[] | undefined; CONTAINS_SPACES?: boolean | undefined; }" - ], - "path": "src/plugins/data_views/common/lib/validate_data_view.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.validateDataView.$1", - "type": "string", - "tags": [], - "label": "indexPattern", - "description": [ - "string to validate" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/lib/validate_data_view.ts", + "path": "src/plugins/data_views/common/lib/validate_data_view.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -7447,84 +7004,20 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.RuntimeField", + "id": "def-public.PersistenceAPI", "type": "Interface", "tags": [], - "label": "RuntimeField", + "label": "PersistenceAPI", "description": [ - "\nThis is the RuntimeField interface enhanced with Data view field\nconfiguration: field format definition, customLabel or popularity." + "\nCommon interface for the saved objects client on server and content management in browser" ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - " extends ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldBase", - "text": "RuntimeFieldBase" - }, - ",", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldConfiguration", - "text": "FieldConfiguration" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.RuntimeField.fields", - "type": "Object", - "tags": [], - "label": "fields", - "description": [ - "\nSubfields of composite field" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeFieldSubFields", - "text": "RuntimeFieldSubFields" - }, - " | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon", - "type": "Interface", - "tags": [], - "label": "SavedObjectsClientCommon", - "description": [ - "\nCommon interface for the saved objects client" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.find", + "id": "def-public.PersistenceAPI.find", "type": "Function", "tags": [], "label": "find", @@ -7564,7 +7057,7 @@ "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.find.$1", + "id": "def-public.PersistenceAPI.find.$1", "type": "Object", "tags": [], "label": "options", @@ -7590,7 +7083,7 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.get", + "id": "def-public.PersistenceAPI.get", "type": "Function", "tags": [], "label": "get", @@ -7622,51 +7115,7 @@ "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.get.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "- id of saved object" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.getSavedSearch", - "type": "Function", - "tags": [], - "label": "getSavedSearch", - "description": [ - "\nUpdate a saved object by id" - ], - "signature": [ - "(id: string) => Promise<", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - ">" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.getSavedSearch.$1", + "id": "def-public.PersistenceAPI.get.$1", "type": "string", "tags": [], "label": "id", @@ -7686,7 +7135,7 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.update", + "id": "def-public.PersistenceAPI.update", "type": "Function", "tags": [], "label": "update", @@ -7718,7 +7167,7 @@ "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.update.$1", + "id": "def-public.PersistenceAPI.update.$1", "type": "string", "tags": [], "label": "id", @@ -7735,7 +7184,7 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.update.$2", + "id": "def-public.PersistenceAPI.update.$2", "type": "Object", "tags": [], "label": "attributes", @@ -7758,7 +7207,7 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.update.$3", + "id": "def-public.PersistenceAPI.update.$3", "type": "Object", "tags": [], "label": "options", @@ -7769,7 +7218,7 @@ "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.update.$3.version", + "id": "def-public.PersistenceAPI.update.$3.version", "type": "string", "tags": [], "label": "version", @@ -7788,7 +7237,7 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.create", + "id": "def-public.PersistenceAPI.create", "type": "Function", "tags": [], "label": "create", @@ -7804,7 +7253,7 @@ "section": "def-common.DataViewAttributes", "text": "DataViewAttributes" }, - ", options: { id?: string | undefined; initialNamespaces?: string[] | undefined; }) => Promise<", + ", options: { id?: string | undefined; initialNamespaces?: string[] | undefined; overwrite?: boolean | undefined; }) => Promise<", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", @@ -7820,7 +7269,7 @@ "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.create.$1", + "id": "def-public.PersistenceAPI.create.$1", "type": "Object", "tags": [], "label": "attributes", @@ -7843,7 +7292,7 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.create.$2", + "id": "def-public.PersistenceAPI.create.$2", "type": "Object", "tags": [], "label": "options", @@ -7854,7 +7303,7 @@ "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.create.$2.id", + "id": "def-public.PersistenceAPI.create.$2.id", "type": "string", "tags": [], "label": "id", @@ -7868,7 +7317,7 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.create.$2.initialNamespaces", + "id": "def-public.PersistenceAPI.create.$2.initialNamespaces", "type": "Array", "tags": [], "label": "initialNamespaces", @@ -7879,6 +7328,20 @@ "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "dataViews", + "id": "def-public.PersistenceAPI.create.$2.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false } ] } @@ -7887,7 +7350,7 @@ }, { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.delete", + "id": "def-public.PersistenceAPI.delete", "type": "Function", "tags": [], "label": "delete", @@ -7903,7 +7366,7 @@ "children": [ { "parentPluginId": "dataViews", - "id": "def-public.SavedObjectsClientCommon.delete.$1", + "id": "def-public.PersistenceAPI.delete.$1", "type": "string", "tags": [], "label": "id", @@ -7924,6 +7387,70 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "dataViews", + "id": "def-public.RuntimeField", + "type": "Interface", + "tags": [], + "label": "RuntimeField", + "description": [ + "\nThis is the RuntimeField interface enhanced with Data view field\nconfiguration: field format definition, customLabel or popularity." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + " extends ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldBase", + "text": "RuntimeFieldBase" + }, + ",", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldConfiguration", + "text": "FieldConfiguration" + } + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.RuntimeField.fields", + "type": "Object", + "tags": [], + "label": "fields", + "description": [ + "\nSubfields of composite field" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSubFields", + "text": "RuntimeFieldSubFields" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "dataViews", "id": "def-public.Tag", @@ -8398,7 +7925,7 @@ }, { "plugin": "observability", - "path": "x-pack/plugins/observability/public/components/threshold/components/expression.tsx" + "path": "x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx" }, { "plugin": "observability", @@ -8420,10 +7947,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/detections/containers/detection_engine/exceptions/get_es_query_filter.ts" }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/detections/components/alerts_table/alerts_sub_grouping.tsx" - }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/utils.ts" @@ -8501,16 +8024,16 @@ "path": "x-pack/plugins/security_solution/public/detection_engine/rule_exceptions/components/flyout_components/alerts_actions/utils.test.ts" }, { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context.test.ts" + "plugin": "savedSearch", + "path": "src/plugins/saved_search/common/expressions/kibana_context.test.ts" }, { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context.test.ts" + "plugin": "savedSearch", + "path": "src/plugins/saved_search/common/expressions/kibana_context.test.ts" }, { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context.test.ts" + "plugin": "savedSearch", + "path": "src/plugins/saved_search/common/expressions/kibana_context.test.ts" }, { "plugin": "@kbn/es-query", @@ -8717,8 +8240,8 @@ "path": "x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts" }, { - "plugin": "infra", - "path": "x-pack/plugins/infra/common/log_views/resolved_log_view.ts" + "plugin": "logsShared", + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts" }, { "plugin": "visTypeTimeseries", @@ -8792,6 +8315,10 @@ "plugin": "stackAlerts", "path": "x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx" + }, { "plugin": "dataVisualizer", "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts" @@ -8896,10 +8423,6 @@ "plugin": "infra", "path": "x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts" }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx" - }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx" @@ -8944,6 +8467,18 @@ "plugin": "enterpriseSearch", "path": "x-pack/plugins/enterprise_search/public/applications/analytics/components/analytics_collection_view/analytics_collection_explore_table_formulas.ts" }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/containers/sourcerer/create_sourcerer_data_view.ts" @@ -8964,18 +8499,6 @@ "plugin": "timelines", "path": "x-pack/plugins/timelines/server/search_strategy/index_fields/index.ts" }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" - }, { "plugin": "transform", "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_term_form.tsx" @@ -12276,7 +11799,7 @@ "section": "def-common.DataViewSpec", "text": "DataViewSpec" }, - ", override?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", + ", overwrite?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -12318,10 +11841,8 @@ "id": "def-server.DataViewsService.createAndSave.$2", "type": "boolean", "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists." - ], + "label": "overwrite", + "description": [], "signature": [ "boolean" ], @@ -12385,7 +11906,7 @@ "section": "def-common.DataView", "text": "DataView" }, - ", override?: boolean, displayErrors?: boolean) => Promise<", + ", overwrite?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -12427,10 +11948,8 @@ "id": "def-server.DataViewsService.createSavedObject.$2", "type": "boolean", "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists" - ], + "label": "overwrite", + "description": [], "signature": [ "boolean" ], @@ -13581,447 +13100,46 @@ } ], "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "dataViews", + "id": "def-server.DATA_VIEW_PATH", + "type": "string", + "tags": [], + "label": "DATA_VIEW_PATH", + "description": [ + "\nPath for data view creation" + ], + "path": "src/plugins/data_views/server/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon", - "type": "Interface", + "id": "def-server.DATA_VIEW_PATH_LEGACY", + "type": "string", "tags": [], - "label": "SavedObjectsClientCommon", + "label": "DATA_VIEW_PATH_LEGACY", "description": [ - "\nCommon interface for the saved objects client" + "\nLegacy path for data view creation" ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.find", - "type": "Function", - "tags": [], - "label": "find", - "description": [ - "\nSearch for saved objects" - ], - "signature": [ - "(options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommonFindArgs", - "text": "SavedObjectsClientCommonFindArgs" - }, - ") => Promise<", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">[]>" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.find.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "- options for search" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommonFindArgs", - "text": "SavedObjectsClientCommonFindArgs" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nGet a single saved object by id" - ], - "signature": [ - "(id: string) => Promise<", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">>" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.get.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "- id of saved object" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.getSavedSearch", - "type": "Function", - "tags": [], - "label": "getSavedSearch", - "description": [ - "\nUpdate a saved object by id" - ], - "signature": [ - "(id: string) => Promise<", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - ">" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.getSavedSearch.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "- id of saved object" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.update", - "type": "Function", - "tags": [], - "label": "update", - "description": [ - "\nUpdate a saved object by id" - ], - "signature": [ - "(id: string, attributes: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ", options: { version?: string | undefined; }) => Promise<", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - ">" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.update.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "- id of saved object" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.update.$2", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [ - "- attributes to update" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.update.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.update.$3.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false - } - ] - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.create", - "type": "Function", - "tags": [], - "label": "create", - "description": [ - "\nCreate a saved object" - ], - "signature": [ - "(attributes: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ", options: { id?: string | undefined; initialNamespaces?: string[] | undefined; }) => Promise<", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - ">" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.create.$1", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [ - "- attributes to set" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.create.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.create.$2.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.create.$2.initialNamespaces", - "type": "Array", - "tags": [], - "label": "initialNamespaces", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false - } - ] - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.delete", - "type": "Function", - "tags": [], - "label": "delete", - "description": [ - "\nDelete a saved object by id" - ], - "signature": [ - "(id: string) => Promise" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-server.SavedObjectsClientCommon.delete.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "- id of saved object" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "enums": [], - "misc": [ - { - "parentPluginId": "dataViews", - "id": "def-server.DATA_VIEW_PATH", - "type": "string", - "tags": [], - "label": "DATA_VIEW_PATH", - "description": [ - "\nPath for data view creation" - ], - "path": "src/plugins/data_views/server/constants.ts", + "path": "src/plugins/data_views/server/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-server.DATA_VIEW_PATH_LEGACY", + "id": "def-server.DATA_VIEW_SWAP_REFERENCES_PATH", "type": "string", "tags": [], - "label": "DATA_VIEW_PATH_LEGACY", + "label": "DATA_VIEW_SWAP_REFERENCES_PATH", "description": [ - "\nLegacy path for data view creation" + "\nPath to swap references" ], "path": "src/plugins/data_views/server/constants.ts", "deprecated": false, @@ -15762,7 +14880,7 @@ }, { "plugin": "observability", - "path": "x-pack/plugins/observability/public/components/threshold/components/expression.tsx" + "path": "x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx" }, { "plugin": "observability", @@ -15784,10 +14902,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/detections/containers/detection_engine/exceptions/get_es_query_filter.ts" }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/detections/components/alerts_table/alerts_sub_grouping.tsx" - }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/utils.ts" @@ -15865,16 +14979,16 @@ "path": "x-pack/plugins/security_solution/public/detection_engine/rule_exceptions/components/flyout_components/alerts_actions/utils.test.ts" }, { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context.test.ts" + "plugin": "savedSearch", + "path": "src/plugins/saved_search/common/expressions/kibana_context.test.ts" }, { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context.test.ts" + "plugin": "savedSearch", + "path": "src/plugins/saved_search/common/expressions/kibana_context.test.ts" }, { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context.test.ts" + "plugin": "savedSearch", + "path": "src/plugins/saved_search/common/expressions/kibana_context.test.ts" }, { "plugin": "@kbn/es-query", @@ -16081,8 +15195,8 @@ "path": "x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts" }, { - "plugin": "infra", - "path": "x-pack/plugins/infra/common/log_views/resolved_log_view.ts" + "plugin": "logsShared", + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts" }, { "plugin": "visTypeTimeseries", @@ -16156,6 +15270,10 @@ "plugin": "stackAlerts", "path": "x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx" + }, { "plugin": "dataVisualizer", "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts" @@ -16260,10 +15378,6 @@ "plugin": "infra", "path": "x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts" }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx" - }, { "plugin": "canvas", "path": "x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx" @@ -16308,6 +15422,18 @@ "plugin": "enterpriseSearch", "path": "x-pack/plugins/enterprise_search/public/applications/analytics/components/analytics_collection_view/analytics_collection_explore_table_formulas.ts" }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/state_management/persistence.ts" + }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/common/containers/sourcerer/create_sourcerer_data_view.ts" @@ -16328,18 +15454,6 @@ "plugin": "timelines", "path": "x-pack/plugins/timelines/server/search_strategy/index_fields/index.ts" }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/datasource.sagas.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/state_management/persistence.ts" - }, { "plugin": "transform", "path": "x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/filter_agg/components/filter_term_form.tsx" @@ -20304,7 +19418,7 @@ "section": "def-common.DataViewSpec", "text": "DataViewSpec" }, - ", override?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", + ", overwrite?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -20346,10 +19460,8 @@ "id": "def-common.DataViewsService.createAndSave.$2", "type": "boolean", "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists." - ], + "label": "overwrite", + "description": [], "signature": [ "boolean" ], @@ -20413,7 +19525,7 @@ "section": "def-common.DataView", "text": "DataView" }, - ", override?: boolean, displayErrors?: boolean) => Promise<", + ", overwrite?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -20455,10 +19567,8 @@ "id": "def-common.DataViewsService.createSavedObject.$2", "type": "boolean", "tags": [], - "label": "override", - "description": [ - "Overwrite if existing index pattern exists" - ], + "label": "overwrite", + "description": [], "signature": [ "boolean" ], @@ -21432,8 +20542,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommon", - "text": "SavedObjectsClientCommon" + "section": "def-common.PersistenceAPI", + "text": "PersistenceAPI" } ], "path": "src/plugins/data_views/common/data_views/data_views.ts", @@ -22201,7 +21311,7 @@ "section": "def-common.DataView", "text": "DataView" }, - ", override?: boolean | undefined, displayErrors?: boolean | undefined) => Promise<", + ", overwrite?: boolean | undefined, displayErrors?: boolean | undefined) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -22241,10 +21351,8 @@ "id": "def-common.DataViewsServicePublicMethods.createSavedObject.$2", "type": "CompoundType", "tags": [], - "label": "override", - "description": [ - "- If true, save over existing data view" - ], + "label": "overwrite", + "description": [], "signature": [ "boolean | undefined" ], @@ -23317,96 +22425,296 @@ "isRequired": false } ], - "returnComment": [] + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.FieldConfiguration", + "type": "Interface", + "tags": [], + "label": "FieldConfiguration", + "description": [ + "\nField attributes that are user configurable" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.FieldConfiguration.format", + "type": "CompoundType", + "tags": [], + "label": "format", + "description": [ + "\nField format in serialized form" + ], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<{}, ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.SerializableRecord", + "text": "SerializableRecord" + }, + "> | null | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.FieldConfiguration.customLabel", + "type": "string", + "tags": [], + "label": "customLabel", + "description": [ + "\nCustom label" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.FieldConfiguration.popularity", + "type": "number", + "tags": [], + "label": "popularity", + "description": [ + "\nPopularity - used for discover" + ], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptions", + "type": "Interface", + "tags": [], + "label": "GetFieldsOptions", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptions.pattern", + "type": "string", + "tags": [], + "label": "pattern", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptions.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptions.lookBack", + "type": "CompoundType", + "tags": [], + "label": "lookBack", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptions.metaFields", + "type": "Array", + "tags": [], + "label": "metaFields", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptions.rollupIndex", + "type": "string", + "tags": [], + "label": "rollupIndex", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptions.allowNoIndex", + "type": "CompoundType", + "tags": [], + "label": "allowNoIndex", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptions.indexFilter", + "type": "Object", + "tags": [], + "label": "indexFilter", + "description": [], + "signature": [ + "QueryDslQueryContainer", + " | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptions.includeUnmapped", + "type": "CompoundType", + "tags": [], + "label": "includeUnmapped", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.GetFieldsOptions.fields", + "type": "Array", + "tags": [], + "label": "fields", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.FieldConfiguration", + "id": "def-common.HasDataService", "type": "Interface", "tags": [], - "label": "FieldConfiguration", - "description": [ - "\nField attributes that are user configurable" - ], + "label": "HasDataService", + "description": [], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.FieldConfiguration.format", - "type": "CompoundType", + "id": "def-common.HasDataService.hasESData", + "type": "Function", "tags": [], - "label": "format", - "description": [ - "\nField format in serialized form" - ], + "label": "hasESData", + "description": [], "signature": [ - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<{}, ", - { - "pluginId": "@kbn/utility-types", - "scope": "common", - "docId": "kibKbnUtilityTypesPluginApi", - "section": "def-common.SerializableRecord", - "text": "SerializableRecord" - }, - "> | null | undefined" + "() => Promise" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.FieldConfiguration.customLabel", - "type": "string", + "id": "def-common.HasDataService.hasUserDataView", + "type": "Function", "tags": [], - "label": "customLabel", - "description": [ - "\nCustom label" - ], + "label": "hasUserDataView", + "description": [], "signature": [ - "string | undefined" + "() => Promise" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.FieldConfiguration.popularity", - "type": "number", + "id": "def-common.HasDataService.hasDataView", + "type": "Function", "tags": [], - "label": "popularity", - "description": [ - "\nPopularity - used for discover" - ], + "label": "hasDataView", + "description": [], "signature": [ - "number | undefined" + "() => Promise" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions", + "id": "def-common.IDataViewsApiClient", "type": "Interface", "tags": [], - "label": "GetFieldsOptions", + "label": "IDataViewsApiClient", "description": [], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -23414,169 +22722,358 @@ "children": [ { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.pattern", - "type": "string", + "id": "def-common.IDataViewsApiClient.getFieldsForWildcard", + "type": "Function", "tags": [], - "label": "pattern", + "label": "getFieldsForWildcard", "description": [], + "signature": [ + "(options: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise<", + "FieldsForWildcardResponse", + ">" + ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IDataViewsApiClient.getFieldsForWildcard.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + } + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.type", - "type": "string", + "id": "def-common.IDataViewsApiClient.hasUserDataView", + "type": "Function", "tags": [], - "label": "type", + "label": "hasUserDataView", "description": [], "signature": [ - "string | undefined" + "() => Promise" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList", + "type": "Interface", + "tags": [], + "label": "IIndexPatternFieldList", + "description": [ + "\nInterface for data view field list which _extends_ the array class." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + }, + " extends ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" }, + "[]" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.lookBack", - "type": "CompoundType", + "id": "def-common.IIndexPatternFieldList.add", + "type": "Function", "tags": [], - "label": "lookBack", - "description": [], + "label": "add", + "description": [ + "\nAdd field to field list." + ], "signature": [ - "boolean | undefined" + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + } + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList.add.$1", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [ + "field spec to add field to list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false + "returnComment": [ + "data view field instance which was added to list" + ] }, { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.metaFields", - "type": "Array", + "id": "def-common.IIndexPatternFieldList.getAll", + "type": "Function", "tags": [], - "label": "metaFields", - "description": [], - "signature": [ - "string[] | undefined" + "label": "getAll", + "description": [ + "\nReturns fields as plain array of data view field instances." ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.rollupIndex", - "type": "string", - "tags": [], - "label": "rollupIndex", - "description": [], "signature": [ - "string | undefined" + "() => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.allowNoIndex", - "type": "CompoundType", + "id": "def-common.IIndexPatternFieldList.getByName", + "type": "Function", "tags": [], - "label": "allowNoIndex", - "description": [], - "signature": [ - "boolean | undefined" + "label": "getByName", + "description": [ + "\nGet field by name. Optimized, uses map to find field." ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.indexFilter", - "type": "Object", - "tags": [], - "label": "indexFilter", - "description": [], "signature": [ - "QueryDslQueryContainer", + "(name: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, " | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.includeUnmapped", - "type": "CompoundType", - "tags": [], - "label": "includeUnmapped", - "description": [], - "signature": [ - "boolean | undefined" + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList.getByName.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "name of field to find" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false + "returnComment": [ + "data view field instance if found, undefined otherwise" + ] }, { "parentPluginId": "dataViews", - "id": "def-common.GetFieldsOptions.fields", - "type": "Array", + "id": "def-common.IIndexPatternFieldList.getByType", + "type": "Function", "tags": [], - "label": "fields", - "description": [], + "label": "getByType", + "description": [ + "\nGet fields by field type. Optimized, uses map to find fields." + ], "signature": [ - "string[] | undefined" + "(type: string) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + "[]" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.HasDataService", - "type": "Interface", - "tags": [], - "label": "HasDataService", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList.getByType.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "type of field to find" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "array of data view field instances if found, empty array otherwise" + ] + }, { "parentPluginId": "dataViews", - "id": "def-common.HasDataService.hasESData", + "id": "def-common.IIndexPatternFieldList.remove", "type": "Function", "tags": [], - "label": "hasESData", - "description": [], + "label": "remove", + "description": [ + "\nRemove field from field list" + ], "signature": [ - "() => Promise" + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + ") => void" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "trackAdoption": false, - "children": [], + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList.remove.$1", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [ + "field for removal" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + " | ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + } + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.HasDataService.hasUserDataView", + "id": "def-common.IIndexPatternFieldList.removeAll", "type": "Function", "tags": [], - "label": "hasUserDataView", - "description": [], + "label": "removeAll", + "description": [ + "\nRemove all fields from field list." + ], "signature": [ - "() => Promise" + "() => void" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "trackAdoption": false, "children": [], @@ -23584,75 +23081,98 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.HasDataService.hasDataView", + "id": "def-common.IIndexPatternFieldList.replaceAll", "type": "Function", "tags": [], - "label": "hasDataView", - "description": [], + "label": "replaceAll", + "description": [ + "\nReplace all fields in field list with new fields." + ], "signature": [ - "() => Promise" + "(specs: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]) => void" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "trackAdoption": false, - "children": [], + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList.replaceAll.$1", + "type": "Array", + "tags": [], + "label": "specs", + "description": [ + "array of field specs to add to list" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IDataViewsApiClient", - "type": "Interface", - "tags": [], - "label": "IDataViewsApiClient", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + }, { "parentPluginId": "dataViews", - "id": "def-common.IDataViewsApiClient.getFieldsForWildcard", + "id": "def-common.IIndexPatternFieldList.update", "type": "Function", "tags": [], - "label": "getFieldsForWildcard", - "description": [], + "label": "update", + "description": [ + "\nUpdate a field in the list" + ], "signature": [ - "(options: ", + "(field: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, - ") => Promise<", - "FieldsForWildcardResponse", - ">" + ") => void" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IDataViewsApiClient.getFieldsForWildcard.$1", - "type": "Object", + "id": "def-common.IIndexPatternFieldList.update.$1", + "type": "CompoundType", "tags": [], - "label": "options", - "description": [], + "label": "field", + "description": [ + "field spec to update" + ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "section": "def-common.FieldSpec", + "text": "FieldSpec" } ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -23662,566 +23182,539 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.IDataViewsApiClient.hasUserDataView", + "id": "def-common.IIndexPatternFieldList.toSpec", "type": "Function", - "tags": [], - "label": "hasUserDataView", - "description": [], + "tags": [ + "return" + ], + "label": "toSpec", + "description": [ + "\nField list as field spec map by name" + ], "signature": [ - "() => Promise" + "(options?: ToSpecOptions | undefined) => ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + } ], - "path": "src/plugins/data_views/common/types.ts", + "path": "src/plugins/data_views/common/fields/field_list.ts", "deprecated": false, "trackAdoption": false, - "children": [], - "returnComment": [] + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.IIndexPatternFieldList.toSpec.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "optionally provide a function to get field formatter for fields" + ], + "signature": [ + "ToSpecOptions | undefined" + ], + "path": "src/plugins/data_views/common/fields/field_list.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [ + "map of field specs by name" + ] } ], "initialIsOpen": false }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList", + "id": "def-common.IndexPatternExpressionType", "type": "Interface", "tags": [], - "label": "IIndexPatternFieldList", + "label": "IndexPatternExpressionType", "description": [ - "\nInterface for data view field list which _extends_ the array class." + "\nIndex pattern expression interface" ], - "signature": [ + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" + "parentPluginId": "dataViews", + "id": "def-common.IndexPatternExpressionType.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nExpression type" + ], + "signature": [ + "\"index_pattern\"" + ], + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "deprecated": false, + "trackAdoption": false }, - " extends ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" + "parentPluginId": "dataViews", + "id": "def-common.IndexPatternExpressionType.value", + "type": "Object", + "tags": [], + "label": "value", + "description": [ + "\nValue - DataViewSpec" + ], + "signature": [ + "{ id?: string | undefined; version?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; sourceFilters?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined; fields?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewFieldMap", + "text": "DataViewFieldMap" + }, + " | undefined; typeMeta?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined; type?: string | undefined; fieldFormats?: Record> | undefined; runtimeFieldMap?: Record | undefined; fieldAttrs?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; }" + ], + "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "deprecated": false, + "trackAdoption": false + } ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.PersistenceAPI", + "type": "Interface", + "tags": [], + "label": "PersistenceAPI", + "description": [ + "\nCommon interface for the saved objects client on server and content management in browser" + ], + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.add", + "id": "def-common.PersistenceAPI.find", "type": "Function", "tags": [], - "label": "add", + "label": "find", "description": [ - "\nAdd field to field list." + "\nSearch for saved objects" ], "signature": [ - "(field: ", + "(options: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.SavedObjectsClientCommonFindArgs", + "text": "SavedObjectsClientCommonFindArgs" }, - ") => ", + ") => Promise<", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + }, + ">[]>" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.add.$1", - "type": "CompoundType", + "id": "def-common.PersistenceAPI.find.$1", + "type": "Object", "tags": [], - "label": "field", + "label": "options", "description": [ - "field spec to add field to list" + "- options for search" ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.SavedObjectsClientCommonFindArgs", + "text": "SavedObjectsClientCommonFindArgs" } ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], - "returnComment": [ - "data view field instance which was added to list" - ] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.getAll", - "type": "Function", - "tags": [], - "label": "getAll", - "description": [ - "\nReturns fields as plain array of data view field instances." - ], - "signature": [ - "() => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - "[]" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.getByName", + "id": "def-common.PersistenceAPI.get", "type": "Function", "tags": [], - "label": "getByName", + "label": "get", "description": [ - "\nGet field by name. Optimized, uses map to find field." + "\nGet a single saved object by id" ], "signature": [ - "(name: string) => ", + "(id: string) => Promise<", { - "pluginId": "dataViews", + "pluginId": "@kbn/core-saved-objects-common", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" }, - " | undefined" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.getByName.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "name of field to find" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [ - "data view field instance if found, undefined otherwise" - ] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.getByType", - "type": "Function", - "tags": [], - "label": "getByType", - "description": [ - "\nGet fields by field type. Optimized, uses map to find fields." - ], - "signature": [ - "(type: string) => ", + "<", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" }, - "[]" + ">>" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.getByType.$1", + "id": "def-common.PersistenceAPI.get.$1", "type": "string", "tags": [], - "label": "type", + "label": "id", "description": [ - "type of field to find" + "- id of saved object" ], "signature": [ "string" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], - "returnComment": [ - "array of data view field instances if found, empty array otherwise" - ] + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.remove", + "id": "def-common.PersistenceAPI.update", "type": "Function", "tags": [], - "label": "remove", + "label": "update", "description": [ - "\nRemove field from field list" + "\nUpdate a saved object by id" ], "signature": [ - "(field: ", + "(id: string, attributes: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" }, - " | ", + ", options: { version?: string | undefined; }) => Promise<", { - "pluginId": "dataViews", + "pluginId": "@kbn/core-saved-objects-common", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" }, - ") => void" + ">" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.remove.$1", - "type": "CompoundType", + "id": "def-common.PersistenceAPI.update.$1", + "type": "string", "tags": [], - "label": "field", + "label": "id", "description": [ - "field for removal" + "- id of saved object" ], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - } + "string" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.removeAll", - "type": "Function", - "tags": [], - "label": "removeAll", - "description": [ - "\nRemove all fields from field list." - ], - "signature": [ - "() => void" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.replaceAll", - "type": "Function", - "tags": [], - "label": "replaceAll", - "description": [ - "\nReplace all fields in field list with new fields." - ], - "signature": [ - "(specs: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" }, - "[]) => void" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.replaceAll.$1", - "type": "Array", + "id": "def-common.PersistenceAPI.update.$2", + "type": "Object", "tags": [], - "label": "specs", + "label": "attributes", "description": [ - "array of field specs to add to list" + "- attributes to update" ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]" + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" + } ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true + }, + { + "parentPluginId": "dataViews", + "id": "def-common.PersistenceAPI.update.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.PersistenceAPI.update.$3.version", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ] } ], "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.update", + "id": "def-common.PersistenceAPI.create", "type": "Function", "tags": [], - "label": "update", + "label": "create", "description": [ - "\nUpdate a field in the list" + "\nCreate a saved object" ], "signature": [ - "(field: ", + "(attributes: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" }, - ") => void" + ", options: { id?: string | undefined; initialNamespaces?: string[] | undefined; overwrite?: boolean | undefined; }) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">" ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.update.$1", - "type": "CompoundType", + "id": "def-common.PersistenceAPI.create.$1", + "type": "Object", "tags": [], - "label": "field", + "label": "attributes", "description": [ - "field spec to update" + "- attributes to set" ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.DataViewAttributes", + "text": "DataViewAttributes" } ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.toSpec", - "type": "Function", - "tags": [ - "return" - ], - "label": "toSpec", - "description": [ - "\nField list as field spec map by name" - ], - "signature": [ - "(options?: ToSpecOptions | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - } - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ + }, { "parentPluginId": "dataViews", - "id": "def-common.IIndexPatternFieldList.toSpec.$1", + "id": "def-common.PersistenceAPI.create.$2", "type": "Object", "tags": [], "label": "options", - "description": [ - "optionally provide a function to get field formatter for fields" - ], - "signature": [ - "ToSpecOptions | undefined" - ], - "path": "src/plugins/data_views/common/fields/field_list.ts", + "description": [], + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, "trackAdoption": false, - "isRequired": false + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.PersistenceAPI.create.$2.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.PersistenceAPI.create.$2.initialNamespaces", + "type": "Array", + "tags": [], + "label": "initialNamespaces", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.PersistenceAPI.create.$2.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ] } ], - "returnComment": [ - "map of field specs by name" - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.IndexPatternExpressionType", - "type": "Interface", - "tags": [], - "label": "IndexPatternExpressionType", - "description": [ - "\nIndex pattern expression interface" - ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.IndexPatternExpressionType.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "\nExpression type" - ], - "signature": [ - "\"index_pattern\"" - ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", - "deprecated": false, - "trackAdoption": false + "returnComment": [] }, { "parentPluginId": "dataViews", - "id": "def-common.IndexPatternExpressionType.value", - "type": "Object", + "id": "def-common.PersistenceAPI.delete", + "type": "Function", "tags": [], - "label": "value", - "description": [ - "\nValue - DataViewSpec" - ], - "signature": [ - "{ id?: string | undefined; version?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; sourceFilters?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SourceFilter", - "text": "SourceFilter" - }, - "[] | undefined; fields?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewFieldMap", - "text": "DataViewFieldMap" - }, - " | undefined; typeMeta?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" - }, - " | undefined; type?: string | undefined; fieldFormats?: Record> | undefined; runtimeFieldMap?: Record | undefined; fieldAttrs?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; }" + "label": "delete", + "description": [ + "\nDelete a saved object by id" ], - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts", + "signature": [ + "(id: string) => Promise" + ], + "path": "src/plugins/data_views/common/types.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-common.PersistenceAPI.delete.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- id of saved object" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -24593,6 +24086,26 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/logs.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/ecommerce.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/flights.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts" + }, { "plugin": "osquery", "path": "x-pack/plugins/osquery/server/routes/pack/read_pack_route.ts" @@ -24681,22 +24194,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/user_risk_score_dashboards.ts" }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/logs.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/ecommerce.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/flights.ts" - }, - { - "plugin": "lists", - "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts" - }, { "plugin": "alerting", "path": "x-pack/plugins/alerting/server/rules_client/lib/siem_legacy_actions/retrieve_migrated_legacy_actions.mock.ts" @@ -24757,482 +24254,67 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObject.typeMigrationVersion", - "type": "string", - "tags": [], - "label": "typeMigrationVersion", - "description": [ - "A semver value that is used when migrating documents between Kibana versions." - ], - "signature": [ - "string | undefined" - ], - "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObject.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [ - "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." - ], - "signature": [ - "string[] | undefined" - ], - "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObject.originId", - "type": "string", - "tags": [], - "label": "originId", - "description": [ - "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." - ], - "signature": [ - "string | undefined" - ], - "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObject.managed", - "type": "CompoundType", - "tags": [], - "label": "managed", - "description": [ - "\nFlag indicating if a saved object is managed by Kibana (default=false)\n\nThis can be leveraged by applications to e.g. prevent edits to a managed\nsaved object. Instead, users can be guided to create a copy first and\nmake their edits to the copy." - ], - "signature": [ - "boolean | undefined" - ], - "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon", - "type": "Interface", - "tags": [], - "label": "SavedObjectsClientCommon", - "description": [ - "\nCommon interface for the saved objects client" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.find", - "type": "Function", - "tags": [], - "label": "find", - "description": [ - "\nSearch for saved objects" - ], - "signature": [ - "(options: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommonFindArgs", - "text": "SavedObjectsClientCommonFindArgs" - }, - ") => Promise<", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">[]>" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.find.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "- options for search" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.SavedObjectsClientCommonFindArgs", - "text": "SavedObjectsClientCommonFindArgs" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nGet a single saved object by id" - ], - "signature": [ - "(id: string) => Promise<", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "<", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ">>" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.get.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "- id of saved object" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.getSavedSearch", - "type": "Function", + "id": "def-common.SavedObject.typeMigrationVersion", + "type": "string", "tags": [], - "label": "getSavedSearch", + "label": "typeMigrationVersion", "description": [ - "\nUpdate a saved object by id" + "A semver value that is used when migrating documents between Kibana versions." ], "signature": [ - "(id: string) => Promise<", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - ">" + "string | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.getSavedSearch.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "- id of saved object" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.update", - "type": "Function", + "id": "def-common.SavedObject.namespaces", + "type": "Array", "tags": [], - "label": "update", + "label": "namespaces", "description": [ - "\nUpdate a saved object by id" + "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." ], "signature": [ - "(id: string, attributes: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ", options: { version?: string | undefined; }) => Promise<", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - ">" + "string[] | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.update.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "- id of saved object" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.update.$2", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [ - "- attributes to update" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.update.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.update.$3.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false - } - ] - } - ], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.create", - "type": "Function", + "id": "def-common.SavedObject.originId", + "type": "string", "tags": [], - "label": "create", + "label": "originId", "description": [ - "\nCreate a saved object" + "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." ], "signature": [ - "(attributes: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - }, - ", options: { id?: string | undefined; initialNamespaces?: string[] | undefined; }) => Promise<", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - ">" + "string | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.create.$1", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [ - "- attributes to set" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewAttributes", - "text": "DataViewAttributes" - } - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.create.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.create.$2.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.create.$2.initialNamespaces", - "type": "Array", - "tags": [], - "label": "initialNamespaces", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false - } - ] - } - ], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.delete", - "type": "Function", + "id": "def-common.SavedObject.managed", + "type": "CompoundType", "tags": [], - "label": "delete", + "label": "managed", "description": [ - "\nDelete a saved object by id" + "\nFlag indicating if a saved object is managed by Kibana (default=false)\n\nThis can be leveraged by applications to e.g. prevent edits to a managed\nsaved object. Instead, users can be guided to create a copy first and\nmake their edits to the copy." ], "signature": [ - "(id: string) => Promise" + "boolean | undefined" ], - "path": "src/plugins/data_views/common/types.ts", + "path": "packages/core/saved-objects/core-saved-objects-common/src/server_types.ts", "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "dataViews", - "id": "def-common.SavedObjectsClientCommon.delete.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "- id of saved object" - ], - "signature": [ - "string" - ], - "path": "src/plugins/data_views/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] + "trackAdoption": false } ], "initialIsOpen": false @@ -25877,7 +24959,7 @@ "section": "def-common.DataViewSpec", "text": "DataViewSpec" }, - ", override?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", + ", overwrite?: boolean, skipFetchFields?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", @@ -25893,7 +24975,7 @@ "section": "def-common.DataView", "text": "DataView" }, - ", override?: boolean, displayErrors?: boolean) => Promise<", + ", overwrite?: boolean, displayErrors?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index 44bd02caec702..41229fb55fd05 100644 --- a/api_docs/data_views.mdx +++ b/api_docs/data_views.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews title: "dataViews" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViews plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] --- import dataViewsObj from './data_views.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 1048 | 0 | 258 | 2 | +| 1009 | 0 | 243 | 2 | ## Client diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index b06578e5105c3..d66d6c4dbdb1d 100644 --- a/api_docs/data_visualizer.mdx +++ b/api_docs/data_visualizer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataVisualizer title: "dataVisualizer" image: https://source.unsplash.com/400x175/?github description: API docs for the dataVisualizer plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] --- import dataVisualizerObj from './data_visualizer.devdocs.json'; diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index aabc7eaaaa889..37523094d7228 100644 --- a/api_docs/deprecations_by_api.mdx +++ b/api_docs/deprecations_by_api.mdx @@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api title: Deprecated API usage by API description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -17,24 +17,25 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Referencing plugin(s) | Remove By | | ---------------|-----------|-----------| | | stackAlerts, ml | - | -| | ruleRegistry, observability, ml, infra, securitySolution, monitoring, stackAlerts, synthetics, transform, uptime | - | +| | ruleRegistry, observability, ml, infra, monitoring, securitySolution, stackAlerts, synthetics, transform, uptime | - | | | stackAlerts, alerting, securitySolution, inputControlVis | - | | | stackAlerts, infra, graph, inputControlVis, securitySolution, savedObjects | - | | | dashboard, stackAlerts, dataVisualizer, expressionPartitionVis | - | -| | @kbn/es-query, visualizationUiComponents, observability, securitySolution, timelines, lists, threatIntelligence, dataViews, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, eventAnnotation, lens, aiops, ml, infra, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, stackAlerts, dataVisualizer, fleet, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - | +| | @kbn/es-query, visualizationUiComponents, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, dataViews, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, eventAnnotation, lens, aiops, ml, logsShared, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, stackAlerts, fleet, dataVisualizer, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - | | | stackAlerts, alerting, securitySolution, inputControlVis | - | -| | @kbn/es-query, visualizationUiComponents, observability, securitySolution, timelines, lists, threatIntelligence, dataViews, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, eventAnnotation, lens, aiops, ml, infra, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, stackAlerts, dataVisualizer, fleet, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - | -| | @kbn/es-query, visualizationUiComponents, observability, securitySolution, timelines, lists, threatIntelligence, data, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, eventAnnotation, lens, aiops, ml, infra, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, stackAlerts, dataVisualizer, fleet, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega | - | +| | @kbn/es-query, visualizationUiComponents, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, dataViews, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, eventAnnotation, lens, aiops, ml, logsShared, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, stackAlerts, fleet, dataVisualizer, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - | +| | @kbn/es-query, visualizationUiComponents, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, data, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, eventAnnotation, lens, aiops, ml, logsShared, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, stackAlerts, fleet, dataVisualizer, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega | - | | | home, data, esUiShared, savedObjectsManagement, exploratoryView, fleet, observability, ml, apm, indexLifecycleManagement, observabilityOnboarding, synthetics, upgradeAssistant, uptime, ux, kibanaOverview | - | -| | encryptedSavedObjects, actions, data, ml, securitySolution, logstash, cloudChat | - | +| | encryptedSavedObjects, actions, data, ml, logstash, securitySolution, cloudChat | - | | | actions, ml, savedObjectsTagging, enterpriseSearch | - | -| | @kbn/core-saved-objects-browser-internal, @kbn/core, savedObjects, embeddable, presentationUtil, visualizations, aiops, ml, dataVisualizer, dashboardEnhanced, graph, uptime, lens, securitySolution, eventAnnotation, @kbn/core-saved-objects-browser-mocks | - | +| | @kbn/core-saved-objects-browser-internal, @kbn/core, savedObjects, presentationUtil, visualizations, aiops, ml, dataVisualizer, dashboardEnhanced, graph, uptime, lens, securitySolution, eventAnnotation, @kbn/core-saved-objects-browser-mocks | - | | | @kbn/core, savedObjects, embeddable, visualizations, canvas, graph, ml, @kbn/core-saved-objects-common, @kbn/core-saved-objects-server, actions, alerting, savedSearch, enterpriseSearch, securitySolution, taskManager, @kbn/core-saved-objects-server-internal, @kbn/core-saved-objects-api-server | - | | | observability, @kbn/securitysolution-data-table, securitySolution | - | -| | @kbn/core-saved-objects-api-browser, @kbn/core, savedObjects, savedObjectsManagement, visualizations, savedObjectsTagging, eventAnnotation, lens, graph, dashboard, savedObjectsTaggingOss, kibanaUtils, expressions, dataViews, data, embeddable, controls, uiActionsEnhanced, cases, maps, canvas, dashboardEnhanced, globalSearchProviders, infra | - | +| | @kbn/core-saved-objects-api-browser, @kbn/core, savedObjects, savedObjectsManagement, visualizations, savedObjectsTagging, eventAnnotation, lens, graph, dashboard, savedObjectsTaggingOss, kibanaUtils, expressions, data, embeddable, controls, uiActionsEnhanced, cases, maps, canvas, dashboardEnhanced, globalSearchProviders, infra | - | +| | monitoring | - | | | 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, home, fleet, osquery, securitySolution, graph, lists, 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, home, fleet, osquery, securitySolution, graph, lists, 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, home, 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, home, fleet, graph, lists, osquery, securitySolution, alerting | - | | | alerting, discover, securitySolution | - | | | securitySolution | - | | | @kbn/securitysolution-data-table, securitySolution | - | @@ -43,11 +44,11 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | @kbn/securitysolution-data-table, securitySolution | - | | | securitySolution | - | | | securitySolution | - | -| | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, home, data, savedObjectsTagging, canvas, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-import-export-server-internal, savedObjectsTaggingOss, securitySolution, lists, upgradeAssistant, savedObjectsManagement, synthetics, @kbn/core-ui-settings-server-internal | - | -| | @kbn/core-saved-objects-migration-server-internal, actions, dataViews, data, alerting, lens, cases, savedObjectsTagging, visualizations, savedSearch, canvas, lists, securitySolution, graph, maps, dashboard, @kbn/core-test-helpers-so-type-serializer | - | -| | securitySolution, lists, @kbn/securitysolution-io-ts-list-types | - | -| | securitySolution, lists, @kbn/securitysolution-io-ts-list-types | - | -| | securitySolution, lists, @kbn/securitysolution-io-ts-list-types | - | +| | @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, synthetics, @kbn/core-ui-settings-server-internal | - | +| | @kbn/core-saved-objects-migration-server-internal, actions, dataViews, data, alerting, lens, cases, savedObjectsTagging, visualizations, savedSearch, canvas, graph, lists, maps, securitySolution, dashboard, @kbn/core-test-helpers-so-type-serializer | - | +| | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - | +| | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - | +| | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - | | | securitySolution | - | | | securitySolution | - | | | securitySolution | - | @@ -57,22 +58,21 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | securitySolution | - | | | securitySolution | - | | | securitySolution | - | -| | monitoring | - | -| | exploratoryView, dataVisualizer, fleet, cloudSecurityPosture, discoverEnhanced, osquery, synthetics | - | -| | @kbn/core-plugins-browser-internal, @kbn/core-root-browser-internal, dataViews, home, data, savedObjects, unifiedSearch, presentationUtil, visualizations, dashboard, lens, fileUpload, dashboardEnhanced, transform, discover, dataVisualizer | - | +| | exploratoryView, fleet, dataVisualizer, cloudSecurityPosture, discoverEnhanced, osquery, synthetics | - | +| | @kbn/core-plugins-browser-internal, @kbn/core-root-browser-internal, home, savedObjects, unifiedSearch, presentationUtil, visualizations, dashboard, fileUpload, dashboardEnhanced, transform, discover, dataVisualizer | - | | | @kbn/core-lifecycle-browser, @kbn/core-saved-objects-browser-internal, @kbn/core, visualizations, dashboard, exploratoryView, transform, @kbn/core-saved-objects-browser-mocks | - | | | actions, alerting | - | | | discover | - | | | data, discover, imageEmbeddable, embeddable | - | -| | @kbn/core-saved-objects-browser-mocks, dataViews, discover, @kbn/core-saved-objects-browser-internal | - | +| | @kbn/core-saved-objects-browser-mocks, discover, @kbn/core-saved-objects-browser-internal | - | | | advancedSettings, discover | - | -| | @kbn/core-saved-objects-browser, @kbn/core-saved-objects-browser-internal, @kbn/core, dataViews, home, savedObjects, visualizations, lens, visTypeTimeseries, @kbn/core-saved-objects-browser-mocks | - | +| | @kbn/core-saved-objects-browser, @kbn/core-saved-objects-browser-internal, @kbn/core, home, savedObjects, visualizations, lens, visTypeTimeseries, @kbn/core-saved-objects-browser-mocks | - | | | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, savedObjects, dashboard | - | | | @kbn/core-saved-objects-browser-mocks, home, @kbn/core-saved-objects-browser-internal | - | | | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, savedObjects, visualizations | - | | | @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-browser-internal | - | | | @kbn/core-saved-objects-browser-mocks, savedObjects, presentationUtil, dashboard, dashboardEnhanced, @kbn/core-saved-objects-browser-internal | - | -| | @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, dashboard, dashboardEnhanced, @kbn/core-saved-objects-browser-internal | - | +| | @kbn/core-saved-objects-browser-mocks, savedObjects, dashboard, dashboardEnhanced, @kbn/core-saved-objects-browser-internal | - | | | @kbn/core-saved-objects-browser-mocks, savedObjects, @kbn/core-saved-objects-browser-internal | - | | | @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-browser-internal | - | | | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, savedObjects | - | @@ -84,7 +84,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server-internal, canvas | - | | | @kbn/core-saved-objects-browser-internal, @kbn/core | - | | | @kbn/core-saved-objects-browser-internal, @kbn/core | - | -| | @kbn/core-saved-objects-browser-internal, @kbn/core, eventAnnotation | - | +| | @kbn/core-saved-objects-browser-internal, @kbn/core | - | | | @kbn/core-saved-objects-browser-internal, @kbn/core | - | | | @kbn/core-saved-objects-browser-internal, @kbn/core, spaces, savedSearch, visualizations, lens, cases, maps, canvas, graph | - | | | @kbn/core-saved-objects-browser-internal, @kbn/core | - | @@ -107,7 +107,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | dataViews, maps | - | | | dataViewManagement, dataViews | - | | | dataViews, dataViewManagement | - | -| | @kbn/core-lifecycle-browser-mocks, @kbn/core, dataViews, @kbn/core-plugins-browser-internal | - | | | spaces, savedObjectsManagement | - | | | unifiedSearch | - | | | unifiedSearch | - | @@ -133,13 +132,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | @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-elasticsearch-server-internal, @kbn/core-plugins-server-internal, console | - | | | @kbn/core-plugins-server-internal | - | -| | security, licenseManagement, ml, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher, profiling | 8.8.0 | -| | spaces, security, actions, alerting, ml, remoteClusters, osquery, securitySolution, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | 8.8.0 | -| | apm, security, securitySolution | 8.8.0 | -| | apm, security, securitySolution | 8.8.0 | +| | security, licenseManagement, ml, profiling, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 | +| | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, osquery, painlessLab, rollup, searchprofiler, securitySolution, snapshotRestore, transform, upgradeAssistant | 8.8.0 | +| | apm, fleet, security, securitySolution | 8.8.0 | +| | apm, fleet, security, securitySolution | 8.8.0 | | | spaces, security, alerting | 8.8.0 | | | embeddable, presentationUtil, dashboard, lens, discover, graph | 8.8.0 | | | @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks, management, fleet, security, kibanaOverview, @kbn/core | 8.8.0 | diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index fc10a044869ca..7a9b1443fda31 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin title: Deprecated API usage by plugin description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -343,7 +343,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [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) | - | | | [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.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/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)+ 16 more | - | +| | [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/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=convertToMultiNamespaceTypeVersion), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/saved_objects/index.ts#:~:text=convertToMultiNamespaceTypeVersion) | - | @@ -381,7 +381,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [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 | | | [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.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes)+ 44 more | - | +| | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [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)+ 54 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/index.ts#:~:text=convertToMultiNamespaceTypeVersion) | - | @@ -514,15 +514,13 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/expressions/kibana_context.test.ts#:~:text=title), [inspector_stats.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/search_source/inspect/inspector_stats.ts#:~:text=title), [response_writer.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/tabify/response_writer.ts#:~:text=title), [field.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=title), [get_display_value.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/query/filter_manager/lib/get_display_value.ts#:~:text=title), [painless_error.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/errors/painless_error.tsx#:~:text=title), [agg_config.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=title), [_terms_other_bucket_helper.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts#:~:text=title)+ 6 more | - | -| | [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/expressions/kibana_context.test.ts#:~:text=title), [inspector_stats.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/search_source/inspect/inspector_stats.ts#:~:text=title), [response_writer.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/tabify/response_writer.ts#:~:text=title), [field.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=title), [get_display_value.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/query/filter_manager/lib/get_display_value.ts#:~:text=title), [painless_error.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/errors/painless_error.tsx#:~:text=title), [agg_config.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=title), [_terms_other_bucket_helper.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts#:~:text=title)+ 6 more | - | -| | [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/expressions/kibana_context.test.ts#:~:text=title), [inspector_stats.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/search_source/inspect/inspector_stats.ts#:~:text=title), [response_writer.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/tabify/response_writer.ts#:~:text=title), [field.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=title), [get_display_value.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/query/filter_manager/lib/get_display_value.ts#:~:text=title), [painless_error.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/errors/painless_error.tsx#:~:text=title), [agg_config.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=title), [_terms_other_bucket_helper.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts#:~:text=title)+ 6 more | - | +| | [inspector_stats.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/search_source/inspect/inspector_stats.ts#:~:text=title), [response_writer.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/tabify/response_writer.ts#:~:text=title), [field.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=title), [get_display_value.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/query/filter_manager/lib/get_display_value.ts#:~:text=title), [painless_error.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/errors/painless_error.tsx#:~:text=title), [agg_config.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=title), [_terms_other_bucket_helper.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts#:~:text=title), [multi_terms.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts#:~:text=title), [multi_terms.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts#:~:text=title), [rare_terms.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts#:~:text=title)+ 3 more | - | +| | [inspector_stats.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/search_source/inspect/inspector_stats.ts#:~:text=title), [response_writer.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/tabify/response_writer.ts#:~:text=title), [field.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=title), [get_display_value.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/query/filter_manager/lib/get_display_value.ts#:~:text=title), [painless_error.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/errors/painless_error.tsx#:~:text=title), [agg_config.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=title), [_terms_other_bucket_helper.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts#:~:text=title), [multi_terms.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts#:~:text=title), [multi_terms.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts#:~:text=title), [rare_terms.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts#:~:text=title)+ 3 more | - | +| | [inspector_stats.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/search_source/inspect/inspector_stats.ts#:~:text=title), [response_writer.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/tabify/response_writer.ts#:~:text=title), [field.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=title), [get_display_value.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/query/filter_manager/lib/get_display_value.ts#:~:text=title), [painless_error.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/errors/painless_error.tsx#:~:text=title), [agg_config.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=title), [_terms_other_bucket_helper.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts#:~:text=title), [multi_terms.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts#:~:text=title), [multi_terms.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts#:~:text=title), [rare_terms.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts#:~:text=title)+ 3 more | - | | | [get_columns.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks) | - | | | [session_service.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/server/search/session/session_service.ts#:~:text=authc) | - | | | [data_table.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx#:~:text=executeTriggerActions), [data_table.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx#:~:text=executeTriggerActions) | - | -| | [kibana_context.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/expressions/kibana_context.ts#:~:text=savedObjects) | - | -| | [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/session/sessions_mgmt/lib/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/session/sessions_mgmt/lib/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/public/search/session/sessions_mgmt/lib/api.ts#:~:text=SavedObject), [search_session_migration.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/server/search/saved_objects/search_session_migration.test.ts#:~:text=SavedObject), [search_session_migration.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/server/search/saved_objects/search_session_migration.test.ts#:~:text=SavedObject), [search_session_migration.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/server/search/saved_objects/search_session_migration.test.ts#:~:text=SavedObject), [search_session_migration.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/server/search/saved_objects/search_session_migration.test.ts#:~:text=SavedObject), [search_session_migration.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/server/search/saved_objects/search_session_migration.test.ts#:~:text=SavedObject), [search_session_migration.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/server/search/saved_objects/search_session_migration.test.ts#:~:text=SavedObject), [search_session_migration.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/server/search/saved_objects/search_session_migration.test.ts#:~:text=SavedObject)+ 2 more | - | -| | [kibana_context.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/expressions/kibana_context.ts#:~:text=SavedObjectReference), [kibana_context.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/expressions/kibana_context.ts#:~:text=SavedObjectReference), [extract_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/search_source/extract_references.ts#:~:text=SavedObjectReference), [extract_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/search_source/extract_references.ts#:~:text=SavedObjectReference), [extract_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/search_source/extract_references.ts#:~:text=SavedObjectReference), [inject_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/search_source/inject_references.ts#:~:text=SavedObjectReference), [inject_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/search/search_source/inject_references.ts#:~:text=SavedObjectReference), [persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/query/filters/persistable_state.ts#:~:text=SavedObjectReference), [persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/query/filters/persistable_state.ts#:~:text=SavedObjectReference), [persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/query/filters/persistable_state.ts#:~:text=SavedObjectReference)+ 5 more | - | +| | [persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/query/filters/persistable_state.ts#:~:text=SavedObjectReference), [persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/query/filters/persistable_state.ts#:~:text=SavedObjectReference), [persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/query/filters/persistable_state.ts#:~:text=SavedObjectReference), [persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/query/persistable_state.ts#:~:text=SavedObjectReference), [persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/query/persistable_state.ts#:~:text=SavedObjectReference), [persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/common/query/persistable_state.ts#:~:text=SavedObjectReference) | - | | | [query.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data/server/saved_objects/query.ts#:~:text=convertToMultiNamespaceTypeVersion) | - | @@ -560,12 +558,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=removeScriptedField) | - | | | [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getNonScriptedFields) | - | | | [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) | - | -| | [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/public/plugin.ts#:~:text=savedObjects) | - | -| | [get_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/lib/get_title.ts#:~:text=SavedObjectsClientContract), [get_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/lib/get_title.ts#:~:text=SavedObjectsClientContract), [saved_objects_client_wrapper.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/public/saved_objects_client_wrapper.ts#:~:text=SavedObjectsClientContract), [saved_objects_client_wrapper.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/public/saved_objects_client_wrapper.ts#:~:text=SavedObjectsClientContract) | - | -| | [get_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/lib/get_title.ts#:~:text=get) | - | -| | [saved_objects_client_wrapper.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/public/saved_objects_client_wrapper.ts#:~:text=resolve) | - | -| | [saved_objects_client_wrapper.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/public/saved_objects_client_wrapper.test.ts#:~:text=savedObjectsServiceMock), [saved_objects_client_wrapper.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/public/saved_objects_client_wrapper.test.ts#:~:text=savedObjectsServiceMock) | - | -| | [load_index_pattern.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/expressions/load_index_pattern.ts#:~:text=SavedObjectReference), [load_index_pattern.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/expressions/load_index_pattern.ts#:~:text=SavedObjectReference), [persistable_state.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/persistable_state.test.ts#:~:text=SavedObjectReference), [persistable_state.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/persistable_state.test.ts#:~:text=SavedObjectReference) | - | | | [data_views.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/server/saved_objects/data_views.ts#:~:text=convertToMultiNamespaceTypeVersion) | - | @@ -613,8 +605,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | ---------------|-----------|-----------| | | [attribute_service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal), [attribute_service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | | [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [explicit_input.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/explicit_input.test.ts#:~:text=executeTriggerActions) | - | -| | [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SimpleSavedObject), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SimpleSavedObject), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SimpleSavedObject) | - | -| | [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes) | - | +| | [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes) | - | | | [migrate_base_input.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/common/lib/migrate_base_input.ts#:~:text=SavedObjectReference), [migrate_base_input.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/common/lib/migrate_base_input.ts#:~:text=SavedObjectReference), [migrate_base_input.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/common/lib/migrate_base_input.ts#:~:text=SavedObjectReference), [inject.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/common/lib/inject.ts#:~:text=SavedObjectReference), [inject.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/common/lib/inject.ts#:~:text=SavedObjectReference) | - | @@ -657,7 +648,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [group_editor_controls.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx#:~:text=title), [table_list.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/table_list.tsx#:~:text=title), [group_editor_controls.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx#:~:text=title), [table_list.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/table_list.tsx#:~:text=title) | - | | | [group_editor_controls.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx#:~:text=title), [table_list.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/table_list.tsx#:~:text=title) | - | | | [service.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/event_annotation_service/service.test.ts#:~:text=SimpleSavedObject), [service.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/event_annotation_service/service.test.ts#:~:text=SimpleSavedObject) | - | -| | [service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/event_annotation_service/service.tsx#:~:text=SavedObjectsFindOptions), [service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/event_annotation_service/service.tsx#:~:text=SavedObjectsFindOptions) | - | | | [service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/event_annotation_service/service.tsx#:~:text=SavedObjectReference), [service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/event_annotation_service/service.tsx#:~:text=SavedObjectReference), [service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/event_annotation_service/service.tsx#:~:text=SavedObjectReference) | - | @@ -711,13 +701,15 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion) | - | -| | [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion)+ 10 more | - | +| | [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion) | - | +| | [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion)+ 14 more | - | | | [query_bar.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#:~:text=title), [query_bar.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#:~:text=title) | - | | | [query_bar.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#:~:text=title), [query_bar.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#:~:text=title) | - | | | [query_bar.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#:~:text=title) | - | | | [use_get_logs_discover_link.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/multi_page_layout/hooks/use_get_logs_discover_link.tsx#:~:text=indexPatternId) | - | | | [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [tutorial_directory_header_link.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/components/home_integration/tutorial_directory_header_link.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [custom_assets_accordion.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/components/custom_assets_accordion.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [agent_logs.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx#:~:text=RedirectAppLinks), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/app.tsx#:~:text=RedirectAppLinks)+ 5 more | - | +| | [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), [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), [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 | | | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 | | | [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion) | - | @@ -793,10 +785,10 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | ---------------|-----------|-----------| | | [log_threshold_executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts#:~:text=alertFactory), [log_threshold_executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts#:~:text=alertFactory), [log_threshold_executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts#:~:text=alertFactory), [metric_threshold_executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/server/lib/alerting/metric_threshold/metric_threshold_executor.ts#:~:text=alertFactory), [inventory_metric_threshold_executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/server/lib/alerting/inventory_metric_threshold/inventory_metric_threshold_executor.ts#:~:text=alertFactory), [metric_anomaly_executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/server/lib/alerting/metric_anomaly/metric_anomaly_executor.ts#:~:text=alertFactory) | - | | | [use_kibana_index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts#:~:text=indexPatterns) | - | -| | [resolved_log_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/log_views/resolved_log_view.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [use_data_view.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_data_view.test.ts#:~:text=title), [resolved_log_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/log_views/resolved_log_view.ts#:~:text=title)+ 8 more | - | -| | [resolved_log_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/log_views/resolved_log_view.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [use_data_view.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_data_view.test.ts#:~:text=title), [resolved_log_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/log_views/resolved_log_view.ts#:~:text=title)+ 8 more | - | -| | [resolved_log_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/log_views/resolved_log_view.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [use_data_view.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_data_view.test.ts#:~:text=title) | - | -| | [log_threshold_references_manager.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_references_manager.ts#:~:text=SavedObjectReference), [log_threshold_references_manager.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_references_manager.ts#:~:text=SavedObjectReference), [log_threshold_references_manager.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_references_manager.ts#:~:text=SavedObjectReference), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/lens/utils.ts#:~:text=SavedObjectReference), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/lens/utils.ts#:~:text=SavedObjectReference), [line_chart.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/line_chart.ts#:~:text=SavedObjectReference), [line_chart.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/line_chart.ts#:~:text=SavedObjectReference), [metric_chart.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/metric_chart.ts#:~:text=SavedObjectReference), [metric_chart.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/metric_chart.ts#:~:text=SavedObjectReference), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/types.ts#:~:text=SavedObjectReference)+ 3 more | - | +| | [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [use_data_view.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_data_view.test.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title)+ 6 more | - | +| | [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [use_data_view.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_data_view.test.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title)+ 6 more | - | +| | [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [use_data_view.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_data_view.test.ts#:~:text=title) | - | +| | [log_threshold_references_manager.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_references_manager.ts#:~:text=SavedObjectReference), [log_threshold_references_manager.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_references_manager.ts#:~:text=SavedObjectReference), [log_threshold_references_manager.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_references_manager.ts#:~:text=SavedObjectReference), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/types.ts#:~:text=SavedObjectReference), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/types.ts#:~:text=SavedObjectReference), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/types.ts#:~:text=SavedObjectReference), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/lens/utils.ts#:~:text=SavedObjectReference), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/lens/utils.ts#:~:text=SavedObjectReference), [xy_chart.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/xy_chart.ts#:~:text=SavedObjectReference), [xy_chart.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/xy_chart.ts#:~:text=SavedObjectReference)+ 10 more | - | @@ -838,7 +830,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [loader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.ts#:~:text=title), [lens_top_nav.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx#:~:text=title), [loader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.ts#:~:text=title), [lens_top_nav.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx#:~:text=title) | - | | | [loader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.ts#:~:text=title), [lens_top_nav.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx#:~:text=title) | - | | | [save_action.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/visualizations/xy/annotations/actions/save_action.tsx#:~:text=SavedObjectSaveModal), [save_action.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/visualizations/xy/annotations/actions/save_action.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | -| | [form_based.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/datasources/form_based/form_based.tsx#:~:text=savedObjects), [form_based.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/datasources/form_based/form_based.tsx#:~:text=savedObjects), [visualization.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/visualizations/xy/visualization.tsx#:~:text=savedObjects), [visualization.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/visualizations/xy/visualization.tsx#:~:text=savedObjects), [visualization.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/visualizations/xy/visualization.tsx#:~:text=savedObjects) | - | | | [find_object_by_title.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/persistence/saved_objects_utils/find_object_by_title.test.ts#:~:text=SavedObjectsClientContract), [find_object_by_title.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/persistence/saved_objects_utils/find_object_by_title.test.ts#:~:text=SavedObjectsClientContract), [find_object_by_title.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/persistence/saved_objects_utils/find_object_by_title.test.ts#:~:text=SavedObjectsClientContract) | - | | | [find_object_by_title.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/persistence/saved_objects_utils/find_object_by_title.test.ts#:~:text=SimpleSavedObject), [find_object_by_title.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/persistence/saved_objects_utils/find_object_by_title.test.ts#:~:text=SimpleSavedObject) | - | | | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/types.ts#:~:text=ResolvedSimpleSavedObject) | - | @@ -874,6 +865,16 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] +## logsShared + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [resolved_log_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts#:~:text=title), [resolved_log_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts#:~:text=title) | - | +| | [resolved_log_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts#:~:text=title), [resolved_log_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts#:~:text=title) | - | +| | [resolved_log_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts#:~:text=title) | - | + + + ## logstash | Deprecated API | Reference location(s) | Remove By | @@ -949,9 +950,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/server/lib/rules/slo_burn_rate/executor.ts#:~:text=alertFactory), [threshold_executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/server/lib/rules/threshold/threshold_executor.ts#:~:text=alertFactory), [executor.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/server/lib/rules/slo_burn_rate/executor.test.ts#:~:text=alertFactory) | - | -| | [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/expression.tsx#:~:text=title), [alert_details_app_section.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/alert_details_app_section.tsx#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title)+ 2 more | - | -| | [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/expression.tsx#:~:text=title), [alert_details_app_section.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/alert_details_app_section.tsx#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title)+ 2 more | - | -| | [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/expression.tsx#:~:text=title), [alert_details_app_section.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/alert_details_app_section.tsx#:~:text=title) | - | +| | [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [threshold_rule_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx#:~:text=title), [alert_details_app_section.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/alert_details_app_section.tsx#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title)+ 2 more | - | +| | [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [threshold_rule_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx#:~:text=title), [alert_details_app_section.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/alert_details_app_section.tsx#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title)+ 2 more | - | +| | [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [threshold_rule_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx#:~:text=title), [alert_details_app_section.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/alert_details_app_section.tsx#:~:text=title) | - | | | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/application/index.tsx#:~:text=RedirectAppLinks), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/application/index.tsx#:~:text=RedirectAppLinks), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/application/index.tsx#:~:text=RedirectAppLinks) | - | | | [render_cell_value.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/alerts_table/render_cell_value.tsx#:~:text=DeprecatedCellValueElementProps), [render_cell_value.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/alerts_table/render_cell_value.tsx#:~:text=DeprecatedCellValueElementProps) | - | @@ -1094,6 +1095,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title) | - | +| | [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title) | - | +| | [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title), [kibana_context.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/common/expressions/kibana_context.test.ts#:~:text=title) | - | | | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/public/services/saved_searches/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/public/services/saved_searches/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/public/services/saved_searches/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/public/services/saved_searches/types.ts#:~:text=ResolvedSimpleSavedObject) | - | | | [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes), [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes), [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes), [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes) | - | | | [search.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search.ts#:~:text=convertToMultiNamespaceTypeVersion) | - | @@ -1141,12 +1145,12 @@ 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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion)+ 12 more | - | | | [dependencies_start_mock.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts#:~:text=indexPatterns) | - | | | [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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion), [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=migrationVersion)+ 78 more | - | -| | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=title), [use_rule_from_timeline.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_from_timeline.tsx#:~:text=title), [get_es_query_filter.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/containers/detection_engine/exceptions/get_es_query_filter.ts#:~:text=title), [alerts_sub_grouping.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/components/alerts_table/alerts_sub_grouping.tsx#:~:text=title), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/utils.ts#:~:text=title), [middleware.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/filter_group/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/components/detection_page_filters/index.tsx#:~:text=title), [get_query_filter.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_query_filter.ts#:~:text=title)+ 24 more | - | +| | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=title), [use_rule_from_timeline.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_from_timeline.tsx#:~:text=title), [get_es_query_filter.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/containers/detection_engine/exceptions/get_es_query_filter.ts#:~:text=title), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/utils.ts#:~:text=title), [middleware.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/filter_group/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/components/detection_page_filters/index.tsx#:~:text=title), [get_query_filter.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_query_filter.ts#:~:text=title), [index_pattern.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/mock/index_pattern.ts#:~:text=title)+ 22 more | - | | | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.ts#:~:text=create) | - | | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.test.ts#:~:text=fetch) | - | | | [api.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/hooks/eql/api.ts#:~:text=options) | - | -| | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=title), [use_rule_from_timeline.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_from_timeline.tsx#:~:text=title), [get_es_query_filter.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/containers/detection_engine/exceptions/get_es_query_filter.ts#:~:text=title), [alerts_sub_grouping.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/components/alerts_table/alerts_sub_grouping.tsx#:~:text=title), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/utils.ts#:~:text=title), [middleware.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/filter_group/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/components/detection_page_filters/index.tsx#:~:text=title), [get_query_filter.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_query_filter.ts#:~:text=title)+ 24 more | - | -| | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=title), [use_rule_from_timeline.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_from_timeline.tsx#:~:text=title), [get_es_query_filter.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/containers/detection_engine/exceptions/get_es_query_filter.ts#:~:text=title), [alerts_sub_grouping.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/components/alerts_table/alerts_sub_grouping.tsx#:~:text=title), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/utils.ts#:~:text=title), [middleware.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/filter_group/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/components/detection_page_filters/index.tsx#:~:text=title), [get_query_filter.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_query_filter.ts#:~:text=title)+ 7 more | - | +| | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=title), [use_rule_from_timeline.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_from_timeline.tsx#:~:text=title), [get_es_query_filter.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/containers/detection_engine/exceptions/get_es_query_filter.ts#:~:text=title), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/utils.ts#:~:text=title), [middleware.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/filter_group/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/components/detection_page_filters/index.tsx#:~:text=title), [get_query_filter.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_query_filter.ts#:~:text=title), [index_pattern.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/mock/index_pattern.ts#:~:text=title)+ 22 more | - | +| | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=title), [use_rule_from_timeline.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_rule_from_timeline.tsx#:~:text=title), [get_es_query_filter.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/containers/detection_engine/exceptions/get_es_query_filter.ts#:~:text=title), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/utils.ts#:~:text=title), [middleware.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/filter_group/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/detections/components/detection_page_filters/index.tsx#:~:text=title), [get_query_filter.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_query_filter.ts#:~:text=title), [index_pattern.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/mock/index_pattern.ts#:~:text=title)+ 6 more | - | | | [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 | | | [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 | | | [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) | 8.8.0 | @@ -1154,7 +1158,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | | [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) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#:~:text=BrowserField), [helpers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/drag_and_drop/helpers.ts#:~:text=BrowserField), [helpers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/drag_and_drop/helpers.ts#:~:text=BrowserField), [helpers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/drag_and_drop/helpers.ts#:~:text=BrowserField), [helpers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/drag_and_drop/helpers.ts#:~:text=BrowserField), [columns.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/event_details/columns.tsx#:~:text=BrowserField), [columns.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/event_details/columns.tsx#:~:text=BrowserField), [enrichment_summary.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/enrichment_summary.tsx#:~:text=BrowserField), [enrichment_summary.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/enrichment_summary.tsx#:~:text=BrowserField), [use_data_view.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/use_data_view.tsx#:~:text=BrowserField)+ 31 more | - | +| | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#:~:text=BrowserField), [helpers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/drag_and_drop/helpers.ts#:~:text=BrowserField), [helpers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/drag_and_drop/helpers.ts#:~:text=BrowserField), [helpers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/drag_and_drop/helpers.ts#:~:text=BrowserField), [helpers.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/drag_and_drop/helpers.ts#:~:text=BrowserField), [columns.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/event_details/columns.tsx#:~:text=BrowserField), [columns.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/event_details/columns.tsx#:~:text=BrowserField), [enrichment_summary.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/enrichment_summary.tsx#:~:text=BrowserField), [enrichment_summary.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/event_details/cti_details/enrichment_summary.tsx#:~:text=BrowserField), [use_data_view.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/containers/source/use_data_view.tsx#:~:text=BrowserField)+ 29 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#:~:text=BrowserFields), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/types/timeline/cells/index.ts#:~:text=BrowserFields), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/types/timeline/cells/index.ts#:~:text=BrowserFields), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/types/header_actions/index.ts#:~:text=BrowserFields), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/types/header_actions/index.ts#:~:text=BrowserFields), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/types/header_actions/index.ts#:~:text=BrowserFields), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/lib/kuery/index.ts#:~:text=BrowserFields), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/lib/kuery/index.ts#:~:text=BrowserFields), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/lib/kuery/index.ts#:~:text=BrowserFields), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/lib/kuery/index.ts#:~:text=BrowserFields)+ 104 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#:~:text=IndexFieldsStrategyRequest), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/search_strategy/endpoint_fields/index.ts#:~:text=IndexFieldsStrategyRequest), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/search_strategy/endpoint_fields/index.ts#:~:text=IndexFieldsStrategyRequest), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/search_strategy/endpoint_fields/index.ts#:~:text=IndexFieldsStrategyRequest), [middleware.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=IndexFieldsStrategyRequest), [middleware.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=IndexFieldsStrategyRequest) | - | | | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#:~:text=IndexFieldsStrategyResponse), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/search_strategy/endpoint_fields/index.ts#:~:text=IndexFieldsStrategyResponse), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/search_strategy/endpoint_fields/index.ts#:~:text=IndexFieldsStrategyResponse), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/search_strategy/endpoint_fields/index.ts#:~:text=IndexFieldsStrategyResponse), [middleware.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=IndexFieldsStrategyResponse), [middleware.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=IndexFieldsStrategyResponse) | - | @@ -1216,10 +1220,10 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [message_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/server/alert_rules/tls_rule/message_utils.ts#:~:text=alertFactory), [common.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/server/alert_rules/common.ts#:~:text=alertFactory), [tls_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/server/alert_rules/tls_rule/tls_rule.ts#:~:text=alertFactory), [monitor_status_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/server/alert_rules/status_rule/monitor_status_rule.ts#:~:text=alertFactory) | - | +| | [common.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/server/alert_rules/common.ts#:~:text=alertFactory), [message_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/server/alert_rules/tls_rule/message_utils.ts#:~:text=alertFactory), [tls_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/server/alert_rules/tls_rule/tls_rule.ts#:~:text=alertFactory), [monitor_status_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/server/alert_rules/status_rule/monitor_status_rule.ts#:~:text=alertFactory) | - | | | [stderr_logs.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/components/common/components/stderr_logs.tsx#:~:text=indexPatternId) | - | | | [synthetics_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=RedirectAppLinks), [synthetics_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=RedirectAppLinks), [synthetics_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=RedirectAppLinks) | - | -| | [actions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/actions.ts#:~:text=SavedObject), [actions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/actions.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/api.ts#:~:text=SavedObject), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/index.ts#:~:text=SavedObject), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/index.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/api.ts#:~:text=SavedObject), [effects.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/effects.ts#:~:text=SavedObject)+ 1 more | - | +| | [api.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/api.ts#:~:text=SavedObject), [effects.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/effects.ts#:~:text=SavedObject), [effects.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/effects.ts#:~:text=SavedObject) | - | diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index ed9272a818d87..9e591b1549daf 100644 --- a/api_docs/deprecations_by_team.mdx +++ b/api_docs/deprecations_by_team.mdx @@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam slug: /kibana-dev-docs/api-meta/deprecations-due-by-team title: Deprecated APIs due to be removed, by team description: Lists the teams that are referencing deprecated APIs with a remove by date. -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -36,6 +36,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| +| fleet | | [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), [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 | +| fleet | | [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), [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 | | fleet | | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 | diff --git a/api_docs/dev_tools.devdocs.json b/api_docs/dev_tools.devdocs.json index f91298e51f8e0..624340d7d5db6 100644 --- a/api_docs/dev_tools.devdocs.json +++ b/api_docs/dev_tools.devdocs.json @@ -39,6 +39,47 @@ "deprecated": false, "trackAdoption": false, "children": [ + { + "parentPluginId": "devTools", + "id": "def-public.DevToolsPlugin.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/dev_tools/public/plugin.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "devTools", + "id": "def-public.DevToolsPlugin.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "initializerContext", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-plugins-browser", + "scope": "common", + "docId": "kibKbnCorePluginsBrowserPluginApi", + "section": "def-common.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "<", + "ConfigSchema", + ">" + ], + "path": "src/plugins/dev_tools/public/plugin.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "devTools", "id": "def-public.DevToolsPlugin.setup", diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index 28a1d98a08541..eee0640d021d8 100644 --- a/api_docs/dev_tools.mdx +++ b/api_docs/dev_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools title: "devTools" image: https://source.unsplash.com/400x175/?github description: API docs for the devTools plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] --- import devToolsObj from './dev_tools.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/platform-deployment-management](https://github.com/orgs/elasti | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 10 | 0 | 8 | 2 | +| 12 | 0 | 10 | 3 | ## Client diff --git a/api_docs/discover.devdocs.json b/api_docs/discover.devdocs.json index f8b77f6000a6b..23266058834e4 100644 --- a/api_docs/discover.devdocs.json +++ b/api_docs/discover.devdocs.json @@ -1196,6 +1196,10 @@ "plugin": "exploratoryView", "path": "x-pack/plugins/exploratory_view/public/components/shared/exploratory_view/hooks/use_discover_link.tsx" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/multi_page_layout/hooks/use_get_logs_discover_link.tsx" + }, { "plugin": "dataVisualizer", "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx" @@ -1204,10 +1208,6 @@ "plugin": "dataVisualizer", "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx" }, - { - "plugin": "fleet", - "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/multi_page_layout/hooks/use_get_logs_discover_link.tsx" - }, { "plugin": "cloudSecurityPosture", "path": "x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/overview_tab.tsx" diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index eaa7e9dc5f378..f2d2a26a7264e 100644 --- a/api_docs/discover.mdx +++ b/api_docs/discover.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover title: "discover" image: https://source.unsplash.com/400x175/?github description: API docs for the discover plugin -date: 2023-06-30 +date: 2023-07-18 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 df3a1d0c882f6..56b69bf1d9a2a 100644 --- a/api_docs/discover_enhanced.mdx +++ b/api_docs/discover_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced title: "discoverEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the discoverEnhanced plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] --- import discoverEnhancedObj from './discover_enhanced.devdocs.json'; diff --git a/api_docs/ecs_data_quality_dashboard.mdx b/api_docs/ecs_data_quality_dashboard.mdx index ba0c81fe3d532..52b7806f5b047 100644 --- a/api_docs/ecs_data_quality_dashboard.mdx +++ b/api_docs/ecs_data_quality_dashboard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ecsDataQualityDashboard title: "ecsDataQualityDashboard" image: https://source.unsplash.com/400x175/?github description: API docs for the ecsDataQualityDashboard plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard'] --- import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json'; diff --git a/api_docs/embeddable.devdocs.json b/api_docs/embeddable.devdocs.json index 0c37b31929ff6..a3efb8ed05233 100644 --- a/api_docs/embeddable.devdocs.json +++ b/api_docs/embeddable.devdocs.json @@ -4,64 +4,28 @@ "classes": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction", + "id": "def-public.AttributeService", "type": "Class", "tags": [], - "label": "AddPanelAction", + "label": "AttributeService", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.AddPanelAction", - "text": "AddPanelAction" - }, - " implements ", - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.Action", - "text": "Action" + "section": "def-public.AttributeService", + "text": "AttributeService" }, - "" + "" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"ACTION_ADD_PANEL\"" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "\"ACTION_ADD_PANEL\"" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed", + "id": "def-public.AttributeService.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -69,90 +33,71 @@ "signature": [ "any" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$1", - "type": "Function", + "id": "def-public.AttributeService.Unnamed.$1", + "type": "string", "tags": [], - "label": "getFactory", + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.AttributeService.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "toasts", "description": [], "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ">(embeddableFactoryId: string) => ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" - }, - " | undefined" + "docId": "kibKbnCoreNotificationsBrowserPluginApi", + "section": "def-common.IToasts", + "text": "IToasts" + } + ], + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.AttributeService.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "AttributeServiceOptions", + "" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$2", + "id": "def-public.AttributeService.Unnamed.$4", "type": "Function", "tags": [], - "label": "getAllFactories", + "label": "getEmbeddableFactory", "description": [], "signature": [ - "() => IterableIterator<", + "((embeddableFactoryId: string) => ", { "pluginId": "embeddable", "scope": "public", @@ -200,102 +145,105 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ", any>, unknown>>" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$3", - "type": "Object", - "tags": [], - "label": "overlays", - "description": [], - "signature": [ - { - "pluginId": "@kbn/core-overlays-browser", - "scope": "common", - "docId": "kibKbnCoreOverlaysBrowserPluginApi", - "section": "def-common.OverlayStart", - "text": "OverlayStart" - } + ", any>, unknown>) | undefined" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, - "isRequired": true - }, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.AttributeService.unwrapAttributes", + "type": "Function", + "tags": [], + "label": "unwrapAttributes", + "description": [], + "signature": [ + "(input: ValType | RefType) => Promise<", + "AttributeServiceUnwrapResult", + ">" + ], + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$4", - "type": "Object", + "id": "def-public.AttributeService.unwrapAttributes.$1", + "type": "CompoundType", "tags": [], - "label": "notifications", + "label": "input", "description": [], "signature": [ - { - "pluginId": "@kbn/core-notifications-browser", - "scope": "common", - "docId": "kibKbnCoreNotificationsBrowserPluginApi", - "section": "def-common.NotificationsStart", - "text": "NotificationsStart" - } + "ValType | RefType" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.AttributeService.wrapAttributes", + "type": "Function", + "tags": [], + "label": "wrapAttributes", + "description": [], + "signature": [ + "(newAttributes: SavedObjectAttributes, useRefType: boolean, input?: ValType | RefType | undefined) => Promise>" + ], + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$5", - "type": "CompoundType", + "id": "def-public.AttributeService.wrapAttributes.$1", + "type": "Uncategorized", "tags": [], - "label": "SavedObjectFinder", + "label": "newAttributes", "description": [], "signature": [ - "React.ComponentType" + "SavedObjectAttributes" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$6", - "type": "Object", + "id": "def-public.AttributeService.wrapAttributes.$2", + "type": "boolean", "tags": [], - "label": "theme", + "label": "useRefType", "description": [], "signature": [ - { - "pluginId": "@kbn/core-theme-browser", - "scope": "common", - "docId": "kibKbnCoreThemeBrowserPluginApi", - "section": "def-common.ThemeServiceStart", - "text": "ThemeServiceStart" - } + "boolean" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$7", - "type": "Function", + "id": "def-public.AttributeService.wrapAttributes.$3", + "type": "CompoundType", "tags": [], - "label": "reportUiCounter", + "label": "input", "description": [], "signature": [ - "((appName: string, type: string, eventNames: string | string[], count?: number | undefined) => void) | undefined" + "ValType | RefType | undefined" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -305,76 +253,61 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.getDisplayName", + "id": "def-public.AttributeService.inputIsRefType", "type": "Function", "tags": [], - "label": "getDisplayName", + "label": "inputIsRefType", "description": [], "signature": [ - "() => any" + "(input: ValType | RefType) => input is RefType" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.getIconType", - "type": "Function", - "tags": [], - "label": "getIconType", - "description": [], - "signature": [ - "() => string" + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.AttributeService.inputIsRefType.$1", + "type": "CompoundType", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "ValType | RefType" + ], + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.isCompatible", + "id": "def-public.AttributeService.getInputAsValueType", "type": "Function", "tags": [], - "label": "isCompatible", + "label": "getInputAsValueType", "description": [], "signature": [ - "(context: ", - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionExecutionContext", - "text": "ActionExecutionContext" - }, - ") => Promise" + "(input: ValType | RefType) => Promise" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.isCompatible.$1", + "id": "def-public.AttributeService.getInputAsValueType.$1", "type": "CompoundType", "tags": [], - "label": "context", + "label": "input", "description": [], "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionExecutionContext", - "text": "ActionExecutionContext" - }, - "" + "ValType | RefType" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -384,47 +317,47 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.execute", + "id": "def-public.AttributeService.getInputAsRefType", "type": "Function", "tags": [], - "label": "execute", + "label": "getInputAsRefType", "description": [], "signature": [ - "(context: ", - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionExecutionContext", - "text": "ActionExecutionContext" - }, - ") => Promise" + "(input: ValType | RefType, saveOptions?: { showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined) => Promise" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.execute.$1", + "id": "def-public.AttributeService.getInputAsRefType.$1", "type": "CompoundType", "tags": [], - "label": "context", + "label": "input", "description": [], "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionExecutionContext", - "text": "ActionExecutionContext" - }, - "" + "ValType | RefType" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.AttributeService.getInputAsRefType.$2", + "type": "CompoundType", + "tags": [], + "label": "saveOptions", + "description": [], + "signature": [ + "{ showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined" + ], + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": false } ], "returnComment": [] @@ -434,28 +367,67 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService", + "id": "def-public.Container", "type": "Class", "tags": [], - "label": "AttributeService", + "label": "Container", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.AttributeService", - "text": "AttributeService" + "section": "def-public.Container", + "text": "Container" }, - "" + " extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" + }, + " implements ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.Unnamed", + "id": "def-public.Container.isContainer", + "type": "boolean", + "tags": [], + "label": "isContainer", + "description": [], + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Container.children", + "type": "Object", + "tags": [], + "label": "children", + "description": [], + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "deprecated": false, + "trackAdoption": false, + "children": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Container.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -463,79 +435,57 @@ "signature": [ "any" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.Unnamed.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.Unnamed.$2", - "type": "Object", + "id": "def-public.Container.Unnamed.$1", + "type": "Uncategorized", "tags": [], - "label": "toasts", + "label": "input", "description": [], "signature": [ - { - "pluginId": "@kbn/core-notifications-browser", - "scope": "common", - "docId": "kibKbnCoreNotificationsBrowserPluginApi", - "section": "def-common.IToasts", - "text": "IToasts" - } + "TContainerInput" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.Unnamed.$3", - "type": "Object", + "id": "def-public.Container.Unnamed.$2", + "type": "Uncategorized", "tags": [], - "label": "options", + "label": "output", "description": [], "signature": [ - "AttributeServiceOptions", - "" + "TContainerOutput" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.Unnamed.$4", + "id": "def-public.Container.Unnamed.$3", "type": "Function", "tags": [], - "label": "getEmbeddableFactory", + "label": "getFactory", "description": [], "signature": [ - "((embeddableFactoryId: string) => ", + " = ", { "pluginId": "embeddable", - "scope": "common", + "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" }, - ", ", + ">(embeddableFactoryId: string) => ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" }, - ", any>, unknown>) | undefined" + " | undefined" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.unwrapAttributes", - "type": "Function", - "tags": [], - "label": "unwrapAttributes", - "description": [], - "signature": [ - "(input: ValType | RefType) => Promise<", - "AttributeServiceUnwrapResult", - ">" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ + "isRequired": true + }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.unwrapAttributes.$1", - "type": "CompoundType", + "id": "def-public.Container.Unnamed.$4", + "type": "Object", "tags": [], - "label": "input", + "label": "parent", "description": [], "signature": [ - "ValType | RefType" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.wrapAttributes", - "type": "Function", - "tags": [], - "label": "wrapAttributes", - "description": [], - "signature": [ - "(newAttributes: SavedObjectAttributes, useRefType: boolean, input?: ValType | RefType | undefined) => Promise>" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.wrapAttributes.$1", - "type": "Uncategorized", - "tags": [], - "label": "newAttributes", - "description": [], - "signature": [ - "SavedObjectAttributes" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.wrapAttributes.$2", - "type": "boolean", - "tags": [], - "label": "useRefType", - "description": [], - "signature": [ - "boolean" + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + "> | undefined" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.wrapAttributes.$3", - "type": "CompoundType", + "id": "def-public.Container.Unnamed.$5", + "type": "Object", "tags": [], - "label": "input", + "label": "settings", "description": [], "signature": [ - "ValType | RefType | undefined" + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableContainerSettings", + "text": "EmbeddableContainerSettings" + }, + " | undefined" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -683,61 +605,76 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.inputIsRefType", + "id": "def-public.Container.setChildLoaded", "type": "Function", "tags": [], - "label": "inputIsRefType", + "label": "setChildLoaded", "description": [], "signature": [ - "(input: ValType | RefType) => input is RefType" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ + "(embeddable: ", { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.inputIsRefType.$1", - "type": "CompoundType", - "tags": [], - "label": "input", - "description": [], - "signature": [ - "ValType | RefType" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.getInputAsValueType", - "type": "Function", - "tags": [], - "label": "getInputAsValueType", - "description": [], - "signature": [ - "(input: ValType | RefType) => Promise" + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", any>) => void" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.getInputAsValueType.$1", - "type": "CompoundType", + "id": "def-public.Container.setChildLoaded.$1", + "type": "Object", "tags": [], - "label": "input", + "label": "embeddable", "description": [], "signature": [ - "ValType | RefType" + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", any>" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -747,123 +684,148 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.getInputAsRefType", + "id": "def-public.Container.updateInputForChild", "type": "Function", "tags": [], - "label": "getInputAsRefType", + "label": "updateInputForChild", "description": [], "signature": [ - "(input: ValType | RefType, saveOptions?: { showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined) => Promise" + "(id: string, changes: Partial) => void" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.getInputAsRefType.$1", - "type": "CompoundType", + "id": "def-public.Container.updateInputForChild.$1", + "type": "string", "tags": [], - "label": "input", + "label": "id", "description": [], "signature": [ - "ValType | RefType" + "string" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.getInputAsRefType.$2", - "type": "CompoundType", + "id": "def-public.Container.updateInputForChild.$2", + "type": "Object", "tags": [], - "label": "saveOptions", + "label": "changes", "description": [], "signature": [ - "{ showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined" + "Partial" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container", - "type": "Class", - "tags": [], - "label": "Container", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.Container", - "text": "Container" }, - " extends ", { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.Embeddable", - "text": "Embeddable" - }, - " implements ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Container.isContainer", - "type": "boolean", - "tags": [], - "label": "isContainer", - "description": [], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.children", - "type": "Object", - "tags": [], - "label": "children", - "description": [], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [] + "parentPluginId": "embeddable", + "id": "def-public.Container.reload", + "type": "Function", + "tags": [], + "label": "reload", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Container.Unnamed", + "id": "def-public.Container.addNewEmbeddable", "type": "Function", "tags": [], - "label": "Constructor", + "label": "addNewEmbeddable", "description": [], "signature": [ - "any" + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(type: string, explicitInput: Partial) => Promise<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" + }, + " | E>" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -871,13 +833,13 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Container.Unnamed.$1", - "type": "Uncategorized", + "id": "def-public.Container.addNewEmbeddable.$1", + "type": "string", "tags": [], - "label": "input", + "label": "type", "description": [], "signature": [ - "TContainerInput" + "string" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -886,84 +848,93 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Container.Unnamed.$2", - "type": "Uncategorized", + "id": "def-public.Container.addNewEmbeddable.$2", + "type": "Object", "tags": [], - "label": "output", + "label": "explicitInput", "description": [], "signature": [ - "TContainerOutput" + "Partial" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Container.replaceEmbeddable", + "type": "Function", + "tags": [], + "label": "replaceEmbeddable", + "description": [], + "signature": [ + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" }, + ">(id: string, newExplicitInput: Partial, newType?: string | undefined) => Promise" + ], + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Container.Unnamed.$3", - "type": "Function", + "id": "def-public.Container.replaceEmbeddable.$1", + "type": "string", "tags": [], - "label": "getFactory", + "label": "id", "description": [], "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ">(embeddableFactoryId: string) => ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" - }, - " | undefined" + "string" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -972,58 +943,28 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Container.Unnamed.$4", + "id": "def-public.Container.replaceEmbeddable.$2", "type": "Object", "tags": [], - "label": "parent", + "label": "newExplicitInput", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - "> | undefined" + "Partial" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, - "isRequired": false + "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.Container.Unnamed.$5", - "type": "Object", + "id": "def-public.Container.replaceEmbeddable.$3", + "type": "string", "tags": [], - "label": "settings", + "label": "newType", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableContainerSettings", - "text": "EmbeddableContainerSettings" - }, - " | undefined" + "string | undefined" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1035,37 +976,13 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Container.setChildLoaded", + "id": "def-public.Container.removeEmbeddable", "type": "Function", "tags": [], - "label": "setChildLoaded", + "label": "removeEmbeddable", "description": [], "signature": [ - "(embeddable: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>) => void" + "(embeddableId: string) => void" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1073,36 +990,13 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Container.setChildLoaded.$1", - "type": "Object", + "id": "def-public.Container.removeEmbeddable.$1", + "type": "string", "tags": [], - "label": "embeddable", + "label": "embeddableId", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>" + "string" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1114,21 +1008,23 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Container.updateInputForChild", + "id": "def-public.Container.onRemoveEmbeddable", "type": "Function", "tags": [], - "label": "updateInputForChild", - "description": [], + "label": "onRemoveEmbeddable", + "description": [ + "\nControl the panels that are pushed to the input stream when an embeddable is\nremoved. This can be used if removing one embeddable has knock-on effects, like\nre-ordering embeddables that come after it." + ], "signature": [ - " { [key: string]: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "section": "def-common.PanelState", + "text": "PanelState" }, - " = ", + "<", { "pluginId": "embeddable", "scope": "common", @@ -1136,7 +1032,7 @@ "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, - ">(id: string, changes: Partial) => void" + " & { id: string; }>; }" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1144,10 +1040,10 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Container.updateInputForChild.$1", + "id": "def-public.Container.onRemoveEmbeddable.$1", "type": "string", "tags": [], - "label": "id", + "label": "embeddableId", "description": [], "signature": [ "string" @@ -1156,34 +1052,19 @@ "deprecated": false, "trackAdoption": false, "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.updateInputForChild.$2", - "type": "Object", - "tags": [], - "label": "changes", - "description": [], - "signature": [ - "Partial" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Container.reload", + "id": "def-public.Container.getChildIds", "type": "Function", "tags": [], - "label": "reload", + "label": "getChildIds", "description": [], "signature": [ - "() => void" + "() => string[]" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1193,21 +1074,21 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Container.addNewEmbeddable", + "id": "def-public.Container.getChild", "type": "Function", "tags": [], - "label": "addNewEmbeddable", + "label": "getChild", "description": [], "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ">(type: string, explicitInput: Partial) => Promise<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ErrorEmbeddable", - "text": "ErrorEmbeddable" - }, - " | E>" + ", any>>(id: string) => E" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1263,10 +1112,10 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Container.addNewEmbeddable.$1", + "id": "def-public.Container.getChild.$1", "type": "string", "tags": [], - "label": "type", + "label": "id", "description": [], "signature": [ "string" @@ -1275,34 +1124,19 @@ "deprecated": false, "trackAdoption": false, "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.addNewEmbeddable.$2", - "type": "Object", - "tags": [], - "label": "explicitInput", - "description": [], - "signature": [ - "Partial" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Container.replaceEmbeddable", + "id": "def-public.Container.getInputForChild", "type": "Function", "tags": [], - "label": "replaceEmbeddable", + "label": "getInputForChild", "description": [], "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ">(id: string, newExplicitInput: Partial, newType?: string | undefined) => Promise" + ">(embeddableId: string) => TEmbeddableInput" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1358,242 +1160,10 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Container.replaceEmbeddable.$1", + "id": "def-public.Container.getInputForChild.$1", "type": "string", "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.replaceEmbeddable.$2", - "type": "Object", - "tags": [], - "label": "newExplicitInput", - "description": [], - "signature": [ - "Partial" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.replaceEmbeddable.$3", - "type": "string", - "tags": [], - "label": "newType", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.removeEmbeddable", - "type": "Function", - "tags": [], - "label": "removeEmbeddable", - "description": [], - "signature": [ - "(embeddableId: string) => void" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Container.removeEmbeddable.$1", - "type": "string", - "tags": [], - "label": "embeddableId", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.onRemoveEmbeddable", - "type": "Function", - "tags": [], - "label": "onRemoveEmbeddable", - "description": [ - "\nControl the panels that are pushed to the input stream when an embeddable is\nremoved. This can be used if removing one embeddable has knock-on effects, like\nre-ordering embeddables that come after it." - ], - "signature": [ - "(embeddableId: string) => { [key: string]: ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.PanelState", - "text": "PanelState" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - " & { id: string; }>; }" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Container.onRemoveEmbeddable.$1", - "type": "string", - "tags": [], - "label": "embeddableId", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.getChildIds", - "type": "Function", - "tags": [], - "label": "getChildIds", - "description": [], - "signature": [ - "() => string[]" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.getChild", - "type": "Function", - "tags": [], - "label": "getChild", - "description": [], - "signature": [ - ">(id: string) => E" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Container.getChild.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.getInputForChild", - "type": "Function", - "tags": [], - "label": "getInputForChild", - "description": [], - "signature": [ - "(embeddableId: string) => TEmbeddableInput" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Container.getInputForChild.$1", - "type": "string", - "tags": [], - "label": "embeddableId", + "label": "embeddableId", "description": [], "signature": [ "string" @@ -2035,18 +1605,18 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction", + "id": "def-public.CustomizePanelAction", "type": "Class", "tags": [], - "label": "EditPanelAction", + "label": "CustomizePanelAction", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EditPanelAction", - "text": "EditPanelAction" + "section": "def-public.CustomizePanelAction", + "text": "CustomizePanelAction" }, " implements ", { @@ -2056,204 +1626,130 @@ "section": "def-public.Action", "text": "Action" }, - "" + "<", + "CustomizePanelActionContext", + ">" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.type", + "id": "def-public.CustomizePanelAction.type", "type": "string", "tags": [], "label": "type", "description": [], - "signature": [ - "\"editPanel\"" - ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.id", + "id": "def-public.CustomizePanelAction.id", "type": "string", "tags": [], "label": "id", "description": [], - "signature": [ - "\"editPanel\"" - ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.order", + "id": "def-public.CustomizePanelAction.order", "type": "number", "tags": [], "label": "order", "description": [], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.currentAppId", - "type": "string", + "id": "def-public.CustomizePanelAction.Unnamed", + "type": "Function", "tags": [], - "label": "currentAppId", + "label": "Constructor", "description": [], "signature": [ - "string | undefined" + "any" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.Unnamed.$1", - "type": "Function", + "id": "def-public.CustomizePanelAction.Unnamed.$1", + "type": "Object", "tags": [], - "label": "getEmbeddableFactory", + "label": "overlays", "description": [], "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ">(embeddableFactoryId: string) => ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" - }, - " | undefined" + "docId": "kibKbnCoreOverlaysBrowserPluginApi", + "section": "def-common.OverlayStart", + "text": "OverlayStart" + } ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.Unnamed.$2", + "id": "def-public.CustomizePanelAction.Unnamed.$2", "type": "Object", "tags": [], - "label": "application", + "label": "theme", "description": [], "signature": [ { - "pluginId": "@kbn/core-application-browser", + "pluginId": "@kbn/core-theme-browser", "scope": "common", - "docId": "kibKbnCoreApplicationBrowserPluginApi", - "section": "def-common.ApplicationStart", - "text": "ApplicationStart" + "docId": "kibKbnCoreThemeBrowserPluginApi", + "section": "def-common.ThemeServiceStart", + "text": "ThemeServiceStart" } ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.Unnamed.$3", - "type": "Object", + "id": "def-public.CustomizePanelAction.Unnamed.$3", + "type": "Array", "tags": [], - "label": "stateTransfer", + "label": "commonlyUsedRanges", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableStateTransfer", - "text": "EmbeddableStateTransfer" - }, - " | undefined" + "CommonlyUsedRange", + "[] | undefined" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.Unnamed.$4", - "type": "Function", + "id": "def-public.CustomizePanelAction.Unnamed.$4", + "type": "string", "tags": [], - "label": "getOriginatingPath", + "label": "dateFormat", "description": [], "signature": [ - "(() => string) | undefined" + "string | undefined" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -2263,29 +1759,31 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getDisplayName", + "id": "def-public.CustomizePanelAction.isTimeRangeCompatible", "type": "Function", "tags": [], - "label": "getDisplayName", + "label": "isTimeRangeCompatible", "description": [], "signature": [ - "({ embeddable }: ActionContext) => any" + "({ embeddable }: ", + "CustomizePanelActionContext", + ") => boolean" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getDisplayName.$1", + "id": "def-public.CustomizePanelAction.isTimeRangeCompatible.$1", "type": "Object", "tags": [], "label": "{ embeddable }", "description": [], "signature": [ - "ActionContext" + "CustomizePanelActionContext" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -2295,45 +1793,31 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getIconType", - "type": "Function", - "tags": [], - "label": "getIconType", - "description": [], - "signature": [ - "() => string" - ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.isCompatible", + "id": "def-public.CustomizePanelAction.getDisplayName", "type": "Function", "tags": [], - "label": "isCompatible", + "label": "getDisplayName", "description": [], "signature": [ - "({ embeddable }: ActionContext) => Promise" + "({ embeddable }: ", + "CustomizePanelActionContext", + ") => string" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.isCompatible.$1", + "id": "def-public.CustomizePanelAction.getDisplayName.$1", "type": "Object", "tags": [], "label": "{ embeddable }", "description": [], "signature": [ - "ActionContext" + "CustomizePanelActionContext" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -2343,61 +1827,47 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.execute", + "id": "def-public.CustomizePanelAction.getIconType", "type": "Function", "tags": [], - "label": "execute", + "label": "getIconType", "description": [], "signature": [ - "(context: ActionContext) => Promise" + "() => string" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.execute.$1", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "ActionContext" - ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getAppTarget", + "id": "def-public.CustomizePanelAction.isCompatible", "type": "Function", "tags": [], - "label": "getAppTarget", + "label": "isCompatible", "description": [], "signature": [ - "({ embeddable }: ActionContext) => NavigationContext | undefined" + "({ embeddable }: ", + "CustomizePanelActionContext", + ") => Promise" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getAppTarget.$1", + "id": "def-public.CustomizePanelAction.isCompatible.$1", "type": "Object", "tags": [], "label": "{ embeddable }", "description": [], "signature": [ - "ActionContext" + "CustomizePanelActionContext" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -2407,29 +1877,31 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getHref", + "id": "def-public.CustomizePanelAction.execute", "type": "Function", "tags": [], - "label": "getHref", + "label": "execute", "description": [], "signature": [ - "({ embeddable }: ActionContext) => Promise" + "({ embeddable }: ", + "CustomizePanelActionContext", + ") => Promise" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getHref.$1", + "id": "def-public.CustomizePanelAction.execute.$1", "type": "Object", "tags": [], "label": "{ embeddable }", "description": [], "signature": [ - "ActionContext" + "CustomizePanelActionContext" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -2442,287 +1914,225 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable", + "id": "def-public.EditPanelAction", "type": "Class", "tags": [], - "label": "Embeddable", + "label": "EditPanelAction", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.Embeddable", - "text": "Embeddable" + "section": "def-public.EditPanelAction", + "text": "EditPanelAction" }, - " implements ", + " implements ", { - "pluginId": "embeddable", + "pluginId": "uiActions", "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" }, - "" + "" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.runtimeId", - "type": "number", - "tags": [], - "label": "runtimeId", - "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.runtimeId", - "type": "number", + "id": "def-public.EditPanelAction.type", + "type": "string", "tags": [], - "label": "runtimeId", + "label": "type", "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "signature": [ + "\"editPanel\"" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.parent", - "type": "Object", + "id": "def-public.EditPanelAction.id", + "type": "string", "tags": [], - "label": "parent", + "label": "id", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - "> | undefined" + "\"editPanel\"" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.isContainer", - "type": "boolean", + "id": "def-public.EditPanelAction.order", + "type": "number", "tags": [], - "label": "isContainer", + "label": "order", "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.deferEmbeddableLoad", - "type": "boolean", + "id": "def-public.EditPanelAction.currentAppId", + "type": "string", "tags": [], - "label": "deferEmbeddableLoad", + "label": "currentAppId", "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "signature": [ + "string | undefined" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.fatalError", - "type": "Object", - "tags": [], - "label": "fatalError", - "description": [], - "signature": [ - "Error | undefined" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.output", - "type": "Uncategorized", - "tags": [], - "label": "output", - "description": [], - "signature": [ - "TEmbeddableOutput" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.input", - "type": "Uncategorized", - "tags": [], - "label": "input", - "description": [], - "signature": [ - "TEmbeddableInput" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.renderComplete", - "type": "Object", - "tags": [], - "label": "renderComplete", - "description": [], - "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "public", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-public.RenderCompleteDispatcher", - "text": "RenderCompleteDispatcher" - } - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.destroyed", - "type": "boolean", - "tags": [], - "label": "destroyed", - "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.Unnamed", - "type": "Function", + "id": "def-public.EditPanelAction.Unnamed", + "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.Unnamed.$1", - "type": "Uncategorized", + "id": "def-public.EditPanelAction.Unnamed.$1", + "type": "Function", "tags": [], - "label": "input", + "label": "getEmbeddableFactory", "description": [], "signature": [ - "TEmbeddableInput" + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(embeddableFactoryId: string) => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + " | undefined" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.Unnamed.$2", - "type": "Uncategorized", + "id": "def-public.EditPanelAction.Unnamed.$2", + "type": "Object", "tags": [], - "label": "output", + "label": "application", "description": [], "signature": [ - "TEmbeddableOutput" + { + "pluginId": "@kbn/core-application-browser", + "scope": "common", + "docId": "kibKbnCoreApplicationBrowserPluginApi", + "section": "def-common.ApplicationStart", + "text": "ApplicationStart" + } ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.Unnamed.$3", + "id": "def-public.EditPanelAction.Unnamed.$3", "type": "Object", "tags": [], - "label": "parent", + "label": "stateTransfer", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" + "section": "def-public.EmbeddableStateTransfer", + "text": "EmbeddableStateTransfer" }, - "> | undefined" + " | undefined" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EditPanelAction.Unnamed.$4", + "type": "Function", + "tags": [], + "label": "getOriginatingPath", + "description": [], + "signature": [ + "(() => string) | undefined" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -2732,31 +2142,47 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.reportsEmbeddableLoad", + "id": "def-public.EditPanelAction.getDisplayName", "type": "Function", "tags": [], - "label": "reportsEmbeddableLoad", + "label": "getDisplayName", "description": [], "signature": [ - "() => boolean" + "({ embeddable }: ActionContext) => any" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, - "children": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EditPanelAction.getDisplayName.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.refreshInputFromParent", + "id": "def-public.EditPanelAction.getIconType", "type": "Function", "tags": [], - "label": "refreshInputFromParent", + "label": "getIconType", "description": [], "signature": [ - "() => void" + "() => string" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [], @@ -2764,451 +2190,349 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getIsContainer", + "id": "def-public.EditPanelAction.isCompatible", "type": "Function", "tags": [], - "label": "getIsContainer", + "label": "isCompatible", "description": [], "signature": [ - "() => this is ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - ">" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.reload", - "type": "Function", - "tags": [], - "label": "reload", - "description": [ - "\nReload will be called when there is a request to refresh the data or view, even if the\ninput data did not change.\n\nIn case if input data did change and reload is requested input$ and output$ would still emit before `reload` is called\n\nThe order would be as follows:\ninput$\noutput$\nreload()\n----\nupdated$" - ], - "signature": [ - "() => void" + "({ embeddable }: ActionContext) => Promise" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getUpdated$", - "type": "Function", - "tags": [], - "label": "getUpdated$", - "description": [ - "\nMerges input$ and output$ streams and debounces emit till next macro-task.\nCould be useful to batch reactions to input$ and output$ updates that happen separately but synchronously.\nIn case corresponding state change triggered `reload` this stream is guarantied to emit later,\nwhich allows to skip state handling in case `reload` already handled it." - ], - "signature": [ - "() => Readonly<", - "Observable", - ">" + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EditPanelAction.isCompatible.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getInput$", + "id": "def-public.EditPanelAction.execute", "type": "Function", "tags": [], - "label": "getInput$", + "label": "execute", "description": [], "signature": [ - "() => Readonly<", - "Observable", - ">" + "(context: ActionContext) => Promise" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getOutput$", - "type": "Function", - "tags": [], - "label": "getOutput$", - "description": [], - "signature": [ - "() => Readonly<", - "Observable", - ">" + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EditPanelAction.execute.$1", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getOutput", + "id": "def-public.EditPanelAction.getAppTarget", "type": "Function", "tags": [], - "label": "getOutput", + "label": "getAppTarget", "description": [], "signature": [ - "() => Readonly" + "({ embeddable }: ActionContext) => NavigationContext | undefined" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, - "children": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EditPanelAction.getAppTarget.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getExplicitInputIsEqual", + "id": "def-public.EditPanelAction.getHref", "type": "Function", "tags": [], - "label": "getExplicitInputIsEqual", + "label": "getHref", "description": [], "signature": [ - "(lastExplicitInput: Partial) => Promise" + "({ embeddable }: ActionContext) => Promise" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getExplicitInputIsEqual.$1", + "id": "def-public.EditPanelAction.getHref.$1", "type": "Object", "tags": [], - "label": "lastExplicitInput", + "label": "{ embeddable }", "description": [], "signature": [ - "Partial" + "ActionContext" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable", + "type": "Class", + "tags": [], + "label": "Embeddable", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" + }, + " implements ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" }, + "" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getExplicitInput", - "type": "Function", + "id": "def-public.Embeddable.runtimeId", + "type": "number", "tags": [], - "label": "getExplicitInput", + "label": "runtimeId", "description": [], - "signature": [ - "() => TEmbeddableInput" - ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getPersistableInput", - "type": "Function", + "id": "def-public.Embeddable.runtimeId", + "type": "number", "tags": [], - "label": "getPersistableInput", + "label": "runtimeId", "description": [], - "signature": [ - "() => TEmbeddableInput" - ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getInput", - "type": "Function", + "id": "def-public.Embeddable.parent", + "type": "Object", "tags": [], - "label": "getInput", + "label": "parent", "description": [], "signature": [ - "() => Readonly" + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + "> | undefined" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getTitle", - "type": "Function", + "id": "def-public.Embeddable.isContainer", + "type": "boolean", "tags": [], - "label": "getTitle", + "label": "isContainer", "description": [], - "signature": [ - "() => string" - ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getDescription", - "type": "Function", + "id": "def-public.Embeddable.deferEmbeddableLoad", + "type": "boolean", "tags": [], - "label": "getDescription", + "label": "deferEmbeddableLoad", "description": [], - "signature": [ - "() => string" - ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getRoot", - "type": "Function", + "id": "def-public.Embeddable.type", + "type": "string", "tags": [], - "label": "getRoot", - "description": [ - "\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent." - ], - "signature": [ - "() => ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any> | ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - ">" - ], + "label": "type", + "description": [], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.updateInput", - "type": "Function", + "id": "def-public.Embeddable.id", + "type": "string", "tags": [], - "label": "updateInput", + "label": "id", "description": [], - "signature": [ - "(changes: Partial) => void" - ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.updateInput.$1", - "type": "Object", - "tags": [], - "label": "changes", - "description": [], - "signature": [ - "Partial" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.render", - "type": "Function", + "id": "def-public.Embeddable.fatalError", + "type": "Object", "tags": [], - "label": "render", + "label": "fatalError", "description": [], "signature": [ - "(el: HTMLElement) => void | TNode" + "Error | undefined" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.render.$1", - "type": "Object", - "tags": [], - "label": "el", - "description": [], - "signature": [ - "HTMLElement" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getInspectorAdapters", - "type": "Function", - "tags": [ - "return" - ], - "label": "getInspectorAdapters", - "description": [ - "\nAn embeddable can return inspector adapters if it want the inspector to be\navailable via the context menu of that panel." - ], + "id": "def-public.Embeddable.output", + "type": "Uncategorized", + "tags": [], + "label": "output", + "description": [], "signature": [ - "() => ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - " | undefined" + "TEmbeddableOutput" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [ - "Inspector adapters that will be used to open an inspector for." - ] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.destroy", - "type": "Function", + "id": "def-public.Embeddable.input", + "type": "Uncategorized", "tags": [], - "label": "destroy", - "description": [ - "\nCalled when this embeddable is no longer used, this should be the place for\nimplementors to add additional clean up tasks, like un-mounting and unsubscribing." - ], + "label": "input", + "description": [], "signature": [ - "() => void" + "TEmbeddableInput" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.setInitializationFinished", - "type": "Function", + "id": "def-public.Embeddable.renderComplete", + "type": "Object", "tags": [], - "label": "setInitializationFinished", - "description": [ - "\ncommunicate to the parent embeddable that this embeddable's initialization is finished.\nThis only applies to embeddables which defer their loading state with deferEmbeddableLoad." - ], + "label": "renderComplete", + "description": [], "signature": [ - "() => void" + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.RenderCompleteDispatcher", + "text": "RenderCompleteDispatcher" + } ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.updateOutput", + "id": "def-public.Embeddable.destroyed", + "type": "boolean", + "tags": [], + "label": "destroyed", + "description": [], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.Unnamed", "type": "Function", "tags": [], - "label": "updateOutput", + "label": "Constructor", "description": [], "signature": [ - "(outputChanges: Partial) => void" + "any" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, @@ -3216,212 +2540,180 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.updateOutput.$1", - "type": "Object", + "id": "def-public.Embeddable.Unnamed.$1", + "type": "Uncategorized", "tags": [], - "label": "outputChanges", + "label": "input", "description": [], "signature": [ - "Partial" + "TEmbeddableInput" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.onFatalError", - "type": "Function", - "tags": [], - "label": "onFatalError", - "description": [ - "\nCall this **only** when your embeddable has encountered a non-recoverable error; recoverable errors\nshould be handled by the individual embeddable types" - ], - "signature": [ - "(e: Error) => void" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ + }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.onFatalError.$1", - "type": "Object", + "id": "def-public.Embeddable.Unnamed.$2", + "type": "Uncategorized", "tags": [], - "label": "e", - "description": [ - "The fatal, unrecoverable Error that was thrown" - ], + "label": "output", + "description": [], "signature": [ - "Error" + "TEmbeddableOutput" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "parent", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + "> | undefined" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.supportedTriggers", + "id": "def-public.Embeddable.reportsEmbeddableLoad", "type": "Function", "tags": [], - "label": "supportedTriggers", + "label": "reportsEmbeddableLoad", "description": [], "signature": [ - "() => string[]" + "() => boolean" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel", - "type": "Class", - "tags": [], - "label": "EmbeddableChildPanel", - "description": [ - "\nThis component can be used by embeddable containers using react to easily render children. It waits\nfor the child to be initialized, showing a loading indicator until that is complete." - ], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableChildPanel", - "text": "EmbeddableChildPanel" - }, - " extends React.Component<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableChildPanelProps", - "text": "EmbeddableChildPanelProps" }, - ", State, any>" - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.mounted", - "type": "boolean", + "id": "def-public.Embeddable.refreshInputFromParent", + "type": "Function", "tags": [], - "label": "mounted", + "label": "refreshInputFromParent", "description": [], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "signature": [ + "() => void" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.embeddable", - "type": "CompoundType", + "id": "def-public.Embeddable.getIsContainer", + "type": "Function", "tags": [], - "label": "embeddable", + "label": "getIsContainer", "description": [], "signature": [ + "() => this is ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "section": "def-public.IContainer", + "text": "IContainer" }, - ", ", + "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" + "section": "def-public.ContainerInput", + "text": "ContainerInput" }, - ", any> | ", + "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ErrorEmbeddable", - "text": "ErrorEmbeddable" - } + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.Unnamed", + "id": "def-public.Embeddable.reload", "type": "Function", "tags": [], - "label": "Constructor", - "description": [], + "label": "reload", + "description": [ + "\nReload will be called when there is a request to refresh the data or view, even if the\ninput data did not change.\n\nIn case if input data did change and reload is requested input$ and output$ would still emit before `reload` is called\n\nThe order would be as follows:\ninput$\noutput$\nreload()\n----\nupdated$" + ], "signature": [ - "any" + "() => void" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "props", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableChildPanelProps", - "text": "EmbeddableChildPanelProps" - } - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.componentDidMount", + "id": "def-public.Embeddable.getUpdated$", "type": "Function", "tags": [], - "label": "componentDidMount", - "description": [], + "label": "getUpdated$", + "description": [ + "\nMerges input$ and output$ streams and debounces emit till next macro-task.\nCould be useful to batch reactions to input$ and output$ updates that happen separately but synchronously.\nIn case corresponding state change triggered `reload` this stream is guarantied to emit later,\nwhich allows to skip state handling in case `reload` already handled it." + ], "signature": [ - "() => Promise" + "() => Readonly<", + "Observable", + ">" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], @@ -3429,15 +2721,17 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.componentWillUnmount", + "id": "def-public.Embeddable.getInput$", "type": "Function", "tags": [], - "label": "componentWillUnmount", + "label": "getInput$", "description": [], "signature": [ - "() => void" + "() => Readonly<", + "Observable", + ">" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], @@ -3445,154 +2739,129 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.render", + "id": "def-public.Embeddable.getOutput$", "type": "Function", "tags": [], - "label": "render", + "label": "getOutput$", "description": [], "signature": [ - "() => JSX.Element" + "() => Readonly<", + "Observable", + ">" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableFactoryNotFoundError", - "type": "Class", - "tags": [], - "label": "EmbeddableFactoryNotFoundError", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactoryNotFoundError", - "text": "EmbeddableFactoryNotFoundError" }, - " extends Error" - ], - "path": "src/plugins/embeddable/public/lib/errors.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableFactoryNotFoundError.code", - "type": "string", + "id": "def-public.Embeddable.getOutput", + "type": "Function", "tags": [], - "label": "code", + "label": "getOutput", "description": [], - "path": "src/plugins/embeddable/public/lib/errors.ts", + "signature": [ + "() => Readonly" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed", + "id": "def-public.Embeddable.getExplicitInputIsEqual", "type": "Function", "tags": [], - "label": "Constructor", + "label": "getExplicitInputIsEqual", "description": [], "signature": [ - "any" + "(lastExplicitInput: Partial) => Promise" ], - "path": "src/plugins/embeddable/public/lib/errors.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed.$1", - "type": "string", + "id": "def-public.Embeddable.getExplicitInputIsEqual.$1", + "type": "Object", "tags": [], - "label": "type", + "label": "lastExplicitInput", "description": [], "signature": [ - "string" + "Partial" ], - "path": "src/plugins/embeddable/public/lib/errors.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel", - "type": "Class", - "tags": [], - "label": "EmbeddablePanel", - "description": [], - "signature": [ + }, { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddablePanel", - "text": "EmbeddablePanel" + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.getExplicitInput", + "type": "Function", + "tags": [], + "label": "getExplicitInput", + "description": [], + "signature": [ + "() => TEmbeddableInput" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] }, - " extends React.Component" - ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.Unnamed", + "id": "def-public.Embeddable.getPersistableInput", "type": "Function", "tags": [], - "label": "Constructor", + "label": "getPersistableInput", "description": [], "signature": [ - "any" + "() => TEmbeddableInput" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "Props" - ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.getInput", + "type": "Function", + "tags": [], + "label": "getInput", + "description": [], + "signature": [ + "() => Readonly" ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.UNSAFE_componentWillMount", + "id": "def-public.Embeddable.getTitle", "type": "Function", "tags": [], - "label": "UNSAFE_componentWillMount", + "label": "getTitle", "description": [], "signature": [ - "() => void" + "() => string" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], @@ -3600,15 +2869,81 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.componentWillUnmount", + "id": "def-public.Embeddable.getDescription", "type": "Function", "tags": [], - "label": "componentWillUnmount", + "label": "getDescription", "description": [], "signature": [ - "() => void" + "() => string" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.getRoot", + "type": "Function", + "tags": [], + "label": "getRoot", + "description": [ + "\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent." + ], + "signature": [ + "() => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", any> | ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], @@ -3616,29 +2951,29 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.onFocus", + "id": "def-public.Embeddable.updateInput", "type": "Function", "tags": [], - "label": "onFocus", + "label": "updateInput", "description": [], "signature": [ - "(focusedPanelIndex: string) => void" + "(changes: Partial) => void" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.onFocus.$1", - "type": "string", + "id": "def-public.Embeddable.updateInput.$1", + "type": "Object", "tags": [], - "label": "focusedPanelIndex", + "label": "changes", "description": [], "signature": [ - "string" + "Partial" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -3648,29 +2983,29 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.onBlur", + "id": "def-public.Embeddable.render", "type": "Function", "tags": [], - "label": "onBlur", + "label": "render", "description": [], "signature": [ - "(blurredPanelIndex: string) => void" + "(el: HTMLElement) => void | TNode" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.onBlur.$1", - "type": "string", + "id": "def-public.Embeddable.render.$1", + "type": "Object", "tags": [], - "label": "blurredPanelIndex", + "label": "el", "description": [], "signature": [ - "string" + "HTMLElement" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -3680,31 +3015,47 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.render", + "id": "def-public.Embeddable.getInspectorAdapters", "type": "Function", - "tags": [], - "label": "render", - "description": [], + "tags": [ + "return" + ], + "label": "getInspectorAdapters", + "description": [ + "\nAn embeddable can return inspector adapters if it want the inspector to be\navailable via the context menu of that panel." + ], "signature": [ - "() => JSX.Element" + "() => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + " | undefined" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], - "returnComment": [] + "returnComment": [ + "Inspector adapters that will be used to open an inspector for." + ] }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.componentDidMount", + "id": "def-public.Embeddable.destroy", "type": "Function", "tags": [], - "label": "componentDidMount", - "description": [], + "label": "destroy", + "description": [ + "\nCalled when this embeddable is no longer used, this should be the place for\nimplementors to add additional clean up tasks, like un-mounting and unsubscribing." + ], "signature": [ "() => void" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], @@ -3712,69 +3063,47 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.closeMyContextMenuPanel", + "id": "def-public.Embeddable.setInitializationFinished", "type": "Function", "tags": [], - "label": "closeMyContextMenuPanel", - "description": [], + "label": "setInitializationFinished", + "description": [ + "\ncommunicate to the parent embeddable that this embeddable's initialization is finished.\nThis only applies to embeddables which defer their loading state with deferEmbeddableLoad." + ], "signature": [ "() => void" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRoot", - "type": "Class", - "tags": [], - "label": "EmbeddableRoot", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableRoot", - "text": "EmbeddableRoot" }, - " extends React.Component" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRoot.Unnamed", + "id": "def-public.Embeddable.updateOutput", "type": "Function", "tags": [], - "label": "Constructor", + "label": "updateOutput", "description": [], "signature": [ - "any" + "(outputChanges: Partial) => void" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRoot.Unnamed.$1", + "id": "def-public.Embeddable.updateOutput.$1", "type": "Object", "tags": [], - "label": "props", + "label": "outputChanges", "description": [], "signature": [ - "Props" + "Partial" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -3784,26 +3113,201 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRoot.componentDidMount", + "id": "def-public.Embeddable.onFatalError", "type": "Function", "tags": [], - "label": "componentDidMount", - "description": [], + "label": "onFatalError", + "description": [ + "\nCall this **only** when your embeddable has encountered a non-recoverable error; recoverable errors\nshould be handled by the individual embeddable types" + ], "signature": [ - "() => void" + "(e: Error) => void" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRoot.componentDidUpdate", - "type": "Function", - "tags": [], - "label": "componentDidUpdate", + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.onFatalError.$1", + "type": "Object", + "tags": [], + "label": "e", + "description": [ + "The fatal, unrecoverable Error that was thrown" + ], + "signature": [ + "Error" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.supportedTriggers", + "type": "Function", + "tags": [], + "label": "supportedTriggers", + "description": [], + "signature": [ + "() => string[]" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableFactoryNotFoundError", + "type": "Class", + "tags": [], + "label": "EmbeddableFactoryNotFoundError", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactoryNotFoundError", + "text": "EmbeddableFactoryNotFoundError" + }, + " extends Error" + ], + "path": "src/plugins/embeddable/public/lib/errors.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableFactoryNotFoundError.code", + "type": "string", + "tags": [], + "label": "code", + "description": [], + "path": "src/plugins/embeddable/public/lib/errors.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/embeddable/public/lib/errors.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/embeddable/public/lib/errors.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableRoot", + "type": "Class", + "tags": [], + "label": "EmbeddableRoot", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableRoot", + "text": "EmbeddableRoot" + }, + " extends React.Component" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableRoot.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableRoot.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "Props" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableRoot.componentDidMount", + "type": "Function", + "tags": [], + "label": "componentDidMount", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableRoot.componentDidUpdate", + "type": "Function", + "tags": [], + "label": "componentDidUpdate", "description": [], "signature": [ "(prevProps?: Props | undefined) => void" @@ -4625,39 +4129,75 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.PanelNotFoundError", + "id": "def-public.InspectPanelAction", "type": "Class", "tags": [], - "label": "PanelNotFoundError", + "label": "InspectPanelAction", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.PanelNotFoundError", - "text": "PanelNotFoundError" + "section": "def-public.InspectPanelAction", + "text": "InspectPanelAction" }, - " extends Error" + " implements ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "" ], - "path": "src/plugins/embeddable/public/lib/errors.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.PanelNotFoundError.code", + "id": "def-public.InspectPanelAction.type", "type": "string", "tags": [], - "label": "code", + "label": "type", "description": [], - "path": "src/plugins/embeddable/public/lib/errors.ts", + "signature": [ + "\"openInspector\"" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.PanelNotFoundError.Unnamed", + "id": "def-public.InspectPanelAction.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "\"openInspector\"" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.order", + "type": "number", + "tags": [], + "label": "order", + "description": [], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -4665,286 +4205,410 @@ "signature": [ "any" ], - "path": "src/plugins/embeddable/public/lib/errors.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "inspector", + "description": [], + "signature": [ + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.Start", + "text": "Start" + } + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.getDisplayName", + "type": "Function", + "tags": [], + "label": "getDisplayName", + "description": [], + "signature": [ + "() => any" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [ - { - "parentPluginId": "embeddable", - "id": "def-public.defaultEmbeddableFactoryProvider", - "type": "Function", - "tags": [], - "label": "defaultEmbeddableFactoryProvider", - "description": [], - "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ", T = ", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" }, - ">(def: ", { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactoryDefinition", - "text": "EmbeddableFactoryDefinition" + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.getIconType", + "type": "Function", + "tags": [], + "label": "getIconType", + "description": [], + "signature": [ + "() => string" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] }, - ") => ", { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.isCompatible", + "type": "Function", + "tags": [], + "label": "isCompatible", + "description": [], + "signature": [ + "({ embeddable }: ActionContext) => Promise" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.isCompatible.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] }, - "" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "embeddable", - "id": "def-public.defaultEmbeddableFactoryProvider.$1", - "type": "CompoundType", + "id": "def-public.InspectPanelAction.execute", + "type": "Function", "tags": [], - "label": "def", + "label": "execute", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactoryDefinition", - "text": "EmbeddableFactoryDefinition" - }, - "" + "({ embeddable }: ActionContext) => Promise" ], - "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.execute.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRenderer", - "type": "Function", + "id": "def-public.PanelNotFoundError", + "type": "Class", "tags": [], - "label": "EmbeddableRenderer", - "description": [ - "\nHelper react component to render an embeddable\nCan be used if you have an embeddable object or an embeddable factory\nSupports updating input by passing `input` prop\n" - ], + "label": "PanelNotFoundError", + "description": [], "signature": [ - "(props: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableRendererProps", - "text": "EmbeddableRendererProps" + "section": "def-public.PanelNotFoundError", + "text": "PanelNotFoundError" }, - ") => JSX.Element" + " extends Error" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", + "path": "src/plugins/embeddable/public/lib/errors.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRenderer.$1", - "type": "CompoundType", + "id": "def-public.PanelNotFoundError.code", + "type": "string", "tags": [], - "label": "props", - "description": [ - "- {@link EmbeddableRendererProps }" - ], + "label": "code", + "description": [], + "path": "src/plugins/embeddable/public/lib/errors.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.PanelNotFoundError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableRendererProps", - "text": "EmbeddableRendererProps" - }, - "" + "any" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", + "path": "src/plugins/embeddable/public/lib/errors.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "children": [], + "returnComment": [] } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "embeddable", - "id": "def-public.genericEmbeddableInputIsEqual", - "type": "Function", + "id": "def-public.RemovePanelAction", + "type": "Class", "tags": [], - "label": "genericEmbeddableInputIsEqual", + "label": "RemovePanelAction", "description": [], "signature": [ - "(currentInput: Partial<", { "pluginId": "embeddable", - "scope": "common", + "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "section": "def-public.RemovePanelAction", + "text": "RemovePanelAction" }, - ">, lastInput: Partial<", + " implements ", { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" }, - ">) => boolean" + "" ], - "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.genericEmbeddableInputIsEqual.$1", - "type": "Object", + "id": "def-public.RemovePanelAction.type", + "type": "string", "tags": [], - "label": "currentInput", + "label": "type", "description": [], "signature": [ - "Partial<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ">" + "\"deletePanel\"" ], - "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "\"deletePanel\"" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.order", + "type": "number", + "tags": [], + "label": "order", + "description": [], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "children": [], + "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.genericEmbeddableInputIsEqual.$2", - "type": "Object", + "id": "def-public.RemovePanelAction.getDisplayName", + "type": "Function", "tags": [], - "label": "lastInput", + "label": "getDisplayName", "description": [], "signature": [ - "Partial<", + "() => any" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.getIconType", + "type": "Function", + "tags": [], + "label": "getIconType", + "description": [], + "signature": [ + "() => string" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.isCompatible", + "type": "Function", + "tags": [], + "label": "isCompatible", + "description": [], + "signature": [ + "({ embeddable }: ActionContext) => Promise" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ">" + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.isCompatible.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } ], - "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.execute", + "type": "Function", + "tags": [], + "label": "execute", + "description": [], + "signature": [ + "({ embeddable }: ActionContext) => Promise" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.execute.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] } ], - "returnComment": [], "initialIsOpen": false - }, + } + ], + "functions": [ { "parentPluginId": "embeddable", - "id": "def-public.isContextMenuTriggerContext", + "id": "def-public.defaultEmbeddableFactoryProvider", "type": "Function", "tags": [], - "label": "isContextMenuTriggerContext", + "label": "defaultEmbeddableFactoryProvider", "description": [], "signature": [ - "(context: unknown) => context is ", + " = ", { "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ", T = ", + { + "pluginId": "@kbn/core-saved-objects-common", "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + }, + ">(def: ", + { + "pluginId": "embeddable", + "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "section": "def-public.EmbeddableFactoryDefinition", + "text": "EmbeddableFactoryDefinition" }, - ", ", + ") => ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" }, - ", any>>" + "" ], - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isContextMenuTriggerContext.$1", - "type": "Unknown", + "id": "def-public.defaultEmbeddableFactoryProvider.$1", + "type": "CompoundType", "tags": [], - "label": "context", + "label": "def", "description": [], "signature": [ - "unknown" + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactoryDefinition", + "text": "EmbeddableFactoryDefinition" + }, + "" ], - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -4995,53 +4682,33 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.isEmbeddable", + "id": "def-public.EmbeddablePanel", "type": "Function", "tags": [], - "label": "isEmbeddable", - "description": [], + "label": "EmbeddablePanel", + "description": [ + "\nLoads and renders an embeddable." + ], "signature": [ - "(x: unknown) => x is ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>" + "(props: ", + "EmbeddablePanelProps", + ") => JSX.Element" ], - "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/index.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isEmbeddable.$1", - "type": "Unknown", + "id": "def-public.EmbeddablePanel.$1", + "type": "Object", "tags": [], - "label": "x", + "label": "props", "description": [], "signature": [ - "unknown" + "EmbeddablePanelProps" ], - "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/index.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5052,44 +4719,56 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.isErrorEmbeddable", + "id": "def-public.EmbeddableRenderer", "type": "Function", "tags": [], - "label": "isErrorEmbeddable", - "description": [], + "label": "EmbeddableRenderer", + "description": [ + "\nHelper react component to render an embeddable\nCan be used if you have an embeddable object or an embeddable factory\nSupports updating input by passing `input` prop\n" + ], "signature": [ - "(embeddable: ", + "(props: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ErrorEmbeddable", - "text": "ErrorEmbeddable" + "section": "def-public.EmbeddableRendererProps", + "text": "EmbeddableRendererProps" }, - " | TEmbeddable) => boolean" + ") => JSX.Element" ], - "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isErrorEmbeddable.$1", + "id": "def-public.EmbeddableRenderer.$1", "type": "CompoundType", "tags": [], - "label": "embeddable", - "description": [], + "label": "props", + "description": [ + "- {@link EmbeddableRendererProps }" + ], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ErrorEmbeddable", - "text": "ErrorEmbeddable" + "section": "def-public.EmbeddableRendererProps", + "text": "EmbeddableRendererProps" }, - " | TEmbeddable" + "" ], - "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5100,68 +4779,13 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.isFilterableEmbeddable", - "type": "Function", - "tags": [], - "label": "isFilterableEmbeddable", - "description": [ - "\nEnsure that embeddable supports filtering/querying" - ], - "signature": [ - "(incoming: unknown) => boolean" - ], - "path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.isFilterableEmbeddable.$1", - "type": "Unknown", - "tags": [], - "label": "incoming", - "description": [ - "Embeddable that is being tested to check if it is a FilterableEmbeddable" - ], - "signature": [ - "unknown" - ], - "path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [ - "true if the incoming embeddable is a FilterableEmbeddable, false if it is not" - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.isMultiValueClickTriggerContext", + "id": "def-public.genericEmbeddableInputIsEqual", "type": "Function", "tags": [], - "label": "isMultiValueClickTriggerContext", + "label": "genericEmbeddableInputIsEqual", "description": [], "signature": [ - "(context: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ChartActionContext", - "text": "ChartActionContext" - }, - "<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", + "(currentInput: Partial<", { "pluginId": "embeddable", "scope": "common", @@ -5169,31 +4793,7 @@ "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>>) => context is ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.MultiValueClickContext", - "text": "MultiValueClickContext" - }, - "<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", + ">, lastInput: Partial<", { "pluginId": "embeddable", "scope": "common", @@ -5201,44 +4801,21 @@ "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>>" + ">) => boolean" ], - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isMultiValueClickTriggerContext.$1", - "type": "CompoundType", + "id": "def-public.genericEmbeddableInputIsEqual.$1", + "type": "Object", "tags": [], - "label": "context", + "label": "currentInput", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ChartActionContext", - "text": "ChartActionContext" - }, - "<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", + "Partial<", { "pluginId": "embeddable", "scope": "common", @@ -5246,17 +4823,32 @@ "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, - ", ", + ">" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.genericEmbeddableInputIsEqual.$2", + "type": "Object", + "tags": [], + "label": "lastInput", + "description": [], + "signature": [ + "Partial<", { "pluginId": "embeddable", - "scope": "public", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" }, - ", any>>" + ">" ], - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5267,19 +4859,19 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.isRangeSelectTriggerContext", + "id": "def-public.isContextMenuTriggerContext", "type": "Function", "tags": [], - "label": "isRangeSelectTriggerContext", + "label": "isContextMenuTriggerContext", "description": [], "signature": [ - "(context: ", + "(context: unknown) => context is ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ChartActionContext", - "text": "ChartActionContext" + "section": "def-public.EmbeddableContext", + "text": "EmbeddableContext" }, "<", { @@ -5305,15 +4897,40 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ", any>>) => context is ", + ", any>>" + ], + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.RangeSelectContext", - "text": "RangeSelectContext" - }, - "<", + "parentPluginId": "embeddable", + "id": "def-public.isContextMenuTriggerContext.$1", + "type": "Unknown", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "unknown" + ], + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.isEmbeddable", + "type": "Function", + "tags": [], + "label": "isEmbeddable", + "description": [], + "signature": [ + "(x: unknown) => x is ", { "pluginId": "embeddable", "scope": "public", @@ -5337,54 +4954,71 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ", any>>" + ", any>" ], - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isRangeSelectTriggerContext.$1", - "type": "CompoundType", + "id": "def-public.isEmbeddable.$1", + "type": "Unknown", "tags": [], - "label": "context", + "label": "x", + "description": [], + "signature": [ + "unknown" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.isErrorEmbeddable", + "type": "Function", + "tags": [], + "label": "isErrorEmbeddable", + "description": [], + "signature": [ + "(embeddable: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" + }, + " | TEmbeddable) => boolean" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.isErrorEmbeddable.$1", + "type": "CompoundType", + "tags": [], + "label": "embeddable", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ChartActionContext", - "text": "ChartActionContext" - }, - "<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" }, - ", any>>" + " | TEmbeddable" ], - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5395,43 +5029,49 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.isReferenceOrValueEmbeddable", + "id": "def-public.isFilterableEmbeddable", "type": "Function", "tags": [], - "label": "isReferenceOrValueEmbeddable", - "description": [], + "label": "isFilterableEmbeddable", + "description": [ + "\nEnsure that embeddable supports filtering/querying" + ], "signature": [ "(incoming: unknown) => boolean" ], - "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isReferenceOrValueEmbeddable.$1", + "id": "def-public.isFilterableEmbeddable.$1", "type": "Unknown", "tags": [], "label": "incoming", - "description": [], + "description": [ + "Embeddable that is being tested to check if it is a FilterableEmbeddable" + ], "signature": [ "unknown" ], - "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], - "returnComment": [], + "returnComment": [ + "true if the incoming embeddable is a FilterableEmbeddable, false if it is not" + ], "initialIsOpen": false }, { "parentPluginId": "embeddable", - "id": "def-public.isRowClickTriggerContext", + "id": "def-public.isMultiValueClickTriggerContext", "type": "Function", "tags": [], - "label": "isRowClickTriggerContext", + "label": "isMultiValueClickTriggerContext", "description": [], "signature": [ "(context: ", @@ -5468,12 +5108,37 @@ }, ", any>>) => context is ", { - "pluginId": "@kbn/ui-actions-browser", + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.MultiValueClickContext", + "text": "MultiValueClickContext" + }, + "<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", "scope": "common", - "docId": "kibKbnUiActionsBrowserPluginApi", - "section": "def-common.RowClickContext", - "text": "RowClickContext" - } + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", any>>" ], "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "deprecated": false, @@ -5481,7 +5146,7 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isRowClickTriggerContext.$1", + "id": "def-public.isMultiValueClickTriggerContext.$1", "type": "CompoundType", "tags": [], "label": "context", @@ -5531,73 +5196,10 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.isSavedObjectEmbeddableInput", - "type": "Function", - "tags": [], - "label": "isSavedObjectEmbeddableInput", - "description": [], - "signature": [ - "(input: ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - " | ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.SavedObjectEmbeddableInput", - "text": "SavedObjectEmbeddableInput" - }, - ") => boolean" - ], - "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.isSavedObjectEmbeddableInput.$1", - "type": "CompoundType", - "tags": [], - "label": "input", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - " | ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.SavedObjectEmbeddableInput", - "text": "SavedObjectEmbeddableInput" - } - ], - "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.isValueClickTriggerContext", + "id": "def-public.isRangeSelectTriggerContext", "type": "Function", "tags": [], - "label": "isValueClickTriggerContext", + "label": "isRangeSelectTriggerContext", "description": [], "signature": [ "(context: ", @@ -5637,8 +5239,8 @@ "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ValueClickContext", - "text": "ValueClickContext" + "section": "def-public.RangeSelectContext", + "text": "RangeSelectContext" }, "<", { @@ -5672,7 +5274,7 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isValueClickTriggerContext.$1", + "id": "def-public.isRangeSelectTriggerContext.$1", "type": "CompoundType", "tags": [], "label": "context", @@ -5722,53 +5324,29 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.omitGenericEmbeddableInput", + "id": "def-public.isReferenceOrValueEmbeddable", "type": "Function", "tags": [], - "label": "omitGenericEmbeddableInput", + "label": "isReferenceOrValueEmbeddable", "description": [], "signature": [ - " = Partial<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ">>(input: I) => Omit" + "(incoming: unknown) => boolean" ], - "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.omitGenericEmbeddableInput.$1", - "type": "Uncategorized", + "id": "def-public.isReferenceOrValueEmbeddable.$1", + "type": "Unknown", "tags": [], - "label": "input", + "label": "incoming", "description": [], "signature": [ - "I" + "unknown" ], - "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5779,45 +5357,29 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout", + "id": "def-public.isRowClickTriggerContext", "type": "Function", "tags": [], - "label": "openAddPanelFlyout", + "label": "isRowClickTriggerContext", "description": [], "signature": [ - "(options: { embeddable: ", + "(context: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" + "section": "def-public.ChartActionContext", + "text": "ChartActionContext" }, - "<{}, ", + "<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - ">; getFactory: >) => context is ", { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", E extends ", + "pluginId": "@kbn/ui-actions-browser", + "scope": "common", + "docId": "kibKbnUiActionsBrowserPluginApi", + "section": "def-common.RowClickContext", + "text": "RowClickContext" + } + ], + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.isRowClickTriggerContext.$1", + "type": "CompoundType", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ChartActionContext", + "text": "ChartActionContext" + }, + "<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", any>>" + ], + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.isSavedObjectEmbeddableInput", + "type": "Function", + "tags": [], + "label": "isSavedObjectEmbeddableInput", + "description": [], + "signature": [ + "(input: ", { "pluginId": "embeddable", - "scope": "public", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" }, - " = ", + " | ", { "pluginId": "embeddable", - "scope": "public", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" + "section": "def-common.SavedObjectEmbeddableInput", + "text": "SavedObjectEmbeddableInput" }, - ">(embeddableFactoryId: string) => ", + ") => boolean" + ], + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.isSavedObjectEmbeddableInput.$1", + "type": "CompoundType", + "tags": [], + "label": "input", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + " | ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.SavedObjectEmbeddableInput", + "text": "SavedObjectEmbeddableInput" + } + ], + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.isValueClickTriggerContext", + "type": "Function", + "tags": [], + "label": "isValueClickTriggerContext", + "description": [], + "signature": [ + "(context: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" + "section": "def-public.ChartActionContext", + "text": "ChartActionContext" }, - " | undefined; getAllFactories: () => IterableIterator<", + "<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" }, "<", { @@ -5889,7 +5561,15 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ", ", + ", any>>) => context is ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ValueClickContext", + "text": "ValueClickContext" + }, + "<", { "pluginId": "embeddable", "scope": "public", @@ -5913,338 +5593,209 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ", any>, unknown>>; overlays: ", - { - "pluginId": "@kbn/core-overlays-browser", - "scope": "common", - "docId": "kibKbnCoreOverlaysBrowserPluginApi", - "section": "def-common.OverlayStart", - "text": "OverlayStart" - }, - "; notifications: ", - { - "pluginId": "@kbn/core-notifications-browser", - "scope": "common", - "docId": "kibKbnCoreNotificationsBrowserPluginApi", - "section": "def-common.NotificationsStart", - "text": "NotificationsStart" - }, - "; SavedObjectFinder: React.ComponentType; showCreateNewMenu?: boolean | undefined; reportUiCounter?: ((appName: string, type: string, eventNames: string | string[], count?: number | undefined) => void) | undefined; theme: ", - { - "pluginId": "@kbn/core-theme-browser", - "scope": "common", - "docId": "kibKbnCoreThemeBrowserPluginApi", - "section": "def-common.ThemeServiceStart", - "text": "ThemeServiceStart" - }, - "; onAddPanel?: ((id: string) => void) | undefined; }) => ", - { - "pluginId": "@kbn/core-mount-utils-browser", - "scope": "common", - "docId": "kibKbnCoreMountUtilsBrowserPluginApi", - "section": "def-common.OverlayRef", - "text": "OverlayRef" - } + ", any>>" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1", - "type": "Object", + "id": "def-public.isValueClickTriggerContext.$1", + "type": "CompoundType", "tags": [], - "label": "options", + "label": "context", "description": [], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ + "signature": [ { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.embeddable", - "type": "Object", - "tags": [], - "label": "embeddable", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - ">" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ChartActionContext", + "text": "ChartActionContext" }, + "<", { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.getFactory", - "type": "Function", - "tags": [], - "label": "getFactory", - "description": [], - "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ">(embeddableFactoryId: string) => ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" - }, - " | undefined" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.getFactory.$1", - "type": "string", - "tags": [], - "label": "embeddableFactoryId", - "description": [], - "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false, - "trackAdoption": false - } - ] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.getAllFactories", - "type": "Function", - "tags": [], - "label": "getAllFactories", - "description": [], - "signature": [ - "() => IterableIterator<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>, unknown>>" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.overlays", - "type": "Object", - "tags": [], - "label": "overlays", - "description": [], - "signature": [ - { - "pluginId": "@kbn/core-overlays-browser", - "scope": "common", - "docId": "kibKbnCoreOverlaysBrowserPluginApi", - "section": "def-common.OverlayStart", - "text": "OverlayStart" - } - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.notifications", - "type": "Object", - "tags": [], - "label": "notifications", - "description": [], - "signature": [ - { - "pluginId": "@kbn/core-notifications-browser", - "scope": "common", - "docId": "kibKbnCoreNotificationsBrowserPluginApi", - "section": "def-common.NotificationsStart", - "text": "NotificationsStart" - } - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.SavedObjectFinder", - "type": "CompoundType", - "tags": [], - "label": "SavedObjectFinder", - "description": [], - "signature": [ - "React.ComponentClass | React.FunctionComponent" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" }, + "<", { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.showCreateNewMenu", - "type": "CompoundType", - "tags": [], - "label": "showCreateNewMenu", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" }, + ", ", { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.reportUiCounter", - "type": "Function", - "tags": [], - "label": "reportUiCounter", - "description": [], - "signature": [ - "((appName: string, type: string, eventNames: string | string[], count?: number | undefined) => void) | undefined" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" }, + ", any>>" + ], + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.omitGenericEmbeddableInput", + "type": "Function", + "tags": [], + "label": "omitGenericEmbeddableInput", + "description": [], + "signature": [ + " = Partial<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ">>(input: I) => Omit" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.omitGenericEmbeddableInput.$1", + "type": "Uncategorized", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "I" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.openAddPanelFlyout", + "type": "Function", + "tags": [], + "label": "openAddPanelFlyout", + "description": [], + "signature": [ + "({ container, onAddPanel, }: { container: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">; onAddPanel?: ((id: string) => void) | undefined; }) => ", + { + "pluginId": "@kbn/core-mount-utils-browser", + "scope": "common", + "docId": "kibKbnCoreMountUtilsBrowserPluginApi", + "section": "def-common.OverlayRef", + "text": "OverlayRef" + } + ], + "path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.openAddPanelFlyout.$1", + "type": "Object", + "tags": [], + "label": "{\n container,\n onAddPanel,\n}", + "description": [], + "path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.theme", + "id": "def-public.openAddPanelFlyout.$1.container", "type": "Object", "tags": [], - "label": "theme", + "label": "container", "description": [], "signature": [ { - "pluginId": "@kbn/core-theme-browser", - "scope": "common", - "docId": "kibKbnCoreThemeBrowserPluginApi", - "section": "def-common.ThemeServiceStart", - "text": "ThemeServiceStart" - } + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx", "deprecated": false, "trackAdoption": false }, @@ -6258,7 +5809,7 @@ "signature": [ "((id: string) => void) | undefined" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx", "deprecated": false, "trackAdoption": false, "children": [ @@ -6272,7 +5823,7 @@ "signature": [ "string" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -6607,302 +6158,89 @@ "id": "def-public.ContainerInput.hidePanelTitles", "type": "CompoundType", "tags": [], - "label": "hidePanelTitles", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.ContainerInput.panels", - "type": "Object", - "tags": [], - "label": "panels", - "description": [], - "signature": [ - "{ [key: string]: ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.PanelState", - "text": "PanelState" - }, - "; }" - ], - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.ContainerOutput", - "type": "Interface", - "tags": [], - "label": "ContainerOutput", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - " extends ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - } - ], - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.ContainerOutput.embeddableLoaded", - "type": "Object", - "tags": [], - "label": "embeddableLoaded", - "description": [], - "signature": [ - "{ [key: string]: boolean; }" - ], - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps", - "type": "Interface", - "tags": [], - "label": "EmbeddableChildPanelProps", - "description": [], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.embeddableId", - "type": "string", - "tags": [], - "label": "embeddableId", - "description": [], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.index", - "type": "number", - "tags": [], - "label": "index", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.className", - "type": "string", - "tags": [], - "label": "className", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.container", - "type": "Object", - "tags": [], - "label": "container", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - ">" - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.PanelComponent", - "type": "Function", - "tags": [], - "label": "PanelComponent", - "description": [], - "signature": [ - "React.FunctionComponent<{ embeddable: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>; hideHeader?: boolean | undefined; containerContext?: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableContainerContext", - "text": "EmbeddableContainerContext" - }, - " | undefined; index?: number | undefined; }>" - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.PanelComponent.$1", - "type": "CompoundType", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P & { children?: React.ReactNode; }" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.PanelComponent.$2", - "type": "Any", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "any" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false, - "trackAdoption": false - } - ] + "label": "hidePanelTitles", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "deprecated": false, + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.onPanelStatusChange", - "type": "Function", + "id": "def-public.ContainerInput.panels", + "type": "Object", "tags": [], - "label": "onPanelStatusChange", + "label": "panels", "description": [], "signature": [ - "((info: ", + "{ [key: string]: ", { "pluginId": "embeddable", - "scope": "public", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.PanelState", + "text": "PanelState" + }, + " void) | undefined" + " & { id: string; }>; }" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.onPanelStatusChange.$1", - "type": "Object", - "tags": [], - "label": "info", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddablePhaseEvent", - "text": "EmbeddablePhaseEvent" - } - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.ContainerOutput", + "type": "Interface", + "tags": [], + "label": "ContainerOutput", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + } + ], + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.ContainerOutput.embeddableLoaded", + "type": "Object", + "tags": [], + "label": "embeddableLoaded", + "description": [], + "signature": [ + "{ [key: string]: boolean; }" ], - "returnComment": [] + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -6913,10 +6251,8 @@ "type": "Interface", "tags": [], "label": "EmbeddableContainerContext", - "description": [ - "\nEmbeddable container may provide information about its environment,\nUse it for drilling down data that is static or doesn't have to be reactive,\notherwise prefer passing data with input$" - ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "description": [], + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -6932,7 +6268,7 @@ "signature": [ "(() => string) | undefined" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false, "children": [], @@ -7949,7 +7285,7 @@ "tags": [], "label": "EmbeddablePhaseEvent", "description": [], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -7960,7 +7296,7 @@ "tags": [], "label": "id", "description": [], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false }, @@ -7972,9 +7308,9 @@ "label": "status", "description": [], "signature": [ - "\"error\" | \"loading\" | \"loaded\" | \"rendered\"" + "\"error\" | \"loading\" | \"rendered\" | \"loaded\"" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false }, @@ -7995,7 +7331,7 @@ }, " | undefined" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false }, @@ -8006,7 +7342,7 @@ "tags": [], "label": "timeToEvent", "description": [], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false } @@ -8184,6 +7520,26 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableStartDependencies.usageCollection", + "type": "Object", + "tags": [], + "label": "usageCollection", + "description": [], + "signature": [ + { + "pluginId": "usageCollection", + "scope": "public", + "docId": "kibUsageCollectionPluginApi", + "section": "def-public.UsageCollectionStart", + "text": "UsageCollectionStart" + } + ], + "path": "src/plugins/embeddable/public/plugin.tsx", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStartDependencies.savedObjectsManagement", @@ -10240,15 +9596,15 @@ "misc": [ { "parentPluginId": "embeddable", - "id": "def-public.ACTION_ADD_PANEL", + "id": "def-public.ACTION_CUSTOMIZE_PANEL", "type": "string", "tags": [], - "label": "ACTION_ADD_PANEL", + "label": "ACTION_CUSTOMIZE_PANEL", "description": [], "signature": [ - "\"ACTION_ADD_PANEL\"" + "\"ACTION_CUSTOMIZE_PANEL\"" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -10263,7 +9619,22 @@ "signature": [ "\"editPanel\"" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.ACTION_INSPECT_PANEL", + "type": "string", + "tags": [], + "label": "ACTION_INSPECT_PANEL", + "description": [], + "signature": [ + "\"openInspector\"" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -10430,95 +9801,19 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanelHOC", - "type": "Type", - "tags": [], - "label": "EmbeddablePanelHOC", - "description": [], - "signature": [ - "React.FunctionComponent<{ embeddable: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>; hideHeader?: boolean | undefined; containerContext?: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableContainerContext", - "text": "EmbeddableContainerContext" - }, - " | undefined; index?: number | undefined; }>" - ], - "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanelHOC.$1", - "type": "CompoundType", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P & { children?: React.ReactNode; }" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanelHOC.$2", - "type": "Any", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "any" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddablePhase", "type": "Type", "tags": [], "label": "EmbeddablePhase", - "description": [], + "description": [ + "\n Performance tracking types" + ], "signature": [ - "\"error\" | \"loading\" | \"loaded\" | \"rendered\"" + "\"error\" | \"loading\" | \"rendered\" | \"loaded\"" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -10600,6 +9895,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "embeddable", + "id": "def-public.REMOVE_PANEL_ACTION", + "type": "string", + "tags": [], + "label": "REMOVE_PANEL_ACTION", + "description": [], + "signature": [ + "\"deletePanel\"" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "embeddable", "id": "def-public.SELECT_RANGE_TRIGGER", @@ -11342,83 +10652,6 @@ "children": [], "returnComment": [] }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableStart.EmbeddablePanel", - "type": "Function", - "tags": [], - "label": "EmbeddablePanel", - "description": [], - "signature": [ - "React.FunctionComponent<{ embeddable: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>; hideHeader?: boolean | undefined; containerContext?: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableContainerContext", - "text": "EmbeddableContainerContext" - }, - " | undefined; index?: number | undefined; }>" - ], - "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableStart.EmbeddablePanel.$1", - "type": "CompoundType", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P & { children?: React.ReactNode; }" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableStart.EmbeddablePanel.$2", - "type": "Any", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "any" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false, - "trackAdoption": false - } - ] - }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStart.getStateTransfer", diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index f1d93502a483e..ab33cb1a07797 100644 --- a/api_docs/embeddable.mdx +++ b/api_docs/embeddable.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable title: "embeddable" image: https://source.unsplash.com/400x175/?github description: API docs for the embeddable plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] --- import embeddableObj from './embeddable.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 | |-------------------|-----------|------------------------|-----------------| -| 548 | 11 | 444 | 4 | +| 532 | 11 | 434 | 7 | ## Client diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index 0e59e0fb9a7aa..0596510265537 100644 --- a/api_docs/embeddable_enhanced.mdx +++ b/api_docs/embeddable_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced title: "embeddableEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the embeddableEnhanced plugin -date: 2023-06-30 +date: 2023-07-18 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 337857d40fed0..9f5561f33548a 100644 --- a/api_docs/encrypted_saved_objects.mdx +++ b/api_docs/encrypted_saved_objects.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects title: "encryptedSavedObjects" image: https://source.unsplash.com/400x175/?github description: API docs for the encryptedSavedObjects plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] --- import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json'; diff --git a/api_docs/enterprise_search.devdocs.json b/api_docs/enterprise_search.devdocs.json index b19bfd8945790..99cda4d5bb3af 100644 --- a/api_docs/enterprise_search.devdocs.json +++ b/api_docs/enterprise_search.devdocs.json @@ -45,21 +45,6 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "enterpriseSearch", - "id": "def-server.CONNECTORS_ACCESS_CONTROL_INDEX_PREFIX", - "type": "string", - "tags": [], - "label": "CONNECTORS_ACCESS_CONTROL_INDEX_PREFIX", - "description": [], - "signature": [ - "\".search-acl-filter-\"" - ], - "path": "x-pack/plugins/enterprise_search/server/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "enterpriseSearch", "id": "def-server.CONNECTORS_INDEX", @@ -134,6 +119,21 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false + }, + { + "parentPluginId": "enterpriseSearch", + "id": "def-server.CURRENT_CONNECTORS_JOB_INDEX", + "type": "string", + "tags": [], + "label": "CURRENT_CONNECTORS_JOB_INDEX", + "description": [], + "signature": [ + "\".elastic-connectors-sync-jobs-v1\"" + ], + "path": "x-pack/plugins/enterprise_search/server/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false } ], "objects": [ diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index 07ccebc213360..4158c491895b4 100644 --- a/api_docs/enterprise_search.mdx +++ b/api_docs/enterprise_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch title: "enterpriseSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the enterpriseSearch plugin -date: 2023-06-30 +date: 2023-07-18 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 c04f0a59a21bb..04f1634f33317 100644 --- a/api_docs/es_ui_shared.mdx +++ b/api_docs/es_ui_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esUiShared title: "esUiShared" image: https://source.unsplash.com/400x175/?github description: API docs for the esUiShared plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] --- import esUiSharedObj from './es_ui_shared.devdocs.json'; diff --git a/api_docs/ess_security.devdocs.json b/api_docs/ess_security.devdocs.json deleted file mode 100644 index 95c1b4c59946a..0000000000000 --- a/api_docs/ess_security.devdocs.json +++ /dev/null @@ -1,114 +0,0 @@ -{ - "id": "essSecurity", - "client": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [], - "setup": { - "parentPluginId": "essSecurity", - "id": "def-public.EssSecurityPluginSetup", - "type": "Interface", - "tags": [], - "label": "EssSecurityPluginSetup", - "description": [], - "path": "x-pack/plugins/ess_security/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "lifecycle": "setup", - "initialIsOpen": true - }, - "start": { - "parentPluginId": "essSecurity", - "id": "def-public.EssSecurityPluginStart", - "type": "Interface", - "tags": [], - "label": "EssSecurityPluginStart", - "description": [], - "path": "x-pack/plugins/ess_security/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "lifecycle": "start", - "initialIsOpen": true - } - }, - "server": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [], - "setup": { - "parentPluginId": "essSecurity", - "id": "def-server.EssSecurityPluginSetup", - "type": "Interface", - "tags": [], - "label": "EssSecurityPluginSetup", - "description": [], - "path": "x-pack/plugins/ess_security/server/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "lifecycle": "setup", - "initialIsOpen": true - }, - "start": { - "parentPluginId": "essSecurity", - "id": "def-server.EssSecurityPluginStart", - "type": "Interface", - "tags": [], - "label": "EssSecurityPluginStart", - "description": [], - "path": "x-pack/plugins/ess_security/server/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "lifecycle": "start", - "initialIsOpen": true - } - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [ - { - "parentPluginId": "essSecurity", - "id": "def-common.PLUGIN_ID", - "type": "string", - "tags": [], - "label": "PLUGIN_ID", - "description": [], - "signature": [ - "\"essSecurity\"" - ], - "path": "x-pack/plugins/ess_security/common/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "essSecurity", - "id": "def-common.PLUGIN_NAME", - "type": "string", - "tags": [], - "label": "PLUGIN_NAME", - "description": [], - "signature": [ - "\"essSecurity\"" - ], - "path": "x-pack/plugins/ess_security/common/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - } - ], - "objects": [] - } -} \ No newline at end of file diff --git a/api_docs/ess_security.mdx b/api_docs/ess_security.mdx deleted file mode 100644 index 399b025106548..0000000000000 --- a/api_docs/ess_security.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -#### -#### 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: kibEssSecurityPluginApi -slug: /kibana-dev-docs/api/essSecurity -title: "essSecurity" -image: https://source.unsplash.com/400x175/?github -description: API docs for the essSecurity plugin -date: 2023-06-30 -tags: ['contributor', 'dev', 'apidocs', 'kibana', 'essSecurity'] ---- -import essSecurityObj from './ess_security.devdocs.json'; - -ESS customizations for Security Solution. - -Contact [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) for questions regarding this plugin. - -**Code health stats** - -| Public API count | Any count | Items lacking comments | Missing exports | -|-------------------|-----------|------------------------|-----------------| -| 6 | 0 | 6 | 0 | - -## Client - -### Setup - - -### Start - - -## Server - -### Setup - - -### Start - - -## Common - -### Consts, variables and types - - diff --git a/api_docs/event_annotation.devdocs.json b/api_docs/event_annotation.devdocs.json index 32aa51ade4db3..9cbab58d01ef1 100644 --- a/api_docs/event_annotation.devdocs.json +++ b/api_docs/event_annotation.devdocs.json @@ -310,6 +310,38 @@ ], "returnComment": [] }, + { + "parentPluginId": "eventAnnotation", + "id": "def-public.EventAnnotationServiceType.groupExistsWithTitle", + "type": "Function", + "tags": [], + "label": "groupExistsWithTitle", + "description": [], + "signature": [ + "(title: string) => Promise" + ], + "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-public.EventAnnotationServiceType.groupExistsWithTitle.$1", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "eventAnnotation", "id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent", @@ -318,23 +350,7 @@ "label": "findAnnotationGroupContent", "description": [], "signature": [ - "(searchTerm: string, pageSize: number, references?: ", - { - "pluginId": "@kbn/core-saved-objects-api-server", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", - "section": "def-common.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, - "[] | undefined, referencesToExclude?: ", - { - "pluginId": "@kbn/core-saved-objects-api-server", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", - "section": "def-common.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, - "[] | undefined) => Promise<{ total: number; hits: ", + "(searchTerm: string, pageSize: number, tagsToInclude?: string[] | undefined, tagsToExclude?: string[] | undefined) => Promise<{ total: number; hits: ", "EventAnnotationGroupContent", "[]; }>" ], @@ -377,17 +393,10 @@ "id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$3", "type": "Array", "tags": [], - "label": "references", + "label": "tagsToInclude", "description": [], "signature": [ - { - "pluginId": "@kbn/core-saved-objects-api-server", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", - "section": "def-common.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, - "[] | undefined" + "string[] | undefined" ], "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", "deprecated": false, @@ -399,17 +408,10 @@ "id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$4", "type": "Array", "tags": [], - "label": "referencesToExclude", + "label": "tagsToExclude", "description": [], "signature": [ - { - "pluginId": "@kbn/core-saved-objects-api-server", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", - "section": "def-common.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, - "[] | undefined" + "string[] | undefined" ], "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", "deprecated": false, @@ -1752,7 +1754,7 @@ "label": "AvailableAnnotationIcon", "description": [], "signature": [ - "\"alert\" | \"circle\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"triangle\"" + "\"alert\" | \"circle\" | \"tag\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"triangle\"" ], "path": "src/plugins/event_annotation/common/types.ts", "deprecated": false, @@ -2545,7 +2547,7 @@ "label": "options", "description": [], "signature": [ - "(\"alert\" | \"circle\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"triangle\")[]" + "(\"alert\" | \"circle\" | \"tag\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"triangle\")[]" ], "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "deprecated": false, @@ -3712,7 +3714,7 @@ "label": "options", "description": [], "signature": [ - "(\"alert\" | \"circle\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"triangle\")[]" + "(\"alert\" | \"circle\" | \"tag\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"triangle\")[]" ], "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "deprecated": false, diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index f91cb517feb63..e57151329db63 100644 --- a/api_docs/event_annotation.mdx +++ b/api_docs/event_annotation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation title: "eventAnnotation" image: https://source.unsplash.com/400x175/?github description: API docs for the eventAnnotation plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] --- import eventAnnotationObj from './event_annotation.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 | |-------------------|-----------|------------------------|-----------------| -| 234 | 30 | 234 | 4 | +| 236 | 30 | 236 | 4 | ## Client diff --git a/api_docs/event_log.devdocs.json b/api_docs/event_log.devdocs.json index 90cda1aa61629..7442d3398b009 100644 --- a/api_docs/event_log.devdocs.json +++ b/api_docs/event_log.devdocs.json @@ -1514,7 +1514,7 @@ "label": "data", "description": [], "signature": [ - "(Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; license?: string | undefined; description?: string | undefined; category?: string | undefined; uuid?: string | undefined; version?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; status?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; rule_type_id?: string | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; version?: string | undefined; space_ids?: string[] | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; kind?: string | undefined; duration?: string | number | undefined; url?: string | undefined; code?: string | undefined; provider?: string | undefined; severity?: string | number | undefined; created?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; original?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]" + "(Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; license?: string | undefined; description?: string | undefined; category?: string | undefined; uuid?: string | undefined; version?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; status?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; rule_type_id?: string | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; version?: string | undefined; space_ids?: string[] | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; kind?: string | undefined; duration?: string | number | undefined; url?: string | undefined; timezone?: string | undefined; risk_score?: number | undefined; severity?: string | number | undefined; code?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; original?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]" ], "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "deprecated": false, @@ -1534,7 +1534,7 @@ "label": "IEvent", "description": [], "signature": [ - "DeepPartial | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; license?: string | undefined; description?: string | undefined; category?: string | undefined; uuid?: string | undefined; version?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; status?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; rule_type_id?: string | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; version?: string | undefined; space_ids?: string[] | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; kind?: string | undefined; duration?: string | number | undefined; url?: string | undefined; code?: string | undefined; provider?: string | undefined; severity?: string | number | undefined; created?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; original?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" + "DeepPartial | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; license?: string | undefined; description?: string | undefined; category?: string | undefined; uuid?: string | undefined; version?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; status?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; rule_type_id?: string | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; version?: string | undefined; space_ids?: string[] | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; kind?: string | undefined; duration?: string | number | undefined; url?: string | undefined; timezone?: string | undefined; risk_score?: number | undefined; severity?: string | number | undefined; code?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; original?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" ], "path": "x-pack/plugins/event_log/generated/schemas.ts", "deprecated": false, @@ -1549,7 +1549,7 @@ "label": "IValidatedEvent", "description": [], "signature": [ - "Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; license?: string | undefined; description?: string | undefined; category?: string | undefined; uuid?: string | undefined; version?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; status?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; rule_type_id?: string | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; version?: string | undefined; space_ids?: string[] | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; kind?: string | undefined; duration?: string | number | undefined; url?: string | undefined; code?: string | undefined; provider?: string | undefined; severity?: string | number | undefined; created?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; original?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}> | undefined" + "Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; license?: string | undefined; description?: string | undefined; category?: string | undefined; uuid?: string | undefined; version?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; status?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; rule_type_id?: string | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; version?: string | undefined; space_ids?: string[] | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; kind?: string | undefined; duration?: string | number | undefined; url?: string | undefined; timezone?: string | undefined; risk_score?: number | undefined; severity?: string | number | undefined; code?: string | undefined; provider?: string | undefined; created?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; original?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}> | undefined" ], "path": "x-pack/plugins/event_log/generated/schemas.ts", "deprecated": false, diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index 3f92b5605985c..5b497273b875d 100644 --- a/api_docs/event_log.mdx +++ b/api_docs/event_log.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog title: "eventLog" image: https://source.unsplash.com/400x175/?github description: API docs for the eventLog plugin -date: 2023-06-30 +date: 2023-07-18 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 f4500594093aa..8783e3434d0c3 100644 --- a/api_docs/exploratory_view.mdx +++ b/api_docs/exploratory_view.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/exploratoryView title: "exploratoryView" image: https://source.unsplash.com/400x175/?github description: API docs for the exploratoryView plugin -date: 2023-06-30 +date: 2023-07-18 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 e5740a7369505..d22d022e09945 100644 --- a/api_docs/expression_error.mdx +++ b/api_docs/expression_error.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError title: "expressionError" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionError plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] --- import expressionErrorObj from './expression_error.devdocs.json'; diff --git a/api_docs/expression_gauge.devdocs.json b/api_docs/expression_gauge.devdocs.json index b3767918876fb..eb53b79bbe044 100644 --- a/api_docs/expression_gauge.devdocs.json +++ b/api_docs/expression_gauge.devdocs.json @@ -1185,9 +1185,9 @@ "section": "def-common.FormatFactory", "text": "FormatFactory" }, - "; chartsThemeService: ", - "Theme", - "; paletteService: ", + "; chartsThemeService: Omit<", + "ThemeService", + ", \"init\">; paletteService: ", { "pluginId": "@kbn/coloring", "scope": "common", @@ -1265,7 +1265,7 @@ "CustomXDomain", " | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ", "LegendStrategy", - " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>>) | undefined; }" + " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial>) | undefined; }" ], "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", "deprecated": false, diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx index 7def1b81a5a4f..bee91a7559b85 100644 --- a/api_docs/expression_gauge.mdx +++ b/api_docs/expression_gauge.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionGauge title: "expressionGauge" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionGauge plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] --- import expressionGaugeObj from './expression_gauge.devdocs.json'; diff --git a/api_docs/expression_heatmap.devdocs.json b/api_docs/expression_heatmap.devdocs.json index 50e3f743d7330..91fc345d8f6c3 100644 --- a/api_docs/expression_heatmap.devdocs.json +++ b/api_docs/expression_heatmap.devdocs.json @@ -488,12 +488,12 @@ { "parentPluginId": "expressionHeatmap", "id": "def-common.HeatmapExpressionProps.overrides", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "overrides", "description": [], "signature": [ - "Partial; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ", "LegendStrategy", - " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> | undefined" + " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial>) | undefined" ], "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_functions.ts", "deprecated": false, @@ -869,9 +869,9 @@ "section": "def-common.FormatFactory", "text": "FormatFactory" }, - "; chartsThemeService: ", - "Theme", - "; chartsActiveCursorService: ", + "; chartsThemeService: Omit<", + "ThemeService", + ", \"init\">; chartsActiveCursorService: ", "ActiveCursor", "; datatableUtilities: ", { diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index bbcc3e7b554f2..03d6400c4be8b 100644 --- a/api_docs/expression_heatmap.mdx +++ b/api_docs/expression_heatmap.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap title: "expressionHeatmap" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionHeatmap plugin -date: 2023-06-30 +date: 2023-07-18 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 67dddb60149ec..f68a9666d303a 100644 --- a/api_docs/expression_image.mdx +++ b/api_docs/expression_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionImage title: "expressionImage" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionImage plugin -date: 2023-06-30 +date: 2023-07-18 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 83a31df66a811..95d1ca610a374 100644 --- a/api_docs/expression_legacy_metric_vis.mdx +++ b/api_docs/expression_legacy_metric_vis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis title: "expressionLegacyMetricVis" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionLegacyMetricVis plugin -date: 2023-06-30 +date: 2023-07-18 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 58dc2b1d88475..09cb3ccb6bc91 100644 --- a/api_docs/expression_metric.mdx +++ b/api_docs/expression_metric.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetric title: "expressionMetric" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionMetric plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] --- import expressionMetricObj from './expression_metric.devdocs.json'; diff --git a/api_docs/expression_metric_vis.devdocs.json b/api_docs/expression_metric_vis.devdocs.json index 22d54b78b9e6d..dfd0f3a000d80 100644 --- a/api_docs/expression_metric_vis.devdocs.json +++ b/api_docs/expression_metric_vis.devdocs.json @@ -863,12 +863,12 @@ { "parentPluginId": "expressionMetricVis", "id": "def-common.MetricVisRenderConfig.overrides", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "overrides", "description": [], "signature": [ - "Partial; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ", "LegendStrategy", - " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> | undefined" + " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial>) | undefined" ], "path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts", "deprecated": false, @@ -1012,7 +1012,7 @@ "label": "AvailableMetricIcon", "description": [], "signature": [ - "\"alert\" | \"temperature\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"compute\" | \"editorComment\" | \"empty\" | \"flag\" | \"globe\" | \"heart\" | \"mapMarker\" | \"pin\" | \"sortDown\" | \"sortUp\" | \"starEmpty\" | \"tag\"" + "\"alert\" | \"tag\" | \"temperature\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"compute\" | \"editorComment\" | \"empty\" | \"flag\" | \"globe\" | \"heart\" | \"mapMarker\" | \"pin\" | \"sortDown\" | \"sortUp\" | \"starEmpty\"" ], "path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts", "deprecated": false, diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx index 0c4232609f3f0..21b8dd7cdec50 100644 --- a/api_docs/expression_metric_vis.mdx +++ b/api_docs/expression_metric_vis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis title: "expressionMetricVis" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionMetricVis plugin -date: 2023-06-30 +date: 2023-07-18 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 813bc296286a2..408df0698486a 100644 --- a/api_docs/expression_partition_vis.mdx +++ b/api_docs/expression_partition_vis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis title: "expressionPartitionVis" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionPartitionVis plugin -date: 2023-06-30 +date: 2023-07-18 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 f20a7524b60b5..2bef0057ffcc3 100644 --- a/api_docs/expression_repeat_image.mdx +++ b/api_docs/expression_repeat_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage title: "expressionRepeatImage" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionRepeatImage plugin -date: 2023-06-30 +date: 2023-07-18 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 f9b6ba47e7433..2329de646304e 100644 --- a/api_docs/expression_reveal_image.mdx +++ b/api_docs/expression_reveal_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage title: "expressionRevealImage" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionRevealImage plugin -date: 2023-06-30 +date: 2023-07-18 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 ef603320e6d0f..22b250781f63a 100644 --- a/api_docs/expression_shape.mdx +++ b/api_docs/expression_shape.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionShape title: "expressionShape" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionShape plugin -date: 2023-06-30 +date: 2023-07-18 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 2ba509c870682..7f04c185002fd 100644 --- a/api_docs/expression_tagcloud.mdx +++ b/api_docs/expression_tagcloud.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud title: "expressionTagcloud" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionTagcloud plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] --- import expressionTagcloudObj from './expression_tagcloud.devdocs.json'; diff --git a/api_docs/expression_x_y.devdocs.json b/api_docs/expression_x_y.devdocs.json index 48f2615fc4e12..dea5fb9e26e9d 100644 --- a/api_docs/expression_x_y.devdocs.json +++ b/api_docs/expression_x_y.devdocs.json @@ -1950,7 +1950,7 @@ "CustomXDomain", " | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ", "LegendStrategy", - " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>>) | undefined" + " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial>) | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", "deprecated": false, @@ -2236,7 +2236,7 @@ "label": "AvailableReferenceLineIcon", "description": [], "signature": [ - "\"alert\" | \"circle\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"empty\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"triangle\"" + "\"alert\" | \"circle\" | \"tag\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"empty\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"triangle\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx index 3b89a347dbf57..6bff07599e530 100644 --- a/api_docs/expression_x_y.mdx +++ b/api_docs/expression_x_y.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionXY title: "expressionXY" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionXY plugin -date: 2023-06-30 +date: 2023-07-18 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 fc95731a8a0b6..fbc3148365c31 100644 --- a/api_docs/expressions.mdx +++ b/api_docs/expressions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions title: "expressions" image: https://source.unsplash.com/400x175/?github description: API docs for the expressions plugin -date: 2023-06-30 +date: 2023-07-18 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 1079256dbb711..3f329d7f351b6 100644 --- a/api_docs/features.devdocs.json +++ b/api_docs/features.devdocs.json @@ -64,7 +64,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; 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; }> | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; disabled?: boolean | 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; }> | 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; }> | 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; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -954,7 +954,7 @@ "\nDenotes which Primary Feature Privilege this sub-feature privilege should be included in.\n`read` is also included in `all` automatically." ], "signature": [ - "\"none\" | \"all\" | \"read\"" + "\"none\" | \"read\" | \"all\"" ], "path": "x-pack/plugins/features/common/sub_feature.ts", "deprecated": false, @@ -1272,7 +1272,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; 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; }> | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; disabled?: boolean | 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; }> | 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; }> | 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; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -2969,7 +2969,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; 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; }> | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; disabled?: boolean | 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; }> | 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; }> | 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; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -3233,7 +3233,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; 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; }> | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; disabled?: boolean | 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; }>" + "; 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; }> | 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; }>" ], "path": "x-pack/plugins/features/common/sub_feature.ts", "deprecated": false, @@ -3270,7 +3270,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; 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; }> | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; disabled?: boolean | 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[]; }>; }>[]; }>[]" + "; 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; }> | 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[]; }>; }>[]; }>[]" ], "path": "x-pack/plugins/features/common/sub_feature.ts", "deprecated": false, @@ -3314,7 +3314,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; 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; }> | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; disabled?: boolean | 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; }" + "; 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; }> | 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; }" ], "path": "x-pack/plugins/features/common/sub_feature.ts", "deprecated": false, @@ -4171,7 +4171,7 @@ "\nDenotes which Primary Feature Privilege this sub-feature privilege should be included in.\n`read` is also included in `all` automatically." ], "signature": [ - "\"none\" | \"all\" | \"read\"" + "\"none\" | \"read\" | \"all\"" ], "path": "x-pack/plugins/features/common/sub_feature.ts", "deprecated": false, diff --git a/api_docs/features.mdx b/api_docs/features.mdx index 127c2d2822f6f..8b342e20abea2 100644 --- a/api_docs/features.mdx +++ b/api_docs/features.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/features title: "features" image: https://source.unsplash.com/400x175/?github description: API docs for the features plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] --- import featuresObj from './features.devdocs.json'; diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index 687978bccc8ad..cb77366a616d7 100644 --- a/api_docs/field_formats.mdx +++ b/api_docs/field_formats.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats title: "fieldFormats" image: https://source.unsplash.com/400x175/?github description: API docs for the fieldFormats plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] --- import fieldFormatsObj from './field_formats.devdocs.json'; diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index ad991578c2ab9..10d05b6a4cd37 100644 --- a/api_docs/file_upload.mdx +++ b/api_docs/file_upload.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload title: "fileUpload" image: https://source.unsplash.com/400x175/?github description: API docs for the fileUpload plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] --- import fileUploadObj from './file_upload.devdocs.json'; diff --git a/api_docs/files.devdocs.json b/api_docs/files.devdocs.json index 6b2aba6f8174f..40f738a455dc1 100644 --- a/api_docs/files.devdocs.json +++ b/api_docs/files.devdocs.json @@ -2058,7 +2058,7 @@ "tags": [], "label": "indexIsAlias", "description": [ - "\nTreat the indices provided as Aliases. If set to true, ES `search()` will be used to\nretrieve the file info and content instead of `get()`. This is needed to ensure the\ncontent can be retrieved in cases where an index may have rolled over (ES `get()`\nneeds a \"real\" index)" + "\nTreat the indices provided as Aliases/Datastreams.\nWhen set to `true`:\n- additional ES calls will be made to get the real backing indexes\n- will not check if indexes exists and attempt to create them if not\n- an additional `@timestamp` property will be written to all documents (at root of document)" ], "signature": [ "boolean | undefined" diff --git a/api_docs/files.mdx b/api_docs/files.mdx index 4e809c08a8c47..212bd12c24882 100644 --- a/api_docs/files.mdx +++ b/api_docs/files.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/files title: "files" image: https://source.unsplash.com/400x175/?github description: API docs for the files plugin -date: 2023-06-30 +date: 2023-07-18 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 8a3d40d0b9191..c072ae6854f2b 100644 --- a/api_docs/files_management.mdx +++ b/api_docs/files_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement title: "filesManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the filesManagement plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement'] --- import filesManagementObj from './files_management.devdocs.json'; diff --git a/api_docs/fleet.devdocs.json b/api_docs/fleet.devdocs.json index 758c30cd14e5a..ee84d6deead3a 100644 --- a/api_docs/fleet.devdocs.json +++ b/api_docs/fleet.devdocs.json @@ -3899,6 +3899,22 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.uninstall_tokens", + "type": "Function", + "tags": [], + "label": "uninstall_tokens", + "description": [], + "signature": [ + "() => [string, string]" + ], + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "fleet", "id": "def-public.pagePathGetters.data_streams", @@ -20305,7 +20321,7 @@ "label": "install_source", "description": [], "signature": [ - "\"upload\" | \"registry\" | \"bundled\"" + "\"custom\" | \"upload\" | \"registry\" | \"bundled\"" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, @@ -20509,7 +20525,7 @@ "label": "installSource", "description": [], "signature": [ - "\"upload\" | \"registry\" | \"bundled\"" + "\"custom\" | \"upload\" | \"registry\" | \"bundled\"" ], "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false, @@ -21026,194 +21042,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput", - "type": "Interface", - "tags": [], - "label": "NewOutput", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.is_default", - "type": "boolean", - "tags": [], - "label": "is_default", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.is_default_monitoring", - "type": "boolean", - "tags": [], - "label": "is_default_monitoring", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.is_preconfigured", - "type": "CompoundType", - "tags": [], - "label": "is_preconfigured", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"logstash\" | \"elasticsearch\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.hosts", - "type": "Array", - "tags": [], - "label": "hosts", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.ca_sha256", - "type": "CompoundType", - "tags": [], - "label": "ca_sha256", - "description": [], - "signature": [ - "string | null | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.ca_trusted_fingerprint", - "type": "CompoundType", - "tags": [], - "label": "ca_trusted_fingerprint", - "description": [], - "signature": [ - "string | null | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.config_yaml", - "type": "CompoundType", - "tags": [], - "label": "config_yaml", - "description": [], - "signature": [ - "string | null | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.ssl", - "type": "CompoundType", - "tags": [], - "label": "ssl", - "description": [], - "signature": [ - "{ certificate_authorities?: string[] | undefined; certificate?: string | undefined; key?: string | undefined; } | null | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.proxy_id", - "type": "CompoundType", - "tags": [], - "label": "proxy_id", - "description": [], - "signature": [ - "string | null | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.shipper", - "type": "CompoundType", - "tags": [], - "label": "shipper", - "description": [], - "signature": [ - "ShipperOutput", - " | null | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.allow_edit", - "type": "Array", - "tags": [], - "label": "allow_edit", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "fleet", "id": "def-common.NewPackagePolicy", @@ -22803,6 +22631,36 @@ "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.routing_rules", + "type": "Array", + "tags": [], + "label": "[RegistryDataStreamKeys.routing_rules]", + "description": [], + "signature": [ + "RegistryDataStreamRoutingRules", + "[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.lifecycle", + "type": "Object", + "tags": [], + "label": "[RegistryDataStreamKeys.lifecycle]", + "description": [], + "signature": [ + "RegistryDataStreamLifecycle", + " | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -24898,6 +24756,25 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.NewOutput", + "type": "Type", + "tags": [], + "label": "NewOutput", + "description": [], + "signature": [ + "NewElasticsearchOutput", + " | ", + "NewLogstashOutput", + " | ", + "KafkaOutput" + ], + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.NotInstalled", @@ -26904,6 +26781,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "fleet", + "id": "def-common.EPM_API_ROUTES.CUSTOM_INTEGRATIONS_PATTERN", + "type": "string", + "tags": [], + "label": "CUSTOM_INTEGRATIONS_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.DELETE_PATTERN", diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index 4cb5430104b85..f67d4425c41e4 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet title: "fleet" image: https://source.unsplash.com/400x175/?github description: API docs for the fleet plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] --- import fleetObj from './fleet.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) for questi | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 1191 | 3 | 1075 | 36 | +| 1182 | 3 | 1066 | 40 | ## Client diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index e5ea2aeecd2a7..cc8a9b93fb41e 100644 --- a/api_docs/global_search.mdx +++ b/api_docs/global_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/globalSearch title: "globalSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the globalSearch plugin -date: 2023-06-30 +date: 2023-07-18 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 e53b84ea30c45..610233322e04d 100644 --- a/api_docs/guided_onboarding.mdx +++ b/api_docs/guided_onboarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/guidedOnboarding title: "guidedOnboarding" image: https://source.unsplash.com/400x175/?github description: API docs for the guidedOnboarding plugin -date: 2023-06-30 +date: 2023-07-18 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 c006f13e44f54..8cebec5105bd3 100644 --- a/api_docs/home.mdx +++ b/api_docs/home.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/home title: "home" image: https://source.unsplash.com/400x175/?github description: API docs for the home plugin -date: 2023-06-30 +date: 2023-07-18 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 37874756ae600..eff026a2b54a2 100644 --- a/api_docs/image_embeddable.mdx +++ b/api_docs/image_embeddable.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/imageEmbeddable title: "imageEmbeddable" image: https://source.unsplash.com/400x175/?github description: API docs for the imageEmbeddable plugin -date: 2023-06-30 +date: 2023-07-18 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 5e7e7abc13378..da0216eed5dbf 100644 --- a/api_docs/index_lifecycle_management.mdx +++ b/api_docs/index_lifecycle_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement title: "indexLifecycleManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the indexLifecycleManagement plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] --- import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json'; diff --git a/api_docs/index_management.devdocs.json b/api_docs/index_management.devdocs.json index bfdd40f900a37..15ae3372c6048 100644 --- a/api_docs/index_management.devdocs.json +++ b/api_docs/index_management.devdocs.json @@ -750,7 +750,7 @@ "label": "IndexManagementConfig", "description": [], "signature": [ - "{ readonly ui: Readonly<{} & { enabled: boolean; }>; }" + "{ readonly ui: Readonly<{} & { enabled: boolean; }>; readonly enableIndexActions: boolean; }" ], "path": "x-pack/plugins/index_management/server/config.ts", "deprecated": false, diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index 9ba60a392c0cb..69106039d28af 100644 --- a/api_docs/index_management.mdx +++ b/api_docs/index_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexManagement title: "indexManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the indexManagement plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] --- import indexManagementObj from './index_management.devdocs.json'; diff --git a/api_docs/infra.devdocs.json b/api_docs/infra.devdocs.json index 28ccc0b48df5d..8e89a67df15ec 100644 --- a/api_docs/infra.devdocs.json +++ b/api_docs/infra.devdocs.json @@ -2,95 +2,8 @@ "id": "infra", "client": { "classes": [], - "functions": [ - { - "parentPluginId": "infra", - "id": "def-public.LazyLogStreamWrapper", - "type": "Function", - "tags": [], - "label": "LazyLogStreamWrapper", - "description": [], - "signature": [ - "(props: ", - { - "pluginId": "infra", - "scope": "public", - "docId": "kibInfraPluginApi", - "section": "def-public.LogStreamProps", - "text": "LogStreamProps" - }, - ") => JSX.Element" - ], - "path": "x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "infra", - "id": "def-public.LazyLogStreamWrapper.$1", - "type": "Object", - "tags": [], - "label": "props", - "description": [], - "signature": [ - { - "pluginId": "infra", - "scope": "public", - "docId": "kibInfraPluginApi", - "section": "def-public.LogStreamProps", - "text": "LogStreamProps" - } - ], - "path": "x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "parentPluginId": "infra", - "id": "def-public.LogStreamProps", - "type": "Interface", - "tags": [], - "label": "LogStreamProps", - "description": [], - "signature": [ - { - "pluginId": "infra", - "scope": "public", - "docId": "kibInfraPluginApi", - "section": "def-public.LogStreamProps", - "text": "LogStreamProps" - }, - " extends LogStreamContentProps" - ], - "path": "x-pack/plugins/infra/public/components/log_stream/log_stream.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "infra", - "id": "def-public.LogStreamProps.height", - "type": "CompoundType", - "tags": [], - "label": "height", - "description": [], - "signature": [ - "string | number | undefined" - ], - "path": "x-pack/plugins/infra/public/components/log_stream/log_stream.tsx", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - } - ], + "functions": [], + "interfaces": [], "enums": [ { "parentPluginId": "infra", @@ -337,20 +250,6 @@ "deprecated": false, "trackAdoption": false }, - { - "parentPluginId": "infra", - "id": "def-public.InfraClientStartExports.logViews", - "type": "Object", - "tags": [], - "label": "logViews", - "description": [], - "signature": [ - "LogViewsServiceStart" - ], - "path": "x-pack/plugins/infra/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, { "parentPluginId": "infra", "id": "def-public.InfraClientStartExports.metricsExplorerViews", @@ -673,13 +572,27 @@ }, { "parentPluginId": "infra", - "id": "def-server.InfraPluginSetup.logViews", - "type": "Object", + "id": "def-server.InfraPluginSetup.inventoryViews", + "type": "Uncategorized", "tags": [], - "label": "logViews", + "label": "inventoryViews", "description": [], "signature": [ - "LogViewsServiceSetup" + "void" + ], + "path": "x-pack/plugins/infra/server/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "infra", + "id": "def-server.InfraPluginSetup.metricsExplorerViews", + "type": "Uncategorized", + "tags": [], + "label": "metricsExplorerViews", + "description": [], + "signature": [ + "void" ], "path": "x-pack/plugins/infra/server/types.ts", "deprecated": false, @@ -714,20 +627,6 @@ "deprecated": false, "trackAdoption": false }, - { - "parentPluginId": "infra", - "id": "def-server.InfraPluginStart.logViews", - "type": "Object", - "tags": [], - "label": "logViews", - "description": [], - "signature": [ - "LogViewsServiceStart" - ], - "path": "x-pack/plugins/infra/server/types.ts", - "deprecated": false, - "trackAdoption": false - }, { "parentPluginId": "infra", "id": "def-server.InfraPluginStart.metricsExplorerViews", diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index a95d95b2f1ae8..b7e06ffc3d9dd 100644 --- a/api_docs/infra.mdx +++ b/api_docs/infra.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/infra title: "infra" image: https://source.unsplash.com/400x175/?github description: API docs for the infra plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] --- import infraObj from './infra.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/inf | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 49 | 0 | 46 | 14 | +| 44 | 0 | 41 | 11 | ## Client @@ -31,12 +31,6 @@ Contact [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/inf ### Objects -### Functions - - -### Interfaces - - ### Enums diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index 46015cb7fdf45..c13c207150017 100644 --- a/api_docs/inspector.mdx +++ b/api_docs/inspector.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inspector title: "inspector" image: https://source.unsplash.com/400x175/?github description: API docs for the inspector plugin -date: 2023-06-30 +date: 2023-07-18 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 d95fbef2f92ed..b702db57d6e3e 100644 --- a/api_docs/interactive_setup.mdx +++ b/api_docs/interactive_setup.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/interactiveSetup title: "interactiveSetup" image: https://source.unsplash.com/400x175/?github description: API docs for the interactiveSetup plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup'] --- import interactiveSetupObj from './interactive_setup.devdocs.json'; diff --git a/api_docs/kbn_ace.mdx b/api_docs/kbn_ace.mdx index 97e504fba24a2..7fde6a4caa004 100644 --- a/api_docs/kbn_ace.mdx +++ b/api_docs/kbn_ace.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ace title: "@kbn/ace" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ace plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace'] --- import kbnAceObj from './kbn_ace.devdocs.json'; diff --git a/api_docs/kbn_aiops_components.mdx b/api_docs/kbn_aiops_components.mdx index ec58624389c64..043a56042376e 100644 --- a/api_docs/kbn_aiops_components.mdx +++ b/api_docs/kbn_aiops_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-components title: "@kbn/aiops-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/aiops-components plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components'] --- import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json'; diff --git a/api_docs/kbn_aiops_utils.mdx b/api_docs/kbn_aiops_utils.mdx index 284ab00535c41..c6dfbb817f49f 100644 --- a/api_docs/kbn_aiops_utils.mdx +++ b/api_docs/kbn_aiops_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils title: "@kbn/aiops-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/aiops-utils plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils'] --- import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json'; diff --git a/api_docs/kbn_alerting_state_types.mdx b/api_docs/kbn_alerting_state_types.mdx index 726cb14e740ff..629ee5572d2ae 100644 --- a/api_docs/kbn_alerting_state_types.mdx +++ b/api_docs/kbn_alerting_state_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-state-types title: "@kbn/alerting-state-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerting-state-types plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types'] --- import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json'; diff --git a/api_docs/kbn_alerts_as_data_utils.devdocs.json b/api_docs/kbn_alerts_as_data_utils.devdocs.json index 9849eec4e5d5b..c58905ca35d4f 100644 --- a/api_docs/kbn_alerts_as_data_utils.devdocs.json +++ b/api_docs/kbn_alerts_as_data_utils.devdocs.json @@ -148,7 +148,7 @@ "label": "AADAlert", "description": [], "signature": [ - "({ '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; }) | ({} & { agent?: { name?: string | undefined; } | undefined; error?: { grouping_key?: string | undefined; } | undefined; kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; processor?: { event?: string | undefined; } | undefined; service?: { environment?: string | undefined; language?: { name?: string | undefined; } | undefined; name?: string | undefined; } | undefined; transaction?: { name?: string | undefined; type?: string | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; ecs: { version: string; }; } & { agent?: { build?: { original?: string | undefined; } | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; client?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; cloud?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; origin?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; target?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; } | undefined; container?: { cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; id?: string | undefined; image?: { hash?: { all?: string[] | undefined; } | undefined; name?: string | undefined; tag?: string[] | undefined; } | undefined; memory?: { usage?: string | number | undefined; } | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; } | undefined; } | undefined; runtime?: string | undefined; } | undefined; destination?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; device?: { id?: string | undefined; manufacturer?: string | undefined; model?: { identifier?: string | undefined; name?: string | undefined; } | undefined; } | undefined; dll?: { code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; name?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; } | undefined; dns?: { answers?: { class?: string | undefined; data?: string | undefined; name?: string | undefined; ttl?: string | number | undefined; type?: string | undefined; }[] | undefined; header_flags?: string[] | undefined; id?: string | undefined; op_code?: string | undefined; question?: { class?: string | undefined; name?: string | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; type?: string | undefined; } | undefined; resolved_ip?: string[] | undefined; response_code?: string | undefined; type?: string | undefined; } | undefined; email?: { attachments?: { file?: { extension?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; mime_type?: string | undefined; name?: string | undefined; size?: string | number | undefined; } | undefined; }[] | undefined; bcc?: { address?: string[] | undefined; } | undefined; cc?: { address?: string[] | undefined; } | undefined; content_type?: string | undefined; delivery_timestamp?: string | undefined; direction?: string | undefined; from?: { address?: string[] | undefined; } | undefined; local_id?: string | undefined; message_id?: string | undefined; origination_timestamp?: string | undefined; reply_to?: { address?: string[] | undefined; } | undefined; sender?: { address?: string | undefined; } | undefined; subject?: string | undefined; to?: { address?: string[] | undefined; } | undefined; x_mailer?: string | undefined; } | undefined; error?: { code?: string | undefined; id?: string | undefined; message?: string | undefined; stack_trace?: string | undefined; type?: string | undefined; } | undefined; event?: { action?: string | undefined; agent_id_status?: string | undefined; category?: string[] | undefined; code?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: string | number | undefined; end?: string | undefined; hash?: string | undefined; id?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; type?: string[] | undefined; url?: string | undefined; } | undefined; faas?: { coldstart?: boolean | undefined; execution?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; host?: { architecture?: string | undefined; boot?: { id?: string | undefined; } | undefined; cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; id?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; } | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; pid_ns_ino?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; type?: string | undefined; uptime?: string | number | undefined; } | undefined; http?: { request?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; id?: string | undefined; method?: string | undefined; mime_type?: string | undefined; referrer?: string | undefined; } | undefined; response?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; mime_type?: string | undefined; status_code?: string | number | undefined; } | undefined; version?: string | undefined; } | undefined; log?: { file?: { path?: string | undefined; } | undefined; level?: string | undefined; logger?: string | undefined; origin?: { file?: { line?: string | number | undefined; name?: string | undefined; } | undefined; function?: string | undefined; } | undefined; } | undefined; message?: string | undefined; network?: { application?: string | undefined; bytes?: string | number | undefined; community_id?: string | undefined; direction?: string | undefined; forwarded_ip?: string | undefined; iana_number?: string | undefined; name?: string | undefined; packets?: string | number | undefined; protocol?: string | undefined; transport?: string | undefined; type?: string | undefined; vlan?: { id?: string | undefined; name?: string | undefined; } | undefined; } | undefined; observer?: { geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; product?: string | undefined; serial_number?: string | undefined; type?: string | undefined; vendor?: string | undefined; version?: string | undefined; } | undefined; orchestrator?: { api_version?: string | undefined; cluster?: { id?: string | undefined; name?: string | undefined; url?: string | undefined; version?: string | undefined; } | undefined; namespace?: string | undefined; organization?: string | undefined; resource?: { id?: string | undefined; ip?: string[] | undefined; name?: string | undefined; parent?: { type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; organization?: { id?: string | undefined; name?: string | undefined; } | undefined; package?: { architecture?: string | undefined; build_version?: string | undefined; checksum?: string | undefined; description?: string | undefined; install_scope?: string | undefined; installed?: string | undefined; license?: string | undefined; name?: string | undefined; path?: string | undefined; reference?: string | undefined; size?: string | number | undefined; type?: string | undefined; version?: string | undefined; } | undefined; process?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; entry_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; attested_groups?: { name?: string | undefined; } | undefined; attested_user?: { id?: string | undefined; name?: string | undefined; } | undefined; command_line?: string | undefined; entity_id?: string | undefined; entry_meta?: { source?: { ip?: string | undefined; } | undefined; type?: string | undefined; } | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; env_vars?: string[] | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; group_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; previous?: { args?: string[] | undefined; args_count?: string | number | undefined; executable?: string | undefined; } | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; session_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; related?: { hash?: string[] | undefined; hosts?: string[] | undefined; ip?: string[] | undefined; user?: string[] | undefined; } | undefined; rule?: { author?: string[] | undefined; category?: string | undefined; description?: string | undefined; id?: string | undefined; license?: string | undefined; name?: string | undefined; reference?: string | undefined; ruleset?: string | undefined; uuid?: string | undefined; version?: string | undefined; } | undefined; server?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; service?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; origin?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; state?: string | undefined; target?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; type?: string | undefined; version?: string | undefined; } | undefined; source?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; span?: { id?: string | undefined; } | undefined; tags?: string[] | undefined; threat?: { enrichments?: { matched?: { atomic?: string | undefined; field?: string | undefined; id?: string | undefined; index?: string | undefined; occurred?: string | undefined; type?: string | undefined; } | undefined; }[] | undefined; feed?: { dashboard_id?: string | undefined; description?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; framework?: string | undefined; group?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; indicator?: { as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; confidence?: string | undefined; description?: string | undefined; email?: { address?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; first_seen?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; last_seen?: string | undefined; marking?: { tlp?: string | undefined; tlp_version?: string | undefined; } | undefined; modified_at?: string | undefined; port?: string | number | undefined; provider?: string | undefined; reference?: string | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; scanner_stats?: string | number | undefined; sightings?: string | number | undefined; type?: string | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; software?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; platforms?: string[] | undefined; reference?: string | undefined; type?: string | undefined; } | undefined; tactic?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; technique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; subtechnique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; } | undefined; } | undefined; tls?: { cipher?: string | undefined; client?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; server_name?: string | undefined; subject?: string | undefined; supported_ciphers?: string[] | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; curve?: string | undefined; established?: boolean | undefined; next_protocol?: string | undefined; resumed?: boolean | undefined; server?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3s?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; version?: string | undefined; version_protocol?: string | undefined; } | undefined; trace?: { id?: string | undefined; } | undefined; transaction?: { id?: string | undefined; } | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; user?: { changes?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; domain?: string | undefined; effective?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; roles?: string[] | undefined; target?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; user_agent?: { device?: { name?: string | undefined; } | undefined; name?: string | undefined; original?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; version?: string | undefined; } | undefined; vulnerability?: { category?: string[] | undefined; classification?: string | undefined; description?: string | undefined; enumeration?: string | undefined; id?: string | undefined; reference?: string | undefined; report_id?: string | undefined; scanner?: { vendor?: string | undefined; } | undefined; score?: { base?: number | undefined; environmental?: number | undefined; temporal?: number | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; } | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; ecs: { version: string; }; } & { agent?: { build?: { original?: string | undefined; } | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; client?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; cloud?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; origin?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; target?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; } | undefined; container?: { cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; id?: string | undefined; image?: { hash?: { all?: string[] | undefined; } | undefined; name?: string | undefined; tag?: string[] | undefined; } | undefined; memory?: { usage?: string | number | undefined; } | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; } | undefined; } | undefined; runtime?: string | undefined; } | undefined; destination?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; device?: { id?: string | undefined; manufacturer?: string | undefined; model?: { identifier?: string | undefined; name?: string | undefined; } | undefined; } | undefined; dll?: { code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; name?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; } | undefined; dns?: { answers?: { class?: string | undefined; data?: string | undefined; name?: string | undefined; ttl?: string | number | undefined; type?: string | undefined; }[] | undefined; header_flags?: string[] | undefined; id?: string | undefined; op_code?: string | undefined; question?: { class?: string | undefined; name?: string | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; type?: string | undefined; } | undefined; resolved_ip?: string[] | undefined; response_code?: string | undefined; type?: string | undefined; } | undefined; email?: { attachments?: { file?: { extension?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; mime_type?: string | undefined; name?: string | undefined; size?: string | number | undefined; } | undefined; }[] | undefined; bcc?: { address?: string[] | undefined; } | undefined; cc?: { address?: string[] | undefined; } | undefined; content_type?: string | undefined; delivery_timestamp?: string | undefined; direction?: string | undefined; from?: { address?: string[] | undefined; } | undefined; local_id?: string | undefined; message_id?: string | undefined; origination_timestamp?: string | undefined; reply_to?: { address?: string[] | undefined; } | undefined; sender?: { address?: string | undefined; } | undefined; subject?: string | undefined; to?: { address?: string[] | undefined; } | undefined; x_mailer?: string | undefined; } | undefined; error?: { code?: string | undefined; id?: string | undefined; message?: string | undefined; stack_trace?: string | undefined; type?: string | undefined; } | undefined; event?: { action?: string | undefined; agent_id_status?: string | undefined; category?: string[] | undefined; code?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: string | number | undefined; end?: string | undefined; hash?: string | undefined; id?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; type?: string[] | undefined; url?: string | undefined; } | undefined; faas?: { coldstart?: boolean | undefined; execution?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; host?: { architecture?: string | undefined; boot?: { id?: string | undefined; } | undefined; cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; id?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; } | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; pid_ns_ino?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; type?: string | undefined; uptime?: string | number | undefined; } | undefined; http?: { request?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; id?: string | undefined; method?: string | undefined; mime_type?: string | undefined; referrer?: string | undefined; } | undefined; response?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; mime_type?: string | undefined; status_code?: string | number | undefined; } | undefined; version?: string | undefined; } | undefined; log?: { file?: { path?: string | undefined; } | undefined; level?: string | undefined; logger?: string | undefined; origin?: { file?: { line?: string | number | undefined; name?: string | undefined; } | undefined; function?: string | undefined; } | undefined; } | undefined; message?: string | undefined; network?: { application?: string | undefined; bytes?: string | number | undefined; community_id?: string | undefined; direction?: string | undefined; forwarded_ip?: string | undefined; iana_number?: string | undefined; name?: string | undefined; packets?: string | number | undefined; protocol?: string | undefined; transport?: string | undefined; type?: string | undefined; vlan?: { id?: string | undefined; name?: string | undefined; } | undefined; } | undefined; observer?: { geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; product?: string | undefined; serial_number?: string | undefined; type?: string | undefined; vendor?: string | undefined; version?: string | undefined; } | undefined; orchestrator?: { api_version?: string | undefined; cluster?: { id?: string | undefined; name?: string | undefined; url?: string | undefined; version?: string | undefined; } | undefined; namespace?: string | undefined; organization?: string | undefined; resource?: { id?: string | undefined; ip?: string[] | undefined; name?: string | undefined; parent?: { type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; organization?: { id?: string | undefined; name?: string | undefined; } | undefined; package?: { architecture?: string | undefined; build_version?: string | undefined; checksum?: string | undefined; description?: string | undefined; install_scope?: string | undefined; installed?: string | undefined; license?: string | undefined; name?: string | undefined; path?: string | undefined; reference?: string | undefined; size?: string | number | undefined; type?: string | undefined; version?: string | undefined; } | undefined; process?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; entry_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; attested_groups?: { name?: string | undefined; } | undefined; attested_user?: { id?: string | undefined; name?: string | undefined; } | undefined; command_line?: string | undefined; entity_id?: string | undefined; entry_meta?: { source?: { ip?: string | undefined; } | undefined; type?: string | undefined; } | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; env_vars?: string[] | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; group_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; previous?: { args?: string[] | undefined; args_count?: string | number | undefined; executable?: string | undefined; } | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; session_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; related?: { hash?: string[] | undefined; hosts?: string[] | undefined; ip?: string[] | undefined; user?: string[] | undefined; } | undefined; rule?: { author?: string[] | undefined; category?: string | undefined; description?: string | undefined; id?: string | undefined; license?: string | undefined; name?: string | undefined; reference?: string | undefined; ruleset?: string | undefined; uuid?: string | undefined; version?: string | undefined; } | undefined; server?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; service?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; origin?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; state?: string | undefined; target?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; type?: string | undefined; version?: string | undefined; } | undefined; source?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; span?: { id?: string | undefined; } | undefined; tags?: string[] | undefined; threat?: { enrichments?: { matched?: { atomic?: string | undefined; field?: string | undefined; id?: string | undefined; index?: string | undefined; occurred?: string | undefined; type?: string | undefined; } | undefined; }[] | undefined; feed?: { dashboard_id?: string | undefined; description?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; framework?: string | undefined; group?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; indicator?: { as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; confidence?: string | undefined; description?: string | undefined; email?: { address?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; first_seen?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; last_seen?: string | undefined; marking?: { tlp?: string | undefined; tlp_version?: string | undefined; } | undefined; modified_at?: string | undefined; port?: string | number | undefined; provider?: string | undefined; reference?: string | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; scanner_stats?: string | number | undefined; sightings?: string | number | undefined; type?: string | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; software?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; platforms?: string[] | undefined; reference?: string | undefined; type?: string | undefined; } | undefined; tactic?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; technique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; subtechnique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; } | undefined; } | undefined; tls?: { cipher?: string | undefined; client?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; server_name?: string | undefined; subject?: string | undefined; supported_ciphers?: string[] | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; curve?: string | undefined; established?: boolean | undefined; next_protocol?: string | undefined; resumed?: boolean | undefined; server?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3s?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; version?: string | undefined; version_protocol?: string | undefined; } | undefined; trace?: { id?: string | undefined; } | undefined; transaction?: { id?: string | undefined; } | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; user?: { changes?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; domain?: string | undefined; effective?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; roles?: string[] | undefined; target?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; user_agent?: { device?: { name?: string | undefined; } | undefined; name?: string | undefined; original?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; version?: string | undefined; } | undefined; vulnerability?: { category?: string[] | undefined; classification?: string | undefined; description?: string | undefined; enumeration?: string | undefined; id?: string | undefined; reference?: string | undefined; report_id?: string | undefined; scanner?: { vendor?: string | undefined; } | undefined; score?: { base?: number | undefined; environmental?: number | undefined; temporal?: number | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; } | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; slo?: { id?: string | undefined; revision?: string | number | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { agent?: { name?: string | undefined; } | undefined; anomaly?: { bucket_span?: { minutes?: string | undefined; } | undefined; start?: string | undefined; } | undefined; error?: { message?: string | undefined; } | undefined; kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; monitor?: { id?: string | undefined; name?: string | undefined; type?: string | undefined; } | undefined; observer?: { geo?: { name?: string | undefined; } | undefined; } | undefined; tls?: { server?: { hash?: { sha256?: string | undefined; } | undefined; x509?: { issuer?: { common_name?: string | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: { common_name?: string | undefined; } | undefined; } | undefined; } | undefined; } | undefined; url?: { full?: string | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({ '@timestamp': string; kibana: { alert: { ancestors: { depth: string | number; id: string; index: string; type: string; }[]; depth: string | number; instance: { id: string; }; original_event: { action: string; category: string[]; created: string; dataset: string; id: string; ingested: string; kind: string; module: string; original: string; outcome: string; provider: string; sequence: string | number; type: string[]; }; original_time: string; rule: { category: string; consumer: string; false_positives: string[]; max_signals: (string | number)[]; name: string; producer: string; revision: string | number; rule_type_id: string; threat: { framework: string; tactic: { id: string; name: string; reference: string; }; technique: { id: string; name: string; reference: string; subtechnique: { id: string; name: string; reference: string; }; }; }; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { ecs?: { version?: string | undefined; } | undefined; event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; ancestors?: { rule?: string | undefined; } | undefined; building_block_type?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; group?: { id?: string | undefined; index?: number | undefined; } | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; new_terms?: string[] | undefined; original_event?: { agent_id_status?: string | undefined; code?: string | undefined; duration?: string | undefined; end?: string | undefined; hash?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; url?: string | undefined; } | undefined; reason?: string | undefined; risk_score?: number | undefined; rule?: { author?: string | undefined; building_block_type?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; execution?: { uuid?: string | undefined; } | undefined; from?: string | undefined; immutable?: string[] | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; parameters?: unknown; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; tags?: string[] | undefined; timeline_id?: string[] | undefined; timeline_title?: string[] | undefined; timestamp_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; start?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; threshold_result?: { count?: string | number | undefined; from?: string | undefined; terms?: { field?: string | undefined; value?: string | undefined; }[] | undefined; } | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_reason?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; workflow_user?: string | undefined; } | undefined; version?: string | undefined; } | undefined; signal?: { ancestors?: { depth?: unknown; id?: unknown; index?: unknown; type?: unknown; } | undefined; depth?: unknown; group?: { id?: unknown; index?: unknown; } | undefined; original_event?: { action?: unknown; category?: unknown; code?: unknown; created?: unknown; dataset?: unknown; duration?: unknown; end?: unknown; hash?: unknown; id?: unknown; kind?: unknown; module?: unknown; outcome?: unknown; provider?: unknown; reason?: unknown; risk_score?: unknown; risk_score_norm?: unknown; sequence?: unknown; severity?: unknown; start?: unknown; timezone?: unknown; type?: unknown; } | undefined; original_time?: unknown; reason?: unknown; rule?: { author?: unknown; building_block_type?: unknown; created_at?: unknown; created_by?: unknown; description?: unknown; enabled?: unknown; false_positives?: unknown; from?: unknown; id?: unknown; immutable?: unknown; interval?: unknown; license?: unknown; max_signals?: unknown; name?: unknown; note?: unknown; references?: unknown; risk_score?: unknown; rule_id?: unknown; rule_name_override?: unknown; severity?: unknown; tags?: unknown; threat?: { framework?: unknown; tactic?: { id?: unknown; name?: unknown; reference?: unknown; } | undefined; technique?: { id?: unknown; name?: unknown; reference?: unknown; subtechnique?: { id?: unknown; name?: unknown; reference?: unknown; } | undefined; } | undefined; } | undefined; timeline_id?: unknown; timeline_title?: unknown; timestamp_override?: unknown; to?: unknown; type?: unknown; updated_at?: unknown; updated_by?: unknown; version?: unknown; } | undefined; status?: unknown; threshold_result?: { cardinality?: { field?: unknown; value?: unknown; } | undefined; count?: unknown; from?: unknown; terms?: { field?: unknown; value?: unknown; } | undefined; } | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; ecs: { version: string; }; } & { agent?: { build?: { original?: string | undefined; } | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; client?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; cloud?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; origin?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; target?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; } | undefined; container?: { cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; id?: string | undefined; image?: { hash?: { all?: string[] | undefined; } | undefined; name?: string | undefined; tag?: string[] | undefined; } | undefined; memory?: { usage?: string | number | undefined; } | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; } | undefined; } | undefined; runtime?: string | undefined; } | undefined; destination?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; device?: { id?: string | undefined; manufacturer?: string | undefined; model?: { identifier?: string | undefined; name?: string | undefined; } | undefined; } | undefined; dll?: { code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; name?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; } | undefined; dns?: { answers?: { class?: string | undefined; data?: string | undefined; name?: string | undefined; ttl?: string | number | undefined; type?: string | undefined; }[] | undefined; header_flags?: string[] | undefined; id?: string | undefined; op_code?: string | undefined; question?: { class?: string | undefined; name?: string | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; type?: string | undefined; } | undefined; resolved_ip?: string[] | undefined; response_code?: string | undefined; type?: string | undefined; } | undefined; email?: { attachments?: { file?: { extension?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; mime_type?: string | undefined; name?: string | undefined; size?: string | number | undefined; } | undefined; }[] | undefined; bcc?: { address?: string[] | undefined; } | undefined; cc?: { address?: string[] | undefined; } | undefined; content_type?: string | undefined; delivery_timestamp?: string | undefined; direction?: string | undefined; from?: { address?: string[] | undefined; } | undefined; local_id?: string | undefined; message_id?: string | undefined; origination_timestamp?: string | undefined; reply_to?: { address?: string[] | undefined; } | undefined; sender?: { address?: string | undefined; } | undefined; subject?: string | undefined; to?: { address?: string[] | undefined; } | undefined; x_mailer?: string | undefined; } | undefined; error?: { code?: string | undefined; id?: string | undefined; message?: string | undefined; stack_trace?: string | undefined; type?: string | undefined; } | undefined; event?: { action?: string | undefined; agent_id_status?: string | undefined; category?: string[] | undefined; code?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: string | number | undefined; end?: string | undefined; hash?: string | undefined; id?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; type?: string[] | undefined; url?: string | undefined; } | undefined; faas?: { coldstart?: boolean | undefined; execution?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; host?: { architecture?: string | undefined; boot?: { id?: string | undefined; } | undefined; cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; id?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; } | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; pid_ns_ino?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; type?: string | undefined; uptime?: string | number | undefined; } | undefined; http?: { request?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; id?: string | undefined; method?: string | undefined; mime_type?: string | undefined; referrer?: string | undefined; } | undefined; response?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; mime_type?: string | undefined; status_code?: string | number | undefined; } | undefined; version?: string | undefined; } | undefined; log?: { file?: { path?: string | undefined; } | undefined; level?: string | undefined; logger?: string | undefined; origin?: { file?: { line?: string | number | undefined; name?: string | undefined; } | undefined; function?: string | undefined; } | undefined; } | undefined; message?: string | undefined; network?: { application?: string | undefined; bytes?: string | number | undefined; community_id?: string | undefined; direction?: string | undefined; forwarded_ip?: string | undefined; iana_number?: string | undefined; name?: string | undefined; packets?: string | number | undefined; protocol?: string | undefined; transport?: string | undefined; type?: string | undefined; vlan?: { id?: string | undefined; name?: string | undefined; } | undefined; } | undefined; observer?: { geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; product?: string | undefined; serial_number?: string | undefined; type?: string | undefined; vendor?: string | undefined; version?: string | undefined; } | undefined; orchestrator?: { api_version?: string | undefined; cluster?: { id?: string | undefined; name?: string | undefined; url?: string | undefined; version?: string | undefined; } | undefined; namespace?: string | undefined; organization?: string | undefined; resource?: { id?: string | undefined; ip?: string[] | undefined; name?: string | undefined; parent?: { type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; organization?: { id?: string | undefined; name?: string | undefined; } | undefined; package?: { architecture?: string | undefined; build_version?: string | undefined; checksum?: string | undefined; description?: string | undefined; install_scope?: string | undefined; installed?: string | undefined; license?: string | undefined; name?: string | undefined; path?: string | undefined; reference?: string | undefined; size?: string | number | undefined; type?: string | undefined; version?: string | undefined; } | undefined; process?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; entry_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; attested_groups?: { name?: string | undefined; } | undefined; attested_user?: { id?: string | undefined; name?: string | undefined; } | undefined; command_line?: string | undefined; entity_id?: string | undefined; entry_meta?: { source?: { ip?: string | undefined; } | undefined; type?: string | undefined; } | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; env_vars?: string[] | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; group_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; previous?: { args?: string[] | undefined; args_count?: string | number | undefined; executable?: string | undefined; } | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; session_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; related?: { hash?: string[] | undefined; hosts?: string[] | undefined; ip?: string[] | undefined; user?: string[] | undefined; } | undefined; rule?: { author?: string[] | undefined; category?: string | undefined; description?: string | undefined; id?: string | undefined; license?: string | undefined; name?: string | undefined; reference?: string | undefined; ruleset?: string | undefined; uuid?: string | undefined; version?: string | undefined; } | undefined; server?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; service?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; origin?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; state?: string | undefined; target?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; type?: string | undefined; version?: string | undefined; } | undefined; source?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; span?: { id?: string | undefined; } | undefined; tags?: string[] | undefined; threat?: { enrichments?: { matched?: { atomic?: string | undefined; field?: string | undefined; id?: string | undefined; index?: string | undefined; occurred?: string | undefined; type?: string | undefined; } | undefined; }[] | undefined; feed?: { dashboard_id?: string | undefined; description?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; framework?: string | undefined; group?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; indicator?: { as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; confidence?: string | undefined; description?: string | undefined; email?: { address?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; first_seen?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; last_seen?: string | undefined; marking?: { tlp?: string | undefined; tlp_version?: string | undefined; } | undefined; modified_at?: string | undefined; port?: string | number | undefined; provider?: string | undefined; reference?: string | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; scanner_stats?: string | number | undefined; sightings?: string | number | undefined; type?: string | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; software?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; platforms?: string[] | undefined; reference?: string | undefined; type?: string | undefined; } | undefined; tactic?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; technique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; subtechnique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; } | undefined; } | undefined; tls?: { cipher?: string | undefined; client?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; server_name?: string | undefined; subject?: string | undefined; supported_ciphers?: string[] | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; curve?: string | undefined; established?: boolean | undefined; next_protocol?: string | undefined; resumed?: boolean | undefined; server?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3s?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; version?: string | undefined; version_protocol?: string | undefined; } | undefined; trace?: { id?: string | undefined; } | undefined; transaction?: { id?: string | undefined; } | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; user?: { changes?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; domain?: string | undefined; effective?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; roles?: string[] | undefined; target?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; user_agent?: { device?: { name?: string | undefined; } | undefined; name?: string | undefined; original?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; version?: string | undefined; } | undefined; vulnerability?: { category?: string[] | undefined; classification?: string | undefined; description?: string | undefined; enumeration?: string | undefined; id?: string | undefined; reference?: string | undefined; report_id?: string | undefined; scanner?: { vendor?: string | undefined; } | undefined; score?: { base?: number | undefined; environmental?: number | undefined; temporal?: number | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; } | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; })" + "({ '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; }) | ({} & { agent?: { name?: string | undefined; } | undefined; error?: { grouping_key?: string | undefined; grouping_name?: string | undefined; } | undefined; kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; processor?: { event?: string | undefined; } | undefined; service?: { environment?: string | undefined; language?: { name?: string | undefined; } | undefined; name?: string | undefined; } | undefined; transaction?: { name?: string | undefined; type?: string | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; ecs: { version: string; }; } & { agent?: { build?: { original?: string | undefined; } | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; client?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; cloud?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; origin?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; target?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; } | undefined; container?: { cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; id?: string | undefined; image?: { hash?: { all?: string[] | undefined; } | undefined; name?: string | undefined; tag?: string[] | undefined; } | undefined; memory?: { usage?: string | number | undefined; } | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; } | undefined; } | undefined; runtime?: string | undefined; } | undefined; destination?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; device?: { id?: string | undefined; manufacturer?: string | undefined; model?: { identifier?: string | undefined; name?: string | undefined; } | undefined; } | undefined; dll?: { code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; name?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; } | undefined; dns?: { answers?: { class?: string | undefined; data?: string | undefined; name?: string | undefined; ttl?: string | number | undefined; type?: string | undefined; }[] | undefined; header_flags?: string[] | undefined; id?: string | undefined; op_code?: string | undefined; question?: { class?: string | undefined; name?: string | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; type?: string | undefined; } | undefined; resolved_ip?: string[] | undefined; response_code?: string | undefined; type?: string | undefined; } | undefined; email?: { attachments?: { file?: { extension?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; mime_type?: string | undefined; name?: string | undefined; size?: string | number | undefined; } | undefined; }[] | undefined; bcc?: { address?: string[] | undefined; } | undefined; cc?: { address?: string[] | undefined; } | undefined; content_type?: string | undefined; delivery_timestamp?: string | undefined; direction?: string | undefined; from?: { address?: string[] | undefined; } | undefined; local_id?: string | undefined; message_id?: string | undefined; origination_timestamp?: string | undefined; reply_to?: { address?: string[] | undefined; } | undefined; sender?: { address?: string | undefined; } | undefined; subject?: string | undefined; to?: { address?: string[] | undefined; } | undefined; x_mailer?: string | undefined; } | undefined; error?: { code?: string | undefined; id?: string | undefined; message?: string | undefined; stack_trace?: string | undefined; type?: string | undefined; } | undefined; event?: { action?: string | undefined; agent_id_status?: string | undefined; category?: string[] | undefined; code?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: string | number | undefined; end?: string | undefined; hash?: string | undefined; id?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; type?: string[] | undefined; url?: string | undefined; } | undefined; faas?: { coldstart?: boolean | undefined; execution?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; host?: { architecture?: string | undefined; boot?: { id?: string | undefined; } | undefined; cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; id?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; } | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; pid_ns_ino?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; type?: string | undefined; uptime?: string | number | undefined; } | undefined; http?: { request?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; id?: string | undefined; method?: string | undefined; mime_type?: string | undefined; referrer?: string | undefined; } | undefined; response?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; mime_type?: string | undefined; status_code?: string | number | undefined; } | undefined; version?: string | undefined; } | undefined; log?: { file?: { path?: string | undefined; } | undefined; level?: string | undefined; logger?: string | undefined; origin?: { file?: { line?: string | number | undefined; name?: string | undefined; } | undefined; function?: string | undefined; } | undefined; } | undefined; message?: string | undefined; network?: { application?: string | undefined; bytes?: string | number | undefined; community_id?: string | undefined; direction?: string | undefined; forwarded_ip?: string | undefined; iana_number?: string | undefined; name?: string | undefined; packets?: string | number | undefined; protocol?: string | undefined; transport?: string | undefined; type?: string | undefined; vlan?: { id?: string | undefined; name?: string | undefined; } | undefined; } | undefined; observer?: { geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; product?: string | undefined; serial_number?: string | undefined; type?: string | undefined; vendor?: string | undefined; version?: string | undefined; } | undefined; orchestrator?: { api_version?: string | undefined; cluster?: { id?: string | undefined; name?: string | undefined; url?: string | undefined; version?: string | undefined; } | undefined; namespace?: string | undefined; organization?: string | undefined; resource?: { id?: string | undefined; ip?: string[] | undefined; name?: string | undefined; parent?: { type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; organization?: { id?: string | undefined; name?: string | undefined; } | undefined; package?: { architecture?: string | undefined; build_version?: string | undefined; checksum?: string | undefined; description?: string | undefined; install_scope?: string | undefined; installed?: string | undefined; license?: string | undefined; name?: string | undefined; path?: string | undefined; reference?: string | undefined; size?: string | number | undefined; type?: string | undefined; version?: string | undefined; } | undefined; process?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; entry_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; attested_groups?: { name?: string | undefined; } | undefined; attested_user?: { id?: string | undefined; name?: string | undefined; } | undefined; command_line?: string | undefined; entity_id?: string | undefined; entry_meta?: { source?: { ip?: string | undefined; } | undefined; type?: string | undefined; } | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; env_vars?: string[] | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; group_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; previous?: { args?: string[] | undefined; args_count?: string | number | undefined; executable?: string | undefined; } | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; session_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; related?: { hash?: string[] | undefined; hosts?: string[] | undefined; ip?: string[] | undefined; user?: string[] | undefined; } | undefined; rule?: { author?: string[] | undefined; category?: string | undefined; description?: string | undefined; id?: string | undefined; license?: string | undefined; name?: string | undefined; reference?: string | undefined; ruleset?: string | undefined; uuid?: string | undefined; version?: string | undefined; } | undefined; server?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; service?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; origin?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; state?: string | undefined; target?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; type?: string | undefined; version?: string | undefined; } | undefined; source?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; span?: { id?: string | undefined; } | undefined; tags?: string[] | undefined; threat?: { enrichments?: { matched?: { atomic?: string | undefined; field?: string | undefined; id?: string | undefined; index?: string | undefined; occurred?: string | undefined; type?: string | undefined; } | undefined; }[] | undefined; feed?: { dashboard_id?: string | undefined; description?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; framework?: string | undefined; group?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; indicator?: { as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; confidence?: string | undefined; description?: string | undefined; email?: { address?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; first_seen?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; last_seen?: string | undefined; marking?: { tlp?: string | undefined; tlp_version?: string | undefined; } | undefined; modified_at?: string | undefined; port?: string | number | undefined; provider?: string | undefined; reference?: string | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; scanner_stats?: string | number | undefined; sightings?: string | number | undefined; type?: string | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; software?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; platforms?: string[] | undefined; reference?: string | undefined; type?: string | undefined; } | undefined; tactic?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; technique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; subtechnique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; } | undefined; } | undefined; tls?: { cipher?: string | undefined; client?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; server_name?: string | undefined; subject?: string | undefined; supported_ciphers?: string[] | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; curve?: string | undefined; established?: boolean | undefined; next_protocol?: string | undefined; resumed?: boolean | undefined; server?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3s?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; version?: string | undefined; version_protocol?: string | undefined; } | undefined; trace?: { id?: string | undefined; } | undefined; transaction?: { id?: string | undefined; } | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; user?: { changes?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; domain?: string | undefined; effective?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; roles?: string[] | undefined; target?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; user_agent?: { device?: { name?: string | undefined; } | undefined; name?: string | undefined; original?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; version?: string | undefined; } | undefined; vulnerability?: { category?: string[] | undefined; classification?: string | undefined; description?: string | undefined; enumeration?: string | undefined; id?: string | undefined; reference?: string | undefined; report_id?: string | undefined; scanner?: { vendor?: string | undefined; } | undefined; score?: { base?: number | undefined; environmental?: number | undefined; temporal?: number | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; } | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; ecs: { version: string; }; } & { agent?: { build?: { original?: string | undefined; } | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; client?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; cloud?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; origin?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; target?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; } | undefined; container?: { cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; id?: string | undefined; image?: { hash?: { all?: string[] | undefined; } | undefined; name?: string | undefined; tag?: string[] | undefined; } | undefined; memory?: { usage?: string | number | undefined; } | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; } | undefined; } | undefined; runtime?: string | undefined; } | undefined; destination?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; device?: { id?: string | undefined; manufacturer?: string | undefined; model?: { identifier?: string | undefined; name?: string | undefined; } | undefined; } | undefined; dll?: { code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; name?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; } | undefined; dns?: { answers?: { class?: string | undefined; data?: string | undefined; name?: string | undefined; ttl?: string | number | undefined; type?: string | undefined; }[] | undefined; header_flags?: string[] | undefined; id?: string | undefined; op_code?: string | undefined; question?: { class?: string | undefined; name?: string | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; type?: string | undefined; } | undefined; resolved_ip?: string[] | undefined; response_code?: string | undefined; type?: string | undefined; } | undefined; email?: { attachments?: { file?: { extension?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; mime_type?: string | undefined; name?: string | undefined; size?: string | number | undefined; } | undefined; }[] | undefined; bcc?: { address?: string[] | undefined; } | undefined; cc?: { address?: string[] | undefined; } | undefined; content_type?: string | undefined; delivery_timestamp?: string | undefined; direction?: string | undefined; from?: { address?: string[] | undefined; } | undefined; local_id?: string | undefined; message_id?: string | undefined; origination_timestamp?: string | undefined; reply_to?: { address?: string[] | undefined; } | undefined; sender?: { address?: string | undefined; } | undefined; subject?: string | undefined; to?: { address?: string[] | undefined; } | undefined; x_mailer?: string | undefined; } | undefined; error?: { code?: string | undefined; id?: string | undefined; message?: string | undefined; stack_trace?: string | undefined; type?: string | undefined; } | undefined; event?: { action?: string | undefined; agent_id_status?: string | undefined; category?: string[] | undefined; code?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: string | number | undefined; end?: string | undefined; hash?: string | undefined; id?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; type?: string[] | undefined; url?: string | undefined; } | undefined; faas?: { coldstart?: boolean | undefined; execution?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; host?: { architecture?: string | undefined; boot?: { id?: string | undefined; } | undefined; cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; id?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; } | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; pid_ns_ino?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; type?: string | undefined; uptime?: string | number | undefined; } | undefined; http?: { request?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; id?: string | undefined; method?: string | undefined; mime_type?: string | undefined; referrer?: string | undefined; } | undefined; response?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; mime_type?: string | undefined; status_code?: string | number | undefined; } | undefined; version?: string | undefined; } | undefined; log?: { file?: { path?: string | undefined; } | undefined; level?: string | undefined; logger?: string | undefined; origin?: { file?: { line?: string | number | undefined; name?: string | undefined; } | undefined; function?: string | undefined; } | undefined; } | undefined; message?: string | undefined; network?: { application?: string | undefined; bytes?: string | number | undefined; community_id?: string | undefined; direction?: string | undefined; forwarded_ip?: string | undefined; iana_number?: string | undefined; name?: string | undefined; packets?: string | number | undefined; protocol?: string | undefined; transport?: string | undefined; type?: string | undefined; vlan?: { id?: string | undefined; name?: string | undefined; } | undefined; } | undefined; observer?: { geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; product?: string | undefined; serial_number?: string | undefined; type?: string | undefined; vendor?: string | undefined; version?: string | undefined; } | undefined; orchestrator?: { api_version?: string | undefined; cluster?: { id?: string | undefined; name?: string | undefined; url?: string | undefined; version?: string | undefined; } | undefined; namespace?: string | undefined; organization?: string | undefined; resource?: { id?: string | undefined; ip?: string[] | undefined; name?: string | undefined; parent?: { type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; organization?: { id?: string | undefined; name?: string | undefined; } | undefined; package?: { architecture?: string | undefined; build_version?: string | undefined; checksum?: string | undefined; description?: string | undefined; install_scope?: string | undefined; installed?: string | undefined; license?: string | undefined; name?: string | undefined; path?: string | undefined; reference?: string | undefined; size?: string | number | undefined; type?: string | undefined; version?: string | undefined; } | undefined; process?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; entry_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; attested_groups?: { name?: string | undefined; } | undefined; attested_user?: { id?: string | undefined; name?: string | undefined; } | undefined; command_line?: string | undefined; entity_id?: string | undefined; entry_meta?: { source?: { ip?: string | undefined; } | undefined; type?: string | undefined; } | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; env_vars?: string[] | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; group_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; previous?: { args?: string[] | undefined; args_count?: string | number | undefined; executable?: string | undefined; } | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; session_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; related?: { hash?: string[] | undefined; hosts?: string[] | undefined; ip?: string[] | undefined; user?: string[] | undefined; } | undefined; rule?: { author?: string[] | undefined; category?: string | undefined; description?: string | undefined; id?: string | undefined; license?: string | undefined; name?: string | undefined; reference?: string | undefined; ruleset?: string | undefined; uuid?: string | undefined; version?: string | undefined; } | undefined; server?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; service?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; origin?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; state?: string | undefined; target?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; type?: string | undefined; version?: string | undefined; } | undefined; source?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; span?: { id?: string | undefined; } | undefined; tags?: string[] | undefined; threat?: { enrichments?: { matched?: { atomic?: string | undefined; field?: string | undefined; id?: string | undefined; index?: string | undefined; occurred?: string | undefined; type?: string | undefined; } | undefined; }[] | undefined; feed?: { dashboard_id?: string | undefined; description?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; framework?: string | undefined; group?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; indicator?: { as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; confidence?: string | undefined; description?: string | undefined; email?: { address?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; first_seen?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; last_seen?: string | undefined; marking?: { tlp?: string | undefined; tlp_version?: string | undefined; } | undefined; modified_at?: string | undefined; port?: string | number | undefined; provider?: string | undefined; reference?: string | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; scanner_stats?: string | number | undefined; sightings?: string | number | undefined; type?: string | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; software?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; platforms?: string[] | undefined; reference?: string | undefined; type?: string | undefined; } | undefined; tactic?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; technique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; subtechnique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; } | undefined; } | undefined; tls?: { cipher?: string | undefined; client?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; server_name?: string | undefined; subject?: string | undefined; supported_ciphers?: string[] | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; curve?: string | undefined; established?: boolean | undefined; next_protocol?: string | undefined; resumed?: boolean | undefined; server?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3s?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; version?: string | undefined; version_protocol?: string | undefined; } | undefined; trace?: { id?: string | undefined; } | undefined; transaction?: { id?: string | undefined; } | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; user?: { changes?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; domain?: string | undefined; effective?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; roles?: string[] | undefined; target?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; user_agent?: { device?: { name?: string | undefined; } | undefined; name?: string | undefined; original?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; version?: string | undefined; } | undefined; vulnerability?: { category?: string[] | undefined; classification?: string | undefined; description?: string | undefined; enumeration?: string | undefined; id?: string | undefined; reference?: string | undefined; report_id?: string | undefined; scanner?: { vendor?: string | undefined; } | undefined; score?: { base?: number | undefined; environmental?: number | undefined; temporal?: number | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; } | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; slo?: { id?: string | undefined; revision?: string | number | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { agent?: { name?: string | undefined; } | undefined; anomaly?: { bucket_span?: { minutes?: string | undefined; } | undefined; start?: string | undefined; } | undefined; error?: { message?: string | undefined; } | undefined; kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; monitor?: { id?: string | undefined; name?: string | undefined; type?: string | undefined; } | undefined; observer?: { geo?: { name?: string | undefined; } | undefined; } | undefined; tls?: { server?: { hash?: { sha256?: string | undefined; } | undefined; x509?: { issuer?: { common_name?: string | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: { common_name?: string | undefined; } | undefined; } | undefined; } | undefined; } | undefined; url?: { full?: string | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({ '@timestamp': string; kibana: { alert: { ancestors: { depth: string | number; id: string; index: string; type: string; }[]; depth: string | number; instance: { id: string; }; original_event: { action: string; category: string[]; created: string; dataset: string; id: string; ingested: string; kind: string; module: string; original: string; outcome: string; provider: string; sequence: string | number; type: string[]; }; original_time: string; rule: { category: string; consumer: string; false_positives: string[]; max_signals: (string | number)[]; name: string; producer: string; revision: string | number; rule_type_id: string; threat: { framework: string; tactic: { id: string; name: string; reference: string; }; technique: { id: string; name: string; reference: string; subtechnique: { id: string; name: string; reference: string; }; }; }; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { ecs?: { version?: string | undefined; } | undefined; event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; ancestors?: { rule?: string | undefined; } | undefined; building_block_type?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; group?: { id?: string | undefined; index?: number | undefined; } | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; new_terms?: string[] | undefined; original_event?: { agent_id_status?: string | undefined; code?: string | undefined; duration?: string | undefined; end?: string | undefined; hash?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; url?: string | undefined; } | undefined; reason?: string | undefined; risk_score?: number | undefined; rule?: { author?: string | undefined; building_block_type?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; execution?: { uuid?: string | undefined; } | undefined; from?: string | undefined; immutable?: string[] | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; parameters?: unknown; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; tags?: string[] | undefined; timeline_id?: string[] | undefined; timeline_title?: string[] | undefined; timestamp_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; start?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; threshold_result?: { count?: string | number | undefined; from?: string | undefined; terms?: { field?: string | undefined; value?: string | undefined; }[] | undefined; } | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_reason?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; workflow_user?: string | undefined; } | undefined; version?: string | undefined; } | undefined; signal?: { ancestors?: { depth?: unknown; id?: unknown; index?: unknown; type?: unknown; } | undefined; depth?: unknown; group?: { id?: unknown; index?: unknown; } | undefined; original_event?: { action?: unknown; category?: unknown; code?: unknown; created?: unknown; dataset?: unknown; duration?: unknown; end?: unknown; hash?: unknown; id?: unknown; kind?: unknown; module?: unknown; outcome?: unknown; provider?: unknown; reason?: unknown; risk_score?: unknown; risk_score_norm?: unknown; sequence?: unknown; severity?: unknown; start?: unknown; timezone?: unknown; type?: unknown; } | undefined; original_time?: unknown; reason?: unknown; rule?: { author?: unknown; building_block_type?: unknown; created_at?: unknown; created_by?: unknown; description?: unknown; enabled?: unknown; false_positives?: unknown; from?: unknown; id?: unknown; immutable?: unknown; interval?: unknown; license?: unknown; max_signals?: unknown; name?: unknown; note?: unknown; references?: unknown; risk_score?: unknown; rule_id?: unknown; rule_name_override?: unknown; severity?: unknown; tags?: unknown; threat?: { framework?: unknown; tactic?: { id?: unknown; name?: unknown; reference?: unknown; } | undefined; technique?: { id?: unknown; name?: unknown; reference?: unknown; subtechnique?: { id?: unknown; name?: unknown; reference?: unknown; } | undefined; } | undefined; } | undefined; timeline_id?: unknown; timeline_title?: unknown; timestamp_override?: unknown; to?: unknown; type?: unknown; updated_at?: unknown; updated_by?: unknown; version?: unknown; } | undefined; status?: unknown; threshold_result?: { cardinality?: { field?: unknown; value?: unknown; } | undefined; count?: unknown; from?: unknown; terms?: { field?: unknown; value?: unknown; } | undefined; } | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; ecs: { version: string; }; } & { agent?: { build?: { original?: string | undefined; } | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; client?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; cloud?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; origin?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; target?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; } | undefined; container?: { cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; id?: string | undefined; image?: { hash?: { all?: string[] | undefined; } | undefined; name?: string | undefined; tag?: string[] | undefined; } | undefined; memory?: { usage?: string | number | undefined; } | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; } | undefined; } | undefined; runtime?: string | undefined; } | undefined; destination?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; device?: { id?: string | undefined; manufacturer?: string | undefined; model?: { identifier?: string | undefined; name?: string | undefined; } | undefined; } | undefined; dll?: { code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; name?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; } | undefined; dns?: { answers?: { class?: string | undefined; data?: string | undefined; name?: string | undefined; ttl?: string | number | undefined; type?: string | undefined; }[] | undefined; header_flags?: string[] | undefined; id?: string | undefined; op_code?: string | undefined; question?: { class?: string | undefined; name?: string | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; type?: string | undefined; } | undefined; resolved_ip?: string[] | undefined; response_code?: string | undefined; type?: string | undefined; } | undefined; email?: { attachments?: { file?: { extension?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; mime_type?: string | undefined; name?: string | undefined; size?: string | number | undefined; } | undefined; }[] | undefined; bcc?: { address?: string[] | undefined; } | undefined; cc?: { address?: string[] | undefined; } | undefined; content_type?: string | undefined; delivery_timestamp?: string | undefined; direction?: string | undefined; from?: { address?: string[] | undefined; } | undefined; local_id?: string | undefined; message_id?: string | undefined; origination_timestamp?: string | undefined; reply_to?: { address?: string[] | undefined; } | undefined; sender?: { address?: string | undefined; } | undefined; subject?: string | undefined; to?: { address?: string[] | undefined; } | undefined; x_mailer?: string | undefined; } | undefined; error?: { code?: string | undefined; id?: string | undefined; message?: string | undefined; stack_trace?: string | undefined; type?: string | undefined; } | undefined; event?: { action?: string | undefined; agent_id_status?: string | undefined; category?: string[] | undefined; code?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: string | number | undefined; end?: string | undefined; hash?: string | undefined; id?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; type?: string[] | undefined; url?: string | undefined; } | undefined; faas?: { coldstart?: boolean | undefined; execution?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; host?: { architecture?: string | undefined; boot?: { id?: string | undefined; } | undefined; cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; id?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; } | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; pid_ns_ino?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; type?: string | undefined; uptime?: string | number | undefined; } | undefined; http?: { request?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; id?: string | undefined; method?: string | undefined; mime_type?: string | undefined; referrer?: string | undefined; } | undefined; response?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; mime_type?: string | undefined; status_code?: string | number | undefined; } | undefined; version?: string | undefined; } | undefined; log?: { file?: { path?: string | undefined; } | undefined; level?: string | undefined; logger?: string | undefined; origin?: { file?: { line?: string | number | undefined; name?: string | undefined; } | undefined; function?: string | undefined; } | undefined; } | undefined; message?: string | undefined; network?: { application?: string | undefined; bytes?: string | number | undefined; community_id?: string | undefined; direction?: string | undefined; forwarded_ip?: string | undefined; iana_number?: string | undefined; name?: string | undefined; packets?: string | number | undefined; protocol?: string | undefined; transport?: string | undefined; type?: string | undefined; vlan?: { id?: string | undefined; name?: string | undefined; } | undefined; } | undefined; observer?: { geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; product?: string | undefined; serial_number?: string | undefined; type?: string | undefined; vendor?: string | undefined; version?: string | undefined; } | undefined; orchestrator?: { api_version?: string | undefined; cluster?: { id?: string | undefined; name?: string | undefined; url?: string | undefined; version?: string | undefined; } | undefined; namespace?: string | undefined; organization?: string | undefined; resource?: { id?: string | undefined; ip?: string[] | undefined; name?: string | undefined; parent?: { type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; organization?: { id?: string | undefined; name?: string | undefined; } | undefined; package?: { architecture?: string | undefined; build_version?: string | undefined; checksum?: string | undefined; description?: string | undefined; install_scope?: string | undefined; installed?: string | undefined; license?: string | undefined; name?: string | undefined; path?: string | undefined; reference?: string | undefined; size?: string | number | undefined; type?: string | undefined; version?: string | undefined; } | undefined; process?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; entry_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; attested_groups?: { name?: string | undefined; } | undefined; attested_user?: { id?: string | undefined; name?: string | undefined; } | undefined; command_line?: string | undefined; entity_id?: string | undefined; entry_meta?: { source?: { ip?: string | undefined; } | undefined; type?: string | undefined; } | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; env_vars?: string[] | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; group_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; previous?: { args?: string[] | undefined; args_count?: string | number | undefined; executable?: string | undefined; } | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; session_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; related?: { hash?: string[] | undefined; hosts?: string[] | undefined; ip?: string[] | undefined; user?: string[] | undefined; } | undefined; rule?: { author?: string[] | undefined; category?: string | undefined; description?: string | undefined; id?: string | undefined; license?: string | undefined; name?: string | undefined; reference?: string | undefined; ruleset?: string | undefined; uuid?: string | undefined; version?: string | undefined; } | undefined; server?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; service?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; origin?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; state?: string | undefined; target?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; type?: string | undefined; version?: string | undefined; } | undefined; source?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; span?: { id?: string | undefined; } | undefined; tags?: string[] | undefined; threat?: { enrichments?: { matched?: { atomic?: string | undefined; field?: string | undefined; id?: string | undefined; index?: string | undefined; occurred?: string | undefined; type?: string | undefined; } | undefined; }[] | undefined; feed?: { dashboard_id?: string | undefined; description?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; framework?: string | undefined; group?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; indicator?: { as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; confidence?: string | undefined; description?: string | undefined; email?: { address?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; first_seen?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; last_seen?: string | undefined; marking?: { tlp?: string | undefined; tlp_version?: string | undefined; } | undefined; modified_at?: string | undefined; port?: string | number | undefined; provider?: string | undefined; reference?: string | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; scanner_stats?: string | number | undefined; sightings?: string | number | undefined; type?: string | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; software?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; platforms?: string[] | undefined; reference?: string | undefined; type?: string | undefined; } | undefined; tactic?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; technique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; subtechnique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; } | undefined; } | undefined; tls?: { cipher?: string | undefined; client?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; server_name?: string | undefined; subject?: string | undefined; supported_ciphers?: string[] | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; curve?: string | undefined; established?: boolean | undefined; next_protocol?: string | undefined; resumed?: boolean | undefined; server?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3s?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; version?: string | undefined; version_protocol?: string | undefined; } | undefined; trace?: { id?: string | undefined; } | undefined; transaction?: { id?: string | undefined; } | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; user?: { changes?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; domain?: string | undefined; effective?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; roles?: string[] | undefined; target?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; user_agent?: { device?: { name?: string | undefined; } | undefined; name?: string | undefined; original?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; version?: string | undefined; } | undefined; vulnerability?: { category?: string[] | undefined; classification?: string | undefined; description?: string | undefined; enumeration?: string | undefined; id?: string | undefined; reference?: string | undefined; report_id?: string | undefined; scanner?: { vendor?: string | undefined; } | undefined; score?: { base?: number | undefined; environmental?: number | undefined; temporal?: number | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; } | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; })" ], "path": "packages/kbn-alerts-as-data-utils/src/schemas/index.ts", "deprecated": false, @@ -244,7 +244,7 @@ "label": "ObservabilityApmAlert", "description": [], "signature": [ - "{} & { agent?: { name?: string | undefined; } | undefined; error?: { grouping_key?: string | undefined; } | undefined; kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; processor?: { event?: string | undefined; } | undefined; service?: { environment?: string | undefined; language?: { name?: string | undefined; } | undefined; name?: string | undefined; } | undefined; transaction?: { name?: string | undefined; type?: string | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }" + "{} & { agent?: { name?: string | undefined; } | undefined; error?: { grouping_key?: string | undefined; grouping_name?: string | undefined; } | undefined; kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; processor?: { event?: string | undefined; } | undefined; service?: { environment?: string | undefined; language?: { name?: string | undefined; } | undefined; name?: string | undefined; } | undefined; transaction?: { name?: string | undefined; type?: string | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }" ], "path": "packages/kbn-alerts-as-data-utils/src/schemas/generated/observability_apm_schema.ts", "deprecated": false, diff --git a/api_docs/kbn_alerts_as_data_utils.mdx b/api_docs/kbn_alerts_as_data_utils.mdx index 95ccd9d032110..b8395ea85bf44 100644 --- a/api_docs/kbn_alerts_as_data_utils.mdx +++ b/api_docs/kbn_alerts_as_data_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-as-data-utils title: "@kbn/alerts-as-data-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerts-as-data-utils plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_alerts_ui_shared.devdocs.json index 7577f6d8519f5..77aa446d1ecfb 100644 --- a/api_docs/kbn_alerts_ui_shared.devdocs.json +++ b/api_docs/kbn_alerts_ui_shared.devdocs.json @@ -66,6 +66,53 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/alerts-ui-shared", + "id": "def-common.MaintenanceWindowCallout", + "type": "Function", + "tags": [], + "label": "MaintenanceWindowCallout", + "description": [], + "signature": [ + "({\n kibanaServices,\n}: { kibanaServices: ", + "KibanaServices", + "; }) => JSX.Element | null" + ], + "path": "packages/kbn-alerts-ui-shared/src/maintenance_window_callout/index.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/alerts-ui-shared", + "id": "def-common.MaintenanceWindowCallout.$1", + "type": "Object", + "tags": [], + "label": "{\n kibanaServices,\n}", + "description": [], + "path": "packages/kbn-alerts-ui-shared/src/maintenance_window_callout/index.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/alerts-ui-shared", + "id": "def-common.MaintenanceWindowCallout.$1.kibanaServices", + "type": "Object", + "tags": [], + "label": "kibanaServices", + "description": [], + "signature": [ + "KibanaServices" + ], + "path": "packages/kbn-alerts-ui-shared/src/maintenance_window_callout/index.tsx", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false } ], "interfaces": [ diff --git a/api_docs/kbn_alerts_ui_shared.mdx b/api_docs/kbn_alerts_ui_shared.mdx index a7589efb2149e..5680a6ed98c96 100644 --- a/api_docs/kbn_alerts_ui_shared.mdx +++ b/api_docs/kbn_alerts_ui_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-ui-shared title: "@kbn/alerts-ui-shared" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerts-ui-shared plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared'] --- import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 5 | 0 | 4 | 0 | +| 8 | 0 | 7 | 1 | ## Common diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index e9892d94dfaa1..ec411b1b95ef0 100644 --- a/api_docs/kbn_analytics.mdx +++ b/api_docs/kbn_analytics.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics title: "@kbn/analytics" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics'] --- import kbnAnalyticsObj from './kbn_analytics.devdocs.json'; diff --git a/api_docs/kbn_analytics_client.devdocs.json b/api_docs/kbn_analytics_client.devdocs.json index f1ccb7fbee547..88e2702e0c82f 100644 --- a/api_docs/kbn_analytics_client.devdocs.json +++ b/api_docs/kbn_analytics_client.devdocs.json @@ -115,7 +115,7 @@ "\nSpecify if the shippers should send their data to the production or staging environments." ], "signature": [ - "\"staging\" | \"production\"" + "\"production\" | \"staging\"" ], "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, @@ -731,28 +731,28 @@ "path": "x-pack/plugins/infra/public/services/telemetry/telemetry_client.ts" }, { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" + "plugin": "globalSearchBar", + "path": "x-pack/plugins/global_search_bar/public/telemetry/event_reporter.ts" }, { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" + "plugin": "globalSearchBar", + "path": "x-pack/plugins/global_search_bar/public/telemetry/event_reporter.ts" }, { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts" }, { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts" }, { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts" }, { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts" }, { "plugin": "securitySolution", @@ -767,28 +767,28 @@ "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts" + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts" + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts" + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts" + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { - "plugin": "globalSearchBar", - "path": "x-pack/plugins/global_search_bar/public/telemetry/event_reporter.ts" + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { - "plugin": "globalSearchBar", - "path": "x-pack/plugins/global_search_bar/public/telemetry/event_reporter.ts" + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" }, { "plugin": "@kbn/core-analytics-browser-mocks", diff --git a/api_docs/kbn_analytics_client.mdx b/api_docs/kbn_analytics_client.mdx index 287ebd767d02b..eb36cc64e22f8 100644 --- a/api_docs/kbn_analytics_client.mdx +++ b/api_docs/kbn_analytics_client.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client title: "@kbn/analytics-client" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-client plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client'] --- import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.devdocs.json b/api_docs/kbn_analytics_shippers_elastic_v3_browser.devdocs.json index ce89b234bfcae..49d27f916b6cf 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_browser.devdocs.json +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.devdocs.json @@ -379,7 +379,7 @@ "\nProvide it to override the Analytics client's default configuration." ], "signature": [ - "\"staging\" | \"production\" | undefined" + "\"production\" | \"staging\" | undefined" ], "path": "packages/analytics/shippers/elastic_v3/common/src/types.ts", "deprecated": false, diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx index f2ace21d05cb0..ec57dfd447602 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-browser title: "@kbn/analytics-shippers-elastic-v3-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_analytics_shippers_elastic_v3_common.devdocs.json index 2e718139d6717..c4c37433bc481 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_common.devdocs.json +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.devdocs.json @@ -387,7 +387,7 @@ "Whether to send it to production or staging." ], "signature": [ - "\"staging\" | \"production\"" + "\"production\" | \"staging\"" ], "path": "packages/analytics/shippers/elastic_v3/common/src/build_url.ts", "deprecated": false, @@ -458,7 +458,7 @@ "\nProvide it to override the Analytics client's default configuration." ], "signature": [ - "\"staging\" | \"production\" | undefined" + "\"production\" | \"staging\" | undefined" ], "path": "packages/analytics/shippers/elastic_v3/common/src/types.ts", "deprecated": false, diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx index 03c8672a9ef25..d793dda08a557 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-common title: "@kbn/analytics-shippers-elastic-v3-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_analytics_shippers_elastic_v3_server.devdocs.json index c74c4ff79cfc9..ad58b596dde46 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_server.devdocs.json +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.devdocs.json @@ -379,7 +379,7 @@ "\nProvide it to override the Analytics client's default configuration." ], "signature": [ - "\"staging\" | \"production\" | undefined" + "\"production\" | \"staging\" | undefined" ], "path": "packages/analytics/shippers/elastic_v3/common/src/types.ts", "deprecated": false, diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx index bbc79116ad84d..029d06a7b84ba 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-server title: "@kbn/analytics-shippers-elastic-v3-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin -date: 2023-06-30 +date: 2023-07-18 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 8121eecbf5b14..59fcee3fd623c 100644 --- a/api_docs/kbn_analytics_shippers_fullstory.mdx +++ b/api_docs/kbn_analytics_shippers_fullstory.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory title: "@kbn/analytics-shippers-fullstory" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-fullstory plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory'] --- import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_gainsight.mdx b/api_docs/kbn_analytics_shippers_gainsight.mdx index 30fd472fb29e7..ae927539334ba 100644 --- a/api_docs/kbn_analytics_shippers_gainsight.mdx +++ b/api_docs/kbn_analytics_shippers_gainsight.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-gainsight title: "@kbn/analytics-shippers-gainsight" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-gainsight plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-gainsight'] --- import kbnAnalyticsShippersGainsightObj from './kbn_analytics_shippers_gainsight.devdocs.json'; diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index dfd07d3e9a68d..0ecd60ae04bc8 100644 --- a/api_docs/kbn_apm_config_loader.mdx +++ b/api_docs/kbn_apm_config_loader.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader title: "@kbn/apm-config-loader" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-config-loader plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader'] --- import kbnApmConfigLoaderObj from './kbn_apm_config_loader.devdocs.json'; diff --git a/api_docs/kbn_apm_synthtrace.mdx b/api_docs/kbn_apm_synthtrace.mdx index 6fcab3e9754fc..2905b80b6ef11 100644 --- a/api_docs/kbn_apm_synthtrace.mdx +++ b/api_docs/kbn_apm_synthtrace.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace title: "@kbn/apm-synthtrace" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-synthtrace plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace'] --- import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json'; diff --git a/api_docs/kbn_apm_synthtrace_client.mdx b/api_docs/kbn_apm_synthtrace_client.mdx index 4e7c5470ccfc6..53979608377a1 100644 --- a/api_docs/kbn_apm_synthtrace_client.mdx +++ b/api_docs/kbn_apm_synthtrace_client.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace-client title: "@kbn/apm-synthtrace-client" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-synthtrace-client plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace-client'] --- import kbnApmSynthtraceClientObj from './kbn_apm_synthtrace_client.devdocs.json'; diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index c8d7ad4403638..43363f2c9a81d 100644 --- a/api_docs/kbn_apm_utils.mdx +++ b/api_docs/kbn_apm_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils title: "@kbn/apm-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-utils plugin -date: 2023-06-30 +date: 2023-07-18 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 cf766ee6c3512..2b0ab911c33ec 100644 --- a/api_docs/kbn_axe_config.mdx +++ b/api_docs/kbn_axe_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config title: "@kbn/axe-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/axe-config plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] --- import kbnAxeConfigObj from './kbn_axe_config.devdocs.json'; diff --git a/api_docs/kbn_cases_components.mdx b/api_docs/kbn_cases_components.mdx index 4b8dc25f45ac9..d9c6d2284bf0f 100644 --- a/api_docs/kbn_cases_components.mdx +++ b/api_docs/kbn_cases_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cases-components title: "@kbn/cases-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cases-components plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cases-components'] --- import kbnCasesComponentsObj from './kbn_cases_components.devdocs.json'; diff --git a/api_docs/kbn_cell_actions.devdocs.json b/api_docs/kbn_cell_actions.devdocs.json index a25ef677ee34e..dcc406e62c1d0 100644 --- a/api_docs/kbn_cell_actions.devdocs.json +++ b/api_docs/kbn_cell_actions.devdocs.json @@ -36,13 +36,7 @@ "text": "FilterManager" }, " | undefined; fieldName: string; value: ", - { - "pluginId": "@kbn/cell-actions", - "scope": "common", - "docId": "kibKbnCellActionsPluginApi", - "section": "def-common.CellActionFieldValue", - "text": "CellActionFieldValue" - }, + "DefaultActionsSupportedValue", "; }) => void" ], "path": "packages/kbn-cell-actions/src/actions/filter/filter_in.ts", @@ -100,7 +94,7 @@ "label": "value", "description": [], "signature": [ - "string | number | boolean | string[] | boolean[] | number[] | null | undefined" + "string[] | boolean[] | number[]" ], "path": "packages/kbn-cell-actions/src/actions/filter/filter_in.ts", "deprecated": false, @@ -129,13 +123,7 @@ "text": "FilterManager" }, " | undefined; fieldName: string; value: ", - { - "pluginId": "@kbn/cell-actions", - "scope": "common", - "docId": "kibKbnCellActionsPluginApi", - "section": "def-common.CellActionFieldValue", - "text": "CellActionFieldValue" - }, + "DefaultActionsSupportedValue", "; }) => void" ], "path": "packages/kbn-cell-actions/src/actions/filter/filter_out.ts", @@ -193,7 +181,7 @@ "label": "value", "description": [], "signature": [ - "string | number | boolean | string[] | boolean[] | number[] | null | undefined" + "string[] | boolean[] | number[]" ], "path": "packages/kbn-cell-actions/src/actions/filter/filter_out.ts", "deprecated": false, @@ -460,6 +448,14 @@ "section": "def-public.FilterManager", "text": "FilterManager" }, + "; notifications: ", + { + "pluginId": "@kbn/core-notifications-browser", + "scope": "common", + "docId": "kibKbnCoreNotificationsBrowserPluginApi", + "section": "def-common.NotificationsStart", + "text": "NotificationsStart" + }, "; }) => ", { "pluginId": "@kbn/cell-actions", @@ -524,6 +520,14 @@ "section": "def-public.FilterManager", "text": "FilterManager" }, + "; notifications: ", + { + "pluginId": "@kbn/core-notifications-browser", + "scope": "common", + "docId": "kibKbnCoreNotificationsBrowserPluginApi", + "section": "def-common.NotificationsStart", + "text": "NotificationsStart" + }, "; }) => ", { "pluginId": "@kbn/cell-actions", @@ -1273,7 +1277,15 @@ "label": "CellActionFieldValue", "description": [], "signature": [ - "string | number | boolean | string[] | boolean[] | number[] | null | undefined" + "string[] | undefined[] | boolean[] | number[] | ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.Serializable", + "text": "Serializable" + }, + " | null[]" ], "path": "packages/kbn-cell-actions/src/types.ts", "deprecated": false, diff --git a/api_docs/kbn_cell_actions.mdx b/api_docs/kbn_cell_actions.mdx index b33eb81b6a1a2..7685adc6b5e19 100644 --- a/api_docs/kbn_cell_actions.mdx +++ b/api_docs/kbn_cell_actions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cell-actions title: "@kbn/cell-actions" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cell-actions plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cell-actions'] --- import kbnCellActionsObj from './kbn_cell_actions.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/security-threat-hunting-explore](https://github.com/orgs/elast | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 62 | 1 | 44 | 2 | +| 62 | 1 | 44 | 3 | ## Common diff --git a/api_docs/kbn_chart_expressions_common.mdx b/api_docs/kbn_chart_expressions_common.mdx index cd02912cf61cc..5b12090122718 100644 --- a/api_docs/kbn_chart_expressions_common.mdx +++ b/api_docs/kbn_chart_expressions_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-expressions-common title: "@kbn/chart-expressions-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/chart-expressions-common plugin -date: 2023-06-30 +date: 2023-07-18 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 5a84b25e188dd..5110ccf4d7a6d 100644 --- a/api_docs/kbn_chart_icons.mdx +++ b/api_docs/kbn_chart_icons.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-icons title: "@kbn/chart-icons" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/chart-icons plugin -date: 2023-06-30 +date: 2023-07-18 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 9baba9fced13b..0964f4f404d33 100644 --- a/api_docs/kbn_ci_stats_core.mdx +++ b/api_docs/kbn_ci_stats_core.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core title: "@kbn/ci-stats-core" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ci-stats-core plugin -date: 2023-06-30 +date: 2023-07-18 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 48b91ddeb3ff0..1404438438f0c 100644 --- a/api_docs/kbn_ci_stats_performance_metrics.mdx +++ b/api_docs/kbn_ci_stats_performance_metrics.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-performance-metrics title: "@kbn/ci-stats-performance-metrics" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ci-stats-performance-metrics plugin -date: 2023-06-30 +date: 2023-07-18 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 9c33e19d0ac89..a21de03532024 100644 --- a/api_docs/kbn_ci_stats_reporter.mdx +++ b/api_docs/kbn_ci_stats_reporter.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter title: "@kbn/ci-stats-reporter" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ci-stats-reporter plugin -date: 2023-06-30 +date: 2023-07-18 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 2fc809b21c27d..bc1726adef480 100644 --- a/api_docs/kbn_cli_dev_mode.mdx +++ b/api_docs/kbn_cli_dev_mode.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode title: "@kbn/cli-dev-mode" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cli-dev-mode plugin -date: 2023-06-30 +date: 2023-07-18 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 a816cd623cbd0..265fb18174108 100644 --- a/api_docs/kbn_code_editor.mdx +++ b/api_docs/kbn_code_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-code-editor title: "@kbn/code-editor" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/code-editor plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-editor'] --- import kbnCodeEditorObj from './kbn_code_editor.devdocs.json'; diff --git a/api_docs/kbn_code_editor_mocks.mdx b/api_docs/kbn_code_editor_mocks.mdx index 67573c599cc48..82616ee4153cd 100644 --- a/api_docs/kbn_code_editor_mocks.mdx +++ b/api_docs/kbn_code_editor_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-code-editor-mocks title: "@kbn/code-editor-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/code-editor-mocks plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-editor-mocks'] --- import kbnCodeEditorMocksObj from './kbn_code_editor_mocks.devdocs.json'; diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx index 25e3b0e8d28c6..83c36d3c21e7a 100644 --- a/api_docs/kbn_coloring.mdx +++ b/api_docs/kbn_coloring.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-coloring title: "@kbn/coloring" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/coloring plugin -date: 2023-06-30 +date: 2023-07-18 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 b0b76d58ad9d5..c1915b7043848 100644 --- a/api_docs/kbn_config.mdx +++ b/api_docs/kbn_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config title: "@kbn/config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/config plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] --- import kbnConfigObj from './kbn_config.devdocs.json'; diff --git a/api_docs/kbn_config_mocks.devdocs.json b/api_docs/kbn_config_mocks.devdocs.json index 800e030c8cac8..df37ecf488422 100644 --- a/api_docs/kbn_config_mocks.devdocs.json +++ b/api_docs/kbn_config_mocks.devdocs.json @@ -230,7 +230,7 @@ "section": "def-common.ConfigPath", "text": "ConfigPath" }, - "]>; get: jest.MockInstance; get: jest.MockInstance; set: jest.MockInstance; set: jest.MockInstance; getFlattenedPaths: jest.MockInstance; toRaw: jest.MockInstance, []>; } & ", + ", value: any], unknown>; getFlattenedPaths: jest.MockInstance; toRaw: jest.MockInstance, [], unknown>; } & ", "Config" ], "path": "packages/kbn-config-mocks/src/config.mock.ts", @@ -264,11 +264,11 @@ "signature": [ "{ validate: jest.MockInstance, [params?: ", "ConfigValidateParameters", - " | undefined]>; getConfig$: jest.MockInstance<", + " | undefined], unknown>; getConfig$: jest.MockInstance<", "Observable", "<", "Config", - ">, []>; setSchema: jest.MockInstance, [], unknown>; setSchema: jest.MockInstance]>; addDeprecationProvider: jest.MockInstance], unknown>; addDeprecationProvider: jest.MockInstance; getHandledDeprecatedConfigs: jest.MockInstance<[string, ", + "], unknown>; getHandledDeprecatedConfigs: jest.MockInstance<[string, ", { "pluginId": "@kbn/config", "scope": "common", @@ -308,7 +308,7 @@ "section": "def-common.DeprecatedConfigDetails", "text": "DeprecatedConfigDetails" }, - "[]][], []>; atPath: jest.MockInstance<", + "[]][], [], unknown>; atPath: jest.MockInstance<", "Observable", ", [path: ", { @@ -318,7 +318,7 @@ "section": "def-common.ConfigPath", "text": "ConfigPath" }, - "]>; atPathSync: jest.MockInstance; atPathSync: jest.MockInstance; isEnabledAtPath: jest.MockInstance, [path: ", + "], unknown>; isEnabledAtPath: jest.MockInstance, [path: ", { "pluginId": "@kbn/config", "scope": "common", @@ -334,7 +334,7 @@ "section": "def-common.ConfigPath", "text": "ConfigPath" }, - "]>; getUnusedPaths: jest.MockInstance, []>; getUsedPaths: jest.MockInstance, []>; getDeprecatedConfigPath$: jest.MockInstance<", + "], unknown>; getUnusedPaths: jest.MockInstance, [], unknown>; getUsedPaths: jest.MockInstance, [], unknown>; getDeprecatedConfigPath$: jest.MockInstance<", "Observable", "<", { @@ -344,7 +344,7 @@ "section": "def-common.ChangedDeprecatedPaths", "text": "ChangedDeprecatedPaths" }, - ">, []>; } & ", + ">, [], unknown>; } & ", "IConfigService" ], "path": "packages/kbn-config-mocks/src/config_service.mock.ts", @@ -360,9 +360,9 @@ "label": "RawConfigServiceMock", "description": [], "signature": [ - "{ stop: jest.MockInstance; getConfig$: jest.MockInstance<", + "{ stop: jest.MockInstance; getConfig$: jest.MockInstance<", "Observable", - ">, []>; loadConfig: jest.MockInstance; reloadConfig: jest.MockInstance; } & ", + ">, [], unknown>; loadConfig: jest.MockInstance; reloadConfig: jest.MockInstance; } & ", { "pluginId": "@kbn/utility-types", "scope": "common", diff --git a/api_docs/kbn_config_mocks.mdx b/api_docs/kbn_config_mocks.mdx index 914fd72c83af5..7cd60bf8329ad 100644 --- a/api_docs/kbn_config_mocks.mdx +++ b/api_docs/kbn_config_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-mocks title: "@kbn/config-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/config-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 e1f235e1d2127..0c52961366de2 100644 --- a/api_docs/kbn_config_schema.mdx +++ b/api_docs/kbn_config_schema.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema title: "@kbn/config-schema" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/config-schema plugin -date: 2023-06-30 +date: 2023-07-18 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 83b44191d3e76..95cf4fd7f4260 100644 --- a/api_docs/kbn_content_management_content_editor.mdx +++ b/api_docs/kbn_content_management_content_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-content-editor title: "@kbn/content-management-content-editor" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-content-editor plugin -date: 2023-06-30 +date: 2023-07-18 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 5b4aa6403c757..e9326fedc6272 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: 2023-06-30 +date: 2023-07-18 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 4a643f4abd01b..752f6e9e99e4c 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: 2023-06-30 +date: 2023-07-18 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_table.devdocs.json b/api_docs/kbn_content_management_table_list_view_table.devdocs.json index 246c8321c04a3..35d5364d4b7d2 100644 --- a/api_docs/kbn_content_management_table_list_view_table.devdocs.json +++ b/api_docs/kbn_content_management_table_list_view_table.devdocs.json @@ -223,7 +223,9 @@ "section": "def-common.OverlayRef", "text": "OverlayRef" }, - "; }; }" + "; }; theme: { theme$: ", + "Observable", + "<{ readonly darkMode: boolean; }>; }; }" ], "path": "packages/content-management/table_list_view_table/src/services.tsx", "deprecated": false, 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 36fc8b77b8819..b87a96861ee91 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: 2023-06-30 +date: 2023-07-18 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 81f91c52398ce..5eb46a5a6ebce 100644 --- a/api_docs/kbn_content_management_utils.mdx +++ b/api_docs/kbn_content_management_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-utils title: "@kbn/content-management-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-utils plugin -date: 2023-06-30 +date: 2023-07-18 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 d9cbd1dcfeb84..4c982e298a8fb 100644 --- a/api_docs/kbn_core_analytics_browser.mdx +++ b/api_docs/kbn_core_analytics_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser title: "@kbn/core-analytics-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 6975139723094..c7c91653aab88 100644 --- a/api_docs/kbn_core_analytics_browser_internal.mdx +++ b/api_docs/kbn_core_analytics_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-internal title: "@kbn/core-analytics-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-browser-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 57b0b1005246f..ba18bd9b46ad0 100644 --- a/api_docs/kbn_core_analytics_browser_mocks.mdx +++ b/api_docs/kbn_core_analytics_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-mocks title: "@kbn/core-analytics-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 6e95e325b8513..b3ab65551a09f 100644 --- a/api_docs/kbn_core_analytics_server.mdx +++ b/api_docs/kbn_core_analytics_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server title: "@kbn/core-analytics-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-server plugin -date: 2023-06-30 +date: 2023-07-18 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 fea858147789d..50d056de0d92a 100644 --- a/api_docs/kbn_core_analytics_server_internal.mdx +++ b/api_docs/kbn_core_analytics_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-internal title: "@kbn/core-analytics-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 4926468326f17..889eec8c3a256 100644 --- a/api_docs/kbn_core_analytics_server_mocks.mdx +++ b/api_docs/kbn_core_analytics_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-mocks title: "@kbn/core-analytics-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 5eec364c82a91..49be1da66eaf1 100644 --- a/api_docs/kbn_core_application_browser.mdx +++ b/api_docs/kbn_core_application_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser title: "@kbn/core-application-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 a42591a619af6..65b8addf9246a 100644 --- a/api_docs/kbn_core_application_browser_internal.mdx +++ b/api_docs/kbn_core_application_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser-internal title: "@kbn/core-application-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-browser-internal plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_application_browser_mocks.devdocs.json index be12beebfd75c..9f38ead6f5aa9 100644 --- a/api_docs/kbn_core_application_browser_mocks.devdocs.json +++ b/api_docs/kbn_core_application_browser_mocks.devdocs.json @@ -38,25 +38,25 @@ "section": "def-common.ScopedHistory", "text": "ScopedHistory" }, - ", [basePath: string]>; createHref: jest.MockInstance, [basePath: string], unknown>; createHref: jest.MockInstance, options?: { prependBasePath?: boolean | undefined; } | undefined]>; length: number; action: ", + ", options?: { prependBasePath?: boolean | undefined; } | undefined], unknown>; length: number; action: ", "Action", "; location: ", "Location", "; push: jest.MockInstance, state?: unknown]>; replace: jest.MockInstance, state?: unknown], unknown>; replace: jest.MockInstance, state?: unknown]>; go: jest.MockInstance; goBack: jest.MockInstance; goForward: jest.MockInstance; block: jest.MockInstance<", + ", state?: unknown], unknown>; go: jest.MockInstance; goBack: jest.MockInstance; goForward: jest.MockInstance; block: jest.MockInstance<", "UnregisterCallback", ", [prompt?: string | boolean | ", "TransitionPromptHook", - " | undefined]>; listen: jest.MockInstance<", + " | undefined], unknown>; listen: jest.MockInstance<", "UnregisterCallback", ", [listener: ", "LocationListener", - "]>; } & ", + "], unknown>; } & ", { "pluginId": "@kbn/core-application-browser", "scope": "common", diff --git a/api_docs/kbn_core_application_browser_mocks.mdx b/api_docs/kbn_core_application_browser_mocks.mdx index a7f3dc9896fa8..2ac2337749903 100644 --- a/api_docs/kbn_core_application_browser_mocks.mdx +++ b/api_docs/kbn_core_application_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser-mocks title: "@kbn/core-application-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 c787874beccfa..98fcc104bf0b1 100644 --- a/api_docs/kbn_core_application_common.mdx +++ b/api_docs/kbn_core_application_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-common title: "@kbn/core-application-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-common plugin -date: 2023-06-30 +date: 2023-07-18 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 4c4bd50d63557..d57d53092ae9d 100644 --- a/api_docs/kbn_core_apps_browser_internal.mdx +++ b/api_docs/kbn_core_apps_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-browser-internal title: "@kbn/core-apps-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-apps-browser-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 c9ce8b9ef4ffb..5defc55ea76c3 100644 --- a/api_docs/kbn_core_apps_browser_mocks.mdx +++ b/api_docs/kbn_core_apps_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-browser-mocks title: "@kbn/core-apps-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-apps-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 04fb2016aac80..157b8e5540975 100644 --- a/api_docs/kbn_core_apps_server_internal.mdx +++ b/api_docs/kbn_core_apps_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-server-internal title: "@kbn/core-apps-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-apps-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 2a8cdfb9e35aa..10ed09ea0a846 100644 --- a/api_docs/kbn_core_base_browser_mocks.mdx +++ b/api_docs/kbn_core_base_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-browser-mocks title: "@kbn/core-base-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 3c2e12d30eb99..90c1bb67edd92 100644 --- a/api_docs/kbn_core_base_common.mdx +++ b/api_docs/kbn_core_base_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-common title: "@kbn/core-base-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-common plugin -date: 2023-06-30 +date: 2023-07-18 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 94bf124c8443d..9a18faf457aed 100644 --- a/api_docs/kbn_core_base_server_internal.mdx +++ b/api_docs/kbn_core_base_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-internal title: "@kbn/core-base-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 b5b2de345636f..2da2a0067bb13 100644 --- a/api_docs/kbn_core_base_server_mocks.mdx +++ b/api_docs/kbn_core_base_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-mocks title: "@kbn/core-base-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 c0162cc0508d9..2bfc72a54004f 100644 --- a/api_docs/kbn_core_capabilities_browser_mocks.mdx +++ b/api_docs/kbn_core_capabilities_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-browser-mocks title: "@kbn/core-capabilities-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 b6c64bd693f11..054c139be0696 100644 --- a/api_docs/kbn_core_capabilities_common.mdx +++ b/api_docs/kbn_core_capabilities_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-common title: "@kbn/core-capabilities-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-common plugin -date: 2023-06-30 +date: 2023-07-18 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 d7719d9c61f05..a6722aba43552 100644 --- a/api_docs/kbn_core_capabilities_server.mdx +++ b/api_docs/kbn_core_capabilities_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-server title: "@kbn/core-capabilities-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-server plugin -date: 2023-06-30 +date: 2023-07-18 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 3e36e267542d7..fc4891adb3b99 100644 --- a/api_docs/kbn_core_capabilities_server_mocks.mdx +++ b/api_docs/kbn_core_capabilities_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-server-mocks title: "@kbn/core-capabilities-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 32156759fca8b..125aa8582db52 100644 --- a/api_docs/kbn_core_chrome_browser.devdocs.json +++ b/api_docs/kbn_core_chrome_browser.devdocs.json @@ -671,6 +671,56 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/core-chrome-browser", + "id": "def-common.ChromeHelpMenuLink", + "type": "Interface", + "tags": [], + "label": "ChromeHelpMenuLink", + "description": [], + "path": "packages/core/chrome/core-chrome-browser/src/nav_controls.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-chrome-browser", + "id": "def-common.ChromeHelpMenuLink.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "packages/core/chrome/core-chrome-browser/src/nav_controls.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-chrome-browser", + "id": "def-common.ChromeHelpMenuLink.href", + "type": "string", + "tags": [], + "label": "href", + "description": [], + "path": "packages/core/chrome/core-chrome-browser/src/nav_controls.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-chrome-browser", + "id": "def-common.ChromeHelpMenuLink.iconType", + "type": "string", + "tags": [], + "label": "iconType", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/chrome/core-chrome-browser/src/nav_controls.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-chrome-browser", "id": "def-common.ChromeNavControl", @@ -941,6 +991,55 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-chrome-browser", + "id": "def-common.ChromeNavControls.setHelpMenuLinks", + "type": "Function", + "tags": [], + "label": "setHelpMenuLinks", + "description": [ + "Set the help menu links" + ], + "signature": [ + "(links: ", + { + "pluginId": "@kbn/core-chrome-browser", + "scope": "common", + "docId": "kibKbnCoreChromeBrowserPluginApi", + "section": "def-common.ChromeHelpMenuLink", + "text": "ChromeHelpMenuLink" + }, + "[]) => void" + ], + "path": "packages/core/chrome/core-chrome-browser/src/nav_controls.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-chrome-browser", + "id": "def-common.ChromeNavControls.setHelpMenuLinks.$1", + "type": "Array", + "tags": [], + "label": "links", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-chrome-browser", + "scope": "common", + "docId": "kibKbnCoreChromeBrowserPluginApi", + "section": "def-common.ChromeHelpMenuLink", + "text": "ChromeHelpMenuLink" + }, + "[]" + ], + "path": "packages/core/chrome/core-chrome-browser/src/nav_controls.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -2227,6 +2326,55 @@ ], "returnComment": [] }, + { + "parentPluginId": "@kbn/core-chrome-browser", + "id": "def-common.ChromeStart.setHelpMenuLinks", + "type": "Function", + "tags": [], + "label": "setHelpMenuLinks", + "description": [ + "\nOverride the default links shown in the help menu" + ], + "signature": [ + "(links: ", + { + "pluginId": "@kbn/core-chrome-browser", + "scope": "common", + "docId": "kibKbnCoreChromeBrowserPluginApi", + "section": "def-common.ChromeHelpMenuLink", + "text": "ChromeHelpMenuLink" + }, + "[]) => void" + ], + "path": "packages/core/chrome/core-chrome-browser/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-chrome-browser", + "id": "def-common.ChromeStart.setHelpMenuLinks.$1", + "type": "Array", + "tags": [], + "label": "links", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-chrome-browser", + "scope": "common", + "docId": "kibKbnCoreChromeBrowserPluginApi", + "section": "def-common.ChromeHelpMenuLink", + "text": "ChromeHelpMenuLink" + }, + "[]" + ], + "path": "packages/core/chrome/core-chrome-browser/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "@kbn/core-chrome-browser", "id": "def-common.ChromeStart.getGlobalHelpExtensionMenuLinks$", @@ -2416,6 +2564,26 @@ ], "returnComment": [] }, + { + "parentPluginId": "@kbn/core-chrome-browser", + "id": "def-common.ChromeStart.getHelpSupportUrl$", + "type": "Function", + "tags": [], + "label": "getHelpSupportUrl$", + "description": [ + "\nGet the support URL shown in the help menu" + ], + "signature": [ + "() => ", + "Observable", + "" + ], + "path": "packages/core/chrome/core-chrome-browser/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "@kbn/core-chrome-browser", "id": "def-common.ChromeStart.getIsNavDrawerLocked$", @@ -2936,19 +3104,19 @@ "section": "def-common.AppId", "text": "AppId" }, - " | \"serverlessElasticsearch\" | ", + " | ", { - "pluginId": "@kbn/deeplinks-observability", + "pluginId": "@kbn/deeplinks-management", "scope": "common", - "docId": "kibKbnDeeplinksObservabilityPluginApi", + "docId": "kibKbnDeeplinksManagementPluginApi", "section": "def-common.AppId", "text": "AppId" }, - " | ", + " | \"serverlessElasticsearch\" | ", { - "pluginId": "@kbn/deeplinks-management", + "pluginId": "@kbn/deeplinks-observability", "scope": "common", - "docId": "kibKbnDeeplinksManagementPluginApi", + "docId": "kibKbnDeeplinksObservabilityPluginApi", "section": "def-common.AppId", "text": "AppId" } @@ -2968,7 +3136,7 @@ "signature": [ "Omit, \"color\" | \"aria-current\"> & ", "CommonProps", - " & { href?: string | undefined; rel?: string | undefined; onClick?: React.MouseEventHandler | undefined; text: React.ReactNode; truncate?: boolean | undefined; color?: \"text\" | \"warning\" | \"success\" | \"subdued\" | \"primary\" | \"accent\" | \"danger\" | \"ghost\" | undefined; 'aria-current'?: boolean | \"page\" | \"date\" | \"time\" | \"true\" | \"false\" | \"step\" | \"location\" | undefined; }" + " & { href?: string | undefined; rel?: string | undefined; onClick?: React.MouseEventHandler | undefined; text: React.ReactNode; truncate?: boolean | undefined; color?: \"text\" | \"warning\" | \"success\" | \"subdued\" | \"primary\" | \"accent\" | \"danger\" | \"ghost\" | undefined; 'aria-current'?: boolean | \"page\" | \"date\" | \"true\" | \"false\" | \"time\" | \"step\" | \"location\" | undefined; }" ], "path": "packages/core/chrome/core-chrome-browser/src/breadcrumb.ts", "deprecated": false, @@ -3047,7 +3215,7 @@ "signature": [ "Omit, \"color\" | \"aria-current\"> & ", "CommonProps", - " & { href?: string | undefined; rel?: string | undefined; onClick?: React.MouseEventHandler | undefined; text: React.ReactNode; truncate?: boolean | undefined; color?: \"text\" | \"warning\" | \"success\" | \"subdued\" | \"primary\" | \"accent\" | \"danger\" | \"ghost\" | undefined; 'aria-current'?: boolean | \"page\" | \"date\" | \"time\" | \"true\" | \"false\" | \"step\" | \"location\" | undefined; }" + " & { href?: string | undefined; rel?: string | undefined; onClick?: React.MouseEventHandler | undefined; text: React.ReactNode; truncate?: boolean | undefined; color?: \"text\" | \"warning\" | \"success\" | \"subdued\" | \"primary\" | \"accent\" | \"danger\" | \"ghost\" | undefined; 'aria-current'?: boolean | \"page\" | \"date\" | \"true\" | \"false\" | \"time\" | \"step\" | \"location\" | undefined; }" ], "path": "packages/core/chrome/core-chrome-browser/src/project_navigation.ts", "deprecated": false, diff --git a/api_docs/kbn_core_chrome_browser.mdx b/api_docs/kbn_core_chrome_browser.mdx index a98f34d29414a..d4cf3a68015c8 100644 --- a/api_docs/kbn_core_chrome_browser.mdx +++ b/api_docs/kbn_core_chrome_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-chrome-browser title: "@kbn/core-chrome-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-chrome-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 | |-------------------|-----------|------------------------|-----------------| -| 157 | 0 | 61 | 0 | +| 166 | 0 | 67 | 0 | ## Common diff --git a/api_docs/kbn_core_chrome_browser_mocks.mdx b/api_docs/kbn_core_chrome_browser_mocks.mdx index 9971dd240ee01..287b3d2e8eadc 100644 --- a/api_docs/kbn_core_chrome_browser_mocks.mdx +++ b/api_docs/kbn_core_chrome_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-chrome-browser-mocks title: "@kbn/core-chrome-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-chrome-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 73f6d07157fc6..e7e36b928fe0d 100644 --- a/api_docs/kbn_core_config_server_internal.mdx +++ b/api_docs/kbn_core_config_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-config-server-internal title: "@kbn/core-config-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-config-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 4dd4c46bdaf4c..362d8ea698015 100644 --- a/api_docs/kbn_core_custom_branding_browser.mdx +++ b/api_docs/kbn_core_custom_branding_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser title: "@kbn/core-custom-branding-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 a3eb72d395357..fb6285bf9610d 100644 --- a/api_docs/kbn_core_custom_branding_browser_internal.mdx +++ b/api_docs/kbn_core_custom_branding_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser-internal title: "@kbn/core-custom-branding-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-browser-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 f56893f9807c8..c25761e92d6af 100644 --- a/api_docs/kbn_core_custom_branding_browser_mocks.mdx +++ b/api_docs/kbn_core_custom_branding_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser-mocks title: "@kbn/core-custom-branding-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 27a4e3f248786..244862eb1a1ce 100644 --- a/api_docs/kbn_core_custom_branding_common.mdx +++ b/api_docs/kbn_core_custom_branding_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-common title: "@kbn/core-custom-branding-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-common plugin -date: 2023-06-30 +date: 2023-07-18 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 9fc4ff8f05bc2..c39f0c851bf75 100644 --- a/api_docs/kbn_core_custom_branding_server.mdx +++ b/api_docs/kbn_core_custom_branding_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server title: "@kbn/core-custom-branding-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-server plugin -date: 2023-06-30 +date: 2023-07-18 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 0f2bdd55f8b34..f7609e27394af 100644 --- a/api_docs/kbn_core_custom_branding_server_internal.mdx +++ b/api_docs/kbn_core_custom_branding_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server-internal title: "@kbn/core-custom-branding-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_custom_branding_server_mocks.devdocs.json index a0dcf7cd134cf..3ce2c8571b4da 100644 --- a/api_docs/kbn_core_custom_branding_server_mocks.devdocs.json +++ b/api_docs/kbn_core_custom_branding_server_mocks.devdocs.json @@ -66,7 +66,7 @@ "label": "createSetupContract", "description": [], "signature": [ - "() => { register: jest.Mock; getBrandingFor: jest.Mock; }" + "() => { register: jest.Mock; getBrandingFor: jest.Mock; }" ], "path": "packages/core/custom-branding/core-custom-branding-server-mocks/src/custom_branding_service.mock.ts", "deprecated": false, diff --git a/api_docs/kbn_core_custom_branding_server_mocks.mdx b/api_docs/kbn_core_custom_branding_server_mocks.mdx index c13ea492a7c12..1029c6db08ed1 100644 --- a/api_docs/kbn_core_custom_branding_server_mocks.mdx +++ b/api_docs/kbn_core_custom_branding_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server-mocks title: "@kbn/core-custom-branding-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 705af1a99f7e6..6049927f22262 100644 --- a/api_docs/kbn_core_deprecations_browser.mdx +++ b/api_docs/kbn_core_deprecations_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser title: "@kbn/core-deprecations-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 fcdb41ea8ec35..d93b31ef24ec2 100644 --- a/api_docs/kbn_core_deprecations_browser_internal.mdx +++ b/api_docs/kbn_core_deprecations_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser-internal title: "@kbn/core-deprecations-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-browser-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 48bad509c8b75..3841e2767bbd7 100644 --- a/api_docs/kbn_core_deprecations_browser_mocks.mdx +++ b/api_docs/kbn_core_deprecations_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser-mocks title: "@kbn/core-deprecations-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 2a3d480017da6..2534247707e7d 100644 --- a/api_docs/kbn_core_deprecations_common.mdx +++ b/api_docs/kbn_core_deprecations_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-common title: "@kbn/core-deprecations-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-common plugin -date: 2023-06-30 +date: 2023-07-18 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 3adc0a462aec1..0b5d33b4e38b5 100644 --- a/api_docs/kbn_core_deprecations_server.mdx +++ b/api_docs/kbn_core_deprecations_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server title: "@kbn/core-deprecations-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-server plugin -date: 2023-06-30 +date: 2023-07-18 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 19b6c3861807f..29cd6d34a89fd 100644 --- a/api_docs/kbn_core_deprecations_server_internal.mdx +++ b/api_docs/kbn_core_deprecations_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server-internal title: "@kbn/core-deprecations-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 7fec2cfc9e9a7..304c0878d2840 100644 --- a/api_docs/kbn_core_deprecations_server_mocks.mdx +++ b/api_docs/kbn_core_deprecations_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server-mocks title: "@kbn/core-deprecations-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 34fa37a32b791..cfd7a922c76c4 100644 --- a/api_docs/kbn_core_doc_links_browser.mdx +++ b/api_docs/kbn_core_doc_links_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser title: "@kbn/core-doc-links-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-browser plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_doc_links_browser_mocks.devdocs.json index cb8eebb761298..d49117767da15 100644 --- a/api_docs/kbn_core_doc_links_browser_mocks.devdocs.json +++ b/api_docs/kbn_core_doc_links_browser_mocks.devdocs.json @@ -58,7 +58,7 @@ "label": "createSetupContract", "description": [], "signature": [ - "() => jest.Mock" + "() => jest.Mock" ], "path": "packages/core/doc-links/core-doc-links-browser-mocks/src/doc_links_service.mock.ts", "deprecated": false, diff --git a/api_docs/kbn_core_doc_links_browser_mocks.mdx b/api_docs/kbn_core_doc_links_browser_mocks.mdx index 14b71b7706477..50ddea93ba6c4 100644 --- a/api_docs/kbn_core_doc_links_browser_mocks.mdx +++ b/api_docs/kbn_core_doc_links_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser-mocks title: "@kbn/core-doc-links-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 39efaa80587c8..de5892045ce14 100644 --- a/api_docs/kbn_core_doc_links_server.mdx +++ b/api_docs/kbn_core_doc_links_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server title: "@kbn/core-doc-links-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-server plugin -date: 2023-06-30 +date: 2023-07-18 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 85c2fb294ecbf..c3703c48f48f8 100644 --- a/api_docs/kbn_core_doc_links_server_mocks.mdx +++ b/api_docs/kbn_core_doc_links_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server-mocks title: "@kbn/core-doc-links-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 c989fe7b121fa..1101e448ea23d 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_internal.mdx +++ b/api_docs/kbn_core_elasticsearch_client_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-client-server-internal title: "@kbn/core-elasticsearch-client-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-client-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json index 5d5398da21156..7ad9ebdcc1c7f 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json @@ -61,7 +61,7 @@ "section": "def-common.ClientApiMockInstance", "text": "ClientApiMockInstance" }, - " extends jest.MockInstance" + " extends jest.MockInstance" ], "path": "packages/core/elasticsearch/core-elasticsearch-client-server-mocks/src/mocks.ts", "deprecated": false, @@ -1366,7 +1366,7 @@ "section": "def-common.ScopedClusterClientMock", "text": "ScopedClusterClientMock" }, - ", []> & (() => ", + ", [], unknown> & (() => ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -3584,7 +3584,7 @@ "label": "CustomClusterClientMock", "description": [], "signature": [ - "{ close: jest.MockInstance, []>; readonly asInternalUser: ", + "{ close: jest.MockInstance, [], unknown>; readonly asInternalUser: ", { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", @@ -3608,7 +3608,7 @@ "section": "def-common.ScopeableRequest", "text": "ScopeableRequest" }, - "]>; } & ", + "], unknown>; } & ", { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", diff --git a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx index e9301439b6ed0..67d7fdfa9a586 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx +++ b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-client-server-mocks title: "@kbn/core-elasticsearch-client-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-client-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_elasticsearch_server.devdocs.json index 6aeb9884c1073..2a0b684c65c01 100644 --- a/api_docs/kbn_core_elasticsearch_server.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_server.devdocs.json @@ -974,7 +974,7 @@ "Headers used for authentication against Elasticsearch" ], "signature": [ - "{ date?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; from?: string | string[] | undefined; etag?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; range?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ date?: string | string[] | undefined; warning?: string | string[] | undefined; range?: string | string[] | undefined; from?: string | string[] | undefined; location?: string | string[] | undefined; etag?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "packages/core/elasticsearch/core-elasticsearch-server/src/client/scopeable_request.ts", "deprecated": false, diff --git a/api_docs/kbn_core_elasticsearch_server.mdx b/api_docs/kbn_core_elasticsearch_server.mdx index c6702cd7c050f..aeff482f51043 100644 --- a/api_docs/kbn_core_elasticsearch_server.mdx +++ b/api_docs/kbn_core_elasticsearch_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server title: "@kbn/core-elasticsearch-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-server plugin -date: 2023-06-30 +date: 2023-07-18 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 d135ff737655e..866ce99c93f26 100644 --- a/api_docs/kbn_core_elasticsearch_server_internal.mdx +++ b/api_docs/kbn_core_elasticsearch_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server-internal title: "@kbn/core-elasticsearch-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_elasticsearch_server_mocks.devdocs.json index 787e518bcf5f8..ce0361d169a13 100644 --- a/api_docs/kbn_core_elasticsearch_server_mocks.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_server_mocks.devdocs.json @@ -75,7 +75,7 @@ "section": "def-common.ElasticsearchClientConfig", "text": "ElasticsearchClientConfig" }, - "> | undefined]> & ((type: string, config?: Partial<", + "> | undefined], unknown> & ((type: string, config?: Partial<", { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", @@ -155,7 +155,7 @@ "section": "def-common.UnauthorizedErrorHandler", "text": "UnauthorizedErrorHandler" }, - "]>; } & Omit<", + "], unknown>; } & Omit<", { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", diff --git a/api_docs/kbn_core_elasticsearch_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_server_mocks.mdx index 8d7e4fdb80df1..b4e5abe39dde2 100644 --- a/api_docs/kbn_core_elasticsearch_server_mocks.mdx +++ b/api_docs/kbn_core_elasticsearch_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server-mocks title: "@kbn/core-elasticsearch-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 a0cbc63237698..ecdbcffc5e773 100644 --- a/api_docs/kbn_core_environment_server_internal.mdx +++ b/api_docs/kbn_core_environment_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-internal title: "@kbn/core-environment-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-environment-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 85b2b29711d5e..98e23de57282a 100644 --- a/api_docs/kbn_core_environment_server_mocks.mdx +++ b/api_docs/kbn_core_environment_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-mocks title: "@kbn/core-environment-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-environment-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 9a4bff3292463..236d3d6bc556c 100644 --- a/api_docs/kbn_core_execution_context_browser.mdx +++ b/api_docs/kbn_core_execution_context_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser title: "@kbn/core-execution-context-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 44fa0c99cac00..2cd337fd00d93 100644 --- a/api_docs/kbn_core_execution_context_browser_internal.mdx +++ b/api_docs/kbn_core_execution_context_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-internal title: "@kbn/core-execution-context-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-browser-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 b6fb4bb8b7abf..22aa0e8058a78 100644 --- a/api_docs/kbn_core_execution_context_browser_mocks.mdx +++ b/api_docs/kbn_core_execution_context_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-mocks title: "@kbn/core-execution-context-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 c2ca321287b08..676bf2765962f 100644 --- a/api_docs/kbn_core_execution_context_common.mdx +++ b/api_docs/kbn_core_execution_context_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-common title: "@kbn/core-execution-context-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-common plugin -date: 2023-06-30 +date: 2023-07-18 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 33a8a9c730e4e..3183fa2743eea 100644 --- a/api_docs/kbn_core_execution_context_server.mdx +++ b/api_docs/kbn_core_execution_context_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server title: "@kbn/core-execution-context-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-server plugin -date: 2023-06-30 +date: 2023-07-18 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 d86a751f18d6d..ef3da3d7cf42e 100644 --- a/api_docs/kbn_core_execution_context_server_internal.mdx +++ b/api_docs/kbn_core_execution_context_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-internal title: "@kbn/core-execution-context-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 6b3d182746dd0..79af222096c33 100644 --- a/api_docs/kbn_core_execution_context_server_mocks.mdx +++ b/api_docs/kbn_core_execution_context_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-mocks title: "@kbn/core-execution-context-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 8d6ec4e81ace1..a567236822738 100644 --- a/api_docs/kbn_core_fatal_errors_browser.mdx +++ b/api_docs/kbn_core_fatal_errors_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser title: "@kbn/core-fatal-errors-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-fatal-errors-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 94604c98e9a1d..cb5c671766134 100644 --- a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx +++ b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser-mocks title: "@kbn/core-fatal-errors-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-fatal-errors-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 57198beac077e..072accb2cf451 100644 --- a/api_docs/kbn_core_http_browser.mdx +++ b/api_docs/kbn_core_http_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser title: "@kbn/core-http-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 a769b60950ea0..330b92bb32e1f 100644 --- a/api_docs/kbn_core_http_browser_internal.mdx +++ b/api_docs/kbn_core_http_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser-internal title: "@kbn/core-http-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-browser-internal plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_http_browser_mocks.devdocs.json index 99f58c97afc9c..39526d744321e 100644 --- a/api_docs/kbn_core_http_browser_mocks.devdocs.json +++ b/api_docs/kbn_core_http_browser_mocks.devdocs.json @@ -164,7 +164,7 @@ "section": "def-common.HttpInterceptor", "text": "HttpInterceptor" }, - "]>; fetch: jest.MockInstance, [options: ", + "], unknown>; fetch: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -172,7 +172,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; delete: jest.MockInstance, [options: ", + "], unknown>; delete: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -180,7 +180,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; get: jest.MockInstance, [options: ", + "], unknown>; get: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -188,7 +188,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; head: jest.MockInstance, [options: ", + "], unknown>; head: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -196,7 +196,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; options: jest.MockInstance, [options: ", + "], unknown>; options: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -204,7 +204,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; patch: jest.MockInstance, [options: ", + "], unknown>; patch: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -212,7 +212,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; post: jest.MockInstance, [options: ", + "], unknown>; post: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -220,7 +220,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; put: jest.MockInstance, [options: ", + "], unknown>; put: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -228,11 +228,11 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; addLoadingCountSource: jest.MockInstance; addLoadingCountSource: jest.MockInstance]>; getLoadingCount$: jest.MockInstance<", + "], unknown>; getLoadingCount$: jest.MockInstance<", "Observable", - ", []>; } & ", + ", [], unknown>; } & ", { "pluginId": "@kbn/core-http-browser", "scope": "common", diff --git a/api_docs/kbn_core_http_browser_mocks.mdx b/api_docs/kbn_core_http_browser_mocks.mdx index 6830558759b94..333e3eb3729b7 100644 --- a/api_docs/kbn_core_http_browser_mocks.mdx +++ b/api_docs/kbn_core_http_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser-mocks title: "@kbn/core-http-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_http_common.devdocs.json index 04efb33e966ff..00c50cae8e9f2 100644 --- a/api_docs/kbn_core_http_common.devdocs.json +++ b/api_docs/kbn_core_http_common.devdocs.json @@ -120,6 +120,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/core-http-common", + "id": "def-common.ELASTIC_HTTP_VERSION_QUERY_PARAM", + "type": "string", + "tags": [], + "label": "ELASTIC_HTTP_VERSION_QUERY_PARAM", + "description": [], + "signature": [ + "\"apiVersion\"" + ], + "path": "packages/core/http/core-http-common/src/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-http-common", "id": "def-common.X_ELASTIC_INTERNAL_ORIGIN_REQUEST", diff --git a/api_docs/kbn_core_http_common.mdx b/api_docs/kbn_core_http_common.mdx index 7f4e3aa97d4fa..1efeee5864ab8 100644 --- a/api_docs/kbn_core_http_common.mdx +++ b/api_docs/kbn_core_http_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-common title: "@kbn/core-http-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-common plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-common'] --- import kbnCoreHttpCommonObj from './kbn_core_http_common.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 | |-------------------|-----------|------------------------|-----------------| -| 7 | 0 | 2 | 0 | +| 8 | 0 | 3 | 0 | ## Common diff --git a/api_docs/kbn_core_http_context_server_mocks.devdocs.json b/api_docs/kbn_core_http_context_server_mocks.devdocs.json index 547559b7e5ce0..fe319a53cb570 100644 --- a/api_docs/kbn_core_http_context_server_mocks.devdocs.json +++ b/api_docs/kbn_core_http_context_server_mocks.devdocs.json @@ -54,7 +54,7 @@ "section": "def-common.RequestHandlerContextBase", "text": "RequestHandlerContextBase" }, - ", \"resolve\">]>; createHandler: jest.MockInstance<(request: ", + ", \"resolve\">], unknown>; createHandler: jest.MockInstance<(request: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -102,7 +102,7 @@ "section": "def-common.KibanaResponseFactory", "text": "KibanaResponseFactory" }, - ">]>; } & ", + ">], unknown>; } & ", { "pluginId": "@kbn/core-http-server", "scope": "common", diff --git a/api_docs/kbn_core_http_context_server_mocks.mdx b/api_docs/kbn_core_http_context_server_mocks.mdx index 44e850dd73eaf..3b43026376e16 100644 --- a/api_docs/kbn_core_http_context_server_mocks.mdx +++ b/api_docs/kbn_core_http_context_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-context-server-mocks title: "@kbn/core-http-context-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-context-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 58c73ddf9155f..9b3394b0e5782 100644 --- a/api_docs/kbn_core_http_request_handler_context_server.mdx +++ b/api_docs/kbn_core_http_request_handler_context_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-request-handler-context-server title: "@kbn/core-http-request-handler-context-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-request-handler-context-server plugin -date: 2023-06-30 +date: 2023-07-18 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 0e251aca15b30..d944832ef224c 100644 --- a/api_docs/kbn_core_http_resources_server.mdx +++ b/api_docs/kbn_core_http_resources_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server title: "@kbn/core-http-resources-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-resources-server plugin -date: 2023-06-30 +date: 2023-07-18 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 104637ea97997..998e3ecb2b596 100644 --- a/api_docs/kbn_core_http_resources_server_internal.mdx +++ b/api_docs/kbn_core_http_resources_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server-internal title: "@kbn/core-http-resources-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-resources-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_http_resources_server_mocks.devdocs.json index 0ce3d88b19cbf..5af3c308b95e5 100644 --- a/api_docs/kbn_core_http_resources_server_mocks.devdocs.json +++ b/api_docs/kbn_core_http_resources_server_mocks.devdocs.json @@ -30,7 +30,7 @@ "label": "HttpResourcesMock", "description": [], "signature": [ - "{ start: jest.MockInstance; setup: jest.MockInstance<{ createRegistrar: (router: ", + "{ start: jest.MockInstance; setup: jest.MockInstance<{ createRegistrar: (router: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -56,7 +56,7 @@ }, "; }, [deps: ", "SetupDeps", - "]>; stop: jest.MockInstance; preboot: jest.MockInstance<{ createRegistrar: (router: ", + "], unknown>; stop: jest.MockInstance; preboot: jest.MockInstance<{ createRegistrar: (router: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -82,7 +82,7 @@ }, "; }, [deps: ", "PrebootDeps", - "]>; } & ", + "], unknown>; } & ", { "pluginId": "@kbn/utility-types", "scope": "common", @@ -181,7 +181,7 @@ "section": "def-common.HttpResources", "text": "HttpResources" }, - ">, []>; }" + ">, [], any>; }" ], "path": "packages/core/http/core-http-resources-server-mocks/src/http_resources_server.mock.ts", "deprecated": false, @@ -205,7 +205,7 @@ "section": "def-common.HttpResources", "text": "HttpResources" }, - ">, []>; }" + ">, [], any>; }" ], "path": "packages/core/http/core-http-resources-server-mocks/src/http_resources_server.mock.ts", "deprecated": false, @@ -237,7 +237,7 @@ "section": "def-common.HttpResourcesRenderOptions", "text": "HttpResourcesRenderOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-resources-server", "scope": "common", @@ -269,7 +269,7 @@ "section": "def-common.HttpResourcesRenderOptions", "text": "HttpResourcesRenderOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-resources-server", "scope": "common", @@ -301,7 +301,7 @@ "section": "def-common.HttpResourcesResponseOptions", "text": "HttpResourcesResponseOptions" }, - "]> & ((options: ", + "], unknown> & ((options: ", { "pluginId": "@kbn/core-http-resources-server", "scope": "common", @@ -333,7 +333,7 @@ "section": "def-common.HttpResourcesResponseOptions", "text": "HttpResourcesResponseOptions" }, - "]> & ((options: ", + "], unknown> & ((options: ", { "pluginId": "@kbn/core-http-resources-server", "scope": "common", @@ -365,7 +365,7 @@ "section": "def-common.HttpResourcesResponseOptions", "text": "HttpResourcesResponseOptions" }, - "]> & ((options: ", + "], unknown> & ((options: ", { "pluginId": "@kbn/core-http-resources-server", "scope": "common", @@ -417,7 +417,7 @@ "section": "def-common.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | undefined> | undefined]> & ( | Error | Buffer | ", + " | undefined; } | undefined> | undefined], unknown> & ( | Error | Buffer | ", "Stream", " | { message: string | Error; attributes?: ", { @@ -479,7 +479,7 @@ "section": "def-common.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | undefined> | undefined]> & ( | Error | Buffer | ", + " | undefined; } | undefined> | undefined], unknown> & ( | Error | Buffer | ", "Stream", " | { message: string | Error; attributes?: ", { @@ -521,7 +521,7 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -553,7 +553,7 @@ "section": "def-common.RedirectResponseOptions", "text": "RedirectResponseOptions" }, - "]> & ((options: ", + "], unknown> & ((options: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -585,7 +585,7 @@ "section": "def-common.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -617,7 +617,7 @@ "section": "def-common.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -649,7 +649,7 @@ "section": "def-common.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -681,7 +681,7 @@ "section": "def-common.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -713,7 +713,7 @@ "section": "def-common.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -755,7 +755,7 @@ "section": "def-common.ResponseError", "text": "ResponseError" }, - ">]> & ((options: ", + ">], unknown> & ((options: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -807,7 +807,7 @@ "section": "def-common.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | undefined>]> & ( | Error | Buffer | ", + " | undefined; } | undefined>], unknown> & ( | Error | Buffer | ", "Stream", " | { message: string | Error; attributes?: ", { @@ -859,7 +859,7 @@ "section": "def-common.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | undefined>]> & ( | Error | Buffer | ", + " | undefined; } | undefined>], unknown> & ( | Error | Buffer | ", "Stream", " | { message: string | Error; attributes?: ", { diff --git a/api_docs/kbn_core_http_resources_server_mocks.mdx b/api_docs/kbn_core_http_resources_server_mocks.mdx index e36512c4a18f1..c0f6a53bac574 100644 --- a/api_docs/kbn_core_http_resources_server_mocks.mdx +++ b/api_docs/kbn_core_http_resources_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server-mocks title: "@kbn/core-http-resources-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-resources-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-resources-server-mocks'] --- import kbnCoreHttpResourcesServerMocksObj from './kbn_core_http_resources_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_router_server_internal.mdx b/api_docs/kbn_core_http_router_server_internal.mdx index 89d0c5b958ecc..fdc1b2a404ebf 100644 --- a/api_docs/kbn_core_http_router_server_internal.mdx +++ b/api_docs/kbn_core_http_router_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-router-server-internal title: "@kbn/core-http-router-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-router-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-router-server-internal'] --- import kbnCoreHttpRouterServerInternalObj from './kbn_core_http_router_server_internal.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 26 | 6 | 26 | 1 | +| 26 | 6 | 26 | 2 | ## Common 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 819bcb68b96bf..8dbc1fe6e57a7 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" }, - ", \"access\"> | undefined; access: \"internal\" | \"public\"; }" + ", \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; }" ], "path": "packages/core/http/core-http-router-server-mocks/src/versioned_router.mock.ts", "deprecated": false, @@ -210,7 +210,7 @@ "section": "def-common.IKibanaResponse", "text": "IKibanaResponse" }, - ">]>; } & ", + ">], unknown>; } & ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -265,7 +265,7 @@ "section": "def-common.VersionedRouteConfig", "text": "VersionedRouteConfig" }, - "<\"get\">]>; put: jest.MockInstance<", + "<\"get\">], unknown>; put: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -281,7 +281,7 @@ "section": "def-common.VersionedRouteConfig", "text": "VersionedRouteConfig" }, - "<\"put\">]>; post: jest.MockInstance<", + "<\"put\">], unknown>; post: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -297,7 +297,7 @@ "section": "def-common.VersionedRouteConfig", "text": "VersionedRouteConfig" }, - "<\"post\">]>; patch: jest.MockInstance<", + "<\"post\">], unknown>; patch: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -313,7 +313,7 @@ "section": "def-common.VersionedRouteConfig", "text": "VersionedRouteConfig" }, - "<\"patch\">]>; delete: jest.MockInstance<", + "<\"patch\">], unknown>; delete: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -329,7 +329,7 @@ "section": "def-common.VersionedRouteConfig", "text": "VersionedRouteConfig" }, - "<\"delete\">]>; } & ", + "<\"delete\">], unknown>; } & ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -400,7 +400,7 @@ "section": "def-common.KibanaResponseFactory", "text": "KibanaResponseFactory" }, - ">]>; post: jest.MockInstance], unknown>; post: jest.MockInstance]>; put: jest.MockInstance], unknown>; put: jest.MockInstance]>; patch: jest.MockInstance], unknown>; patch: jest.MockInstance]>; delete: jest.MockInstance], unknown>; delete: jest.MockInstance]>; handleLegacyErrors: jest.MockInstance<", + ">], unknown>; handleLegacyErrors: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -560,7 +560,7 @@ "section": "def-common.KibanaResponseFactory", "text": "KibanaResponseFactory" }, - ">]>; getRoutes: jest.MockInstance<", + ">], unknown>; getRoutes: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -568,7 +568,7 @@ "section": "def-common.RouterRoute", "text": "RouterRoute" }, - "[], []>; versioned: ", + "[], [], unknown>; versioned: ", { "pluginId": "@kbn/core-http-server", "scope": "common", diff --git a/api_docs/kbn_core_http_router_server_mocks.mdx b/api_docs/kbn_core_http_router_server_mocks.mdx index 8b8c401974e25..7af8ac3b08302 100644 --- a/api_docs/kbn_core_http_router_server_mocks.mdx +++ b/api_docs/kbn_core_http_router_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-router-server-mocks title: "@kbn/core-http-router-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-router-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 92518c2c6c986..ec363d8fadb07 100644 --- a/api_docs/kbn_core_http_server.devdocs.json +++ b/api_docs/kbn_core_http_server.devdocs.json @@ -754,7 +754,7 @@ "The headers associated with the request." ], "signature": [ - "{ date?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; from?: string | string[] | undefined; etag?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; range?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ date?: string | string[] | undefined; warning?: string | string[] | undefined; range?: string | string[] | undefined; from?: string | string[] | undefined; location?: string | string[] | undefined; etag?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "packages/core/http/core-http-server/src/router/raw_request.ts", "deprecated": false, @@ -3267,6 +3267,14 @@ "plugin": "@kbn/core-ui-settings-server-internal", "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/get.ts" }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/get.ts" + }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/get.ts" + }, { "plugin": "@kbn/core-status-server-internal", "path": "packages/core/status/core-status-server-internal/src/routes/status.ts" @@ -3487,10 +3495,6 @@ "plugin": "actions", "path": "x-pack/plugins/actions/server/routes/legacy/list_action_types.ts" }, - { - "plugin": "bfetch", - "path": "src/plugins/bfetch/server/plugin.ts" - }, { "plugin": "data", "path": "src/plugins/data/server/scripts/route.ts" @@ -3687,6 +3691,26 @@ "plugin": "infra", "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" }, + { + "plugin": "profiling", + "path": "x-pack/plugins/profiling/server/routes/flamechart.ts" + }, + { + "plugin": "profiling", + "path": "x-pack/plugins/profiling/server/routes/functions.ts" + }, + { + "plugin": "profiling", + "path": "x-pack/plugins/profiling/server/routes/setup.ts" + }, + { + "plugin": "profiling", + "path": "x-pack/plugins/profiling/server/routes/setup.ts" + }, + { + "plugin": "profiling", + "path": "x-pack/plugins/profiling/server/routes/topn.ts" + }, { "plugin": "assetManager", "path": "x-pack/plugins/asset_manager/server/routes/ping.ts" @@ -3739,14 +3763,6 @@ "plugin": "cloudSecurityPosture", "path": "x-pack/plugins/cloud_security_posture/server/routes/vulnerabilities_dashboard/vulnerabilities_dashboard.ts" }, - { - "plugin": "cloudSecurityPosture", - "path": "x-pack/plugins/cloud_security_posture/server/routes/benchmarks/benchmarks.ts" - }, - { - "plugin": "cloudSecurityPosture", - "path": "x-pack/plugins/cloud_security_posture/server/routes/status/status.ts" - }, { "plugin": "indexManagement", "path": "x-pack/plugins/index_management/server/routes/api/data_streams/register_get_route.ts" @@ -4223,6 +4239,50 @@ "plugin": "enterpriseSearch", "path": "x-pack/plugins/enterprise_search/server/routes/workplace_search/sources.ts" }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/nodes/register_list_route.ts" + }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/nodes/register_details_route.ts" + }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/policies/register_fetch_route.ts" + }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/templates/register_fetch_route.ts" + }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/snapshot_policies/register_fetch_route.ts" + }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/snapshot_repositories/register_fetch_route.ts" + }, + { + "plugin": "ingestPipelines", + "path": "x-pack/plugins/ingest_pipelines/server/routes/api/get.ts" + }, + { + "plugin": "ingestPipelines", + "path": "x-pack/plugins/ingest_pipelines/server/routes/api/get.ts" + }, + { + "plugin": "ingestPipelines", + "path": "x-pack/plugins/ingest_pipelines/server/routes/api/privileges.ts" + }, + { + "plugin": "ingestPipelines", + "path": "x-pack/plugins/ingest_pipelines/server/routes/api/documents.ts" + }, + { + "plugin": "licenseManagement", + "path": "x-pack/plugins/license_management/server/routes/api/license/register_start_trial_routes.ts" + }, { "plugin": "lists", "path": "x-pack/plugins/lists/server/routes/find_endpoint_list_item_route.ts" @@ -4280,84 +4340,52 @@ "path": "x-pack/plugins/lists/server/routes/summary_exception_list_route.ts" }, { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health/get_cluster_health_route.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health/get_space_health_route.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.ts" - }, - { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/live_query/get_live_query_details_route.ts" - }, - { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/live_query/get_live_query_results_route.ts" - }, - { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/live_query/find_live_query_route.ts" - }, - { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/saved_query/find_saved_query_route.ts" - }, - { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/saved_query/read_saved_query_route.ts" + "plugin": "logstash", + "path": "x-pack/plugins/logstash/server/routes/cluster/load.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/status/create_status_route.ts" + "plugin": "logstash", + "path": "x-pack/plugins/logstash/server/routes/pipeline/load.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/fleet_wrapper/get_agent_policies.ts" + "plugin": "logstash", + "path": "x-pack/plugins/logstash/server/routes/pipelines/list.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/fleet_wrapper/get_agent_policy.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/server/plugin.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/fleet_wrapper/get_agent_status_for_agent_policy.ts" + "plugin": "reporting", + "path": "x-pack/plugins/reporting/server/test_helpers/create_mock_reportingplugin.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/fleet_wrapper/get_package_policies.ts" + "plugin": "rollup", + "path": "x-pack/plugins/rollup/server/routes/api/indices/register_get_route.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/fleet_wrapper/get_agents.ts" + "plugin": "rollup", + "path": "x-pack/plugins/rollup/server/routes/api/indices/register_validate_index_pattern_route.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/fleet_wrapper/get_agent_details.ts" + "plugin": "rollup", + "path": "x-pack/plugins/rollup/server/routes/api/jobs/register_get_route.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/pack/find_pack_route.ts" + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health/get_cluster_health_route.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/pack/read_pack_route.ts" + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health/get_space_health_route.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/privileges_check/privileges_check_route.ts" + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/asset/get_assets_status_route.ts" + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.ts" }, { "plugin": "securitySolution", @@ -4444,196 +4472,96 @@ "path": "x-pack/plugins/security_solution/server/lib/tags/routes/get_tags_by_name.ts" }, { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/file_download_handler.ts" + "plugin": "serverlessSearch", + "path": "x-pack/plugins/serverless_search/server/routes/api_key_routes.ts" }, { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/nodes/register_list_route.ts" + "plugin": "serverlessSearch", + "path": "x-pack/plugins/serverless_search/server/routes/indices_routes.ts" }, { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/nodes/register_details_route.ts" + "plugin": "snapshotRestore", + "path": "x-pack/plugins/snapshot_restore/server/routes/api/app.ts" }, { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/policies/register_fetch_route.ts" + "plugin": "snapshotRestore", + "path": "x-pack/plugins/snapshot_restore/server/routes/api/repositories.ts" }, { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/templates/register_fetch_route.ts" + "plugin": "snapshotRestore", + "path": "x-pack/plugins/snapshot_restore/server/routes/api/repositories.ts" }, { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/snapshot_policies/register_fetch_route.ts" + "plugin": "snapshotRestore", + "path": "x-pack/plugins/snapshot_restore/server/routes/api/repositories.ts" }, { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/snapshot_repositories/register_fetch_route.ts" + "plugin": "snapshotRestore", + "path": "x-pack/plugins/snapshot_restore/server/routes/api/repositories.ts" }, { - "plugin": "ingestPipelines", - "path": "x-pack/plugins/ingest_pipelines/server/routes/api/get.ts" + "plugin": "snapshotRestore", + "path": "x-pack/plugins/snapshot_restore/server/routes/api/snapshots.ts" }, { - "plugin": "ingestPipelines", - "path": "x-pack/plugins/ingest_pipelines/server/routes/api/get.ts" + "plugin": "snapshotRestore", + "path": "x-pack/plugins/snapshot_restore/server/routes/api/snapshots.ts" }, { - "plugin": "ingestPipelines", - "path": "x-pack/plugins/ingest_pipelines/server/routes/api/privileges.ts" + "plugin": "snapshotRestore", + "path": "x-pack/plugins/snapshot_restore/server/routes/api/restore.ts" }, { - "plugin": "ingestPipelines", - "path": "x-pack/plugins/ingest_pipelines/server/routes/api/documents.ts" + "plugin": "snapshotRestore", + "path": "x-pack/plugins/snapshot_restore/server/routes/api/policy.ts" }, { - "plugin": "licenseManagement", - "path": "x-pack/plugins/license_management/server/routes/api/license/register_start_trial_routes.ts" + "plugin": "snapshotRestore", + "path": "x-pack/plugins/snapshot_restore/server/routes/api/policy.ts" }, { - "plugin": "logstash", - "path": "x-pack/plugins/logstash/server/routes/cluster/load.ts" + "plugin": "snapshotRestore", + "path": "x-pack/plugins/snapshot_restore/server/routes/api/policy.ts" }, { - "plugin": "logstash", - "path": "x-pack/plugins/logstash/server/routes/pipeline/load.ts" + "plugin": "snapshotRestore", + "path": "x-pack/plugins/snapshot_restore/server/routes/api/policy.ts" }, { - "plugin": "logstash", - "path": "x-pack/plugins/logstash/server/routes/pipelines/list.ts" + "plugin": "snapshotRestore", + "path": "x-pack/plugins/snapshot_restore/server/routes/api/policy.ts" }, { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/server/plugin.ts" + "plugin": "stackConnectors", + "path": "x-pack/plugins/stack_connectors/server/routes/get_well_known_email_service.ts" }, { - "plugin": "profiling", - "path": "x-pack/plugins/profiling/server/routes/flamechart.ts" + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/server/server.ts" }, { - "plugin": "profiling", - "path": "x-pack/plugins/profiling/server/routes/functions.ts" + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/server/routes/reindex_indices/reindex_indices.ts" }, { - "plugin": "profiling", - "path": "x-pack/plugins/profiling/server/routes/setup.ts" + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/server/routes/reindex_indices/batch_reindex_indices.ts" }, { - "plugin": "profiling", - "path": "x-pack/plugins/profiling/server/routes/setup.ts" + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/server/routes/app.ts" }, { - "plugin": "profiling", - "path": "x-pack/plugins/profiling/server/routes/topn.ts" + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/server/routes/cloud_backup_status.ts" }, { - "plugin": "reporting", - "path": "x-pack/plugins/reporting/server/test_helpers/create_mock_reportingplugin.ts" + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/server/routes/cluster_upgrade_status.ts" }, { - "plugin": "rollup", - "path": "x-pack/plugins/rollup/server/routes/api/indices/register_get_route.ts" - }, - { - "plugin": "rollup", - "path": "x-pack/plugins/rollup/server/routes/api/indices/register_validate_index_pattern_route.ts" - }, - { - "plugin": "rollup", - "path": "x-pack/plugins/rollup/server/routes/api/jobs/register_get_route.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": "snapshotRestore", - "path": "x-pack/plugins/snapshot_restore/server/routes/api/app.ts" - }, - { - "plugin": "snapshotRestore", - "path": "x-pack/plugins/snapshot_restore/server/routes/api/repositories.ts" - }, - { - "plugin": "snapshotRestore", - "path": "x-pack/plugins/snapshot_restore/server/routes/api/repositories.ts" - }, - { - "plugin": "snapshotRestore", - "path": "x-pack/plugins/snapshot_restore/server/routes/api/repositories.ts" - }, - { - "plugin": "snapshotRestore", - "path": "x-pack/plugins/snapshot_restore/server/routes/api/repositories.ts" - }, - { - "plugin": "snapshotRestore", - "path": "x-pack/plugins/snapshot_restore/server/routes/api/snapshots.ts" - }, - { - "plugin": "snapshotRestore", - "path": "x-pack/plugins/snapshot_restore/server/routes/api/snapshots.ts" - }, - { - "plugin": "snapshotRestore", - "path": "x-pack/plugins/snapshot_restore/server/routes/api/restore.ts" - }, - { - "plugin": "snapshotRestore", - "path": "x-pack/plugins/snapshot_restore/server/routes/api/policy.ts" - }, - { - "plugin": "snapshotRestore", - "path": "x-pack/plugins/snapshot_restore/server/routes/api/policy.ts" - }, - { - "plugin": "snapshotRestore", - "path": "x-pack/plugins/snapshot_restore/server/routes/api/policy.ts" - }, - { - "plugin": "snapshotRestore", - "path": "x-pack/plugins/snapshot_restore/server/routes/api/policy.ts" - }, - { - "plugin": "snapshotRestore", - "path": "x-pack/plugins/snapshot_restore/server/routes/api/policy.ts" - }, - { - "plugin": "stackConnectors", - "path": "x-pack/plugins/stack_connectors/server/routes/get_well_known_email_service.ts" - }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/server/server.ts" - }, - { - "plugin": "upgradeAssistant", - "path": "x-pack/plugins/upgrade_assistant/server/routes/reindex_indices/reindex_indices.ts" - }, - { - "plugin": "upgradeAssistant", - "path": "x-pack/plugins/upgrade_assistant/server/routes/reindex_indices/batch_reindex_indices.ts" - }, - { - "plugin": "upgradeAssistant", - "path": "x-pack/plugins/upgrade_assistant/server/routes/app.ts" - }, - { - "plugin": "upgradeAssistant", - "path": "x-pack/plugins/upgrade_assistant/server/routes/cloud_backup_status.ts" - }, - { - "plugin": "upgradeAssistant", - "path": "x-pack/plugins/upgrade_assistant/server/routes/cluster_upgrade_status.ts" - }, - { - "plugin": "upgradeAssistant", - "path": "x-pack/plugins/upgrade_assistant/server/routes/system_indices_migration.ts" + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/server/routes/system_indices_migration.ts" }, { "plugin": "upgradeAssistant", @@ -5480,16 +5408,8 @@ "path": "x-pack/plugins/cloud_integrations/cloud_chat/server/routes/chat.test.ts" }, { - "plugin": "cloudSecurityPosture", - "path": "x-pack/plugins/cloud_security_posture/server/routes/benchmarks/benchmarks.test.ts" - }, - { - "plugin": "cloudSecurityPosture", - "path": "x-pack/plugins/cloud_security_posture/server/routes/benchmarks/benchmarks.test.ts" - }, - { - "plugin": "cloudSecurityPosture", - "path": "x-pack/plugins/cloud_security_posture/server/routes/benchmarks/benchmarks.test.ts" + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/uninstall_token/handlers.test.ts" }, { "plugin": "fleet", @@ -5819,6 +5739,10 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/server/routes/uninstall_token/index.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/uninstall_token/index.ts" + }, { "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/security/fleet_router.test.ts" @@ -6189,6 +6113,22 @@ "plugin": "@kbn/core-ui-settings-server-internal", "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/set.ts" }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set_many.ts" + }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set_many.ts" + }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set.ts" + }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set.ts" + }, { "plugin": "@kbn/core-capabilities-server-internal", "path": "packages/core/capabilities/core-capabilities-server-internal/src/routes/resolve_capabilities.ts" @@ -6345,10 +6285,6 @@ "plugin": "contentManagement", "path": "src/plugins/content_management/server/rpc/routes/routes.ts" }, - { - "plugin": "bfetch", - "path": "src/plugins/bfetch/server/plugin.ts" - }, { "plugin": "data", "path": "src/plugins/data/server/kql_telemetry/route.ts" @@ -6391,7 +6327,7 @@ }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/create_rule.ts" + "path": "x-pack/plugins/alerting/server/routes/rule/create/create_rule_route.ts" }, { "plugin": "alerting", @@ -6469,6 +6405,14 @@ "plugin": "alerting", "path": "x-pack/plugins/alerting/server/routes/maintenance_window/finish_maintenance_window.ts" }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/routes/suggestions/values_suggestion_rules.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/routes/suggestions/fields_rules.ts" + }, { "plugin": "alerting", "path": "x-pack/plugins/alerting/server/routes/maintenance_window/bulk_get_maintenance_windows.ts" @@ -6549,6 +6493,10 @@ "plugin": "infra", "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" }, + { + "plugin": "profiling", + "path": "x-pack/plugins/profiling/server/routes/setup.ts" + }, { "plugin": "assetManager", "path": "x-pack/plugins/asset_manager/server/routes/sample_assets.ts" @@ -6977,6 +6925,58 @@ "plugin": "enterpriseSearch", "path": "x-pack/plugins/enterprise_search/server/routes/workplace_search/sources.ts" }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/routes/search.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/routes/explore.ts" + }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/index/register_retry_route.ts" + }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/index/register_remove_route.ts" + }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/index/register_add_policy_route.ts" + }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/policies/register_create_route.ts" + }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/templates/register_add_policy_route.ts" + }, + { + "plugin": "ingestPipelines", + "path": "x-pack/plugins/ingest_pipelines/server/routes/api/create.ts" + }, + { + "plugin": "ingestPipelines", + "path": "x-pack/plugins/ingest_pipelines/server/routes/api/simulate.ts" + }, + { + "plugin": "ingestPipelines", + "path": "x-pack/plugins/ingest_pipelines/server/routes/api/parse_csv.ts" + }, + { + "plugin": "licenseManagement", + "path": "x-pack/plugins/license_management/server/routes/api/license/register_start_basic_route.ts" + }, + { + "plugin": "licenseManagement", + "path": "x-pack/plugins/license_management/server/routes/api/license/register_start_trial_routes.ts" + }, + { + "plugin": "licenseManagement", + "path": "x-pack/plugins/license_management/server/routes/api/license/register_permissions_route.ts" + }, { "plugin": "lists", "path": "x-pack/plugins/lists/server/routes/create_endpoint_list_item_route.ts" @@ -7034,36 +7034,68 @@ "path": "x-pack/plugins/lists/server/routes/internal/create_exceptions_list_route.ts" }, { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health/get_cluster_health_route.ts" + "plugin": "logstash", + "path": "x-pack/plugins/logstash/server/routes/pipelines/delete.ts" }, { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_rule_health/get_rule_health_route.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/server/routes/api/v1/alerts/enable.ts" }, { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health/get_space_health_route.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/server/routes/api/v1/alerts/status.ts" }, { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/setup/setup_health_route.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/server/routes/api/v1/elasticsearch_settings/check/internal_monitoring.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/live_query/create_live_query_route.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/server/plugin.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/saved_query/create_saved_query_route.ts" + "plugin": "painlessLab", + "path": "x-pack/plugins/painless_lab/server/routes/api/execute.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/pack/create_pack_route.ts" + "plugin": "reporting", + "path": "x-pack/plugins/reporting/server/test_helpers/create_mock_reportingplugin.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/asset/update_assets_route.ts" + "plugin": "rollup", + "path": "x-pack/plugins/rollup/server/routes/api/jobs/register_delete_route.ts" + }, + { + "plugin": "rollup", + "path": "x-pack/plugins/rollup/server/routes/api/jobs/register_start_route.ts" + }, + { + "plugin": "rollup", + "path": "x-pack/plugins/rollup/server/routes/api/jobs/register_stop_route.ts" + }, + { + "plugin": "rollup", + "path": "x-pack/plugins/rollup/server/routes/api/search/register_search_route.ts" + }, + { + "plugin": "searchprofiler", + "path": "x-pack/plugins/searchprofiler/server/routes/profile.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health/get_cluster_health_route.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_rule_health/get_rule_health_route.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health/get_space_health_route.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/setup/setup_health_route.ts" }, { "plugin": "securitySolution", @@ -7205,110 +7237,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/risk_engine/routes/risk_score_preview_route.ts" }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/routes/search.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/routes/explore.ts" - }, - { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/index/register_retry_route.ts" - }, - { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/index/register_remove_route.ts" - }, - { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/index/register_add_policy_route.ts" - }, - { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/policies/register_create_route.ts" - }, - { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/templates/register_add_policy_route.ts" - }, - { - "plugin": "ingestPipelines", - "path": "x-pack/plugins/ingest_pipelines/server/routes/api/create.ts" - }, - { - "plugin": "ingestPipelines", - "path": "x-pack/plugins/ingest_pipelines/server/routes/api/simulate.ts" - }, - { - "plugin": "ingestPipelines", - "path": "x-pack/plugins/ingest_pipelines/server/routes/api/parse_csv.ts" - }, - { - "plugin": "licenseManagement", - "path": "x-pack/plugins/license_management/server/routes/api/license/register_start_basic_route.ts" - }, - { - "plugin": "licenseManagement", - "path": "x-pack/plugins/license_management/server/routes/api/license/register_start_trial_routes.ts" - }, - { - "plugin": "licenseManagement", - "path": "x-pack/plugins/license_management/server/routes/api/license/register_permissions_route.ts" - }, - { - "plugin": "logstash", - "path": "x-pack/plugins/logstash/server/routes/pipelines/delete.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/server/routes/api/v1/alerts/enable.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/server/routes/api/v1/alerts/status.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/server/routes/api/v1/elasticsearch_settings/check/internal_monitoring.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/server/plugin.ts" - }, - { - "plugin": "painlessLab", - "path": "x-pack/plugins/painless_lab/server/routes/api/execute.ts" - }, - { - "plugin": "profiling", - "path": "x-pack/plugins/profiling/server/routes/setup.ts" - }, - { - "plugin": "reporting", - "path": "x-pack/plugins/reporting/server/test_helpers/create_mock_reportingplugin.ts" - }, - { - "plugin": "rollup", - "path": "x-pack/plugins/rollup/server/routes/api/jobs/register_delete_route.ts" - }, - { - "plugin": "rollup", - "path": "x-pack/plugins/rollup/server/routes/api/jobs/register_start_route.ts" - }, - { - "plugin": "rollup", - "path": "x-pack/plugins/rollup/server/routes/api/jobs/register_stop_route.ts" - }, - { - "plugin": "rollup", - "path": "x-pack/plugins/rollup/server/routes/api/search/register_search_route.ts" - }, - { - "plugin": "searchprofiler", - "path": "x-pack/plugins/searchprofiler/server/routes/profile.ts" - }, { "plugin": "serverless", "path": "x-pack/plugins/serverless/server/plugin.ts" @@ -7337,10 +7265,6 @@ "plugin": "snapshotRestore", "path": "x-pack/plugins/snapshot_restore/server/routes/api/policy.ts" }, - { - "plugin": "stackConnectors", - "path": "x-pack/plugins/stack_connectors/server/routes/get_slack_api_channels.ts" - }, { "plugin": "synthetics", "path": "x-pack/plugins/synthetics/server/server.ts" @@ -7642,68 +7566,40 @@ "path": "x-pack/plugins/actions/server/routes/get_oauth_access_token.test.ts" }, { - "plugin": "actions", - "path": "x-pack/plugins/actions/server/routes/get_oauth_access_token.test.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/bulk_edit_rules.test.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/bulk_edit_rules.test.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/bulk_edit_rules.test.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/bulk_edit_rules.test.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/clone_rule.test.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/clone_rule.test.ts" - }, - { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/clone_rule.test.ts" + "plugin": "actions", + "path": "x-pack/plugins/actions/server/routes/get_oauth_access_token.test.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/clone_rule.test.ts" + "path": "x-pack/plugins/alerting/server/routes/bulk_edit_rules.test.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/create_rule.test.ts" + "path": "x-pack/plugins/alerting/server/routes/bulk_edit_rules.test.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/create_rule.test.ts" + "path": "x-pack/plugins/alerting/server/routes/bulk_edit_rules.test.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/create_rule.test.ts" + "path": "x-pack/plugins/alerting/server/routes/bulk_edit_rules.test.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/create_rule.test.ts" + "path": "x-pack/plugins/alerting/server/routes/clone_rule.test.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/create_rule.test.ts" + "path": "x-pack/plugins/alerting/server/routes/clone_rule.test.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/create_rule.test.ts" + "path": "x-pack/plugins/alerting/server/routes/clone_rule.test.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/routes/create_rule.test.ts" + "path": "x-pack/plugins/alerting/server/routes/clone_rule.test.ts" }, { "plugin": "alerting", @@ -8057,10 +7953,50 @@ "plugin": "alerting", "path": "x-pack/plugins/alerting/server/routes/maintenance_window/update_maintenance_window.test.ts" }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/routes/suggestions/fileds_rule.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/routes/suggestions/fileds_rule.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/routes/suggestions/values_suggestion_rules.test.ts" + }, { "plugin": "remoteClusters", "path": "x-pack/plugins/remote_clusters/server/routes/api/add_route.test.ts" }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/routes/rule/create/create_rule_route.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/routes/rule/create/create_rule_route.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/routes/rule/create/create_rule_route.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/routes/rule/create/create_rule_route.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/routes/rule/create/create_rule_route.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/routes/rule/create/create_rule_route.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/routes/rule/create/create_rule_route.test.ts" + }, { "plugin": "crossClusterReplication", "path": "x-pack/plugins/cross_cluster_replication/server/routes/api/auto_follow_pattern/register_create_route.test.ts" @@ -8209,6 +8145,10 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/server/routes/epm/index.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/epm/index.ts" + }, { "plugin": "fleet", "path": "x-pack/plugins/fleet/server/routes/setup/index.ts" @@ -8627,10 +8567,6 @@ "plugin": "actions", "path": "x-pack/plugins/actions/server/routes/legacy/update.ts" }, - { - "plugin": "bfetch", - "path": "src/plugins/bfetch/server/plugin.ts" - }, { "plugin": "alerting", "path": "x-pack/plugins/alerting/server/routes/legacy/update.ts" @@ -8867,6 +8803,14 @@ "plugin": "enterpriseSearch", "path": "x-pack/plugins/enterprise_search/server/routes/workplace_search/sources.ts" }, + { + "plugin": "ingestPipelines", + "path": "x-pack/plugins/ingest_pipelines/server/routes/api/update.ts" + }, + { + "plugin": "licenseManagement", + "path": "x-pack/plugins/license_management/server/routes/api/license/register_license_route.ts" + }, { "plugin": "lists", "path": "x-pack/plugins/lists/server/routes/update_endpoint_list_item_route.ts" @@ -8888,12 +8832,20 @@ "path": "x-pack/plugins/lists/server/routes/update_list_route.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/saved_query/update_saved_query_route.ts" + "plugin": "logstash", + "path": "x-pack/plugins/logstash/server/routes/pipeline/save.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/pack/update_pack_route.ts" + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/server/plugin.ts" + }, + { + "plugin": "reporting", + "path": "x-pack/plugins/reporting/server/test_helpers/create_mock_reportingplugin.ts" + }, + { + "plugin": "rollup", + "path": "x-pack/plugins/rollup/server/routes/api/jobs/register_create_route.ts" }, { "plugin": "securitySolution", @@ -8919,30 +8871,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/tags/routes/create_tag.ts" }, - { - "plugin": "ingestPipelines", - "path": "x-pack/plugins/ingest_pipelines/server/routes/api/update.ts" - }, - { - "plugin": "licenseManagement", - "path": "x-pack/plugins/license_management/server/routes/api/license/register_license_route.ts" - }, - { - "plugin": "logstash", - "path": "x-pack/plugins/logstash/server/routes/pipeline/save.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/server/plugin.ts" - }, - { - "plugin": "reporting", - "path": "x-pack/plugins/reporting/server/test_helpers/create_mock_reportingplugin.ts" - }, - { - "plugin": "rollup", - "path": "x-pack/plugins/rollup/server/routes/api/jobs/register_create_route.ts" - }, { "plugin": "snapshotRestore", "path": "x-pack/plugins/snapshot_restore/server/routes/api/repositories.ts" @@ -9743,6 +9671,14 @@ "plugin": "@kbn/core-ui-settings-server-internal", "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/delete.ts" }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/delete.ts" + }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/delete.ts" + }, { "plugin": "home", "path": "src/plugins/home/server/services/sample_data/routes/uninstall.ts" @@ -9771,10 +9707,6 @@ "plugin": "actions", "path": "x-pack/plugins/actions/server/routes/legacy/delete.ts" }, - { - "plugin": "bfetch", - "path": "src/plugins/bfetch/server/plugin.ts" - }, { "plugin": "share", "path": "src/plugins/share/server/url_service/http/short_urls/register_delete_route.ts" @@ -9951,6 +9883,14 @@ "plugin": "enterpriseSearch", "path": "x-pack/plugins/enterprise_search/server/routes/workplace_search/sources.ts" }, + { + "plugin": "indexLifecycleManagement", + "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/policies/register_delete_route.ts" + }, + { + "plugin": "ingestPipelines", + "path": "x-pack/plugins/ingest_pipelines/server/routes/api/delete.ts" + }, { "plugin": "lists", "path": "x-pack/plugins/lists/server/routes/delete_endpoint_list_item_route.ts" @@ -9976,12 +9916,12 @@ "path": "x-pack/plugins/lists/server/routes/delete_list_route.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/saved_query/delete_saved_query_route.ts" + "plugin": "logstash", + "path": "x-pack/plugins/logstash/server/routes/pipeline/delete.ts" }, { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/routes/pack/delete_pack_route.ts" + "plugin": "reporting", + "path": "x-pack/plugins/reporting/server/test_helpers/create_mock_reportingplugin.ts" }, { "plugin": "securitySolution", @@ -10011,22 +9951,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/risk_score/stored_scripts/delete_script_route.ts" }, - { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/routes/api/policies/register_delete_route.ts" - }, - { - "plugin": "ingestPipelines", - "path": "x-pack/plugins/ingest_pipelines/server/routes/api/delete.ts" - }, - { - "plugin": "logstash", - "path": "x-pack/plugins/logstash/server/routes/pipeline/delete.ts" - }, - { - "plugin": "reporting", - "path": "x-pack/plugins/reporting/server/test_helpers/create_mock_reportingplugin.ts" - }, { "plugin": "snapshotRestore", "path": "x-pack/plugins/snapshot_restore/server/routes/api/repositories.ts" @@ -11157,7 +11081,7 @@ "\nReadonly copy of incoming request headers." ], "signature": [ - "{ date?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; from?: string | string[] | undefined; etag?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; range?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ date?: string | string[] | undefined; warning?: string | string[] | undefined; range?: string | string[] | undefined; from?: string | string[] | undefined; location?: string | string[] | undefined; etag?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false, @@ -12717,7 +12641,7 @@ "tags": [], "label": "access", "description": [ - "\nDefines intended request origin of the route:\n- public. The route is public, declared stable and intended for external access.\n In the future, may require an incomming request to contain a specified header.\n- internal. The route is internal and intended for internal access only.\n\nIf not declared, infers access from route path:\n- access =`internal` for '/internal' route path prefix\n- access = `public` for everything else" + "\nDefines intended request origin of the route:\n- public. The route is public, declared stable and intended for external access.\n In the future, may require an incomming request to contain a specified header.\n- internal. The route is internal and intended for internal access only.\n\nDefaults to 'internal' If not declared," ], "signature": [ "\"internal\" | \"public\" | undefined" @@ -13818,6 +13742,10 @@ "plugin": "@kbn/core-http-router-server-mocks", "path": "packages/core/http/core-http-router-server-mocks/src/versioned_router.mock.ts" }, + { + "plugin": "bfetch", + "path": "src/plugins/bfetch/server/plugin.ts" + }, { "plugin": "dataViews", "path": "src/plugins/data_views/server/rest_api_routes/public/runtime_fields/get_runtime_field.ts" @@ -14047,88 +13975,204 @@ "path": "x-pack/plugins/ml/server/routes/model_management.ts" }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/routes/system.ts" + "plugin": "ml", + "path": "x-pack/plugins/ml/server/routes/system.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/server/routes/system.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/server/routes/system.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/server/routes/trained_models.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/server/routes/trained_models.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/server/routes/trained_models.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/server/routes/trained_models.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/server/routes/management.ts" + }, + { + "plugin": "logsShared", + "path": "x-pack/plugins/logs_shared/server/lib/adapters/framework/kibana_framework_adapter.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/custom_elements/find.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/custom_elements/get.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/shareables/download.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/workpad/find.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/workpad/get.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/workpad/resolve.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/templates/list.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/functions/functions.ts" + }, + { + "plugin": "cloudDefend", + "path": "x-pack/plugins/cloud_defend/server/routes/policies/policies.ts" + }, + { + "plugin": "cloudDefend", + "path": "x-pack/plugins/cloud_defend/server/routes/status/status.ts" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/server/routes/compliance_dashboard/compliance_dashboard.ts" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/server/routes/benchmarks/benchmarks.ts" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/server/routes/status/status.ts" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/server/routes/csp_rule_template/get_csp_rule_template.ts" + }, + { + "plugin": "fileUpload", + "path": "x-pack/plugins/file_upload/server/routes.ts" + }, + { + "plugin": "kubernetesSecurity", + "path": "x-pack/plugins/kubernetes_security/server/routes/aggregate.ts" + }, + { + "plugin": "kubernetesSecurity", + "path": "x-pack/plugins/kubernetes_security/server/routes/count.ts" + }, + { + "plugin": "kubernetesSecurity", + "path": "x-pack/plugins/kubernetes_security/server/routes/multi_terms_aggregate.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/server/mvt/mvt_routes.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/server/mvt/mvt_routes.ts" }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/routes/system.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/server/data_indexing/indexing_routes.ts" }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/routes/system.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/server/data_indexing/indexing_routes.ts" }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/routes/trained_models.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/server/routes.ts" }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/routes/trained_models.ts" + "plugin": "maps", + "path": "x-pack/plugins/maps/server/routes.ts" }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/routes/trained_models.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/live_query/get_live_query_details_route.ts" }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/routes/trained_models.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/live_query/get_live_query_results_route.ts" }, { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/routes/management.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/live_query/find_live_query_route.ts" }, { - "plugin": "infra", - "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/saved_query/find_saved_query_route.ts" }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/server/routes/custom_elements/find.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/saved_query/read_saved_query_route.ts" }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/server/routes/custom_elements/get.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/status/create_status_route.ts" }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/server/routes/shareables/download.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/fleet_wrapper/get_agent_policies.ts" }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/server/routes/workpad/find.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/fleet_wrapper/get_agent_policy.ts" }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/server/routes/workpad/get.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/fleet_wrapper/get_agent_status_for_agent_policy.ts" }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/server/routes/workpad/resolve.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/fleet_wrapper/get_package_policies.ts" }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/server/routes/templates/list.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/fleet_wrapper/get_agents.ts" }, { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/server/routes/functions/functions.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/fleet_wrapper/get_agent_details.ts" }, { - "plugin": "cloudDefend", - "path": "x-pack/plugins/cloud_defend/server/routes/policies/policies.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/pack/find_pack_route.ts" }, { - "plugin": "cloudDefend", - "path": "x-pack/plugins/cloud_defend/server/routes/status/status.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/pack/read_pack_route.ts" }, { - "plugin": "cloudSecurityPosture", - "path": "x-pack/plugins/cloud_security_posture/server/routes/compliance_dashboard/compliance_dashboard.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/privileges_check/privileges_check_route.ts" }, { - "plugin": "cloudSecurityPosture", - "path": "x-pack/plugins/cloud_security_posture/server/routes/csp_rule_template/get_csp_rule_template.ts" + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/asset/get_assets_status_route.ts" }, { "plugin": "securitySolution", @@ -14154,6 +14198,10 @@ "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/details.ts" @@ -14174,46 +14222,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/endpoint/routes/actions/list.ts" }, - { - "plugin": "fileUpload", - "path": "x-pack/plugins/file_upload/server/routes.ts" - }, - { - "plugin": "kubernetesSecurity", - "path": "x-pack/plugins/kubernetes_security/server/routes/aggregate.ts" - }, - { - "plugin": "kubernetesSecurity", - "path": "x-pack/plugins/kubernetes_security/server/routes/count.ts" - }, - { - "plugin": "kubernetesSecurity", - "path": "x-pack/plugins/kubernetes_security/server/routes/multi_terms_aggregate.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/mvt/mvt_routes.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/mvt/mvt_routes.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/indexing_routes.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/indexing_routes.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/routes.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/routes.ts" - }, { "plugin": "sessionView", "path": "x-pack/plugins/session_view/server/routes/alerts_route.ts" @@ -14362,6 +14370,18 @@ "plugin": "cloudDefend", "path": "x-pack/plugins/cloud_defend/server/routes/status/status.test.ts" }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/server/routes/benchmarks/benchmarks.test.ts" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/server/routes/benchmarks/benchmarks.test.ts" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/server/routes/benchmarks/benchmarks.test.ts" + }, { "plugin": "cloudSecurityPosture", "path": "x-pack/plugins/cloud_security_posture/server/routes/compliance_dashboard/compliance_dashboard.test.ts" @@ -14405,7 +14425,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"access\"> | undefined; access: \"internal\" | \"public\"; }" + ", \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; }" ], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, @@ -14450,6 +14470,10 @@ "plugin": "@kbn/core-http-router-server-mocks", "path": "packages/core/http/core-http-router-server-mocks/src/versioned_router.mock.ts" }, + { + "plugin": "bfetch", + "path": "src/plugins/bfetch/server/plugin.ts" + }, { "plugin": "dataViews", "path": "src/plugins/data_views/server/rest_api_routes/public/runtime_fields/put_runtime_field.ts" @@ -14510,6 +14534,10 @@ "plugin": "ml", "path": "x-pack/plugins/ml/server/routes/trained_models.ts" }, + { + "plugin": "logsShared", + "path": "x-pack/plugins/logs_shared/server/lib/adapters/framework/kibana_framework_adapter.ts" + }, { "plugin": "infra", "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" @@ -14530,6 +14558,14 @@ "plugin": "canvas", "path": "x-pack/plugins/canvas/server/routes/workpad/update.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/update_pack_route.ts" + }, { "plugin": "transform", "path": "x-pack/plugins/transform/server/routes/api/transforms.ts" @@ -14577,7 +14613,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"access\"> | undefined; access: \"internal\" | \"public\"; }" + ", \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; }" ], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, @@ -14622,6 +14658,10 @@ "plugin": "@kbn/core-http-router-server-mocks", "path": "packages/core/http/core-http-router-server-mocks/src/versioned_router.mock.ts" }, + { + "plugin": "bfetch", + "path": "src/plugins/bfetch/server/plugin.ts" + }, { "plugin": "dataViews", "path": "src/plugins/data_views/server/rest_api_routes/public/fields/update_fields.ts" @@ -14654,6 +14694,10 @@ "plugin": "dataViews", "path": "src/plugins/data_views/server/rest_api_routes/public/update_data_view.ts" }, + { + "plugin": "dataViews", + "path": "src/plugins/data_views/server/rest_api_routes/public/swap_references.ts" + }, { "plugin": "dataViews", "path": "src/plugins/data_views/server/rest_api_routes/internal/fields_for.ts" @@ -14694,6 +14738,10 @@ "plugin": "aiops", "path": "x-pack/plugins/aiops/server/routes/explain_log_rate_spikes.ts" }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/value_suggestions_route.ts" + }, { "plugin": "ml", "path": "x-pack/plugins/ml/server/routes/annotations.ts" @@ -14790,14 +14838,6 @@ "plugin": "ml", "path": "x-pack/plugins/ml/server/routes/anomaly_detectors.ts" }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/routes/anomaly_detectors.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/server/routes/anomaly_detectors.ts" - }, { "plugin": "ml", "path": "x-pack/plugins/ml/server/routes/job_service.ts" @@ -14990,6 +15030,10 @@ "plugin": "ml", "path": "x-pack/plugins/ml/server/routes/alerting.ts" }, + { + "plugin": "logsShared", + "path": "x-pack/plugins/logs_shared/server/lib/adapters/framework/kibana_framework_adapter.ts" + }, { "plugin": "infra", "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" @@ -15011,8 +15055,44 @@ "path": "x-pack/plugins/canvas/server/routes/workpad/import.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/value_suggestions_route.ts" + "plugin": "fileUpload", + "path": "x-pack/plugins/file_upload/server/routes.ts" + }, + { + "plugin": "fileUpload", + "path": "x-pack/plugins/file_upload/server/routes.ts" + }, + { + "plugin": "fileUpload", + "path": "x-pack/plugins/file_upload/server/routes.ts" + }, + { + "plugin": "fileUpload", + "path": "x-pack/plugins/file_upload/server/routes.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/server/data_indexing/indexing_routes.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/server/data_indexing/indexing_routes.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/pack/create_pack_route.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/asset/update_assets_route.ts" }, { "plugin": "securitySolution", @@ -15058,30 +15138,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/endpoint/routes/suggestions/index.ts" }, - { - "plugin": "fileUpload", - "path": "x-pack/plugins/file_upload/server/routes.ts" - }, - { - "plugin": "fileUpload", - "path": "x-pack/plugins/file_upload/server/routes.ts" - }, - { - "plugin": "fileUpload", - "path": "x-pack/plugins/file_upload/server/routes.ts" - }, - { - "plugin": "fileUpload", - "path": "x-pack/plugins/file_upload/server/routes.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/indexing_routes.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/data_indexing/indexing_routes.ts" - }, { "plugin": "transform", "path": "x-pack/plugins/transform/server/routes/api/field_histograms.ts" @@ -15185,7 +15241,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"access\"> | undefined; access: \"internal\" | \"public\"; }" + ", \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; }" ], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, @@ -15230,6 +15286,10 @@ "plugin": "@kbn/core-http-router-server-mocks", "path": "packages/core/http/core-http-router-server-mocks/src/versioned_router.mock.ts" }, + { + "plugin": "logsShared", + "path": "x-pack/plugins/logs_shared/server/lib/adapters/framework/kibana_framework_adapter.ts" + }, { "plugin": "infra", "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" @@ -15265,7 +15325,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"access\"> | undefined; access: \"internal\" | \"public\"; }" + ", \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; }" ], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, @@ -15310,6 +15370,10 @@ "plugin": "@kbn/core-http-router-server-mocks", "path": "packages/core/http/core-http-router-server-mocks/src/versioned_router.mock.ts" }, + { + "plugin": "bfetch", + "path": "src/plugins/bfetch/server/plugin.ts" + }, { "plugin": "dataViews", "path": "src/plugins/data_views/server/rest_api_routes/public/runtime_fields/delete_runtime_field.ts" @@ -15366,6 +15430,10 @@ "plugin": "ml", "path": "x-pack/plugins/ml/server/routes/trained_models.ts" }, + { + "plugin": "logsShared", + "path": "x-pack/plugins/logs_shared/server/lib/adapters/framework/kibana_framework_adapter.ts" + }, { "plugin": "infra", "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts" @@ -15382,6 +15450,14 @@ "plugin": "maps", "path": "x-pack/plugins/maps/server/data_indexing/indexing_routes.ts" }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/saved_query/delete_saved_query_route.ts" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/routes/pack/delete_pack_route.ts" + }, { "plugin": "@kbn/core-http-router-server-internal", "path": "packages/core/http/core-http-router-server-internal/src/versioned_router/core_versioned_router.ts" @@ -15425,7 +15501,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"access\"> | undefined; access: \"internal\" | \"public\"; }" + ", \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; }" ], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, @@ -16007,7 +16083,7 @@ "\nHttp request headers to read." ], "signature": [ - "{ date?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; from?: string | string[] | undefined; etag?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; range?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ date?: string | string[] | undefined; warning?: string | string[] | undefined; range?: string | string[] | undefined; from?: string | string[] | undefined; location?: string | string[] | undefined; etag?: string | string[] | undefined; accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "packages/core/http/core-http-server/src/router/headers.ts", "deprecated": false, @@ -16313,7 +16389,7 @@ "\nSet of well-known HTTP headers." ], "signature": [ - "\"date\" | \"warning\" | \"location\" | \"from\" | \"etag\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" + "\"date\" | \"warning\" | \"range\" | \"from\" | \"location\" | \"etag\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" ], "path": "packages/core/http/core-http-server/src/router/headers.ts", "deprecated": false, @@ -17419,7 +17495,7 @@ "\nHttp response headers to set." ], "signature": [ - "Record | Record<\"date\" | \"warning\" | \"location\" | \"from\" | \"etag\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]>" + "Record | Record<\"date\" | \"warning\" | \"range\" | \"from\" | \"location\" | \"etag\" | \"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"expires\" | \"forwarded\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]>" ], "path": "packages/core/http/core-http-server/src/router/headers.ts", "deprecated": false, @@ -17909,7 +17985,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"access\"> | undefined; access: \"internal\" | \"public\"; }" + ", \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | undefined; }" ], "path": "packages/core/http/core-http-server/src/versioning/types.ts", "deprecated": false, @@ -17979,7 +18055,7 @@ "section": "def-common.RouteConfigOptions", "text": "RouteConfigOptions" }, - ", \"access\"> | undefined; access: \"internal\" | \"public\"; }" + ", \"access\"> | undefined; access: \"internal\" | \"public\"; enableQueryVersion?: boolean | 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 c8ce637609a8d..1b979e3c5b3f2 100644 --- a/api_docs/kbn_core_http_server.mdx +++ b/api_docs/kbn_core_http_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server title: "@kbn/core-http-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-server plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server'] --- import kbnCoreHttpServerObj from './kbn_core_http_server.devdocs.json'; diff --git a/api_docs/kbn_core_http_server_internal.devdocs.json b/api_docs/kbn_core_http_server_internal.devdocs.json index 7978ebec5add0..80c7e6211eac8 100644 --- a/api_docs/kbn_core_http_server_internal.devdocs.json +++ b/api_docs/kbn_core_http_server_internal.devdocs.json @@ -519,7 +519,9 @@ "label": "versioned", "description": [], "signature": [ - "{ versionResolution: \"newest\" | \"oldest\"; strictClientVersionCheck: boolean; }" + "{ versionResolution: ", + "HandlerResolutionStrategy", + "; strictClientVersionCheck: boolean; }" ], "path": "packages/core/http/core-http-server-internal/src/http_config.ts", "deprecated": false, @@ -907,7 +909,7 @@ "label": "HttpConfigType", "description": [], "signature": [ - "{ readonly uuid?: string | undefined; readonly basePath?: string | undefined; readonly publicBaseUrl?: string | undefined; readonly name: string; readonly ssl: Readonly<{ key?: string | undefined; certificateAuthorities?: string | string[] | undefined; certificate?: string | undefined; keyPassphrase?: string | undefined; redirectHttpFromPort?: number | undefined; } & { enabled: boolean; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; cipherSuites: string[]; supportedProtocols: string[]; clientAuthentication: \"none\" | \"optional\" | \"required\"; }>; readonly host: string; readonly compression: Readonly<{ referrerWhitelist?: string[] | undefined; } & { enabled: boolean; brotli: Readonly<{} & { enabled: boolean; quality: number; }>; }>; readonly port: number; readonly cors: Readonly<{} & { enabled: boolean; allowCredentials: boolean; allowOrigin: string[] | \"*\"[]; }>; readonly versioned: Readonly<{} & { versionResolution: \"newest\" | \"oldest\"; strictClientVersionCheck: boolean; }>; readonly autoListen: boolean; readonly shutdownTimeout: moment.Duration; readonly securityResponseHeaders: Readonly<{} & { referrerPolicy: \"origin\" | \"no-referrer\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"same-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | \"unsafe-url\" | null; strictTransportSecurity: string | null; xContentTypeOptions: \"nosniff\" | null; permissionsPolicy: string | null; disableEmbedding: boolean; crossOriginOpenerPolicy: \"same-origin\" | \"unsafe-none\" | \"same-origin-allow-popups\" | null; }>; readonly customResponseHeaders: Record; readonly maxPayload: ", + "{ readonly uuid?: string | undefined; readonly basePath?: string | undefined; readonly publicBaseUrl?: string | undefined; readonly name: string; readonly ssl: Readonly<{ key?: string | undefined; certificateAuthorities?: string | string[] | undefined; certificate?: string | undefined; keyPassphrase?: string | undefined; redirectHttpFromPort?: number | undefined; } & { enabled: boolean; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; cipherSuites: string[]; supportedProtocols: string[]; clientAuthentication: \"none\" | \"optional\" | \"required\"; }>; readonly host: string; readonly compression: Readonly<{ referrerWhitelist?: string[] | undefined; } & { enabled: boolean; brotli: Readonly<{} & { enabled: boolean; quality: number; }>; }>; readonly port: number; readonly cors: Readonly<{} & { enabled: boolean; allowCredentials: boolean; allowOrigin: string[] | \"*\"[]; }>; readonly versioned: Readonly<{} & { versionResolution: \"none\" | \"newest\" | \"oldest\"; strictClientVersionCheck: boolean; }>; readonly autoListen: boolean; readonly shutdownTimeout: moment.Duration; readonly securityResponseHeaders: Readonly<{} & { referrerPolicy: \"origin\" | \"no-referrer\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"same-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | \"unsafe-url\" | null; strictTransportSecurity: string | null; xContentTypeOptions: \"nosniff\" | null; permissionsPolicy: string | null; disableEmbedding: boolean; crossOriginOpenerPolicy: \"same-origin\" | \"unsafe-none\" | \"same-origin-allow-popups\" | null; }>; readonly customResponseHeaders: Record; readonly maxPayload: ", { "pluginId": "@kbn/config-schema", "scope": "common", diff --git a/api_docs/kbn_core_http_server_internal.mdx b/api_docs/kbn_core_http_server_internal.mdx index 37152419ec61d..041638721baa8 100644 --- a/api_docs/kbn_core_http_server_internal.mdx +++ b/api_docs/kbn_core_http_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server-internal title: "@kbn/core-http-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_http_server_mocks.devdocs.json index 3c0c4edef0ffa..f62b950435af3 100644 --- a/api_docs/kbn_core_http_server_mocks.devdocs.json +++ b/api_docs/kbn_core_http_server_mocks.devdocs.json @@ -27,7 +27,7 @@ "label": "createConfigService", "description": [], "signature": [ - "({ server, externalUrl, csp, }?: Partial<{ server: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; cipherSuites: string[]; supportedProtocols: string[]; clientAuthentication: \"none\" | \"optional\" | \"required\"; }>; host: string; compression: Readonly<{ referrerWhitelist?: string[] | undefined; } & { enabled: boolean; brotli: Readonly<{} & { enabled: boolean; quality: number; }>; }>; port: number; cors: Readonly<{} & { enabled: boolean; allowCredentials: boolean; allowOrigin: string[] | \"*\"[]; }>; versioned: Readonly<{} & { versionResolution: \"newest\" | \"oldest\"; strictClientVersionCheck: boolean; }>; autoListen: boolean; shutdownTimeout: moment.Duration; securityResponseHeaders: Readonly<{} & { referrerPolicy: \"origin\" | \"no-referrer\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"same-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | \"unsafe-url\" | null; strictTransportSecurity: string | null; xContentTypeOptions: \"nosniff\" | null; permissionsPolicy: string | null; disableEmbedding: boolean; crossOriginOpenerPolicy: \"same-origin\" | \"unsafe-none\" | \"same-origin-allow-popups\" | null; }>; customResponseHeaders: Record; maxPayload: ", + "({ server, externalUrl, csp, }?: Partial<{ server: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; cipherSuites: string[]; supportedProtocols: string[]; clientAuthentication: \"none\" | \"optional\" | \"required\"; }>; host: string; compression: Readonly<{ referrerWhitelist?: string[] | undefined; } & { enabled: boolean; brotli: Readonly<{} & { enabled: boolean; quality: number; }>; }>; port: number; cors: Readonly<{} & { enabled: boolean; allowCredentials: boolean; allowOrigin: string[] | \"*\"[]; }>; versioned: Readonly<{} & { versionResolution: \"none\" | \"newest\" | \"oldest\"; strictClientVersionCheck: boolean; }>; autoListen: boolean; shutdownTimeout: moment.Duration; securityResponseHeaders: Readonly<{} & { referrerPolicy: \"origin\" | \"no-referrer\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"same-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | \"unsafe-url\" | null; strictTransportSecurity: string | null; xContentTypeOptions: \"nosniff\" | null; permissionsPolicy: string | null; disableEmbedding: boolean; crossOriginOpenerPolicy: \"same-origin\" | \"unsafe-none\" | \"same-origin-allow-popups\" | null; }>; customResponseHeaders: Record; maxPayload: ", { "pluginId": "@kbn/config-schema", "scope": "common", @@ -64,7 +64,7 @@ "label": "{\n server,\n externalUrl,\n csp,\n}", "description": [], "signature": [ - "Partial<{ server: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; cipherSuites: string[]; supportedProtocols: string[]; clientAuthentication: \"none\" | \"optional\" | \"required\"; }>; host: string; compression: Readonly<{ referrerWhitelist?: string[] | undefined; } & { enabled: boolean; brotli: Readonly<{} & { enabled: boolean; quality: number; }>; }>; port: number; cors: Readonly<{} & { enabled: boolean; allowCredentials: boolean; allowOrigin: string[] | \"*\"[]; }>; versioned: Readonly<{} & { versionResolution: \"newest\" | \"oldest\"; strictClientVersionCheck: boolean; }>; autoListen: boolean; shutdownTimeout: moment.Duration; securityResponseHeaders: Readonly<{} & { referrerPolicy: \"origin\" | \"no-referrer\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"same-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | \"unsafe-url\" | null; strictTransportSecurity: string | null; xContentTypeOptions: \"nosniff\" | null; permissionsPolicy: string | null; disableEmbedding: boolean; crossOriginOpenerPolicy: \"same-origin\" | \"unsafe-none\" | \"same-origin-allow-popups\" | null; }>; customResponseHeaders: Record; maxPayload: ", + "Partial<{ server: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; cipherSuites: string[]; supportedProtocols: string[]; clientAuthentication: \"none\" | \"optional\" | \"required\"; }>; host: string; compression: Readonly<{ referrerWhitelist?: string[] | undefined; } & { enabled: boolean; brotli: Readonly<{} & { enabled: boolean; quality: number; }>; }>; port: number; cors: Readonly<{} & { enabled: boolean; allowCredentials: boolean; allowOrigin: string[] | \"*\"[]; }>; versioned: Readonly<{} & { versionResolution: \"none\" | \"newest\" | \"oldest\"; strictClientVersionCheck: boolean; }>; autoListen: boolean; shutdownTimeout: moment.Duration; securityResponseHeaders: Readonly<{} & { referrerPolicy: \"origin\" | \"no-referrer\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"same-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | \"unsafe-url\" | null; strictTransportSecurity: string | null; xContentTypeOptions: \"nosniff\" | null; permissionsPolicy: string | null; disableEmbedding: boolean; crossOriginOpenerPolicy: \"same-origin\" | \"unsafe-none\" | \"same-origin-allow-popups\" | null; }>; customResponseHeaders: Record; maxPayload: ", { "pluginId": "@kbn/config-schema", "scope": "common", @@ -197,7 +197,7 @@ "section": "def-common.RequestHandlerContextBase", "text": "RequestHandlerContextBase" }, - ">) => void]>; basePath: ", + ">) => void], unknown>; basePath: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -213,7 +213,7 @@ "section": "def-common.HttpServerInfo", "text": "HttpServerInfo" }, - ", []>; } & ", + ", [], unknown>; } & ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -268,7 +268,7 @@ "section": "def-common.IContextProvider", "text": "IContextProvider" }, - ">]>; getServerInfo: jest.MockInstance<", + ">], unknown>; getServerInfo: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -276,7 +276,7 @@ "section": "def-common.HttpServerInfo", "text": "HttpServerInfo" }, - ", []>; createCookieSessionStorageFactory: jest.MockInstance; createCookieSessionStorageFactory: jest.MockInstance]>; registerOnPreRouting: jest.MockInstance], unknown>; registerOnPreRouting: jest.MockInstance; registerOnPreAuth: jest.MockInstance; registerOnPreAuth: jest.MockInstance; registerAuth: jest.MockInstance; registerAuth: jest.MockInstance; registerOnPostAuth: jest.MockInstance; registerOnPostAuth: jest.MockInstance; registerOnPreResponse: jest.MockInstance; registerOnPreResponse: jest.MockInstance; } & Omit<", + "], unknown>; } & Omit<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -387,7 +387,7 @@ "section": "def-common.HttpServerInfo", "text": "HttpServerInfo" }, - ", []>; } & ", + ", [], unknown>; } & ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -436,7 +436,15 @@ }, "; server: ", "Server", - "; registerStaticDir: jest.MockInstance; registerRouteHandlerContext: jest.MockInstance; registerRouteHandlerContext: >(pluginOpaqueId: symbol, contextName: ContextName, provider: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -444,15 +452,15 @@ "section": "def-common.IContextProvider", "text": "IContextProvider" }, - "<", + ") => ", { "pluginId": "@kbn/core-http-server", "scope": "common", "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.RequestHandlerContextBase", - "text": "RequestHandlerContextBase" + "section": "def-common.IContextContainer", + "text": "IContextContainer" }, - ", never>]>; getServerInfo: jest.MockInstance<", + "; getServerInfo: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -460,7 +468,7 @@ "section": "def-common.HttpServerInfo", "text": "HttpServerInfo" }, - ", []>; registerRoutes: jest.MockInstance; registerRoutes: jest.MockInstance) => void]>; } & Omit<", + ">) => void], unknown>; } & Omit<", "InternalHttpServicePreboot", ", \"basePath\"> & { basePath: BasePathMocked; }" ], @@ -511,7 +519,15 @@ }, "; server: ", "Server", - "; registerStaticDir: jest.MockInstance; registerRouteHandlerContext: jest.MockInstance; registerRouteHandlerContext: >(pluginOpaqueId: symbol, contextName: ContextName, provider: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -519,15 +535,15 @@ "section": "def-common.IContextProvider", "text": "IContextProvider" }, - "<", + ") => ", { "pluginId": "@kbn/core-http-server", "scope": "common", "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.RequestHandlerContextBase", - "text": "RequestHandlerContextBase" + "section": "def-common.IContextContainer", + "text": "IContextContainer" }, - ", never>]>; getServerInfo: jest.MockInstance<", + "; getServerInfo: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -535,7 +551,7 @@ "section": "def-common.HttpServerInfo", "text": "HttpServerInfo" }, - ", []>; createCookieSessionStorageFactory: jest.MockInstance; createCookieSessionStorageFactory: jest.MockInstance]>; registerOnPreRouting: jest.MockInstance], unknown>; registerOnPreRouting: jest.MockInstance; registerOnPreAuth: jest.MockInstance; registerOnPreAuth: jest.MockInstance; registerAuth: jest.MockInstance; registerAuth: jest.MockInstance; registerOnPostAuth: jest.MockInstance; registerOnPostAuth: jest.MockInstance; registerOnPreResponse: jest.MockInstance; registerOnPreResponse: jest.MockInstance; registerRouterAfterListening: jest.MockInstance; registerRouterAfterListening: jest.MockInstance]>; } & Omit<", + ">], unknown>; } & Omit<", "InternalHttpServiceSetup", ", \"createRouter\" | \"basePath\" | \"auth\" | \"authRequestHeaders\"> & { auth: AuthMocked; basePath: BasePathMocked; createRouter: jest.MockedFunction<(path: string) => ", { @@ -640,7 +656,7 @@ "label": "InternalHttpServiceStartMock", "description": [], "signature": [ - "{ isListening: jest.MockInstance; basePath: ", + "{ isListening: jest.MockInstance; basePath: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -664,7 +680,7 @@ "section": "def-common.HttpServerInfo", "text": "HttpServerInfo" }, - ", []>; } & ", + ", [], unknown>; } & ", "InternalHttpServiceStart", " & { basePath: BasePathMocked; }" ], diff --git a/api_docs/kbn_core_http_server_mocks.mdx b/api_docs/kbn_core_http_server_mocks.mdx index 38b996d68e19e..f90accc6a4d8c 100644 --- a/api_docs/kbn_core_http_server_mocks.mdx +++ b/api_docs/kbn_core_http_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server-mocks title: "@kbn/core-http-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 384056aae6faa..565e92579e9ab 100644 --- a/api_docs/kbn_core_i18n_browser.mdx +++ b/api_docs/kbn_core_i18n_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser title: "@kbn/core-i18n-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 a146a9355e538..10e05b851ac05 100644 --- a/api_docs/kbn_core_i18n_browser_mocks.mdx +++ b/api_docs/kbn_core_i18n_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser-mocks title: "@kbn/core-i18n-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 48738f858e1db..4d72ddc9dfc1e 100644 --- a/api_docs/kbn_core_i18n_server.mdx +++ b/api_docs/kbn_core_i18n_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server title: "@kbn/core-i18n-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-server plugin -date: 2023-06-30 +date: 2023-07-18 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 31ce4c84da6bb..ae00498d2c66f 100644 --- a/api_docs/kbn_core_i18n_server_internal.mdx +++ b/api_docs/kbn_core_i18n_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server-internal title: "@kbn/core-i18n-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 3e0175adb9a29..642e521b35781 100644 --- a/api_docs/kbn_core_i18n_server_mocks.mdx +++ b/api_docs/kbn_core_i18n_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server-mocks title: "@kbn/core-i18n-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 c2e1506137554..b2b6ac1276961 100644 --- a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx +++ b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser-mocks title: "@kbn/core-injected-metadata-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-injected-metadata-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 08d4413e6f96a..0c5f836906698 100644 --- a/api_docs/kbn_core_integrations_browser_internal.mdx +++ b/api_docs/kbn_core_integrations_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-integrations-browser-internal title: "@kbn/core-integrations-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-integrations-browser-internal plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_integrations_browser_mocks.devdocs.json index a5bbc4f2e637b..0a1cd1cd04f08 100644 --- a/api_docs/kbn_core_integrations_browser_mocks.devdocs.json +++ b/api_docs/kbn_core_integrations_browser_mocks.devdocs.json @@ -61,7 +61,7 @@ "section": "def-common.IntegrationsServiceSetupDeps", "text": "IntegrationsServiceSetupDeps" }, - "]>; setup: jest.MockInstance, []>; stop: jest.MockInstance, []>; } & ", + "], unknown>; setup: jest.MockInstance, [], unknown>; stop: jest.MockInstance, [], unknown>; } & ", { "pluginId": "@kbn/core-integrations-browser-mocks", "scope": "common", diff --git a/api_docs/kbn_core_integrations_browser_mocks.mdx b/api_docs/kbn_core_integrations_browser_mocks.mdx index ca3a0ec2fc9fc..0b8ac1349d9ed 100644 --- a/api_docs/kbn_core_integrations_browser_mocks.mdx +++ b/api_docs/kbn_core_integrations_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-integrations-browser-mocks title: "@kbn/core-integrations-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-integrations-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-integrations-browser-mocks'] --- import kbnCoreIntegrationsBrowserMocksObj from './kbn_core_integrations_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_browser.devdocs.json b/api_docs/kbn_core_lifecycle_browser.devdocs.json index 947feb97012fe..6c0164d6acd02 100644 --- a/api_docs/kbn_core_lifecycle_browser.devdocs.json +++ b/api_docs/kbn_core_lifecycle_browser.devdocs.json @@ -561,18 +561,10 @@ "plugin": "@kbn/core-root-browser-internal", "path": "packages/core/root/core-root-browser-internal/src/core_system.ts" }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/plugin.ts" - }, { "plugin": "home", "path": "src/plugins/home/public/plugin.ts" }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/expressions/kibana_context.ts" - }, { "plugin": "savedObjects", "path": "src/plugins/saved_objects/public/plugin.ts" @@ -593,26 +585,6 @@ "plugin": "dashboard", "path": "src/plugins/dashboard/public/dashboard_actions/index.ts" }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/datasources/form_based/form_based.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/datasources/form_based/form_based.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/visualizations/xy/visualization.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/visualizations/xy/visualization.tsx" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/public/visualizations/xy/visualization.tsx" - }, { "plugin": "fileUpload", "path": "x-pack/plugins/file_upload/public/kibana_services.ts" diff --git a/api_docs/kbn_core_lifecycle_browser.mdx b/api_docs/kbn_core_lifecycle_browser.mdx index fbc58e07cc3c6..34102a2b4b88c 100644 --- a/api_docs/kbn_core_lifecycle_browser.mdx +++ b/api_docs/kbn_core_lifecycle_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-browser title: "@kbn/core-lifecycle-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-browser plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_lifecycle_browser_mocks.devdocs.json index b366bf385edb9..5818e585029e8 100644 --- a/api_docs/kbn_core_lifecycle_browser_mocks.devdocs.json +++ b/api_docs/kbn_core_lifecycle_browser_mocks.devdocs.json @@ -70,7 +70,7 @@ }, ">; hasCustomBranding$: ", "Observable", - "; }; docLinks: jest.Mock; executionContext: jest.Mocked<", + "; }; docLinks: jest.Mock; executionContext: jest.Mocked<", { "pluginId": "@kbn/core-execution-context-browser", "scope": "common", @@ -244,7 +244,7 @@ "section": "def-common.FatalErrorsSetup", "text": "FatalErrorsSetup" }, - ">; }, any, any]>, []>; http: ", + ">; }, any, any]>, [], any>; http: ", { "pluginId": "@kbn/core-http-browser-mocks", "scope": "common", diff --git a/api_docs/kbn_core_lifecycle_browser_mocks.mdx b/api_docs/kbn_core_lifecycle_browser_mocks.mdx index b1fa75a0c7840..5567d2de7814b 100644 --- a/api_docs/kbn_core_lifecycle_browser_mocks.mdx +++ b/api_docs/kbn_core_lifecycle_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-browser-mocks title: "@kbn/core-lifecycle-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 19837d2466be7..9ac808641c90c 100644 --- a/api_docs/kbn_core_lifecycle_server.mdx +++ b/api_docs/kbn_core_lifecycle_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-server title: "@kbn/core-lifecycle-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-server plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_lifecycle_server_mocks.devdocs.json index 5a0a8c83af587..3eb3da50099db 100644 --- a/api_docs/kbn_core_lifecycle_server_mocks.devdocs.json +++ b/api_docs/kbn_core_lifecycle_server_mocks.devdocs.json @@ -68,7 +68,7 @@ "section": "def-common.HttpResources", "text": "HttpResources" }, - ">, []>; }; uiSettings: jest.Mocked<", + ">, [], any>; }; uiSettings: jest.Mocked<", "InternalUiSettingsServicePreboot", ">; logging: jest.Mocked<", "InternalLoggingServicePreboot", @@ -152,7 +152,7 @@ "section": "def-common.HttpResources", "text": "HttpResources" }, - ">, []>; }; rendering: jest.Mocked<", + ">, [], any>; }; rendering: jest.Mocked<", "InternalRenderingServiceSetup", ">; uiSettings: jest.Mocked<", { @@ -184,7 +184,7 @@ "IExecutionContext", ">; coreUsageData: jest.Mocked<", "InternalCoreUsageDataSetup", - ">; customBranding: { register: jest.Mock; getBrandingFor: jest.Mock; }; userSettings: { setUserProfileSettings: jest.Mock; getUserSettingDarkMode: jest.Mock; }; }" + ">; customBranding: { register: jest.Mock; getBrandingFor: jest.Mock; }; userSettings: { setUserProfileSettings: jest.Mock; getUserSettingDarkMode: jest.Mock; }; }" ], "path": "packages/core/lifecycle/core-lifecycle-server-mocks/src/index.ts", "deprecated": false, diff --git a/api_docs/kbn_core_lifecycle_server_mocks.mdx b/api_docs/kbn_core_lifecycle_server_mocks.mdx index 27dba6e73fc29..1470d39bb8f66 100644 --- a/api_docs/kbn_core_lifecycle_server_mocks.mdx +++ b/api_docs/kbn_core_lifecycle_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-server-mocks title: "@kbn/core-lifecycle-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 92a43ea8687d5..af1eb990925a4 100644 --- a/api_docs/kbn_core_logging_browser_mocks.mdx +++ b/api_docs/kbn_core_logging_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-browser-mocks title: "@kbn/core-logging-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 263c754aa7684..49b2abaf3a4a4 100644 --- a/api_docs/kbn_core_logging_common_internal.mdx +++ b/api_docs/kbn_core_logging_common_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-common-internal title: "@kbn/core-logging-common-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-common-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 f5bb802aa6c40..ac3270216024e 100644 --- a/api_docs/kbn_core_logging_server.mdx +++ b/api_docs/kbn_core_logging_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server title: "@kbn/core-logging-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-server plugin -date: 2023-06-30 +date: 2023-07-18 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 2dba6b6673c5d..f202b36b2f6e5 100644 --- a/api_docs/kbn_core_logging_server_internal.mdx +++ b/api_docs/kbn_core_logging_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-internal title: "@kbn/core-logging-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 45ffe9cf4d651..9e79e07dde15a 100644 --- a/api_docs/kbn_core_logging_server_mocks.mdx +++ b/api_docs/kbn_core_logging_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-mocks title: "@kbn/core-logging-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 837c4e7df325f..dd381017f2dc6 100644 --- a/api_docs/kbn_core_metrics_collectors_server_internal.mdx +++ b/api_docs/kbn_core_metrics_collectors_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-collectors-server-internal title: "@kbn/core-metrics-collectors-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-collectors-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 d2840e4e3968b..20af81eeb69ab 100644 --- a/api_docs/kbn_core_metrics_collectors_server_mocks.mdx +++ b/api_docs/kbn_core_metrics_collectors_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-collectors-server-mocks title: "@kbn/core-metrics-collectors-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-collectors-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 8df5f813b9768..6ea0bbbc392b2 100644 --- a/api_docs/kbn_core_metrics_server.mdx +++ b/api_docs/kbn_core_metrics_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server title: "@kbn/core-metrics-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-server plugin -date: 2023-06-30 +date: 2023-07-18 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 af792e2945fc4..2ac3390eb76a2 100644 --- a/api_docs/kbn_core_metrics_server_internal.mdx +++ b/api_docs/kbn_core_metrics_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server-internal title: "@kbn/core-metrics-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 e41644eb284f5..66173b5ab1888 100644 --- a/api_docs/kbn_core_metrics_server_mocks.mdx +++ b/api_docs/kbn_core_metrics_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server-mocks title: "@kbn/core-metrics-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 084ba973a9e70..ed1add1daaf58 100644 --- a/api_docs/kbn_core_mount_utils_browser.mdx +++ b/api_docs/kbn_core_mount_utils_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-mount-utils-browser title: "@kbn/core-mount-utils-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-mount-utils-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 9d2c1bbc4f07c..68f50de9f1454 100644 --- a/api_docs/kbn_core_node_server.mdx +++ b/api_docs/kbn_core_node_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server title: "@kbn/core-node-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-node-server plugin -date: 2023-06-30 +date: 2023-07-18 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 5b265d7f20e05..5599d36241dab 100644 --- a/api_docs/kbn_core_node_server_internal.mdx +++ b/api_docs/kbn_core_node_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-internal title: "@kbn/core-node-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-node-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 a3a7f979c4a37..5e0e6e282eb86 100644 --- a/api_docs/kbn_core_node_server_mocks.mdx +++ b/api_docs/kbn_core_node_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-mocks title: "@kbn/core-node-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-node-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 d1a80ab0625fc..a173bebb190c7 100644 --- a/api_docs/kbn_core_notifications_browser.mdx +++ b/api_docs/kbn_core_notifications_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser title: "@kbn/core-notifications-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-notifications-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 dc00617d5b379..1c04b2e3fddba 100644 --- a/api_docs/kbn_core_notifications_browser_internal.mdx +++ b/api_docs/kbn_core_notifications_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser-internal title: "@kbn/core-notifications-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-notifications-browser-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 559a39395b091..c394f139e5e9e 100644 --- a/api_docs/kbn_core_notifications_browser_mocks.mdx +++ b/api_docs/kbn_core_notifications_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser-mocks title: "@kbn/core-notifications-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-notifications-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 6ad21beb9fbb2..7cc3ef83e5a47 100644 --- a/api_docs/kbn_core_overlays_browser.mdx +++ b/api_docs/kbn_core_overlays_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser title: "@kbn/core-overlays-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-overlays-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 6a923c38874b6..7a71ad8e1cf7e 100644 --- a/api_docs/kbn_core_overlays_browser_internal.mdx +++ b/api_docs/kbn_core_overlays_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser-internal title: "@kbn/core-overlays-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-overlays-browser-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 3d0bb2d7f0e3c..20caec205a34a 100644 --- a/api_docs/kbn_core_overlays_browser_mocks.mdx +++ b/api_docs/kbn_core_overlays_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser-mocks title: "@kbn/core-overlays-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-overlays-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 011a4a7ec2fd5..c3d9c7f07f523 100644 --- a/api_docs/kbn_core_plugins_browser.mdx +++ b/api_docs/kbn_core_plugins_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-browser title: "@kbn/core-plugins-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 4b57b1c67b92a..ec62a319db3d5 100644 --- a/api_docs/kbn_core_plugins_browser_mocks.mdx +++ b/api_docs/kbn_core_plugins_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-browser-mocks title: "@kbn/core-plugins-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-browser-mocks'] --- import kbnCorePluginsBrowserMocksObj from './kbn_core_plugins_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_server.mdx b/api_docs/kbn_core_plugins_server.mdx index dcc5f9bce15e8..750479149fed7 100644 --- a/api_docs/kbn_core_plugins_server.mdx +++ b/api_docs/kbn_core_plugins_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-server title: "@kbn/core-plugins-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-server plugin -date: 2023-06-30 +date: 2023-07-18 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 81327250270c9..7d49520aa896d 100644 --- a/api_docs/kbn_core_plugins_server_mocks.mdx +++ b/api_docs/kbn_core_plugins_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-server-mocks title: "@kbn/core-plugins-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 b5088454b1d8a..50717f04ad56b 100644 --- a/api_docs/kbn_core_preboot_server.mdx +++ b/api_docs/kbn_core_preboot_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-preboot-server title: "@kbn/core-preboot-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-preboot-server plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_preboot_server_mocks.devdocs.json index 0d76046807017..c762b352747d3 100644 --- a/api_docs/kbn_core_preboot_server_mocks.devdocs.json +++ b/api_docs/kbn_core_preboot_server_mocks.devdocs.json @@ -30,7 +30,7 @@ "label": "InternalPrebootServicePrebootMock", "description": [], "signature": [ - "{ readonly isSetupOnHold: jest.MockInstance; readonly holdSetupUntilResolved: jest.MockInstance]>; readonly waitUntilCanSetup: jest.MockInstance, []>; } & ", + "{ readonly isSetupOnHold: jest.MockInstance; readonly holdSetupUntilResolved: jest.MockInstance], unknown>; readonly waitUntilCanSetup: jest.MockInstance, [], unknown>; } & ", "InternalPrebootServicePreboot" ], "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", @@ -46,7 +46,7 @@ "label": "PrebootServicePrebootMock", "description": [], "signature": [ - "{ readonly isSetupOnHold: jest.MockInstance; readonly holdSetupUntilResolved: jest.MockInstance]>; } & ", + "{ readonly isSetupOnHold: jest.MockInstance; readonly holdSetupUntilResolved: jest.MockInstance], unknown>; } & ", { "pluginId": "@kbn/core-preboot-server", "scope": "common", diff --git a/api_docs/kbn_core_preboot_server_mocks.mdx b/api_docs/kbn_core_preboot_server_mocks.mdx index 22ee50388f0b0..533569ce1c36a 100644 --- a/api_docs/kbn_core_preboot_server_mocks.mdx +++ b/api_docs/kbn_core_preboot_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-preboot-server-mocks title: "@kbn/core-preboot-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-preboot-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 4ae90668e74e6..2bc14e07b216c 100644 --- a/api_docs/kbn_core_rendering_browser_mocks.mdx +++ b/api_docs/kbn_core_rendering_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-browser-mocks title: "@kbn/core-rendering-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-rendering-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 9a54cf7cf3920..e4e16364bd9d7 100644 --- a/api_docs/kbn_core_rendering_server_internal.mdx +++ b/api_docs/kbn_core_rendering_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-server-internal title: "@kbn/core-rendering-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-rendering-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 b135ed45cbc2d..540371de2e74b 100644 --- a/api_docs/kbn_core_rendering_server_mocks.mdx +++ b/api_docs/kbn_core_rendering_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-server-mocks title: "@kbn/core-rendering-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-rendering-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 b79f72ccb4974..40a4cf22ded1e 100644 --- a/api_docs/kbn_core_root_server_internal.mdx +++ b/api_docs/kbn_core_root_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-root-server-internal title: "@kbn/core-root-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-root-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-root-server-internal'] --- import kbnCoreRootServerInternalObj from './kbn_core_root_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_api_browser.devdocs.json b/api_docs/kbn_core_saved_objects_api_browser.devdocs.json index 8caf2a21241bb..cc9449f2b9824 100644 --- a/api_docs/kbn_core_saved_objects_api_browser.devdocs.json +++ b/api_docs/kbn_core_saved_objects_api_browser.devdocs.json @@ -902,22 +902,6 @@ "plugin": "@kbn/core", "path": "src/core/public/index.ts" }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/lib/get_title.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/lib/get_title.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts" - }, { "plugin": "home", "path": "src/plugins/home/public/application/kibana_services.ts" @@ -1751,10 +1735,6 @@ "plugin": "@kbn/core-saved-objects-browser-mocks", "path": "packages/core/saved-objects/core-saved-objects-browser-mocks/src/saved_objects_service.mock.ts" }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/lib/get_title.ts" - }, { "plugin": "savedObjects", "path": "src/plugins/saved_objects/public/saved_object/helpers/initialize_saved_object.ts" @@ -1996,10 +1976,6 @@ "plugin": "@kbn/core-saved-objects-browser-mocks", "path": "packages/core/saved-objects/core-saved-objects-browser-mocks/src/saved_objects_service.mock.ts" }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts" - }, { "plugin": "discover", "path": "src/plugins/discover/public/application/main/services/discover_state.test.ts" @@ -3019,18 +2995,6 @@ "plugin": "savedObjects", "path": "src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts" }, - { - "plugin": "embeddable", - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx" - }, - { - "plugin": "embeddable", - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx" - }, - { - "plugin": "embeddable", - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx" - }, { "plugin": "presentationUtil", "path": "src/plugins/presentation_util/public/services/dashboards/types.ts" @@ -3732,14 +3696,6 @@ { "plugin": "@kbn/core", "path": "src/core/public/index.ts" - }, - { - "plugin": "eventAnnotation", - "path": "src/plugins/event_annotation/public/event_annotation_service/service.tsx" - }, - { - "plugin": "eventAnnotation", - "path": "src/plugins/event_annotation/public/event_annotation_service/service.tsx" } ], "initialIsOpen": false diff --git a/api_docs/kbn_core_saved_objects_api_browser.mdx b/api_docs/kbn_core_saved_objects_api_browser.mdx index 90d97d003d6b8..abf9d8b066fef 100644 --- a/api_docs/kbn_core_saved_objects_api_browser.mdx +++ b/api_docs/kbn_core_saved_objects_api_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-browser title: "@kbn/core-saved-objects-api-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-browser plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_saved_objects_api_server.devdocs.json index 93700c7aaeabf..31fbb9fb8cb39 100644 --- a/api_docs/kbn_core_saved_objects_api_server.devdocs.json +++ b/api_docs/kbn_core_saved_objects_api_server.devdocs.json @@ -2366,6 +2366,26 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/logs.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/ecommerce.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/flights.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts" + }, { "plugin": "osquery", "path": "x-pack/plugins/osquery/server/routes/pack/read_pack_route.ts" @@ -2454,22 +2474,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/user_risk_score_dashboards.ts" }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/logs.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/ecommerce.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/flights.ts" - }, - { - "plugin": "lists", - "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts" - }, { "plugin": "alerting", "path": "x-pack/plugins/alerting/server/rules_client/lib/siem_legacy_actions/retrieve_migrated_legacy_actions.mock.ts" @@ -2671,16 +2675,16 @@ "path": "x-pack/plugins/actions/server/types.ts" }, { - "plugin": "actions", - "path": "x-pack/plugins/actions/server/types.ts" + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" }, { - "plugin": "actions", - "path": "x-pack/plugins/actions/server/types.ts" + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" }, { - "plugin": "actions", - "path": "x-pack/plugins/actions/server/types.ts" + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" }, { "plugin": "alerting", @@ -2716,23 +2720,31 @@ }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/common/rule.ts" + "path": "x-pack/plugins/alerting/server/rules_client/common/inject_references.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/common/rule.ts" + "path": "x-pack/plugins/alerting/server/rules_client/common/inject_references.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/common/rule.ts" + "path": "x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/common/inject_references.ts" + "path": "x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/common/inject_references.ts" + "path": "x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts" }, { "plugin": "alerting", diff --git a/api_docs/kbn_core_saved_objects_api_server.mdx b/api_docs/kbn_core_saved_objects_api_server.mdx index 5f3dae559b6d9..445570339188b 100644 --- a/api_docs/kbn_core_saved_objects_api_server.mdx +++ b/api_docs/kbn_core_saved_objects_api_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server title: "@kbn/core-saved-objects-api-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-server plugin -date: 2023-06-30 +date: 2023-07-18 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 ce1c8b4561da9..c7b362b597c44 100644 --- a/api_docs/kbn_core_saved_objects_api_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_api_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server-mocks title: "@kbn/core-saved-objects-api-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-server-mocks'] --- import kbnCoreSavedObjectsApiServerMocksObj from './kbn_core_saved_objects_api_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_base_server_internal.devdocs.json b/api_docs/kbn_core_saved_objects_base_server_internal.devdocs.json index 222ceba14f230..bfdf4b5b8d482 100644 --- a/api_docs/kbn_core_saved_objects_base_server_internal.devdocs.json +++ b/api_docs/kbn_core_saved_objects_base_server_internal.devdocs.json @@ -884,8 +884,6 @@ "description": [], "signature": [ "(mappings: ", - "IndexMapping", - " | ", { "pluginId": "@kbn/core-saved-objects-server", "scope": "common", @@ -893,6 +891,8 @@ "section": "def-common.SavedObjectsFieldMapping", "text": "SavedObjectsFieldMapping" }, + " | ", + "IndexMapping", ", path: string | string[]) => ", { "pluginId": "@kbn/core-saved-objects-server", @@ -915,15 +915,15 @@ "label": "mappings", "description": [], "signature": [ - "IndexMapping", - " | ", { "pluginId": "@kbn/core-saved-objects-server", "scope": "common", "docId": "kibKbnCoreSavedObjectsServerPluginApi", "section": "def-common.SavedObjectsFieldMapping", "text": "SavedObjectsFieldMapping" - } + }, + " | ", + "IndexMapping" ], "path": "packages/core/saved-objects/core-saved-objects-base-server-internal/src/mappings/lib/get_property.ts", "deprecated": false, 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 3c9f791e6f1bb..8a2c5301568b9 100644 --- a/api_docs/kbn_core_saved_objects_base_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_base_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-base-server-internal title: "@kbn/core-saved-objects-base-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-base-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 10017078ace48..4e3975b725d58 100644 --- a/api_docs/kbn_core_saved_objects_base_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_base_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-base-server-mocks title: "@kbn/core-saved-objects-base-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-base-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 2d148f9c34964..e49b46e9aeae0 100644 --- a/api_docs/kbn_core_saved_objects_browser.mdx +++ b/api_docs/kbn_core_saved_objects_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser title: "@kbn/core-saved-objects-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 c23757de2cf8f..dff0b99762170 100644 --- a/api_docs/kbn_core_saved_objects_browser_internal.mdx +++ b/api_docs/kbn_core_saved_objects_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser-internal title: "@kbn/core-saved-objects-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-browser-internal plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_saved_objects_browser_mocks.devdocs.json index 8d5d226883f46..ebe7a8f233c79 100644 --- a/api_docs/kbn_core_saved_objects_browser_mocks.devdocs.json +++ b/api_docs/kbn_core_saved_objects_browser_mocks.devdocs.json @@ -48,14 +48,6 @@ "plugin": "@kbn/core", "path": "src/core/public/mocks.ts" }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/public/saved_objects_client_wrapper.test.ts" - }, { "plugin": "@kbn/core-plugins-browser-internal", "path": "packages/core/plugins/core-plugins-browser-internal/src/plugins_service.test.ts" diff --git a/api_docs/kbn_core_saved_objects_browser_mocks.mdx b/api_docs/kbn_core_saved_objects_browser_mocks.mdx index f4256143bb941..20e4c4a88df88 100644 --- a/api_docs/kbn_core_saved_objects_browser_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser-mocks title: "@kbn/core-saved-objects-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser-mocks'] --- import kbnCoreSavedObjectsBrowserMocksObj from './kbn_core_saved_objects_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_common.devdocs.json b/api_docs/kbn_core_saved_objects_common.devdocs.json index 7b4695420afa3..df94083947f81 100644 --- a/api_docs/kbn_core_saved_objects_common.devdocs.json +++ b/api_docs/kbn_core_saved_objects_common.devdocs.json @@ -1213,18 +1213,6 @@ "plugin": "home", "path": "src/plugins/home/server/services/sample_data/sample_data_registry.ts" }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/session/sessions_mgmt/lib/api.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/session/sessions_mgmt/lib/api.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/search/session/sessions_mgmt/lib/api.ts" - }, { "plugin": "savedObjectsTagging", "path": "x-pack/plugins/saved_objects_tagging/public/ui_api/get_table_column_definition.tsx" @@ -1369,22 +1357,6 @@ "plugin": "savedObjectsTagging", "path": "x-pack/plugins/saved_objects_tagging/public/utils.ts" }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/host_risk_score_dashboards.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/host_risk_score_dashboards.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/user_risk_score_dashboards.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/user_risk_score_dashboards.ts" - }, { "plugin": "lists", "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts" @@ -1417,6 +1389,22 @@ "plugin": "savedObjectsTagging", "path": "x-pack/plugins/saved_objects_tagging/public/utils.test.ts" }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/host_risk_score_dashboards.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/host_risk_score_dashboards.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/user_risk_score_dashboards.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/user_risk_score_dashboards.ts" + }, { "plugin": "upgradeAssistant", "path": "x-pack/plugins/upgrade_assistant/common/types.ts" @@ -1453,70 +1441,6 @@ "plugin": "savedObjectsManagement", "path": "src/plugins/saved_objects_management/server/lib/find_relationships.test.ts" }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/saved_objects/search_session_migration.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/saved_objects/search_session_migration.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/saved_objects/search_session_migration.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/saved_objects/search_session_migration.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/saved_objects/search_session_migration.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/saved_objects/search_session_migration.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/saved_objects/search_session_migration.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/saved_objects/search_session_migration.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/search/saved_objects/search_session_migration.test.ts" - }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/actions.ts" - }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/actions.ts" - }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/api.ts" - }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/api.ts" - }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/api.ts" - }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/index.ts" - }, - { - "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/global_params/index.ts" - }, { "plugin": "synthetics", "path": "x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_list/api.ts" @@ -1715,18 +1639,6 @@ "plugin": "savedObjects", "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts" }, - { - "plugin": "embeddable", - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx" - }, - { - "plugin": "embeddable", - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx" - }, - { - "plugin": "embeddable", - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx" - }, { "plugin": "embeddable", "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts" @@ -2116,115 +2028,115 @@ }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/types.ts" + "path": "x-pack/plugins/lens/public/datasources/form_based/loader.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/types.ts" + "path": "x-pack/plugins/lens/public/datasources/form_based/loader.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/types.ts" + "path": "x-pack/plugins/lens/public/datasources/form_based/loader.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/types.ts" + "path": "x-pack/plugins/lens/public/datasources/form_based/loader.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/types.ts" + "path": "x-pack/plugins/lens/public/datasources/form_based/loader.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/types.ts" + "path": "x-pack/plugins/lens/public/datasources/form_based/form_based.tsx" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/types.ts" + "path": "x-pack/plugins/lens/public/datasources/form_based/form_based.tsx" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/types.ts" + "path": "x-pack/plugins/lens/public/datasources/form_based/form_based.tsx" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/types.ts" + "path": "x-pack/plugins/lens/public/datasources/form_based/form_based.tsx" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/types.ts" + "path": "x-pack/plugins/lens/public/visualizations/xy/state_helpers.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/datasources/form_based/loader.ts" + "path": "x-pack/plugins/lens/public/visualizations/xy/state_helpers.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/datasources/form_based/loader.ts" + "path": "x-pack/plugins/lens/public/visualizations/xy/state_helpers.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/datasources/form_based/loader.ts" + "path": "x-pack/plugins/lens/public/visualizations/xy/visualization.tsx" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/datasources/form_based/loader.ts" + "path": "x-pack/plugins/lens/public/visualizations/xy/visualization.tsx" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/datasources/form_based/loader.ts" + "path": "x-pack/plugins/lens/public/datasources/text_based/text_based_languages.tsx" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/datasources/form_based/form_based.tsx" + "path": "x-pack/plugins/lens/public/datasources/text_based/text_based_languages.tsx" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/datasources/form_based/form_based.tsx" + "path": "x-pack/plugins/lens/public/app_plugin/save_modal_container.tsx" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/datasources/form_based/form_based.tsx" + "path": "x-pack/plugins/lens/public/app_plugin/save_modal_container.tsx" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/datasources/form_based/form_based.tsx" + "path": "x-pack/plugins/lens/public/types.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/visualizations/xy/state_helpers.ts" + "path": "x-pack/plugins/lens/public/types.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/visualizations/xy/state_helpers.ts" + "path": "x-pack/plugins/lens/public/types.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/visualizations/xy/state_helpers.ts" + "path": "x-pack/plugins/lens/public/types.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/visualizations/xy/visualization.tsx" + "path": "x-pack/plugins/lens/public/types.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/visualizations/xy/visualization.tsx" + "path": "x-pack/plugins/lens/public/types.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/datasources/text_based/text_based_languages.tsx" + "path": "x-pack/plugins/lens/public/types.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/datasources/text_based/text_based_languages.tsx" + "path": "x-pack/plugins/lens/public/types.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/save_modal_container.tsx" + "path": "x-pack/plugins/lens/public/types.ts" }, { "plugin": "lens", - "path": "x-pack/plugins/lens/public/app_plugin/save_modal_container.tsx" + "path": "x-pack/plugins/lens/public/types.ts" }, { "plugin": "graph", @@ -2362,42 +2274,6 @@ "plugin": "expressions", "path": "src/plugins/expressions/common/executor/executor.ts" }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/expressions/load_index_pattern.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/extract_references.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/extract_references.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/extract_references.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/inject_references.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/inject_references.ts" - }, { "plugin": "data", "path": "src/plugins/data/common/query/filters/persistable_state.ts" @@ -2770,14 +2646,6 @@ "plugin": "globalSearchProviders", "path": "x-pack/plugins/global_search_providers/server/providers/saved_objects/map_object_to_result.test.ts" }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/persistable_state.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/persistable_state.test.ts" - }, { "plugin": "expressions", "path": "src/plugins/expressions/common/executor/executor.test.ts" @@ -2790,14 +2658,6 @@ "plugin": "expressions", "path": "src/plugins/expressions/common/executor/executor.test.ts" }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/inject_references.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/inject_references.test.ts" - }, { "plugin": "lens", "path": "x-pack/plugins/lens/common/locator/locator.ts" @@ -2830,6 +2690,18 @@ "plugin": "infra", "path": "x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_references_manager.ts" }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/common/visualizations/types.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/common/visualizations/types.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/common/visualizations/types.ts" + }, { "plugin": "infra", "path": "x-pack/plugins/infra/public/common/visualizations/lens/utils.ts" @@ -2840,11 +2712,11 @@ }, { "plugin": "infra", - "path": "x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/line_chart.ts" + "path": "x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/xy_chart.ts" }, { "plugin": "infra", - "path": "x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/line_chart.ts" + "path": "x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/xy_chart.ts" }, { "plugin": "infra", @@ -2856,11 +2728,27 @@ }, { "plugin": "infra", - "path": "x-pack/plugins/infra/public/common/visualizations/types.ts" + "path": "x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/layers/metric_layer.ts" }, { "plugin": "infra", - "path": "x-pack/plugins/infra/public/common/visualizations/types.ts" + "path": "x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/layers/metric_layer.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/layers/xy_data_layer.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/layers/xy_data_layer.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/layers/xy_reference_lines_layer.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/layers/xy_reference_lines_layer.ts" }, { "plugin": "infra", diff --git a/api_docs/kbn_core_saved_objects_common.mdx b/api_docs/kbn_core_saved_objects_common.mdx index 786f7ea994800..acbf27dd2bee6 100644 --- a/api_docs/kbn_core_saved_objects_common.mdx +++ b/api_docs/kbn_core_saved_objects_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-common title: "@kbn/core-saved-objects-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-common plugin -date: 2023-06-30 +date: 2023-07-18 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 5f66640f4d31b..8c955dd881ae4 100644 --- a/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-import-export-server-internal title: "@kbn/core-saved-objects-import-export-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-import-export-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 6112c22b2b6a4..03408e52687c9 100644 --- a/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-import-export-server-mocks title: "@kbn/core-saved-objects-import-export-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-import-export-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-import-export-server-mocks'] --- import kbnCoreSavedObjectsImportExportServerMocksObj from './kbn_core_saved_objects_import_export_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_migration_server_internal.devdocs.json b/api_docs/kbn_core_saved_objects_migration_server_internal.devdocs.json index 699397cdf48dc..3a6495d4c5078 100644 --- a/api_docs/kbn_core_saved_objects_migration_server_internal.devdocs.json +++ b/api_docs/kbn_core_saved_objects_migration_server_internal.devdocs.json @@ -1335,7 +1335,7 @@ "tags": [], "label": "pickupUpdatedMappings", "description": [ - "\nPickup updated mappings by performing an update by query operation on all\ndocuments in the index. Returns a task ID which can be\ntracked for progress.\n" + "\nPickup updated mappings by performing an update by query operation on all\ndocuments matching the passed in query. Returns a task ID which can be\ntracked for progress.\n" ], "signature": [ "(client: ", @@ -1346,7 +1346,9 @@ "section": "def-common.ElasticsearchClient", "text": "ElasticsearchClient" }, - ", index: string, batchSize: number) => ", + ", index: string, batchSize: number, query?: ", + "QueryDslQueryContainer", + " | undefined) => ", "TaskEither", "<", "RetryableEsClientError", @@ -1414,6 +1416,22 @@ "deprecated": false, "trackAdoption": false, "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-migration-server-internal", + "id": "def-common.pickupUpdatedMappings.$4", + "type": "Object", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "QueryDslQueryContainer", + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/pickup_updated_mappings.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false } ], "returnComment": [], @@ -1746,7 +1764,7 @@ "\nUpdates an index's mappings and runs an pickupUpdatedMappings task so that the mapping\nchanges are \"picked up\". Returns a taskId to track progress." ], "signature": [ - "({ client, index, mappings, batchSize, }: ", + "({ client, index, mappings, batchSize, query, }: ", "UpdateAndPickupMappingsParams", ") => ", "TaskEither", @@ -1765,7 +1783,7 @@ "id": "def-common.updateAndPickupMappings.$1", "type": "Object", "tags": [], - "label": "{\n client,\n index,\n mappings,\n batchSize,\n}", + "label": "{\n client,\n index,\n mappings,\n batchSize,\n query,\n}", "description": [], "signature": [ "UpdateAndPickupMappingsParams" diff --git a/api_docs/kbn_core_saved_objects_migration_server_internal.mdx b/api_docs/kbn_core_saved_objects_migration_server_internal.mdx index b04305fac4f0d..5ec61e50855ea 100644 --- a/api_docs/kbn_core_saved_objects_migration_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_migration_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-migration-server-internal title: "@kbn/core-saved-objects-migration-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-migration-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-migration-server-internal'] --- import kbnCoreSavedObjectsMigrationServerInternalObj from './kbn_core_saved_objects_migration_server_internal.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 123 | 0 | 89 | 46 | +| 124 | 0 | 90 | 46 | ## Common diff --git a/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx b/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx index d78a63e5b0821..b3315dacc6801 100644 --- a/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-migration-server-mocks title: "@kbn/core-saved-objects-migration-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-migration-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-migration-server-mocks'] --- import kbnCoreSavedObjectsMigrationServerMocksObj from './kbn_core_saved_objects_migration_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_server.devdocs.json b/api_docs/kbn_core_saved_objects_server.devdocs.json index 2c2cee40c0058..c8938d2d31144 100644 --- a/api_docs/kbn_core_saved_objects_server.devdocs.json +++ b/api_docs/kbn_core_saved_objects_server.devdocs.json @@ -5831,6 +5831,26 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/logs.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/ecommerce.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/sample_data/flights.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts" + }, { "plugin": "osquery", "path": "x-pack/plugins/osquery/server/routes/pack/read_pack_route.ts" @@ -5919,22 +5939,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/risk_score/prebuilt_saved_objects/saved_object/user_risk_score_dashboards.ts" }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/logs.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/ecommerce.ts" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/sample_data/flights.ts" - }, - { - "plugin": "lists", - "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.mock.ts" - }, { "plugin": "alerting", "path": "x-pack/plugins/alerting/server/rules_client/lib/siem_legacy_actions/retrieve_migrated_legacy_actions.mock.ts" @@ -6136,16 +6140,16 @@ "path": "x-pack/plugins/actions/server/types.ts" }, { - "plugin": "actions", - "path": "x-pack/plugins/actions/server/types.ts" + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" }, { - "plugin": "actions", - "path": "x-pack/plugins/actions/server/types.ts" + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" }, { - "plugin": "actions", - "path": "x-pack/plugins/actions/server/types.ts" + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" }, { "plugin": "alerting", @@ -6181,23 +6185,31 @@ }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/common/rule.ts" + "path": "x-pack/plugins/alerting/server/rules_client/common/inject_references.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/common/rule.ts" + "path": "x-pack/plugins/alerting/server/rules_client/common/inject_references.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/common/rule.ts" + "path": "x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/common/inject_references.ts" + "path": "x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts" }, { "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/rules_client/common/inject_references.ts" + "path": "x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts" }, { "plugin": "alerting", @@ -6909,6 +6921,46 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectModelDataBackfillResult", + "type": "Interface", + "tags": [], + "label": "SavedObjectModelDataBackfillResult", + "description": [ + "\nReturn type for the {@link SavedObjectModelTransformationFn | transformation functions}\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectModelDataBackfillResult", + "text": "SavedObjectModelDataBackfillResult" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/transformations.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectModelDataBackfillResult.attributes", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "{ [P in keyof DocAttrs]?: DocAttrs[P] | undefined; }" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/transformations.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectModelTransformationContext", @@ -7908,7 +7960,7 @@ "tags": [], "label": "SavedObjectsModelDataBackfillChange", "description": [ - "\nA {@link SavedObjectsModelChange | model change} used to backfill fields introduced in the same model version.\n" + "\nA {@link SavedObjectsModelChange | model change} backfilling fields introduced in the same model version.\n" ], "signature": [ { @@ -7940,10 +7992,10 @@ }, { "parentPluginId": "@kbn/core-saved-objects-server", - "id": "def-common.SavedObjectsModelDataBackfillChange.transform", + "id": "def-common.SavedObjectsModelDataBackfillChange.backfillFn", "type": "Function", "tags": [], - "label": "transform", + "label": "backfillFn", "description": [ "\nThe backfill function to run." ], @@ -7969,8 +8021,8 @@ "pluginId": "@kbn/core-saved-objects-server", "scope": "common", "docId": "kibKbnCoreSavedObjectsServerPluginApi", - "section": "def-common.SavedObjectModelTransformationResult", - "text": "SavedObjectModelTransformationResult" + "section": "def-common.SavedObjectModelDataBackfillResult", + "text": "SavedObjectModelDataBackfillResult" }, "" ], @@ -7981,7 +8033,7 @@ "children": [ { "parentPluginId": "@kbn/core-saved-objects-server", - "id": "def-common.SavedObjectsModelDataBackfillChange.transform.$1", + "id": "def-common.SavedObjectsModelDataBackfillChange.backfillFn.$1", "type": "CompoundType", "tags": [], "label": "document", @@ -8003,7 +8055,7 @@ }, { "parentPluginId": "@kbn/core-saved-objects-server", - "id": "def-common.SavedObjectsModelDataBackfillChange.transform.$2", + "id": "def-common.SavedObjectsModelDataBackfillChange.backfillFn.$2", "type": "Object", "tags": [], "label": "context", @@ -8026,6 +8078,52 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectsModelDataRemovalChange", + "type": "Interface", + "tags": [], + "label": "SavedObjectsModelDataRemovalChange", + "description": [ + "\nA {@link SavedObjectsModelChange | model change} removing data from all documents of the type.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectsModelDataRemovalChange.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"data_removal\"" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectsModelDataRemovalChange.removedAttributePaths", + "type": "Array", + "tags": [], + "label": "removedAttributePaths", + "description": [ + "\nThe list of attribute paths to remove." + ], + "signature": [ + "string[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectsModelMappingsAdditionChange", @@ -8124,6 +8222,131 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectsModelUnsafeTransformChange", + "type": "Interface", + "tags": [], + "label": "SavedObjectsModelUnsafeTransformChange", + "description": [ + "\nA {@link SavedObjectsModelChange | model change} executing an arbitrary transformation function.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectsModelUnsafeTransformChange", + "text": "SavedObjectsModelUnsafeTransformChange" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectsModelUnsafeTransformChange.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"unsafe_transform\"" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectsModelUnsafeTransformChange.transformFn", + "type": "Function", + "tags": [], + "label": "transformFn", + "description": [ + "\nThe transform function to execute." + ], + "signature": [ + "(document: ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectModelTransformationDoc", + "text": "SavedObjectModelTransformationDoc" + }, + ", context: ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectModelTransformationContext", + "text": "SavedObjectModelTransformationContext" + }, + ") => ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectModelTransformationResult", + "text": "SavedObjectModelTransformationResult" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectsModelUnsafeTransformChange.transformFn.$1", + "type": "CompoundType", + "tags": [], + "label": "document", + "description": [], + "signature": [ + "SavedObjectDoc & { references?: ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[] | undefined; }" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/transformations.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectsModelUnsafeTransformChange.transformFn.$2", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectModelTransformationContext", + "text": "SavedObjectModelTransformationContext" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/transformations.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectsModelVersion", @@ -10364,10 +10587,18 @@ "plugin": "canvas", "path": "x-pack/plugins/canvas/server/saved_objects/custom_element.ts" }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/server/saved_objects/graph_workspace.ts" + }, { "plugin": "lists", "path": "x-pack/plugins/lists/server/saved_objects/exception_list.ts" }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/server/saved_objects/setup_saved_objects.ts" + }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/timeline/saved_object_mappings/timelines.ts" @@ -10384,14 +10615,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_saved_object_mappings.ts" }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/server/saved_objects/graph_workspace.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/saved_objects/setup_saved_objects.ts" - }, { "plugin": "dashboard", "path": "src/plugins/dashboard/server/dashboard_saved_object/dashboard_saved_object.ts" @@ -11348,8 +11571,8 @@ "pluginId": "@kbn/core-saved-objects-server", "scope": "common", "docId": "kibKbnCoreSavedObjectsServerPluginApi", - "section": "def-common.SavedObjectModelTransformationResult", - "text": "SavedObjectModelTransformationResult" + "section": "def-common.SavedObjectModelDataBackfillResult", + "text": "SavedObjectModelDataBackfillResult" }, "" ], @@ -11514,6 +11737,92 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectModelUnsafeTransformFn", + "type": "Type", + "tags": [], + "label": "SavedObjectModelUnsafeTransformFn", + "description": [ + "\nA data transformation function associated with a {@link SavedObjectsModelUnsafeTransformChange | unsafe transform} change.\n" + ], + "signature": [ + "(document: ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectModelTransformationDoc", + "text": "SavedObjectModelTransformationDoc" + }, + ", context: ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectModelTransformationContext", + "text": "SavedObjectModelTransformationContext" + }, + ") => ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectModelTransformationResult", + "text": "SavedObjectModelTransformationResult" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/transformations.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectModelUnsafeTransformFn.$1", + "type": "CompoundType", + "tags": [], + "label": "document", + "description": [], + "signature": [ + "SavedObjectDoc & { references?: ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[] | undefined; }" + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/transformations.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-server", + "id": "def-common.SavedObjectModelUnsafeTransformFn.$2", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectModelTransformationContext", + "text": "SavedObjectModelTransformationContext" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/transformations.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-saved-objects-server", "id": "def-common.SavedObjectModelVersionForwardCompatibilityFn", @@ -12129,7 +12438,7 @@ "tags": [], "label": "SavedObjectsModelChange", "description": [ - "\nRepresents a change of model associated with a given {@link SavedObjectsModelVersion}.\n\nThe existing types of model changes are:\n - 'mappings_addition' ({@link SavedObjectsModelMappingsAdditionChange}\n - 'mappings_deprecation' ({@link SavedObjectsModelMappingsDeprecationChange}\n - 'data_backfill' ({@link SavedObjectsModelDataBackfillChange}\n" + "\nRepresents a change of model associated with a given {@link SavedObjectsModelVersion}.\n\nThe existing types of model changes are:\n - 'mappings_addition' ({@link SavedObjectsModelMappingsAdditionChange}\n - 'mappings_deprecation' ({@link SavedObjectsModelMappingsDeprecationChange}\n - 'data_backfill' ({@link SavedObjectsModelDataBackfillChange}\n - 'data_removal' ({@link SavedObjectsModelDataRemovalChange})\n - 'unsafe_transform' ({@link SavedObjectsModelUnsafeTransformChange})\n" ], "signature": [ { @@ -12155,6 +12464,22 @@ "section": "def-common.SavedObjectsModelDataBackfillChange", "text": "SavedObjectsModelDataBackfillChange" }, + " | ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectsModelDataRemovalChange", + "text": "SavedObjectsModelDataRemovalChange" + }, + " | ", + { + "pluginId": "@kbn/core-saved-objects-server", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsServerPluginApi", + "section": "def-common.SavedObjectsModelUnsafeTransformChange", + "text": "SavedObjectsModelUnsafeTransformChange" + }, "" ], "path": "packages/core/saved-objects/core-saved-objects-server/src/model_version/model_change.ts", diff --git a/api_docs/kbn_core_saved_objects_server.mdx b/api_docs/kbn_core_saved_objects_server.mdx index d99d4ea8528ca..88a78f577891d 100644 --- a/api_docs/kbn_core_saved_objects_server.mdx +++ b/api_docs/kbn_core_saved_objects_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server title: "@kbn/core-saved-objects-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-server plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server'] --- import kbnCoreSavedObjectsServerObj from './kbn_core_saved_objects_server.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 535 | 1 | 115 | 4 | +| 548 | 1 | 122 | 4 | ## Common diff --git a/api_docs/kbn_core_saved_objects_server_internal.mdx b/api_docs/kbn_core_saved_objects_server_internal.mdx index b193ab1fff041..8514a50b4d946 100644 --- a/api_docs/kbn_core_saved_objects_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server-internal title: "@kbn/core-saved-objects-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 1c1fe623094b0..63dd9fac0c554 100644 --- a/api_docs/kbn_core_saved_objects_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server-mocks title: "@kbn/core-saved-objects-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 f25d9886ec4af..c4ee5b42b247b 100644 --- a/api_docs/kbn_core_saved_objects_utils_server.mdx +++ b/api_docs/kbn_core_saved_objects_utils_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-utils-server title: "@kbn/core-saved-objects-utils-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-utils-server plugin -date: 2023-06-30 +date: 2023-07-18 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_status_common.devdocs.json b/api_docs/kbn_core_status_common.devdocs.json index 9f812b6cacb3d..10cab0bc06263 100644 --- a/api_docs/kbn_core_status_common.devdocs.json +++ b/api_docs/kbn_core_status_common.devdocs.json @@ -211,7 +211,7 @@ "\nPossible values for the ID of a {@link ServiceStatusLevel}\n" ], "signature": [ - "\"degraded\" | \"unavailable\" | \"critical\" | \"available\"" + "\"degraded\" | \"unavailable\" | \"available\" | \"critical\"" ], "path": "packages/core/status/core-status-common/src/service_status.ts", "deprecated": false, diff --git a/api_docs/kbn_core_status_common.mdx b/api_docs/kbn_core_status_common.mdx index 098b77d3a5be4..cc2546ee00b6e 100644 --- a/api_docs/kbn_core_status_common.mdx +++ b/api_docs/kbn_core_status_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-common title: "@kbn/core-status-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-common plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_status_common_internal.devdocs.json index ee881532c5b66..819813f5db06c 100644 --- a/api_docs/kbn_core_status_common_internal.devdocs.json +++ b/api_docs/kbn_core_status_common_internal.devdocs.json @@ -212,7 +212,7 @@ "label": "level", "description": [], "signature": [ - "\"degraded\" | \"unavailable\" | \"critical\" | \"available\"" + "\"degraded\" | \"unavailable\" | \"available\" | \"critical\"" ], "path": "packages/core/status/core-status-common-internal/src/status.ts", "deprecated": false, diff --git a/api_docs/kbn_core_status_common_internal.mdx b/api_docs/kbn_core_status_common_internal.mdx index f3b3cb0d5f2d3..3043175953dfd 100644 --- a/api_docs/kbn_core_status_common_internal.mdx +++ b/api_docs/kbn_core_status_common_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-common-internal title: "@kbn/core-status-common-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-common-internal plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_status_server.devdocs.json index f417cc31259e8..b345658f08790 100644 --- a/api_docs/kbn_core_status_server.devdocs.json +++ b/api_docs/kbn_core_status_server.devdocs.json @@ -398,7 +398,7 @@ "\nPossible values for the ID of a {@link ServiceStatusLevel}\n" ], "signature": [ - "\"degraded\" | \"unavailable\" | \"critical\" | \"available\"" + "\"degraded\" | \"unavailable\" | \"available\" | \"critical\"" ], "path": "packages/core/status/core-status-common/src/service_status.ts", "deprecated": false, diff --git a/api_docs/kbn_core_status_server.mdx b/api_docs/kbn_core_status_server.mdx index b2615ef588e50..ac3f6cd3cde00 100644 --- a/api_docs/kbn_core_status_server.mdx +++ b/api_docs/kbn_core_status_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server title: "@kbn/core-status-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-server plugin -date: 2023-06-30 +date: 2023-07-18 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 33a59a6da2ac8..c97ee6c6e3901 100644 --- a/api_docs/kbn_core_status_server_internal.mdx +++ b/api_docs/kbn_core_status_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server-internal title: "@kbn/core-status-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 08e898d63952d..18101fbdc4c6a 100644 --- a/api_docs/kbn_core_status_server_mocks.mdx +++ b/api_docs/kbn_core_status_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server-mocks title: "@kbn/core-status-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 fb9cfe5e06eda..3a56072e09cfd 100644 --- a/api_docs/kbn_core_test_helpers_deprecations_getters.mdx +++ b/api_docs/kbn_core_test_helpers_deprecations_getters.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-deprecations-getters title: "@kbn/core-test-helpers-deprecations-getters" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-deprecations-getters plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_test_helpers_http_setup_browser.devdocs.json index f60b10783ed6e..5d94094ad2028 100644 --- a/api_docs/kbn_core_test_helpers_http_setup_browser.devdocs.json +++ b/api_docs/kbn_core_test_helpers_http_setup_browser.devdocs.json @@ -123,13 +123,13 @@ "label": "injectedMetadata", "description": [], "signature": [ - "{ getBasePath: jest.MockInstance; getServerBasePath: jest.MockInstance; getPublicBaseUrl: jest.MockInstance; getKibanaBuildNumber: jest.MockInstance; getKibanaBranch: jest.MockInstance; getKibanaVersion: jest.MockInstance; getCspConfig: jest.MockInstance<{ warnLegacyBrowsers: boolean; }, []>; getExternalUrlConfig: jest.MockInstance<{ policy: ", + "{ getBasePath: jest.MockInstance; getServerBasePath: jest.MockInstance; getPublicBaseUrl: jest.MockInstance; getKibanaBuildNumber: jest.MockInstance; getKibanaBranch: jest.MockInstance; getKibanaVersion: jest.MockInstance; getCspConfig: jest.MockInstance<{ warnLegacyBrowsers: boolean; }, [], unknown>; getExternalUrlConfig: jest.MockInstance<{ policy: ", "InjectedMetadataExternalUrlPolicy", - "[]; }, []>; getTheme: jest.MockInstance<{ darkMode: boolean; version: \"v8\"; }, []>; getElasticsearchInfo: jest.MockInstance<", + "[]; }, [], unknown>; getTheme: jest.MockInstance<{ darkMode: boolean; version: \"v8\"; }, [], unknown>; getElasticsearchInfo: jest.MockInstance<", "InjectedMetadataClusterInfo", - ", []>; getPlugins: jest.MockInstance<", + ", [], unknown>; getPlugins: jest.MockInstance<", "InjectedMetadataPlugin", - "[], []>; getAnonymousStatusPage: jest.MockInstance; getLegacyMetadata: jest.MockInstance<{ uiSettings: { defaults: Record; user?: Record | undefined; }; globalUiSettings: { defaults: Record; user?: Record | undefined; }; }, []>; getInjectedVar: jest.MockInstance; getInjectedVars: jest.MockInstance<{ [key: string]: unknown; }, []>; getCustomBranding: jest.MockInstance<", + "[], [], unknown>; getAnonymousStatusPage: jest.MockInstance; getLegacyMetadata: jest.MockInstance<{ uiSettings: { defaults: Record; user?: Record | undefined; }; globalUiSettings: { defaults: Record; user?: Record | undefined; }; }, [], unknown>; getInjectedVar: jest.MockInstance; getInjectedVars: jest.MockInstance<{ [key: string]: unknown; }, [], unknown>; getCustomBranding: jest.MockInstance<", { "pluginId": "@kbn/core-custom-branding-common", "scope": "common", @@ -137,7 +137,7 @@ "section": "def-common.CustomBranding", "text": "CustomBranding" }, - ", []>; } & ", + ", [], unknown>; } & ", "InternalInjectedMetadataSetup" ], "path": "packages/core/test-helpers/core-test-helpers-http-setup-browser/src/http_test_setup.ts", @@ -152,7 +152,7 @@ "label": "fatalErrors", "description": [], "signature": [ - "{ add: jest.MockInstance; get$: jest.MockInstance<", + "{ add: jest.MockInstance; get$: jest.MockInstance<", "Observable", "<", { @@ -162,7 +162,7 @@ "section": "def-common.FatalErrorInfo", "text": "FatalErrorInfo" }, - ">, []>; } & ", + ">, [], unknown>; } & ", { "pluginId": "@kbn/core-fatal-errors-browser", "scope": "common", 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 29b267c229a22..62b15f048f46e 100644 --- a/api_docs/kbn_core_test_helpers_http_setup_browser.mdx +++ b/api_docs/kbn_core_test_helpers_http_setup_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-http-setup-browser title: "@kbn/core-test-helpers-http-setup-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-http-setup-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 6835fa78db714..4de09c81c2467 100644 --- a/api_docs/kbn_core_test_helpers_kbn_server.mdx +++ b/api_docs/kbn_core_test_helpers_kbn_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-kbn-server title: "@kbn/core-test-helpers-kbn-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-kbn-server plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-kbn-server'] --- import kbnCoreTestHelpersKbnServerObj from './kbn_core_test_helpers_kbn_server.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_so_type_serializer.mdx b/api_docs/kbn_core_test_helpers_so_type_serializer.mdx index cec382dd67f99..50658c724fe44 100644 --- a/api_docs/kbn_core_test_helpers_so_type_serializer.mdx +++ b/api_docs/kbn_core_test_helpers_so_type_serializer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-so-type-serializer title: "@kbn/core-test-helpers-so-type-serializer" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-so-type-serializer plugin -date: 2023-06-30 +date: 2023-07-18 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 2ef04f8382050..d99e35c6b25d7 100644 --- a/api_docs/kbn_core_test_helpers_test_utils.mdx +++ b/api_docs/kbn_core_test_helpers_test_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-test-utils title: "@kbn/core-test-helpers-test-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-test-utils plugin -date: 2023-06-30 +date: 2023-07-18 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 f7c4977627024..4d87680e023e0 100644 --- a/api_docs/kbn_core_theme_browser.mdx +++ b/api_docs/kbn_core_theme_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser title: "@kbn/core-theme-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-theme-browser plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser'] --- import kbnCoreThemeBrowserObj from './kbn_core_theme_browser.devdocs.json'; diff --git a/api_docs/kbn_core_theme_browser_internal.mdx b/api_docs/kbn_core_theme_browser_internal.mdx index c4f34300dd40a..65bcf6fa2c6d8 100644 --- a/api_docs/kbn_core_theme_browser_internal.mdx +++ b/api_docs/kbn_core_theme_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-internal title: "@kbn/core-theme-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-theme-browser-internal plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-internal'] --- import kbnCoreThemeBrowserInternalObj from './kbn_core_theme_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_theme_browser_mocks.mdx b/api_docs/kbn_core_theme_browser_mocks.mdx index b06fc8d98390a..51b1e05bae400 100644 --- a/api_docs/kbn_core_theme_browser_mocks.mdx +++ b/api_docs/kbn_core_theme_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-mocks title: "@kbn/core-theme-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-theme-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 92824665b9051..16cd20f3f0c52 100644 --- a/api_docs/kbn_core_ui_settings_browser.mdx +++ b/api_docs/kbn_core_ui_settings_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser title: "@kbn/core-ui-settings-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 e36154decf480..a8de5e5d5fcef 100644 --- a/api_docs/kbn_core_ui_settings_browser_internal.mdx +++ b/api_docs/kbn_core_ui_settings_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser-internal title: "@kbn/core-ui-settings-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-browser-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 f3f0d04629090..5c6ba1704dbfb 100644 --- a/api_docs/kbn_core_ui_settings_browser_mocks.mdx +++ b/api_docs/kbn_core_ui_settings_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser-mocks title: "@kbn/core-ui-settings-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-browser-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 1c86bc3581739..ec4c340a14cf6 100644 --- a/api_docs/kbn_core_ui_settings_common.mdx +++ b/api_docs/kbn_core_ui_settings_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-common title: "@kbn/core-ui-settings-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-common plugin -date: 2023-06-30 +date: 2023-07-18 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 d1191aae7a3e6..8175442173cb9 100644 --- a/api_docs/kbn_core_ui_settings_server.mdx +++ b/api_docs/kbn_core_ui_settings_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server title: "@kbn/core-ui-settings-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-server plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_ui_settings_server_internal.devdocs.json index 51a298f3e4469..19b0355b0870b 100644 --- a/api_docs/kbn_core_ui_settings_server_internal.devdocs.json +++ b/api_docs/kbn_core_ui_settings_server_internal.devdocs.json @@ -298,7 +298,15 @@ "section": "def-common.ObjectType", "text": "ObjectType" }, - "<{}>; }>" + "<{}>; publicApiEnabled: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.ConditionalType", + "text": "ConditionalType" + }, + "; }>" ], "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts", "deprecated": false, diff --git a/api_docs/kbn_core_ui_settings_server_internal.mdx b/api_docs/kbn_core_ui_settings_server_internal.mdx index 1527eee1a5ab3..22fa49b318d90 100644 --- a/api_docs/kbn_core_ui_settings_server_internal.mdx +++ b/api_docs/kbn_core_ui_settings_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server-internal title: "@kbn/core-ui-settings-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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 197fbf81d7eb7..373b288cc72fa 100644 --- a/api_docs/kbn_core_ui_settings_server_mocks.mdx +++ b/api_docs/kbn_core_ui_settings_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server-mocks title: "@kbn/core-ui-settings-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 b8ebf1dc853dc..2c59177c7b21d 100644 --- a/api_docs/kbn_core_usage_data_server.mdx +++ b/api_docs/kbn_core_usage_data_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server title: "@kbn/core-usage-data-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-usage-data-server plugin -date: 2023-06-30 +date: 2023-07-18 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 29af37cbe1019..d96001e8d4eaa 100644 --- a/api_docs/kbn_core_usage_data_server_internal.mdx +++ b/api_docs/kbn_core_usage_data_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server-internal title: "@kbn/core-usage-data-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-usage-data-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_core_usage_data_server_mocks.devdocs.json index 161e578a32ed5..b96ca62e45b33 100644 --- a/api_docs/kbn_core_usage_data_server_mocks.devdocs.json +++ b/api_docs/kbn_core_usage_data_server_mocks.devdocs.json @@ -101,39 +101,39 @@ "section": "def-common.CoreUsageStats", "text": "CoreUsageStats" }, - ">, []>; incrementSavedObjectsBulkCreate: jest.MockInstance, [options: ", + ">, [], unknown>; incrementSavedObjectsBulkCreate: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsBulkGet: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsBulkGet: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsBulkResolve: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsBulkResolve: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsBulkUpdate: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsBulkUpdate: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsBulkDelete: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsBulkDelete: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsCreate: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsCreate: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsDelete: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsDelete: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsFind: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsFind: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsGet: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsGet: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsResolve: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsResolve: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsUpdate: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsUpdate: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsImport: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsImport: jest.MockInstance, [options: ", "IncrementSavedObjectsImportOptions", - "]>; incrementSavedObjectsResolveImportErrors: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsResolveImportErrors: jest.MockInstance, [options: ", "IncrementSavedObjectsResolveImportErrorsOptions", - "]>; incrementSavedObjectsExport: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsExport: jest.MockInstance, [options: ", "IncrementSavedObjectsExportOptions", - "]>; incrementLegacyDashboardsImport: jest.MockInstance, [options: ", + "], unknown>; incrementLegacyDashboardsImport: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementLegacyDashboardsExport: jest.MockInstance, [options: ", + "], unknown>; incrementLegacyDashboardsExport: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; } & ", + "], unknown>; } & ", "ICoreUsageStatsClient" ], "path": "packages/core/usage-data/core-usage-data-server-mocks/src/core_usage_data_service.mock.ts", diff --git a/api_docs/kbn_core_usage_data_server_mocks.mdx b/api_docs/kbn_core_usage_data_server_mocks.mdx index 7f08c46084950..0fb8c70cd8d9f 100644 --- a/api_docs/kbn_core_usage_data_server_mocks.mdx +++ b/api_docs/kbn_core_usage_data_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server-mocks title: "@kbn/core-usage-data-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-usage-data-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server-mocks'] --- import kbnCoreUsageDataServerMocksObj from './kbn_core_usage_data_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_user_settings_server.mdx b/api_docs/kbn_core_user_settings_server.mdx index 5b45a9ecf9ee5..238ae61a501b0 100644 --- a/api_docs/kbn_core_user_settings_server.mdx +++ b/api_docs/kbn_core_user_settings_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-settings-server title: "@kbn/core-user-settings-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-settings-server plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-settings-server'] --- import kbnCoreUserSettingsServerObj from './kbn_core_user_settings_server.devdocs.json'; diff --git a/api_docs/kbn_core_user_settings_server_internal.mdx b/api_docs/kbn_core_user_settings_server_internal.mdx index 5f97644173576..c00c5fbd8cf13 100644 --- a/api_docs/kbn_core_user_settings_server_internal.mdx +++ b/api_docs/kbn_core_user_settings_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-settings-server-internal title: "@kbn/core-user-settings-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-settings-server-internal plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-settings-server-internal'] --- import kbnCoreUserSettingsServerInternalObj from './kbn_core_user_settings_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_user_settings_server_mocks.devdocs.json b/api_docs/kbn_core_user_settings_server_mocks.devdocs.json index 08b7ea7d803fe..3b10d96b110bf 100644 --- a/api_docs/kbn_core_user_settings_server_mocks.devdocs.json +++ b/api_docs/kbn_core_user_settings_server_mocks.devdocs.json @@ -66,7 +66,7 @@ "label": "createSetupContract", "description": [], "signature": [ - "() => { setUserProfileSettings: jest.Mock; getUserSettingDarkMode: jest.Mock; }" + "() => { setUserProfileSettings: jest.Mock; getUserSettingDarkMode: jest.Mock; }" ], "path": "packages/core/user-settings/core-user-settings-server-mocks/src/user_settings_service.mock.ts", "deprecated": false, diff --git a/api_docs/kbn_core_user_settings_server_mocks.mdx b/api_docs/kbn_core_user_settings_server_mocks.mdx index 050770ee7f4bf..8c31623fabfff 100644 --- a/api_docs/kbn_core_user_settings_server_mocks.mdx +++ b/api_docs/kbn_core_user_settings_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-settings-server-mocks title: "@kbn/core-user-settings-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-settings-server-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 91ac99d537313..b0a1de5b5af59 100644 --- a/api_docs/kbn_crypto.mdx +++ b/api_docs/kbn_crypto.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-crypto title: "@kbn/crypto" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/crypto plugin -date: 2023-06-30 +date: 2023-07-18 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 c7c180037c65a..8aec175e147d0 100644 --- a/api_docs/kbn_crypto_browser.mdx +++ b/api_docs/kbn_crypto_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-crypto-browser title: "@kbn/crypto-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/crypto-browser plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto-browser'] --- import kbnCryptoBrowserObj from './kbn_crypto_browser.devdocs.json'; diff --git a/api_docs/kbn_cypress_config.mdx b/api_docs/kbn_cypress_config.mdx index e6e7c8e90d2b6..fdfe2b09019e0 100644 --- a/api_docs/kbn_cypress_config.mdx +++ b/api_docs/kbn_cypress_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cypress-config title: "@kbn/cypress-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cypress-config plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cypress-config'] --- import kbnCypressConfigObj from './kbn_cypress_config.devdocs.json'; diff --git a/api_docs/kbn_data_service.mdx b/api_docs/kbn_data_service.mdx index 08c01439606dc..e56fb02b0c363 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: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/data-service'] --- import kbnDataServiceObj from './kbn_data_service.devdocs.json'; diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index ab7a457ca2973..145528d256c47 100644 --- a/api_docs/kbn_datemath.mdx +++ b/api_docs/kbn_datemath.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-datemath title: "@kbn/datemath" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/datemath plugin -date: 2023-06-30 +date: 2023-07-18 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 bc29e3db1a242..73b3d5b61c823 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: 2023-06-30 +date: 2023-07-18 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 746d744ec21e6..c2c616b165bc5 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: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-devtools'] --- import kbnDeeplinksDevtoolsObj from './kbn_deeplinks_devtools.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_management.devdocs.json b/api_docs/kbn_deeplinks_management.devdocs.json index 9132a4b8b3809..4d6cf71eb42eb 100644 --- a/api_docs/kbn_deeplinks_management.devdocs.json +++ b/api_docs/kbn_deeplinks_management.devdocs.json @@ -45,9 +45,7 @@ "label": "DeepLinkId", "description": [], "signature": [ - "IntegrationsDeepLinkId", - " | ", - "ManagementDeepLinkId" + "\"fleet\" | \"monitoring\" | \"management\" | \"integrations\" | \"osquery\" | \"management:transform\" | \"management:watcher\" | \"management:cases\" | \"management:tags\" | \"management:settings\" | \"management:dataViews\" | \"management:spaces\" | \"management:reporting\" | \"management:rollup_jobs\" | \"management:snapshot_restore\" | \"management:api_keys\" | \"management:cross_cluster_replication\" | \"management:index_lifecycle_management\" | \"management:index_management\" | \"management:ingest_pipelines\" | \"management:jobsListLink\" | \"management:objects\" | \"management:pipelines\" | \"management:remote_clusters\" | \"management:triggersActions\" | \"management:triggersActionsConnectors\"" ], "path": "packages/deeplinks/management/deep_links.ts", "deprecated": false, diff --git a/api_docs/kbn_deeplinks_management.mdx b/api_docs/kbn_deeplinks_management.mdx index 0805671dc905c..503876303ca6b 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: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-management'] --- import kbnDeeplinksManagementObj from './kbn_deeplinks_management.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/platform-deployment-management](https://github.com/orgs/elasti | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 4 | 0 | 4 | 2 | +| 4 | 0 | 4 | 0 | ## Common diff --git a/api_docs/kbn_deeplinks_ml.mdx b/api_docs/kbn_deeplinks_ml.mdx index ef8961d35cec1..5ca3ac071fc5a 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: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-ml'] --- import kbnDeeplinksMlObj from './kbn_deeplinks_ml.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_observability.devdocs.json b/api_docs/kbn_deeplinks_observability.devdocs.json index fbb81a96f0d22..51a50d02fa1b1 100644 --- a/api_docs/kbn_deeplinks_observability.devdocs.json +++ b/api_docs/kbn_deeplinks_observability.devdocs.json @@ -30,7 +30,7 @@ "label": "AppId", "description": [], "signature": [ - "\"apm\" | \"metrics\" | \"logs\" | \"observability-overview\" | \"observabilityOnboarding\"" + "\"metrics\" | \"apm\" | \"logs\" | \"observability-overview\" | \"observabilityOnboarding\"" ], "path": "packages/deeplinks/observability/deep_links.ts", "deprecated": false, diff --git a/api_docs/kbn_deeplinks_observability.mdx b/api_docs/kbn_deeplinks_observability.mdx index 5bb85866f3529..cf455bca54e38 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: 2023-06-30 +date: 2023-07-18 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 aa6ad4b0817db..8cac3543b1027 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: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-search'] --- import kbnDeeplinksSearchObj from './kbn_deeplinks_search.devdocs.json'; diff --git a/api_docs/kbn_default_nav_analytics.mdx b/api_docs/kbn_default_nav_analytics.mdx index 0fe33103acb2e..c72dd47253f74 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: 2023-06-30 +date: 2023-07-18 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 e9e9a3976b1b4..14eea9458925b 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: 2023-06-30 +date: 2023-07-18 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 06c7cd0227d3c..31f1489f110be 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: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_default_nav_ml.devdocs.json index 45e7eed780000..ef16da2dd9b34 100644 --- a/api_docs/kbn_default_nav_ml.devdocs.json +++ b/api_docs/kbn_default_nav_ml.devdocs.json @@ -175,7 +175,7 @@ "label": "children", "description": [], "signature": [ - "[{ title: string; id: \"root\"; children: [{ link: \"ml:overview\"; }, { link: \"ml:notifications\"; }]; }, { title: any; id: \"anomaly_detection\"; children: [{ title: any; link: \"ml:anomalyDetection\"; }, { link: \"ml:anomalyExplorer\"; }, { link: \"ml:singleMetricViewer\"; }, { link: \"ml:settings\"; }]; }, { id: \"data_frame_analytics\"; title: any; children: [{ title: string; link: \"ml:dataFrameAnalytics\"; }, { link: \"ml:resultExplorer\"; }, { link: \"ml:analyticsMap\"; }]; }, { id: \"model_management\"; title: any; children: [{ link: \"ml:nodesOverview\"; }, { link: \"ml:nodes\"; }]; }, { id: \"data_visualizer\"; title: any; children: [{ title: any; link: \"ml:fileUpload\"; }, { title: any; link: \"ml:indexDataVisualizer\"; }]; }, { id: \"aiops_labs\"; title: any; children: [{ title: any; link: \"ml:explainLogRateSpikes\"; }, { link: \"ml:logPatternAnalysis\"; }]; }]" + "[{ title: string; id: \"root\"; children: [{ link: \"ml:overview\"; }, { link: \"ml:notifications\"; }]; }, { title: any; id: \"anomaly_detection\"; children: [{ title: any; link: \"ml:anomalyDetection\"; }, { link: \"ml:anomalyExplorer\"; }, { link: \"ml:singleMetricViewer\"; }, { link: \"ml:settings\"; }]; }, { id: \"data_frame_analytics\"; title: any; children: [{ title: string; link: \"ml:dataFrameAnalytics\"; }, { link: \"ml:resultExplorer\"; }, { link: \"ml:analyticsMap\"; }]; }, { id: \"model_management\"; title: any; children: [{ link: \"ml:nodesOverview\"; }, { link: \"ml:nodes\"; }]; }, { id: \"data_visualizer\"; title: any; children: [{ title: any; link: \"ml:fileUpload\"; }, { title: any; link: \"ml:indexDataVisualizer\"; }]; }, { id: \"aiops_labs\"; title: any; children: [{ link: \"ml:explainLogRateSpikes\"; }, { link: \"ml:logPatternAnalysis\"; }, { link: \"ml:changePointDetections\"; }]; }]" ], "path": "packages/default-nav/ml/default_navigation.ts", "deprecated": false, diff --git a/api_docs/kbn_default_nav_ml.mdx b/api_docs/kbn_default_nav_ml.mdx index 1e0c9b2fbf3a5..435c434182642 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: 2023-06-30 +date: 2023-07-18 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 2c35736b115b5..9a446ec2f4266 100644 --- a/api_docs/kbn_dev_cli_errors.mdx +++ b/api_docs/kbn_dev_cli_errors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-errors title: "@kbn/dev-cli-errors" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-cli-errors plugin -date: 2023-06-30 +date: 2023-07-18 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 2c92f09a74ba5..108b57349a132 100644 --- a/api_docs/kbn_dev_cli_runner.mdx +++ b/api_docs/kbn_dev_cli_runner.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-runner title: "@kbn/dev-cli-runner" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-cli-runner plugin -date: 2023-06-30 +date: 2023-07-18 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 03f904c56b50f..17492c16f1e3a 100644 --- a/api_docs/kbn_dev_proc_runner.mdx +++ b/api_docs/kbn_dev_proc_runner.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-proc-runner title: "@kbn/dev-proc-runner" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-proc-runner plugin -date: 2023-06-30 +date: 2023-07-18 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 976f85187ad6f..2058fa074df2a 100644 --- a/api_docs/kbn_dev_utils.mdx +++ b/api_docs/kbn_dev_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-utils title: "@kbn/dev-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-utils plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] --- import kbnDevUtilsObj from './kbn_dev_utils.devdocs.json'; diff --git a/api_docs/kbn_doc_links.devdocs.json b/api_docs/kbn_doc_links.devdocs.json index 38e1fa294e145..5a252ff685400 100644 --- a/api_docs/kbn_doc_links.devdocs.json +++ b/api_docs/kbn_doc_links.devdocs.json @@ -300,7 +300,7 @@ "label": "enterpriseSearch", "description": [], "signature": [ - "{ readonly apiKeys: string; readonly behavioralAnalytics: string; readonly behavioralAnalyticsCORS: string; readonly behavioralAnalyticsEvents: string; readonly buildConnector: string; readonly bulkApi: string; readonly configuration: string; readonly connectors: string; readonly connectorsAzureBlobStorage: string; readonly connectorsClients: string; readonly connectorsConfluence: string; readonly connectorsContentExtraction: string; readonly connectorsDropbox: string; readonly connectorsGoogleCloudStorage: string; readonly connectorsJira: string; readonly connectorsMicrosoftSQL: string; readonly connectorsMongoDB: string; readonly connectorsMySQL: string; readonly connectorsNative: string; readonly connectorsNetworkDrive: string; readonly connectorsOracle: string; readonly connectorsPostgreSQL: string; readonly connectorsS3: string; readonly connectorsServiceNow: string; readonly connectorsSharepoint: string; readonly connectorsSharepointOnline: string; readonly connectorsWorkplaceSearch: string; readonly crawlerExtractionRules: string; readonly crawlerManaging: string; readonly crawlerOverview: string; readonly deployTrainedModels: string; readonly documentLevelSecurity: string; readonly elser: string; readonly engines: string; readonly esre: string; readonly esreFaq: string; readonly esreHelp: string; readonly esreLearn: string; readonly indexApi: string; readonly ingestionApis: string; readonly ingestPipelines: string; readonly knnSearch: string; readonly knnSearchCombine: string; readonly languageAnalyzers: string; readonly languageClients: string; readonly licenseManagement: string; readonly machineLearningStart: string; readonly mailService: string; readonly mlDocumentEnrichment: string; readonly searchApplicationsTemplates: string; readonly searchApplicationsSearchApi: string; readonly searchApplications: string; readonly searchApplicationsGettingStarted: string; readonly searchTemplates: string; readonly start: string; readonly supportedNlpModels: string; readonly syncRules: string; readonly trainedModels: string; readonly textEmbedding: string; readonly troubleshootSetup: string; readonly usersAccess: string; }" + "{ readonly apiKeys: string; readonly behavioralAnalytics: string; readonly behavioralAnalyticsCORS: string; readonly behavioralAnalyticsEvents: string; readonly buildConnector: string; readonly bulkApi: string; readonly configuration: string; readonly connectors: string; readonly connectorsAzureBlobStorage: string; readonly connectorsClients: string; readonly connectorsConfluence: string; readonly connectorsContentExtraction: string; readonly connectorsDropbox: string; readonly connectorsGoogleCloudStorage: string; readonly connectorsGoogleDrive: string; readonly connectorsJira: string; readonly connectorsMicrosoftSQL: string; readonly connectorsMongoDB: string; readonly connectorsMySQL: string; readonly connectorsNative: string; readonly connectorsNetworkDrive: string; readonly connectorsOracle: string; readonly connectorsPostgreSQL: string; readonly connectorsS3: string; readonly connectorsServiceNow: string; readonly connectorsSharepoint: string; readonly connectorsSharepointOnline: string; readonly connectorsWorkplaceSearch: string; readonly crawlerExtractionRules: string; readonly crawlerManaging: string; readonly crawlerOverview: string; readonly deployTrainedModels: string; readonly documentLevelSecurity: string; readonly elser: string; readonly engines: string; readonly esre: string; readonly esreFaq: string; readonly esreHelp: string; readonly esreLearn: string; readonly indexApi: string; readonly ingestionApis: string; readonly ingestPipelines: string; readonly knnSearch: string; readonly knnSearchCombine: string; readonly languageAnalyzers: string; readonly languageClients: string; readonly licenseManagement: string; readonly machineLearningStart: string; readonly mailService: string; readonly mlDocumentEnrichment: string; readonly searchApplicationsTemplates: string; readonly searchApplicationsSearchApi: string; readonly searchApplications: string; readonly searchApplicationsSearch: string; readonly searchTemplates: string; readonly start: string; readonly supportedNlpModels: string; readonly syncRules: string; readonly trainedModels: string; readonly textEmbedding: string; readonly troubleshootSetup: string; readonly usersAccess: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false, @@ -479,7 +479,7 @@ "label": "kibana", "description": [], "signature": [ - "{ readonly guide: string; readonly autocompleteSuggestions: string; readonly secureSavedObject: string; readonly xpackSecurity: string; }" + "{ readonly askElastic: string; readonly createGithubIssue: string; readonly feedback: string; readonly guide: string; readonly autocompleteSuggestions: string; readonly secureSavedObject: string; readonly xpackSecurity: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false, @@ -658,7 +658,7 @@ "label": "observability", "description": [], "signature": [ - "{ readonly guide: string; readonly infrastructureThreshold: string; readonly logsThreshold: string; readonly metricsThreshold: string; readonly threshold: string; readonly monitorStatus: string; readonly monitorUptime: string; readonly tlsCertificate: string; readonly uptimeDurationAnomaly: string; readonly monitorLogs: string; readonly analyzeMetrics: string; readonly monitorUptimeSynthetics: string; readonly userExperience: string; readonly createAlerts: string; readonly syntheticsCommandReference: string; readonly syntheticsProjectMonitors: string; readonly syntheticsMigrateFromIntegration: string; }" + "{ readonly guide: string; readonly infrastructureThreshold: string; readonly logsThreshold: string; readonly metricsThreshold: string; readonly threshold: string; readonly monitorStatus: string; readonly monitorUptime: string; readonly tlsCertificate: string; readonly uptimeDurationAnomaly: string; readonly monitorLogs: string; readonly analyzeMetrics: string; readonly monitorUptimeSynthetics: string; readonly userExperience: string; readonly createAlerts: string; readonly syntheticsCommandReference: string; readonly syntheticsProjectMonitors: string; readonly syntheticsMigrateFromIntegration: string; readonly sloBurnRateRule: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false, @@ -1008,6 +1008,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/doc-links", + "id": "def-common.DocLinksMeta.elasticGithubUrl", + "type": "string", + "tags": [], + "label": "elasticGithubUrl", + "description": [], + "path": "packages/kbn-doc-links/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/doc-links", "id": "def-common.DocLinksMeta.docsWebsiteUrl", diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index db9b6d0b85d0b..26bdea6148221 100644 --- a/api_docs/kbn_doc_links.mdx +++ b/api_docs/kbn_doc_links.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-doc-links title: "@kbn/doc-links" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/doc-links plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links'] --- import kbnDocLinksObj from './kbn_doc_links.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/docs](https://github.com/orgs/elastic/teams/docs) for question | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 71 | 0 | 71 | 2 | +| 72 | 0 | 72 | 2 | ## Common diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index f911e310903cc..2f53e5ec81609 100644 --- a/api_docs/kbn_docs_utils.mdx +++ b/api_docs/kbn_docs_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-docs-utils title: "@kbn/docs-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/docs-utils plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_dom_drag_drop.devdocs.json index d02552cab9614..cb21105a32b80 100644 --- a/api_docs/kbn_dom_drag_drop.devdocs.json +++ b/api_docs/kbn_dom_drag_drop.devdocs.json @@ -1,11 +1,27 @@ { "id": "@kbn/dom-drag-drop", "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.ChildDragDropProvider", + "id": "def-common.ChildDragDropProvider", "type": "Function", "tags": [], "label": "ChildDragDropProvider", @@ -13,7 +29,7 @@ "\nA React drag / drop provider that derives its state from a RootDragDropProvider. If\npart of a React application is rendered separately from the root, this provider can\nbe used to enable drag / drop functionality within the disconnected part.\n" ], "signature": [ - "({\n dragging,\n setDragging,\n setKeyboardMode,\n keyboardMode,\n activeDropTarget,\n setActiveDropTarget,\n setA11yMessage,\n registerDropTarget,\n dropTargetsByOrder,\n dataTestSubjPrefix,\n onTrackUICounterEvent,\n children,\n}: ", + "({ value, children }: ", "ProviderProps", ") => JSX.Element" ], @@ -23,10 +39,10 @@ "children": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.ChildDragDropProvider.$1", + "id": "def-common.ChildDragDropProvider.$1", "type": "Object", "tags": [], - "label": "{\n dragging,\n setDragging,\n setKeyboardMode,\n keyboardMode,\n activeDropTarget,\n setActiveDropTarget,\n setA11yMessage,\n registerDropTarget,\n dropTargetsByOrder,\n dataTestSubjPrefix,\n onTrackUICounterEvent,\n children,\n}", + "label": "{ value, children }", "description": [], "signature": [ "ProviderProps" @@ -42,7 +58,7 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragDrop", + "id": "def-common.DragDrop", "type": "Function", "tags": [ "constructor" @@ -60,7 +76,7 @@ "children": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragDrop.$1", + "id": "def-common.DragDrop.$1", "type": "Object", "tags": [], "label": "props", @@ -79,7 +95,7 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropOverlayWrapper", + "id": "def-common.DropOverlayWrapper", "type": "Function", "tags": [ "constructor" @@ -92,9 +108,9 @@ "({ isVisible, children, overlayProps, className, ...otherProps }: React.PropsWithChildren<", { "pluginId": "@kbn/dom-drag-drop", - "scope": "public", + "scope": "common", "docId": "kibKbnDomDragDropPluginApi", - "section": "def-public.DropOverlayWrapperProps", + "section": "def-common.DropOverlayWrapperProps", "text": "DropOverlayWrapperProps" }, ">) => JSX.Element" @@ -105,7 +121,7 @@ "children": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropOverlayWrapper.$1", + "id": "def-common.DropOverlayWrapper.$1", "type": "CompoundType", "tags": [], "label": "{\n isVisible,\n children,\n overlayProps,\n className,\n ...otherProps\n}", @@ -114,9 +130,9 @@ "React.PropsWithChildren<", { "pluginId": "@kbn/dom-drag-drop", - "scope": "public", + "scope": "common", "docId": "kibKbnDomDragDropPluginApi", - "section": "def-public.DropOverlayWrapperProps", + "section": "def-common.DropOverlayWrapperProps", "text": "DropOverlayWrapperProps" }, ">" @@ -132,17 +148,13 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.ReorderProvider", + "id": "def-common.ReorderProvider", "type": "Function", - "tags": [ - "constructor" - ], + "tags": [], "label": "ReorderProvider", - "description": [ - "\nTo create a reordering group, surround the elements from the same group with a `ReorderProvider`" - ], + "description": [], "signature": [ - "({\n id,\n children,\n className,\n draggingHeight = REORDER_ITEM_HEIGHT,\n dataTestSubj = DEFAULT_DATA_TEST_SUBJ,\n}: { id: string; children: React.ReactNode; className?: string | undefined; draggingHeight?: number | undefined; dataTestSubj?: string | undefined; }) => JSX.Element" + "({\n children,\n className,\n dataTestSubj = DEFAULT_DATA_TEST_SUBJ,\n}: { children: React.ReactNode; className?: string | undefined; dataTestSubj?: string | undefined; }) => JSX.Element" ], "path": "packages/kbn-dom-drag-drop/src/providers/reorder_provider.tsx", "deprecated": false, @@ -150,10 +162,10 @@ "children": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.ReorderProvider.$1", + "id": "def-common.ReorderProvider.$1", "type": "Object", "tags": [], - "label": "{\n id,\n children,\n className,\n draggingHeight = REORDER_ITEM_HEIGHT,\n dataTestSubj = DEFAULT_DATA_TEST_SUBJ,\n}", + "label": "{\n children,\n className,\n dataTestSubj = DEFAULT_DATA_TEST_SUBJ,\n}", "description": [], "path": "packages/kbn-dom-drag-drop/src/providers/reorder_provider.tsx", "deprecated": false, @@ -161,18 +173,7 @@ "children": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.ReorderProvider.$1.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "packages/kbn-dom-drag-drop/src/providers/reorder_provider.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.ReorderProvider.$1.children", + "id": "def-common.ReorderProvider.$1.children", "type": "CompoundType", "tags": [], "label": "children", @@ -186,7 +187,7 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.ReorderProvider.$1.className", + "id": "def-common.ReorderProvider.$1.className", "type": "string", "tags": [], "label": "className", @@ -200,21 +201,7 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.ReorderProvider.$1.draggingHeight", - "type": "number", - "tags": [], - "label": "draggingHeight", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/reorder_provider.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.ReorderProvider.$1.dataTestSubj", + "id": "def-common.ReorderProvider.$1.dataTestSubj", "type": "string", "tags": [], "label": "dataTestSubj", @@ -234,15 +221,15 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.RootDragDropProvider", + "id": "def-common.RootDragDropProvider", "type": "Function", "tags": [], "label": "RootDragDropProvider", - "description": [ - "\nA React provider that tracks the dragging state. This should\nbe placed at the root of any React application that supports\ndrag / drop.\n" - ], + "description": [], "signature": [ - "({\n children,\n dataTestSubj = DEFAULT_DATA_TEST_SUBJ,\n onTrackUICounterEvent,\n}: { children: React.ReactNode; dataTestSubj?: string | undefined; onTrackUICounterEvent?: ((event: string) => void) | undefined; }) => JSX.Element" + "({\n children,\n dataTestSubj = DEFAULT_DATA_TEST_SUBJ,\n customMiddleware,\n}: { children: React.ReactNode; dataTestSubj?: string | undefined; customMiddleware?: ", + "CustomMiddleware", + " | undefined; }) => JSX.Element" ], "path": "packages/kbn-dom-drag-drop/src/providers/providers.tsx", "deprecated": false, @@ -250,10 +237,10 @@ "children": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.RootDragDropProvider.$1", + "id": "def-common.RootDragDropProvider.$1", "type": "Object", "tags": [], - "label": "{\n children,\n dataTestSubj = DEFAULT_DATA_TEST_SUBJ,\n onTrackUICounterEvent,\n}", + "label": "{\n children,\n dataTestSubj = DEFAULT_DATA_TEST_SUBJ,\n customMiddleware,\n}", "description": [], "path": "packages/kbn-dom-drag-drop/src/providers/providers.tsx", "deprecated": false, @@ -261,7 +248,7 @@ "children": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.RootDragDropProvider.$1.children", + "id": "def-common.RootDragDropProvider.$1.children", "type": "CompoundType", "tags": [], "label": "children", @@ -275,7 +262,7 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.RootDragDropProvider.$1.dataTestSubj", + "id": "def-common.RootDragDropProvider.$1.dataTestSubj", "type": "string", "tags": [], "label": "dataTestSubj", @@ -289,13 +276,14 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.RootDragDropProvider.$1.onTrackUICounterEvent", + "id": "def-common.RootDragDropProvider.$1.customMiddleware", "type": "Function", "tags": [], - "label": "onTrackUICounterEvent", + "label": "customMiddleware", "description": [], "signature": [ - "((event: string) => void) | undefined" + "CustomMiddleware", + " | undefined" ], "path": "packages/kbn-dom-drag-drop/src/providers/providers.tsx", "deprecated": false, @@ -306,25 +294,47 @@ ], "returnComment": [], "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dom-drag-drop", + "id": "def-common.useDragDropContext", + "type": "Function", + "tags": [], + "label": "useDragDropContext", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "@kbn/dom-drag-drop", + "scope": "common", + "docId": "kibKbnDomDragDropPluginApi", + "section": "def-common.DragContextValue", + "text": "DragContextValue" + } + ], + "path": "packages/kbn-dom-drag-drop/src/providers/providers.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [], + "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState", + "id": "def-common.DragContextState", "type": "Interface", "tags": [], "label": "DragContextState", - "description": [ - "\nThe shape of the drag / drop context." - ], + "description": [], "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.dragging", + "id": "def-common.DragContextState.dragging", "type": "CompoundType", "tags": [], "label": "dragging", @@ -334,9 +344,9 @@ "signature": [ { "pluginId": "@kbn/dom-drag-drop", - "scope": "public", + "scope": "common", "docId": "kibKbnDomDragDropPluginApi", - "section": "def-public.DraggingIdentifier", + "section": "def-common.DraggingIdentifier", "text": "DraggingIdentifier" }, " | undefined" @@ -347,7 +357,7 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.keyboardMode", + "id": "def-common.DragContextState.keyboardMode", "type": "boolean", "tags": [], "label": "keyboardMode", @@ -360,94 +370,13 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.setKeyboardMode", - "type": "Function", - "tags": [], - "label": "setKeyboardMode", - "description": [ - "\nkeyboard mode" - ], - "signature": [ - "(mode: boolean) => void" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.setKeyboardMode.$1", - "type": "boolean", - "tags": [], - "label": "mode", - "description": [], - "signature": [ - "boolean" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.setDragging", - "type": "Function", - "tags": [], - "label": "setDragging", - "description": [ - "\nSet the item being dragged." - ], - "signature": [ - "(dragging?: ", - { - "pluginId": "@kbn/dom-drag-drop", - "scope": "public", - "docId": "kibKbnDomDragDropPluginApi", - "section": "def-public.DraggingIdentifier", - "text": "DraggingIdentifier" - }, - " | undefined) => void" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.setDragging.$1", - "type": "CompoundType", - "tags": [], - "label": "dragging", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dom-drag-drop", - "scope": "public", - "docId": "kibKbnDomDragDropPluginApi", - "section": "def-public.DraggingIdentifier", - "text": "DraggingIdentifier" - }, - " | undefined" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.activeDropTarget", + "id": "def-common.DragContextState.activeDropTarget", "type": "CompoundType", "tags": [], "label": "activeDropTarget", - "description": [], + "description": [ + "\ncurrently selected drop target" + ], "signature": [ "DropIdentifier", " | undefined" @@ -458,11 +387,13 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.dropTargetsByOrder", + "id": "def-common.DragContextState.dropTargetsByOrder", "type": "Object", "tags": [], "label": "dropTargetsByOrder", - "description": [], + "description": [ + "\ncurrently registered drop targets" + ], "signature": [ "Record void" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.setActiveDropTarget.$1", - "type": "CompoundType", - "tags": [], - "label": "newTarget", - "description": [], - "signature": [ - "DropIdentifier", - " | undefined" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.setA11yMessage", - "type": "Function", - "tags": [], - "label": "setA11yMessage", - "description": [], - "signature": [ - "(message: string) => void" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.setA11yMessage.$1", - "type": "string", - "tags": [], - "label": "message", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.registerDropTarget", - "type": "Function", - "tags": [], - "label": "registerDropTarget", - "description": [], - "signature": [ - "(order: number[], dropTarget?: ", - "DropIdentifier", - " | undefined) => void" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.registerDropTarget.$1", - "type": "Array", - "tags": [], - "label": "order", - "description": [], - "signature": [ - "number[]" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.registerDropTarget.$2", - "type": "CompoundType", - "tags": [], - "label": "dropTarget", - "description": [], - "signature": [ - "DropIdentifier", - " | undefined" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.dataTestSubjPrefix", + "id": "def-common.DragContextState.dataTestSubjPrefix", "type": "string", "tags": [], "label": "dataTestSubjPrefix", @@ -601,47 +415,13 @@ "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", "deprecated": false, "trackAdoption": false - }, - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.onTrackUICounterEvent", - "type": "Function", - "tags": [], - "label": "onTrackUICounterEvent", - "description": [ - "\nA custom callback for telemetry" - ], - "signature": [ - "((event: string) => void) | undefined" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContextState.onTrackUICounterEvent.$1", - "type": "string", - "tags": [], - "label": "event", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropOverlayWrapperProps", + "id": "def-common.DropOverlayWrapperProps", "type": "Interface", "tags": [], "label": "DropOverlayWrapperProps", @@ -654,7 +434,7 @@ "children": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropOverlayWrapperProps.isVisible", + "id": "def-common.DropOverlayWrapperProps.isVisible", "type": "boolean", "tags": [], "label": "isVisible", @@ -665,7 +445,7 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropOverlayWrapperProps.className", + "id": "def-common.DropOverlayWrapperProps.className", "type": "string", "tags": [], "label": "className", @@ -679,7 +459,7 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropOverlayWrapperProps.overlayProps", + "id": "def-common.DropOverlayWrapperProps.overlayProps", "type": "Uncategorized", "tags": [], "label": "overlayProps", @@ -699,7 +479,55 @@ "misc": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragDropIdentifier", + "id": "def-common.DragContextValue", + "type": "Type", + "tags": [], + "label": "DragContextValue", + "description": [], + "signature": [ + "[state: ", + { + "pluginId": "@kbn/dom-drag-drop", + "scope": "common", + "docId": "kibKbnDomDragDropPluginApi", + "section": "def-common.DragContextState", + "text": "DragContextState" + }, + ", dispatch: React.Dispatch<", + { + "pluginId": "@kbn/dom-drag-drop", + "scope": "common", + "docId": "kibKbnDomDragDropPluginApi", + "section": "def-common.DragDropAction", + "text": "DragDropAction" + }, + ">, customMiddleware?: ", + "CustomMiddleware", + " | undefined]" + ], + "path": "packages/kbn-dom-drag-drop/src/providers/types.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dom-drag-drop", + "id": "def-common.DragDropAction", + "type": "Type", + "tags": [], + "label": "DragDropAction", + "description": [], + "signature": [ + "ResetStateAction | RegisterDropTargetAction | LeaveDropTargetAction | SelectDropTargetAction | DragToTargetAction | StartDraggingAction | EndDraggingAction" + ], + "path": "packages/kbn-dom-drag-drop/src/providers/providers.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dom-drag-drop", + "id": "def-common.DragDropIdentifier", "type": "Type", "tags": [], "label": "DragDropIdentifier", @@ -718,7 +546,7 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DraggingIdentifier", + "id": "def-common.DraggingIdentifier", "type": "Type", "tags": [], "label": "DraggingIdentifier", @@ -739,7 +567,7 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropType", + "id": "def-common.DropType", "type": "Type", "tags": [], "label": "DropType", @@ -758,32 +586,7 @@ "objects": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DragContext", - "type": "Object", - "tags": [], - "label": "DragContext", - "description": [ - "\nThe drag / drop context singleton, used like so:\n\nconst { dragging, setDragging } = useContext(DragContext);" - ], - "signature": [ - "React.Context<", - { - "pluginId": "@kbn/dom-drag-drop", - "scope": "public", - "docId": "kibKbnDomDragDropPluginApi", - "section": "def-public.DragContextState", - "text": "DragContextState" - }, - ">" - ], - "path": "packages/kbn-dom-drag-drop/src/providers/providers.tsx", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropTargetSwapDuplicateCombine", + "id": "def-common.DropTargetSwapDuplicateCombine", "type": "Object", "tags": [], "label": "DropTargetSwapDuplicateCombine", @@ -796,7 +599,7 @@ "children": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropTargetSwapDuplicateCombine.getCustomDropTarget", + "id": "def-common.DropTargetSwapDuplicateCombine.getCustomDropTarget", "type": "Function", "tags": [], "label": "getCustomDropTarget", @@ -805,9 +608,9 @@ "(dropType: ", { "pluginId": "@kbn/dom-drag-drop", - "scope": "public", + "scope": "common", "docId": "kibKbnDomDragDropPluginApi", - "section": "def-public.DropType", + "section": "def-common.DropType", "text": "DropType" }, ") => React.ReactElement> | null" @@ -819,7 +622,7 @@ "children": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropTargetSwapDuplicateCombine.getCustomDropTarget.$1", + "id": "def-common.DropTargetSwapDuplicateCombine.getCustomDropTarget.$1", "type": "CompoundType", "tags": [], "label": "dropType", @@ -835,7 +638,7 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropTargetSwapDuplicateCombine.getAdditionalClassesOnDroppable", + "id": "def-common.DropTargetSwapDuplicateCombine.getAdditionalClassesOnDroppable", "type": "Function", "tags": [], "label": "getAdditionalClassesOnDroppable", @@ -850,7 +653,7 @@ "children": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropTargetSwapDuplicateCombine.getAdditionalClassesOnDroppable.$1", + "id": "def-common.DropTargetSwapDuplicateCombine.getAdditionalClassesOnDroppable.$1", "type": "string", "tags": [], "label": "dropType", @@ -866,7 +669,7 @@ }, { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropTargetSwapDuplicateCombine.getAdditionalClassesOnEnter", + "id": "def-common.DropTargetSwapDuplicateCombine.getAdditionalClassesOnEnter", "type": "Function", "tags": [], "label": "getAdditionalClassesOnEnter", @@ -881,7 +684,7 @@ "children": [ { "parentPluginId": "@kbn/dom-drag-drop", - "id": "def-public.DropTargetSwapDuplicateCombine.getAdditionalClassesOnEnter.$1", + "id": "def-common.DropTargetSwapDuplicateCombine.getAdditionalClassesOnEnter.$1", "type": "string", "tags": [], "label": "dropType", @@ -899,21 +702,5 @@ "initialIsOpen": false } ] - }, - "server": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_dom_drag_drop.mdx b/api_docs/kbn_dom_drag_drop.mdx index e01a14c6c1ec2..3f9fc374ccc2a 100644 --- a/api_docs/kbn_dom_drag_drop.mdx +++ b/api_docs/kbn_dom_drag_drop.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dom-drag-drop title: "@kbn/dom-drag-drop" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dom-drag-drop plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dom-drag-drop'] --- import kbnDomDragDropObj from './kbn_dom_drag_drop.devdocs.json'; @@ -21,19 +21,19 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 52 | 0 | 34 | 4 | +| 39 | 0 | 26 | 5 | -## Client +## Common ### Objects - + ### Functions - + ### Interfaces - + ### Consts, variables and types - + diff --git a/api_docs/kbn_ebt_tools.mdx b/api_docs/kbn_ebt_tools.mdx index aa6acb99d617a..d27e70f7d915c 100644 --- a/api_docs/kbn_ebt_tools.mdx +++ b/api_docs/kbn_ebt_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ebt-tools title: "@kbn/ebt-tools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ebt-tools plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ebt-tools'] --- import kbnEbtToolsObj from './kbn_ebt_tools.devdocs.json'; diff --git a/api_docs/kbn_ecs.mdx b/api_docs/kbn_ecs.mdx index 635d7c5314ee4..4522207aceb37 100644 --- a/api_docs/kbn_ecs.mdx +++ b/api_docs/kbn_ecs.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ecs title: "@kbn/ecs" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ecs plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ecs'] --- import kbnEcsObj from './kbn_ecs.devdocs.json'; diff --git a/api_docs/kbn_ecs_data_quality_dashboard.mdx b/api_docs/kbn_ecs_data_quality_dashboard.mdx index 69a8ef8bcb216..0939eacafac3f 100644 --- a/api_docs/kbn_ecs_data_quality_dashboard.mdx +++ b/api_docs/kbn_ecs_data_quality_dashboard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ecs-data-quality-dashboard title: "@kbn/ecs-data-quality-dashboard" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ecs-data-quality-dashboard plugin -date: 2023-06-30 +date: 2023-07-18 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_assistant.devdocs.json b/api_docs/kbn_elastic_assistant.devdocs.json index 7e9042123f6a9..8e4208cecb509 100644 --- a/api_docs/kbn_elastic_assistant.devdocs.json +++ b/api_docs/kbn_elastic_assistant.devdocs.json @@ -90,7 +90,7 @@ "\nModal container for Elastic AI Assistant conversations, receiving the page contents as context, plus whatever\ncomponent currently has focus and any specific context it may provide through the SAssInterface." ], "signature": [ - "React.FunctionComponent<{}>" + "React.NamedExoticComponent" ], "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/assistant_overlay/index.tsx", "deprecated": false, @@ -100,26 +100,12 @@ { "parentPluginId": "@kbn/elastic-assistant", "id": "def-public.AssistantOverlay.$1", - "type": "CompoundType", + "type": "Uncategorized", "tags": [], "label": "props", "description": [], "signature": [ - "P & { children?: React.ReactNode; }" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.AssistantOverlay.$2", - "type": "Any", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "any" + "P" ], "path": "node_modules/@types/react/index.d.ts", "deprecated": false, @@ -136,7 +122,7 @@ "label": "AssistantProvider", "description": [], "signature": [ - "({ actionTypeRegistry, augmentMessageCodeBlocks, baseAllow, baseAllowReplacement, defaultAllow, defaultAllowReplacement, basePromptContexts, baseQuickPrompts, baseSystemPrompts, children, getComments, http, getInitialConversations, nameSpace, setConversations, setDefaultAllow, setDefaultAllowReplacement, title, }: React.PropsWithChildren) => JSX.Element" + "({ actionTypeRegistry, augmentMessageCodeBlocks, baseAllow, baseAllowReplacement, defaultAllow, defaultAllowReplacement, docLinks, basePromptContexts, baseQuickPrompts, baseSystemPrompts, children, getComments, http, getInitialConversations, nameSpace, setConversations, setDefaultAllow, setDefaultAllowReplacement, title, }: React.PropsWithChildren) => JSX.Element" ], "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant_context/index.tsx", "deprecated": false, @@ -147,7 +133,7 @@ "id": "def-public.AssistantProvider.$1", "type": "CompoundType", "tags": [], - "label": "{\n actionTypeRegistry,\n augmentMessageCodeBlocks,\n baseAllow,\n baseAllowReplacement,\n defaultAllow,\n defaultAllowReplacement,\n basePromptContexts = [],\n baseQuickPrompts = [],\n baseSystemPrompts = BASE_SYSTEM_PROMPTS,\n children,\n getComments,\n http,\n getInitialConversations,\n nameSpace = DEFAULT_ASSISTANT_NAMESPACE,\n setConversations,\n setDefaultAllow,\n setDefaultAllowReplacement,\n title = DEFAULT_ASSISTANT_TITLE,\n}", + "label": "{\n actionTypeRegistry,\n augmentMessageCodeBlocks,\n baseAllow,\n baseAllowReplacement,\n defaultAllow,\n defaultAllowReplacement,\n docLinks,\n basePromptContexts = [],\n baseQuickPrompts = [],\n baseSystemPrompts = BASE_SYSTEM_PROMPTS,\n children,\n getComments,\n http,\n getInitialConversations,\n nameSpace = DEFAULT_ASSISTANT_NAMESPACE,\n setConversations,\n setDefaultAllow,\n setDefaultAllowReplacement,\n title = DEFAULT_ASSISTANT_TITLE,\n}", "description": [], "signature": [ "React.PropsWithChildren" @@ -379,7 +365,7 @@ "label": "type", "description": [], "signature": [ - "\"eql\" | \"json\" | \"kql\" | \"dsl\" | \"no-type\"" + "\"eql\" | \"kql\" | \"dsl\" | \"json\" | \"no-type\"" ], "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/helpers.ts", "deprecated": false, @@ -420,17 +406,19 @@ }, { "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.CodeBlockDetails.controlContainer", - "type": "CompoundType", + "id": "def-public.CodeBlockDetails.getControlContainer", + "type": "Function", "tags": [], - "label": "controlContainer", + "label": "getControlContainer", "description": [], "signature": [ - "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" + "(() => Element | undefined) | undefined" ], "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/helpers.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "@kbn/elastic-assistant", @@ -470,17 +458,9 @@ "label": "apiConfig", "description": [], "signature": [ - "{ connectorId?: string | undefined; defaultSystemPrompt?: ", - { - "pluginId": "@kbn/elastic-assistant", - "scope": "public", - "docId": "kibKbnElasticAssistantPluginApi", - "section": "def-public.Prompt", - "text": "Prompt" - }, - " | undefined; provider?: ", + "{ connectorId?: string | undefined; defaultSystemPromptId?: string | undefined; provider?: ", "OpenAiProviderType", - " | undefined; }" + " | undefined; model?: string | undefined; }" ], "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant_context/types.tsx", "deprecated": false, @@ -560,6 +540,20 @@ "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant_context/types.tsx", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "@kbn/elastic-assistant", + "id": "def-public.Conversation.excludeFromLastConversationStorage", + "type": "CompoundType", + "tags": [], + "label": "excludeFromLastConversationStorage", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant_context/types.tsx", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -903,6 +897,21 @@ ], "enums": [], "misc": [ + { + "parentPluginId": "@kbn/elastic-assistant", + "id": "def-public.ELASTIC_AI_ASSISTANT_TITLE", + "type": "Any", + "tags": [], + "label": "ELASTIC_AI_ASSISTANT_TITLE", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/translations.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/elastic-assistant", "id": "def-public.PromptContextTemplate", @@ -928,298 +937,30 @@ "label": "QueryType", "description": [], "signature": [ - "\"eql\" | \"json\" | \"kql\" | \"dsl\" | \"no-type\"" + "\"eql\" | \"kql\" | \"dsl\" | \"json\" | \"no-type\"" ], "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/helpers.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false - } - ], - "objects": [ + }, { "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS", - "type": "Object", + "id": "def-public.WELCOME_CONVERSATION_TITLE", + "type": "Any", "tags": [], - "label": "BASE_CONVERSATIONS", + "label": "WELCOME_CONVERSATION_TITLE", "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", + "signature": [ + "any" + ], + "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/translations.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.DEFAULT_CONVERSATION_TITLE", - "type": "Object", - "tags": [], - "label": "[DEFAULT_CONVERSATION_TITLE]", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.DEFAULT_CONVERSATION_TITLE.id", - "type": "Any", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.DEFAULT_CONVERSATION_TITLE.messages", - "type": "Array", - "tags": [], - "label": "messages", - "description": [], - "signature": [ - "({ role: \"user\"; content: string; timestamp: string; } | { role: \"assistant\"; content: string; timestamp: string; })[]" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.DEFAULT_CONVERSATION_TITLE.apiConfig", - "type": "Object", - "tags": [], - "label": "apiConfig", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [] - } - ] - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.timeline", - "type": "Object", - "tags": [], - "label": "timeline", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.timeline.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.timeline.messages", - "type": "Array", - "tags": [], - "label": "messages", - "description": [], - "signature": [ - "never[]" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.timeline.apiConfig", - "type": "Object", - "tags": [], - "label": "apiConfig", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [] - } - ] - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE", - "type": "Object", - "tags": [], - "label": "[WELCOME_CONVERSATION_TITLE]", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.id", - "type": "Any", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme", - "type": "Object", - "tags": [], - "label": "theme", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.title", - "type": "Any", - "tags": [], - "label": "title", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.titleIcon", - "type": "string", - "tags": [], - "label": "titleIcon", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.assistant", - "type": "Object", - "tags": [], - "label": "assistant", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.assistant.name", - "type": "Any", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.assistant.icon", - "type": "string", - "tags": [], - "label": "icon", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - } - ] - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.system", - "type": "Object", - "tags": [], - "label": "system", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.system.icon", - "type": "string", - "tags": [], - "label": "icon", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - } - ] - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.user", - "type": "Object", - "tags": [], - "label": "user", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [] - } - ] - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.messages", - "type": "Array", - "tags": [], - "label": "messages", - "description": [], - "signature": [ - "{ role: \"assistant\"; content: any; timestamp: string; presentation: { delay: number; stream: true; }; }[]" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.apiConfig", - "type": "Object", - "tags": [], - "label": "apiConfig", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [] - } - ] - } - ], "initialIsOpen": false } - ] + ], + "objects": [] }, "server": { "classes": [], diff --git a/api_docs/kbn_elastic_assistant.mdx b/api_docs/kbn_elastic_assistant.mdx index 76d40eae7cbe4..c094e420ac63c 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: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/elastic-assistant'] --- import kbnElasticAssistantObj from './kbn_elastic_assistant.devdocs.json'; @@ -21,13 +21,10 @@ Contact [@elastic/security-solution](https://github.com/orgs/elastic/teams/secur | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 84 | 4 | 64 | 3 | +| 64 | 2 | 45 | 3 | ## Client -### Objects - - ### Functions diff --git a/api_docs/kbn_es.mdx b/api_docs/kbn_es.mdx index 8f5a641fc5a37..8cd3319d0a144 100644 --- a/api_docs/kbn_es.mdx +++ b/api_docs/kbn_es.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es title: "@kbn/es" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es plugin -date: 2023-06-30 +date: 2023-07-18 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 62b55c2cbe6ea..27a3e80c9a301 100644 --- a/api_docs/kbn_es_archiver.mdx +++ b/api_docs/kbn_es_archiver.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-archiver title: "@kbn/es-archiver" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-archiver plugin -date: 2023-06-30 +date: 2023-07-18 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 b542ac4590921..917c281115ca9 100644 --- a/api_docs/kbn_es_errors.mdx +++ b/api_docs/kbn_es_errors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-errors title: "@kbn/es-errors" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-errors plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-errors'] --- import kbnEsErrorsObj from './kbn_es_errors.devdocs.json'; diff --git a/api_docs/kbn_es_query.devdocs.json b/api_docs/kbn_es_query.devdocs.json index 5155512ed1399..bc53217d27e65 100644 --- a/api_docs/kbn_es_query.devdocs.json +++ b/api_docs/kbn_es_query.devdocs.json @@ -4036,6 +4036,55 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.toKqlExpression", + "type": "Function", + "tags": [], + "label": "toKqlExpression", + "description": [ + "\nGiven a KQL AST node, generate the corresponding KQL expression." + ], + "signature": [ + "(node: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + }, + ") => string" + ], + "path": "packages/kbn-es-query/src/kuery/ast/ast.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.toKqlExpression.$1", + "type": "Object", + "tags": [], + "label": "node", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + } + ], + "path": "packages/kbn-es-query/src/kuery/ast/ast.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/es-query", "id": "def-common.uniqFilters", @@ -4243,6 +4292,8 @@ "FilterMetaParams", " | undefined; from?: string | number | undefined; to?: string | number | undefined; gt?: string | number | undefined; lt?: string | number | undefined; gte?: string | number | undefined; lte?: string | number | undefined; format?: string | undefined; } | { query: ", "FilterMetaParams", + " | undefined; length: number; toString(): string; toLocaleString(): string; pop(): number | undefined; push(...items: number[]): number; concat(...items: ConcatArray[]): number[]; concat(...items: (number | ConcatArray)[]): number[]; join(separator?: string | undefined): string; reverse(): number[]; shift(): number | undefined; slice(start?: number | undefined, end?: number | undefined): number[]; sort(compareFn?: ((a: number, b: number) => number) | undefined): number[]; splice(start: number, deleteCount?: number | undefined): number[]; splice(start: number, deleteCount: number, ...items: number[]): number[]; unshift(...items: number[]): number; indexOf(searchElement: number, fromIndex?: number | undefined): number; lastIndexOf(searchElement: number, fromIndex?: number | undefined): number; every(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): this is S[]; every(predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): boolean; some(predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): boolean; forEach(callbackfn: (value: number, index: number, array: number[]) => void, thisArg?: any): void; map(callbackfn: (value: number, index: number, array: number[]) => U, thisArg?: any): U[]; filter(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): S[]; filter(predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): number[]; reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; reduce(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; reduceRight(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; find(predicate: (this: void, value: number, index: number, obj: number[]) => value is S, thisArg?: any): S | undefined; find(predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any): number | undefined; findIndex(predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any): number; fill(value: number, start?: number | undefined, end?: number | undefined): number[]; copyWithin(target: number, start: number, end?: number | undefined): number[]; entries(): IterableIterator<[number, number]>; keys(): IterableIterator; values(): IterableIterator; includes(searchElement: number, fromIndex?: number | undefined): boolean; flatMap(callback: (this: This, value: number, index: number, array: number[]) => U | readonly U[], thisArg?: This | undefined): U[]; flat(this: A, depth?: D | undefined): FlatArray[]; [Symbol.iterator](): IterableIterator; [Symbol.unscopables](): { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }; at(index: number): number | undefined; } | { query: ", + "FilterMetaParams", " | undefined; $state?: { store: ", { "pluginId": "@kbn/es-query", @@ -4261,8 +4312,6 @@ }, "; } | { query: ", "FilterMetaParams", - " | undefined; length: number; toString(): string; toLocaleString(): string; pop(): number | undefined; push(...items: number[]): number; concat(...items: ConcatArray[]): number[]; concat(...items: (number | ConcatArray)[]): number[]; join(separator?: string | undefined): string; reverse(): number[]; shift(): number | undefined; slice(start?: number | undefined, end?: number | undefined): number[]; sort(compareFn?: ((a: number, b: number) => number) | undefined): number[]; splice(start: number, deleteCount?: number | undefined): number[]; splice(start: number, deleteCount: number, ...items: number[]): number[]; unshift(...items: number[]): number; indexOf(searchElement: number, fromIndex?: number | undefined): number; lastIndexOf(searchElement: number, fromIndex?: number | undefined): number; every(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): this is S[]; every(predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): boolean; some(predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): boolean; forEach(callbackfn: (value: number, index: number, array: number[]) => void, thisArg?: any): void; map(callbackfn: (value: number, index: number, array: number[]) => U, thisArg?: any): U[]; filter(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): S[]; filter(predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): number[]; reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; reduce(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; reduceRight(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; find(predicate: (this: void, value: number, index: number, obj: number[]) => value is S, thisArg?: any): S | undefined; find(predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any): number | undefined; findIndex(predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any): number; fill(value: number, start?: number | undefined, end?: number | undefined): number[]; copyWithin(target: number, start: number, end?: number | undefined): number[]; entries(): IterableIterator<[number, number]>; keys(): IterableIterator; values(): IterableIterator; includes(searchElement: number, fromIndex?: number | undefined): boolean; flatMap(callback: (this: This, value: number, index: number, array: number[]) => U | readonly U[], thisArg?: This | undefined): U[]; flat(this: A, depth?: D | undefined): FlatArray[]; [Symbol.iterator](): IterableIterator; [Symbol.unscopables](): { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }; at(index: number): number | undefined; } | { query: ", - "FilterMetaParams", " | undefined; alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type: \"range\"; key?: string | undefined; params?: (", "FilterMetaParams", " & ", @@ -5295,62 +5344,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/es-query", - "id": "def-common.FunctionTypeBuildNode", - "type": "Interface", - "tags": [], - "label": "FunctionTypeBuildNode", - "description": [], - "path": "packages/kbn-es-query/src/kuery/node_types/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/es-query", - "id": "def-common.FunctionTypeBuildNode.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"function\"" - ], - "path": "packages/kbn-es-query/src/kuery/node_types/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/es-query", - "id": "def-common.FunctionTypeBuildNode.function", - "type": "CompoundType", - "tags": [], - "label": "function", - "description": [], - "signature": [ - "\"nested\" | \"exists\" | \"is\" | \"range\" | \"and\" | \"or\" | \"not\"" - ], - "path": "packages/kbn-es-query/src/kuery/node_types/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/es-query", - "id": "def-common.FunctionTypeBuildNode.arguments", - "type": "Array", - "tags": [], - "label": "arguments", - "description": [], - "signature": [ - "any[]" - ], - "path": "packages/kbn-es-query/src/kuery/node_types/types.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/es-query", "id": "def-common.IFieldSubTypeMulti", diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index 2dc931afb9ac6..0cdc2fffbe4e9 100644 --- a/api_docs/kbn_es_query.mdx +++ b/api_docs/kbn_es_query.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-query title: "@kbn/es-query" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-query plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query'] --- import kbnEsQueryObj from './kbn_es_query.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 255 | 1 | 197 | 15 | +| 253 | 1 | 194 | 15 | ## Common diff --git a/api_docs/kbn_es_types.mdx b/api_docs/kbn_es_types.mdx index a688291dcb466..296353fb09f5d 100644 --- a/api_docs/kbn_es_types.mdx +++ b/api_docs/kbn_es_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-types title: "@kbn/es-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-types plugin -date: 2023-06-30 +date: 2023-07-18 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 2ac3fbec286f1..a7c8a29fe6e85 100644 --- a/api_docs/kbn_eslint_plugin_imports.mdx +++ b/api_docs/kbn_eslint_plugin_imports.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-eslint-plugin-imports title: "@kbn/eslint-plugin-imports" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/eslint-plugin-imports plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] --- import kbnEslintPluginImportsObj from './kbn_eslint_plugin_imports.devdocs.json'; diff --git a/api_docs/kbn_expandable_flyout.devdocs.json b/api_docs/kbn_expandable_flyout.devdocs.json index 7fcd69c291a2e..bff7c42b73719 100644 --- a/api_docs/kbn_expandable_flyout.devdocs.json +++ b/api_docs/kbn_expandable_flyout.devdocs.json @@ -37,7 +37,7 @@ "section": "def-common.ExpandableFlyoutProps", "text": "ExpandableFlyoutProps" }, - ">): JSX.Element; displayName: string | undefined; }" + ">): JSX.Element | null; displayName: string | undefined; }" ], "path": "packages/kbn-expandable-flyout/src/index.tsx", "deprecated": false, @@ -540,9 +540,9 @@ "section": "def-common.ExpandableFlyoutProps", "text": "ExpandableFlyoutProps" }, - " extends ", + " extends Omit<", "EuiFlyoutProps", - "<\"div\">" + "<\"div\">, \"onClose\">" ], "path": "packages/kbn-expandable-flyout/src/index.tsx", "deprecated": false, diff --git a/api_docs/kbn_expandable_flyout.mdx b/api_docs/kbn_expandable_flyout.mdx index 817316ee50a29..6d8621c0d4042 100644 --- a/api_docs/kbn_expandable_flyout.mdx +++ b/api_docs/kbn_expandable_flyout.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-expandable-flyout title: "@kbn/expandable-flyout" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/expandable-flyout plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/expandable-flyout'] --- import kbnExpandableFlyoutObj from './kbn_expandable_flyout.devdocs.json'; diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index 9db7ac2995823..6e1abf87c2821 100644 --- a/api_docs/kbn_field_types.mdx +++ b/api_docs/kbn_field_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-field-types title: "@kbn/field-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/field-types plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types'] --- import kbnFieldTypesObj from './kbn_field_types.devdocs.json'; diff --git a/api_docs/kbn_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx index 5e918d373f28e..7ae737f48afd0 100644 --- a/api_docs/kbn_find_used_node_modules.mdx +++ b/api_docs/kbn_find_used_node_modules.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-find-used-node-modules title: "@kbn/find-used-node-modules" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/find-used-node-modules plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/find-used-node-modules'] --- import kbnFindUsedNodeModulesObj from './kbn_find_used_node_modules.devdocs.json'; diff --git a/api_docs/kbn_ftr_common_functional_services.mdx b/api_docs/kbn_ftr_common_functional_services.mdx index 08df7c49d423f..e2fc4a1a0bbd3 100644 --- a/api_docs/kbn_ftr_common_functional_services.mdx +++ b/api_docs/kbn_ftr_common_functional_services.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ftr-common-functional-services title: "@kbn/ftr-common-functional-services" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ftr-common-functional-services plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ftr-common-functional-services'] --- import kbnFtrCommonFunctionalServicesObj from './kbn_ftr_common_functional_services.devdocs.json'; diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx index 5db131ac2aa64..c313524e58a8f 100644 --- a/api_docs/kbn_generate.mdx +++ b/api_docs/kbn_generate.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate title: "@kbn/generate" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/generate plugin -date: 2023-06-30 +date: 2023-07-18 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 134885dce4e31..e94a78f083db3 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: 2023-06-30 +date: 2023-07-18 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 29277fd436268..ac124430b754a 100644 --- a/api_docs/kbn_generate_csv.mdx +++ b/api_docs/kbn_generate_csv.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate-csv title: "@kbn/generate-csv" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/generate-csv plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate-csv'] --- import kbnGenerateCsvObj from './kbn_generate_csv.devdocs.json'; diff --git a/api_docs/kbn_generate_csv_types.mdx b/api_docs/kbn_generate_csv_types.mdx index 08cb04241e202..281d4ef2bff0b 100644 --- a/api_docs/kbn_generate_csv_types.mdx +++ b/api_docs/kbn_generate_csv_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate-csv-types title: "@kbn/generate-csv-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/generate-csv-types plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate-csv-types'] --- import kbnGenerateCsvTypesObj from './kbn_generate_csv_types.devdocs.json'; diff --git a/api_docs/kbn_guided_onboarding.mdx b/api_docs/kbn_guided_onboarding.mdx index a0b070753b4af..6777af841ba76 100644 --- a/api_docs/kbn_guided_onboarding.mdx +++ b/api_docs/kbn_guided_onboarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-guided-onboarding title: "@kbn/guided-onboarding" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/guided-onboarding plugin -date: 2023-06-30 +date: 2023-07-18 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 6053a1722a462..d3ddc3033b172 100644 --- a/api_docs/kbn_handlebars.mdx +++ b/api_docs/kbn_handlebars.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-handlebars title: "@kbn/handlebars" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/handlebars plugin -date: 2023-06-30 +date: 2023-07-18 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 46d6377ce2fd5..967114b7c9816 100644 --- a/api_docs/kbn_hapi_mocks.mdx +++ b/api_docs/kbn_hapi_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-hapi-mocks title: "@kbn/hapi-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/hapi-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 8af183c664100..60430aaca7c4d 100644 --- a/api_docs/kbn_health_gateway_server.mdx +++ b/api_docs/kbn_health_gateway_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-health-gateway-server title: "@kbn/health-gateway-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/health-gateway-server plugin -date: 2023-06-30 +date: 2023-07-18 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 3da9b96032b86..d8c753198de04 100644 --- a/api_docs/kbn_home_sample_data_card.mdx +++ b/api_docs/kbn_home_sample_data_card.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-home-sample-data-card title: "@kbn/home-sample-data-card" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/home-sample-data-card plugin -date: 2023-06-30 +date: 2023-07-18 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 97225879065a0..791432038ecce 100644 --- a/api_docs/kbn_home_sample_data_tab.mdx +++ b/api_docs/kbn_home_sample_data_tab.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-home-sample-data-tab title: "@kbn/home-sample-data-tab" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/home-sample-data-tab plugin -date: 2023-06-30 +date: 2023-07-18 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 6d95092b2fb2a..570c5bba2b302 100644 --- a/api_docs/kbn_i18n.mdx +++ b/api_docs/kbn_i18n.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-i18n title: "@kbn/i18n" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/i18n plugin -date: 2023-06-30 +date: 2023-07-18 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 34e812c2a9724..65aad58cf21a5 100644 --- a/api_docs/kbn_i18n_react.mdx +++ b/api_docs/kbn_i18n_react.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-i18n-react title: "@kbn/i18n-react" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/i18n-react plugin -date: 2023-06-30 +date: 2023-07-18 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 08c68565ae2b1..715f96af8717f 100644 --- a/api_docs/kbn_import_resolver.mdx +++ b/api_docs/kbn_import_resolver.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-import-resolver title: "@kbn/import-resolver" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/import-resolver plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] --- import kbnImportResolverObj from './kbn_import_resolver.devdocs.json'; diff --git a/api_docs/kbn_infra_forge.mdx b/api_docs/kbn_infra_forge.mdx index 0a01ba4056433..dcd5f433df565 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: 2023-06-30 +date: 2023-07-18 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 818fce8ad7e93..96b2b7ef31dac 100644 --- a/api_docs/kbn_interpreter.mdx +++ b/api_docs/kbn_interpreter.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-interpreter title: "@kbn/interpreter" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/interpreter plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter'] --- import kbnInterpreterObj from './kbn_interpreter.devdocs.json'; diff --git a/api_docs/kbn_io_ts_utils.devdocs.json b/api_docs/kbn_io_ts_utils.devdocs.json index ada7290e57182..dc01ec7124709 100644 --- a/api_docs/kbn_io_ts_utils.devdocs.json +++ b/api_docs/kbn_io_ts_utils.devdocs.json @@ -210,17 +210,7 @@ "signature": [ "(start: number, end: number) => ", "Type", - "<", - "Branded", - ", unknown, unknown>" + "" ], "path": "packages/kbn-io-ts-utils/src/in_range_rt/index.ts", "deprecated": false, @@ -269,18 +259,8 @@ "description": [], "signature": [ "(start: number, end: number) => ", - "BrandC", - "<", - "NumberC", - ", ", - { - "pluginId": "@kbn/io-ts-utils", - "scope": "common", - "docId": "kibKbnIoTsUtilsPluginApi", - "section": "def-common.InRangeBrand", - "text": "InRangeBrand" - }, - ">" + "Type", + "" ], "path": "packages/kbn-io-ts-utils/src/in_range_rt/index.ts", "deprecated": false, diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx index 0d332dec34ec3..ffb3c34a2d652 100644 --- a/api_docs/kbn_io_ts_utils.mdx +++ b/api_docs/kbn_io_ts_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-io-ts-utils title: "@kbn/io-ts-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/io-ts-utils plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-utils'] --- import kbnIoTsUtilsObj from './kbn_io_ts_utils.devdocs.json'; diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx index 8161ced3eb36b..241ec3e2d6f12 100644 --- a/api_docs/kbn_jest_serializers.mdx +++ b/api_docs/kbn_jest_serializers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-jest-serializers title: "@kbn/jest-serializers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/jest-serializers plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] --- import kbnJestSerializersObj from './kbn_jest_serializers.devdocs.json'; diff --git a/api_docs/kbn_journeys.devdocs.json b/api_docs/kbn_journeys.devdocs.json index b0a4c65e8be13..24a4280bfdb1a 100644 --- a/api_docs/kbn_journeys.devdocs.json +++ b/api_docs/kbn_journeys.devdocs.json @@ -995,7 +995,7 @@ "label": "get", "description": [], "signature": [ - "() => { path: string; fullscreenPath: string; type: \"failure\" | \"success\"; title: string; filename: string; fullscreenFilename: string; }[]" + "() => { path: string; fullscreenPath: string; type: \"success\" | \"failure\"; title: string; filename: string; fullscreenFilename: string; }[]" ], "path": "packages/kbn-journeys/journey/journey_screenshots.ts", "deprecated": false, diff --git a/api_docs/kbn_journeys.mdx b/api_docs/kbn_journeys.mdx index cf2f98e7566f3..3575ee5cb37ac 100644 --- a/api_docs/kbn_journeys.mdx +++ b/api_docs/kbn_journeys.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-journeys title: "@kbn/journeys" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/journeys plugin -date: 2023-06-30 +date: 2023-07-18 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 6116993499422..b1bad1e325707 100644 --- a/api_docs/kbn_json_ast.mdx +++ b/api_docs/kbn_json_ast.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-json-ast title: "@kbn/json-ast" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/json-ast plugin -date: 2023-06-30 +date: 2023-07-18 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 0af2869630512..51772e55e29c9 100644 --- a/api_docs/kbn_kibana_manifest_schema.mdx +++ b/api_docs/kbn_kibana_manifest_schema.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-kibana-manifest-schema title: "@kbn/kibana-manifest-schema" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/kibana-manifest-schema plugin -date: 2023-06-30 +date: 2023-07-18 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 f2261e06cb1e2..366e245a4a56a 100644 --- a/api_docs/kbn_language_documentation_popover.mdx +++ b/api_docs/kbn_language_documentation_popover.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-language-documentation-popover title: "@kbn/language-documentation-popover" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/language-documentation-popover plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/language-documentation-popover'] --- import kbnLanguageDocumentationPopoverObj from './kbn_language_documentation_popover.devdocs.json'; diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx index 337cf5640c3ae..6340b91343b08 100644 --- a/api_docs/kbn_logging.mdx +++ b/api_docs/kbn_logging.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-logging title: "@kbn/logging" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/logging plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] --- import kbnLoggingObj from './kbn_logging.devdocs.json'; diff --git a/api_docs/kbn_logging_mocks.devdocs.json b/api_docs/kbn_logging_mocks.devdocs.json index 617062bcc5f08..39e3725849b91 100644 --- a/api_docs/kbn_logging_mocks.devdocs.json +++ b/api_docs/kbn_logging_mocks.devdocs.json @@ -38,7 +38,7 @@ "section": "def-common.LogMeta", "text": "LogMeta" }, - " | undefined]>; debug: jest.MockInstance; debug: jest.MockInstance; info: jest.MockInstance; info: jest.MockInstance; warn: jest.MockInstance; warn: jest.MockInstance; error: jest.MockInstance; error: jest.MockInstance; fatal: jest.MockInstance; fatal: jest.MockInstance; log: jest.MockInstance; log: jest.MockInstance; isLevelEnabled: jest.MockInstance; isLevelEnabled: jest.MockInstance; get: jest.MockInstance<", + "], unknown>; get: jest.MockInstance<", { "pluginId": "@kbn/logging", "scope": "common", @@ -90,7 +90,7 @@ "section": "def-common.Logger", "text": "Logger" }, - ", string[]>; } & ", + ", string[], unknown>; } & ", { "pluginId": "@kbn/logging", "scope": "common", @@ -195,7 +195,7 @@ "section": "def-common.LogMeta", "text": "LogMeta" }, - " | undefined]>; debug: jest.MockInstance; debug: jest.MockInstance; info: jest.MockInstance; info: jest.MockInstance; warn: jest.MockInstance; warn: jest.MockInstance; error: jest.MockInstance; error: jest.MockInstance; fatal: jest.MockInstance; fatal: jest.MockInstance; log: jest.MockInstance; log: jest.MockInstance; isLevelEnabled: jest.MockInstance; isLevelEnabled: jest.MockInstance; get: jest.MockInstance<", + "], unknown>; get: jest.MockInstance<", { "pluginId": "@kbn/logging", "scope": "common", @@ -247,7 +247,7 @@ "section": "def-common.Logger", "text": "Logger" }, - ", string[]>; } & ", + ", string[], unknown>; } & ", { "pluginId": "@kbn/logging", "scope": "common", @@ -352,7 +352,7 @@ "section": "def-common.LogMeta", "text": "LogMeta" }, - " | undefined]>; debug: jest.MockInstance; debug: jest.MockInstance; info: jest.MockInstance; info: jest.MockInstance; warn: jest.MockInstance; warn: jest.MockInstance; error: jest.MockInstance; error: jest.MockInstance; fatal: jest.MockInstance; fatal: jest.MockInstance; log: jest.MockInstance; log: jest.MockInstance; isLevelEnabled: jest.MockInstance; isLevelEnabled: jest.MockInstance; get: jest.MockInstance<", + "], unknown>; get: jest.MockInstance<", { "pluginId": "@kbn/logging", "scope": "common", @@ -404,7 +404,7 @@ "section": "def-common.Logger", "text": "Logger" }, - ", string[]>; } & ", + ", string[], unknown>; } & ", { "pluginId": "@kbn/logging", "scope": "common", diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index ed7a25e96af4d..bb793014c1dcd 100644 --- a/api_docs/kbn_logging_mocks.mdx +++ b/api_docs/kbn_logging_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-logging-mocks title: "@kbn/logging-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/logging-mocks plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks'] --- import kbnLoggingMocksObj from './kbn_logging_mocks.devdocs.json'; diff --git a/api_docs/kbn_managed_vscode_config.mdx b/api_docs/kbn_managed_vscode_config.mdx index 27686b46252de..a9858be70faa6 100644 --- a/api_docs/kbn_managed_vscode_config.mdx +++ b/api_docs/kbn_managed_vscode_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-managed-vscode-config title: "@kbn/managed-vscode-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/managed-vscode-config plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_management_cards_navigation.devdocs.json new file mode 100644 index 0000000000000..35116d25824c5 --- /dev/null +++ b/api_docs/kbn_management_cards_navigation.devdocs.json @@ -0,0 +1,191 @@ +{ + "id": "@kbn/management-cards-navigation", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/management-cards-navigation", + "id": "def-common.CardsNavigation", + "type": "Function", + "tags": [], + "label": "CardsNavigation", + "description": [], + "signature": [ + "({ sections, appBasePath, onCardClick, hideLinksTo, }: ", + { + "pluginId": "@kbn/management-cards-navigation", + "scope": "common", + "docId": "kibKbnManagementCardsNavigationPluginApi", + "section": "def-common.CardsNavigationComponentProps", + "text": "CardsNavigationComponentProps" + }, + ") => JSX.Element" + ], + "path": "packages/kbn-management/cards_navigation/src/cards_navigation.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/management-cards-navigation", + "id": "def-common.CardsNavigation.$1", + "type": "Object", + "tags": [], + "label": "{\n sections,\n appBasePath,\n onCardClick,\n hideLinksTo = [],\n}", + "description": [], + "signature": [ + { + "pluginId": "@kbn/management-cards-navigation", + "scope": "common", + "docId": "kibKbnManagementCardsNavigationPluginApi", + "section": "def-common.CardsNavigationComponentProps", + "text": "CardsNavigationComponentProps" + } + ], + "path": "packages/kbn-management/cards_navigation/src/cards_navigation.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/management-cards-navigation", + "id": "def-common.CardsNavigationComponentProps", + "type": "Interface", + "tags": [], + "label": "CardsNavigationComponentProps", + "description": [], + "path": "packages/kbn-management/cards_navigation/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/management-cards-navigation", + "id": "def-common.CardsNavigationComponentProps.sections", + "type": "Array", + "tags": [], + "label": "sections", + "description": [], + "signature": [ + "AppRegistrySections", + "[]" + ], + "path": "packages/kbn-management/cards_navigation/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/management-cards-navigation", + "id": "def-common.CardsNavigationComponentProps.appBasePath", + "type": "string", + "tags": [], + "label": "appBasePath", + "description": [], + "path": "packages/kbn-management/cards_navigation/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/management-cards-navigation", + "id": "def-common.CardsNavigationComponentProps.onCardClick", + "type": "Function", + "tags": [], + "label": "onCardClick", + "description": [], + "signature": [ + "((e: React.MouseEvent) => void) | undefined" + ], + "path": "packages/kbn-management/cards_navigation/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/management-cards-navigation", + "id": "def-common.CardsNavigationComponentProps.onCardClick.$1", + "type": "Object", + "tags": [], + "label": "e", + "description": [], + "signature": [ + "React.MouseEvent" + ], + "path": "packages/kbn-management/cards_navigation/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/management-cards-navigation", + "id": "def-common.CardsNavigationComponentProps.hideLinksTo", + "type": "Array", + "tags": [], + "label": "hideLinksTo", + "description": [], + "signature": [ + "(\"transform\" | \"tags\" | \"maintenanceWindows\" | \"dataViews\" | \"data_view\" | \"filesManagement\" | \"reporting\" | \"api_keys\" | \"index_management\" | \"ingest_pipelines\" | \"jobsListLink\" | \"objects\" | \"pipelines\" | \"triggersActions\" | \"triggersActionsConnectors\")[] | undefined" + ], + "path": "packages/kbn-management/cards_navigation/src/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "@kbn/management-cards-navigation", + "id": "def-common.appIds", + "type": "Enum", + "tags": [], + "label": "appIds", + "description": [], + "path": "packages/kbn-management/cards_navigation/src/consts.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "@kbn/management-cards-navigation", + "id": "def-common.AppId", + "type": "Type", + "tags": [], + "label": "AppId", + "description": [], + "signature": [ + "\"transform\" | \"tags\" | \"maintenanceWindows\" | \"dataViews\" | \"data_view\" | \"filesManagement\" | \"reporting\" | \"api_keys\" | \"index_management\" | \"ingest_pipelines\" | \"jobsListLink\" | \"objects\" | \"pipelines\" | \"triggersActions\" | \"triggersActionsConnectors\"" + ], + "path": "packages/kbn-management/cards_navigation/src/consts.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_management_cards_navigation.mdx b/api_docs/kbn_management_cards_navigation.mdx new file mode 100644 index 0000000000000..5de1208541fd4 --- /dev/null +++ b/api_docs/kbn_management_cards_navigation.mdx @@ -0,0 +1,39 @@ +--- +#### +#### 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: kibKbnManagementCardsNavigationPluginApi +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: 2023-07-18 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-cards-navigation'] +--- +import kbnManagementCardsNavigationObj from './kbn_management_cards_navigation.devdocs.json'; + + + +Contact [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 10 | 0 | 10 | 1 | + +## Common + +### Functions + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/kbn_management_storybook_config.devdocs.json b/api_docs/kbn_management_storybook_config.devdocs.json new file mode 100644 index 0000000000000..7615017ad3902 --- /dev/null +++ b/api_docs/kbn_management_storybook_config.devdocs.json @@ -0,0 +1,62 @@ +{ + "id": "@kbn/management-storybook-config", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/management-storybook-config", + "id": "def-common.TITLE", + "type": "string", + "tags": [], + "label": "TITLE", + "description": [ + "The title of the Storybook." + ], + "signature": [ + "\"kbn-management storybook\"" + ], + "path": "packages/kbn-management/storybook/config/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/management-storybook-config", + "id": "def-common.URL", + "type": "string", + "tags": [], + "label": "URL", + "description": [ + "The remote URL of the root from which Storybook loads stories for kbn-management." + ], + "signature": [ + "\"https://github.com/elastic/kibana/tree/main/packages/kbn-management\"" + ], + "path": "packages/kbn-management/storybook/config/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_management_storybook_config.mdx b/api_docs/kbn_management_storybook_config.mdx new file mode 100644 index 0000000000000..5c388698066b9 --- /dev/null +++ b/api_docs/kbn_management_storybook_config.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: kibKbnManagementStorybookConfigPluginApi +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: 2023-07-18 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-storybook-config'] +--- +import kbnManagementStorybookConfigObj from './kbn_management_storybook_config.devdocs.json'; + + + +Contact [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 2 | 0 | 0 | 0 | + +## Common + +### Consts, variables and types + + diff --git a/api_docs/kbn_mapbox_gl.devdocs.json b/api_docs/kbn_mapbox_gl.devdocs.json index 77583b59f73f0..176946b8db4e2 100644 --- a/api_docs/kbn_mapbox_gl.devdocs.json +++ b/api_docs/kbn_mapbox_gl.devdocs.json @@ -145,7 +145,7 @@ "label": "_data", "description": [], "signature": [ - "string | GeoJSON.GeoJSON" + "string | GeoJSON.GeoJSON | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -154,12 +154,12 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.GeoJSONSource._options", - "type": "Any", + "type": "Object", "tags": [], "label": "_options", "description": [], "signature": [ - "any" + "{ data?: string | GeoJSON.GeoJSON | undefined; cluster?: boolean | undefined; clusterMaxZoom?: number | undefined; clusterRadius?: number | undefined; clusterMinPoints?: number | undefined; generateId?: boolean | undefined; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -168,12 +168,12 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.GeoJSONSource.workerOptions", - "type": "Any", + "type": "Object", "tags": [], "label": "workerOptions", "description": [], "signature": [ - "any" + "{ source?: string | undefined; cluster?: boolean | undefined; geojsonVtOptions?: { buffer?: number | undefined; tolerance?: number | undefined; extent?: number | undefined; maxZoom?: number | undefined; linemetrics?: boolean | undefined; generateId?: boolean | undefined; } | undefined; superclusterOptions?: { maxZoom?: number | undefined; miniPoints?: number | undefined; extent?: number | undefined; radius?: number | undefined; log?: boolean | undefined; generateId?: boolean | undefined; } | undefined; clusterProperties?: any; fliter?: any; promoteId?: any; collectResourceTiming?: boolean | undefined; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -405,6 +405,82 @@ "this" ] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.GeoJSONSource.updateData", + "type": "Function", + "tags": [], + "label": "updateData", + "description": [ + "\nUpdates the source's GeoJSON, and re-renders the map.\n\nFor sources with lots of features, this method can be used to make updates more quickly.\n\nThis approach requires unique IDs for every feature in the source. The IDs can either be specified on the feature,\nor by using the promoteId option to specify which property should be used as the ID.\n\nIt is an error to call updateData on a source that did not have unique IDs for each of its features already.\n\nUpdates are applied on a best-effort basis, updating an ID that does not exist will not result in an error.\n" + ], + "signature": [ + "(diff: maplibregl.GeoJSONSourceDiff) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.GeoJSONSource.updateData.$1", + "type": "Object", + "tags": [], + "label": "diff", + "description": [ + "The changes that need to be applied." + ], + "signature": [ + "maplibregl.GeoJSONSourceDiff" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "this" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.GeoJSONSource.setClusterOptions", + "type": "Function", + "tags": [], + "label": "setClusterOptions", + "description": [ + "\nTo disable/enable clustering on the source options" + ], + "signature": [ + "(options: maplibregl.SetClusterOptions) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.GeoJSONSource.setClusterOptions.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "The options to set" + ], + "signature": [ + "maplibregl.SetClusterOptions" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "this" + ] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.GeoJSONSource.getClusterExpansionZoom", @@ -612,7 +688,7 @@ "label": "_updateWorkerData", "description": [], "signature": [ - "(sourceDataType: maplibregl.MapSourceDataType) => void" + "(diff?: maplibregl.GeoJSONSourceDiff | undefined) => void" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -621,17 +697,17 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.GeoJSONSource._updateWorkerData.$1", - "type": "CompoundType", + "type": "Object", "tags": [], - "label": "sourceDataType", + "label": "diff", "description": [], "signature": [ - "maplibregl.MapSourceDataType" + "maplibregl.GeoJSONSourceDiff | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] @@ -927,14 +1003,14 @@ "\nReturns the coordinates represented as an array of two numbers.\n" ], "signature": [ - "() => number[]" + "() => [number, number]" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ - "The coordinates represeted as an array of longitude and latitude." + "The coordinates represented as an array of longitude and latitude." ] }, { @@ -995,44 +1071,6 @@ "Distance in meters between the two coordinates." ] }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.LngLat.toBounds", - "type": "Function", - "tags": [], - "label": "toBounds", - "description": [ - "\nReturns a `LngLatBounds` from the coordinates extended by a given `radius`. The returned `LngLatBounds` completely contains the `radius`.\n" - ], - "signature": [ - "(radius?: number | undefined) => maplibregl.LngLatBounds" - ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.LngLat.toBounds.$1", - "type": "number", - "tags": [], - "label": "radius", - "description": [ - "Distance in meters from the coordinates to extend the bounds." - ], - "signature": [ - "number | undefined" - ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [ - "A new `LngLatBounds` object representing the coordinates extended by the `radius`." - ] - }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.LngLat.convert", @@ -1133,32 +1171,36 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.LngLatBounds.Unnamed.$1", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "sw", - "description": [], + "description": [ + "The southwest corner of the bounding box.\nOR array of 4 numbers in the order of west, south, east, north\nOR array of 2 LngLatLike: [sw,ne]" + ], "signature": [ - "any" + "[number, number, number, number] | maplibregl.LngLatLike | [maplibregl.LngLatLike, maplibregl.LngLatLike] | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.LngLatBounds.Unnamed.$2", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "ne", - "description": [], + "description": [ + "The northeast corner of the bounding box." + ], "signature": [ - "any" + "maplibregl.LngLatLike | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] @@ -1467,7 +1509,7 @@ "\nReturns the bounding box represented as an array.\n" ], "signature": [ - "() => number[][]" + "() => [number, number][]" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -1592,6 +1634,61 @@ "returnComment": [ "A new `LngLatBounds` object, if a conversion occurred, or the original `LngLatBounds` object." ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.LngLatBounds.fromLngLat", + "type": "Function", + "tags": [], + "label": "fromLngLat", + "description": [ + "\nReturns a `LngLatBounds` from the coordinates extended by a given `radius`. The returned `LngLatBounds` completely contains the `radius`.\n" + ], + "signature": [ + "(center: maplibregl.LngLat, radius?: number | undefined) => maplibregl.LngLatBounds" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.LngLatBounds.fromLngLat.$1", + "type": "Object", + "tags": [], + "label": "center", + "description": [ + "center coordinates of the new bounds." + ], + "signature": [ + "maplibregl.LngLat" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.LngLatBounds.fromLngLat.$2", + "type": "number", + "tags": [], + "label": "radius", + "description": [ + "Distance in meters from the coordinates to extend the bounds." + ], + "signature": [ + "number | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [ + "A new `LngLatBounds` object representing the coordinates extended by the `radius`." + ] } ], "initialIsOpen": false @@ -1719,6 +1816,48 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._cooperativeGestures", + "type": "CompoundType", + "tags": [], + "label": "_cooperativeGestures", + "description": [], + "signature": [ + "boolean | maplibregl.GestureOptions" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._cooperativeGesturesScreen", + "type": "Object", + "tags": [], + "label": "_cooperativeGesturesScreen", + "description": [], + "signature": [ + "HTMLElement" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._metaKey", + "type": "CompoundType", + "tags": [], + "label": "_metaKey", + "description": [], + "signature": [ + "keyof MouseEvent" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map._showTileBoundaries", @@ -1810,6 +1949,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._maxTileCacheZoomLevels", + "type": "number", + "tags": [], + "label": "_maxTileCacheZoomLevels", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map._frame", @@ -1868,6 +2018,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._idleTriggered", + "type": "boolean", + "tags": [], + "label": "_idleTriggered", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map._fullyLoaded", @@ -1890,6 +2051,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._resizeObserver", + "type": "Object", + "tags": [], + "label": "_resizeObserver", + "description": [], + "signature": [ + "ResizeObserver" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map._preserveDrawingBuffer", @@ -2056,6 +2231,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._validateStyle", + "type": "boolean", + "tags": [], + "label": "_validateStyle", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map._requestManager", @@ -2119,23 +2305,67 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map.scrollZoom", - "type": "Object", + "id": "def-common.Map._terrainDataCallback", + "type": "Function", "tags": [], - "label": "scrollZoom", - "description": [ - "\nThe map's {@link ScrollZoomHandler}, which implements zooming in and out with a scroll wheel or trackpad.\nFind more details and examples using `scrollZoom` in the {@link ScrollZoomHandler} section." - ], + "label": "_terrainDataCallback", + "description": [], "signature": [ - "maplibregl.ScrollZoomHandler" + "(e: maplibregl.MapStyleDataEvent | maplibregl.MapSourceDataEvent) => void" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map.boxZoom", + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._terrainDataCallback.$1", + "type": "CompoundType", + "tags": [], + "label": "e", + "description": [], + "signature": [ + "maplibregl.MapStyleDataEvent | maplibregl.MapSourceDataEvent" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._imageQueueHandle", + "type": "number", + "tags": [], + "label": "_imageQueueHandle", + "description": [ + "image queue throttling handle. To be used later when clean up" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.scrollZoom", + "type": "Object", + "tags": [], + "label": "scrollZoom", + "description": [ + "\nThe map's {@link ScrollZoomHandler}, which implements zooming in and out with a scroll wheel or trackpad.\nFind more details and examples using `scrollZoom` in the {@link ScrollZoomHandler} section." + ], + "signature": [ + "maplibregl.ScrollZoomHandler" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.boxZoom", "type": "Object", "tags": [], "label": "boxZoom", @@ -2220,10 +2450,10 @@ "tags": [], "label": "touchZoomRotate", "description": [ - "\nThe map's {@link TouchZoomRotateHandler}, which allows the user to zoom or rotate the map with touch gestures.\nFind more details and examples using `touchZoomRotate` in the {@link TouchZoomRotateHandler} section." + "\nThe map's {@link TwoFingersTouchZoomRotateHandler}, which allows the user to zoom or rotate the map with touch gestures.\nFind more details and examples using `touchZoomRotate` in the {@link TwoFingersTouchZoomRotateHandler} section." ], "signature": [ - "maplibregl.TouchZoomRotateHandler" + "maplibregl.TwoFingersTouchZoomRotateHandler" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -2236,10 +2466,10 @@ "tags": [], "label": "touchPitch", "description": [ - "\nThe map's {@link TouchPitchHandler}, which allows the user to pitch the map with touch gestures.\nFind more details and examples using `touchPitch` in the {@link TouchPitchHandler} section." + "\nThe map's {@link TwoFingersTouchPitchHandler}, which allows the user to pitch the map with touch gestures.\nFind more details and examples using `touchPitch` in the {@link TwoFingersTouchPitchHandler} section." ], "signature": [ - "maplibregl.TouchPitchHandler" + "maplibregl.TwoFingersTouchPitchHandler" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -2426,6 +2656,83 @@ "True if map contains control." ] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.calculateCameraOptionsFromTo", + "type": "Function", + "tags": [], + "label": "calculateCameraOptionsFromTo", + "description": [], + "signature": [ + "(from: maplibregl.LngLat, altitudeFrom: number, to: maplibregl.LngLat, altitudeTo?: number | undefined) => maplibregl.CameraOptions" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.calculateCameraOptionsFromTo.$1", + "type": "Object", + "tags": [], + "label": "from", + "description": [], + "signature": [ + "maplibregl.LngLat" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.calculateCameraOptionsFromTo.$2", + "type": "number", + "tags": [], + "label": "altitudeFrom", + "description": [], + "signature": [ + "number" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.calculateCameraOptionsFromTo.$3", + "type": "Object", + "tags": [], + "label": "to", + "description": [], + "signature": [ + "maplibregl.LngLat" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.calculateCameraOptionsFromTo.$4", + "type": "number", + "tags": [], + "label": "altitudeTo", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.resize", @@ -2892,6 +3199,64 @@ "`this`" ] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getCooperativeGestures", + "type": "Function", + "tags": [], + "label": "getCooperativeGestures", + "description": [ + "\nGets the map's cooperativeGestures option\n" + ], + "signature": [ + "() => boolean | maplibregl.GestureOptions" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [ + "gestureOptions" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setCooperativeGestures", + "type": "Function", + "tags": [], + "label": "setCooperativeGestures", + "description": [ + "\nSets or clears the map's cooperativeGestures option\n" + ], + "signature": [ + "(gestureOptions?: boolean | maplibregl.GestureOptions | null | undefined) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setCooperativeGestures.$1", + "type": "CompoundType", + "tags": [], + "label": "gestureOptions", + "description": [ + "If `true` or set to an options object, map is only accessible on desktop while holding Command/Ctrl and only accessible on mobile with two fingers. Interacting with the map using normal gestures will trigger an informational screen. With this option enabled, \"drag to pitch\" requires a three-finger gesture." + ], + "signature": [ + "boolean | maplibregl.GestureOptions | null | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [ + "`this`" + ] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.project", @@ -3037,7 +3402,7 @@ "label": "_createDelegatedListener", "description": [], "signature": [ - "(type: string, layerId: string, listener: maplibregl.Listener) => { layer: string; listener: maplibregl.Listener; delegates: { error?: ((e: any) => void) | undefined; load?: ((e: any) => void) | undefined; idle?: ((e: any) => void) | undefined; remove?: ((e: any) => void) | undefined; render?: ((e: any) => void) | undefined; resize?: ((e: any) => void) | undefined; webglcontextlost?: ((e: any) => void) | undefined; webglcontextrestored?: ((e: any) => void) | undefined; dataloading?: ((e: any) => void) | undefined; data?: ((e: any) => void) | undefined; tiledataloading?: ((e: any) => void) | undefined; sourcedataloading?: ((e: any) => void) | undefined; styledataloading?: ((e: any) => void) | undefined; sourcedata?: ((e: any) => void) | undefined; styledata?: ((e: any) => void) | undefined; styleimagemissing?: ((e: any) => void) | undefined; dataabort?: ((e: any) => void) | undefined; sourcedataabort?: ((e: any) => void) | undefined; boxzoomcancel?: ((e: any) => void) | undefined; boxzoomstart?: ((e: any) => void) | undefined; boxzoomend?: ((e: any) => void) | undefined; touchcancel?: ((e: any) => void) | undefined; touchmove?: ((e: any) => void) | undefined; touchend?: ((e: any) => void) | undefined; touchstart?: ((e: any) => void) | undefined; click?: ((e: any) => void) | undefined; contextmenu?: ((e: any) => void) | undefined; dblclick?: ((e: any) => void) | undefined; mousemove?: ((e: any) => void) | undefined; mouseup?: ((e: any) => void) | undefined; mousedown?: ((e: any) => void) | undefined; mouseout?: ((e: any) => void) | undefined; mouseover?: ((e: any) => void) | undefined; movestart?: ((e: any) => void) | undefined; move?: ((e: any) => void) | undefined; moveend?: ((e: any) => void) | undefined; zoomstart?: ((e: any) => void) | undefined; zoom?: ((e: any) => void) | undefined; zoomend?: ((e: any) => void) | undefined; rotatestart?: ((e: any) => void) | undefined; rotate?: ((e: any) => void) | undefined; rotateend?: ((e: any) => void) | undefined; dragstart?: ((e: any) => void) | undefined; drag?: ((e: any) => void) | undefined; dragend?: ((e: any) => void) | undefined; pitchstart?: ((e: any) => void) | undefined; pitch?: ((e: any) => void) | undefined; pitchend?: ((e: any) => void) | undefined; wheel?: ((e: any) => void) | undefined; }; }" + "(type: string, layerId: string, listener: maplibregl.Listener) => { layer: string; listener: maplibregl.Listener; delegates: { error?: ((e: any) => void) | undefined; load?: ((e: any) => void) | undefined; idle?: ((e: any) => void) | undefined; remove?: ((e: any) => void) | undefined; render?: ((e: any) => void) | undefined; resize?: ((e: any) => void) | undefined; webglcontextlost?: ((e: any) => void) | undefined; webglcontextrestored?: ((e: any) => void) | undefined; dataloading?: ((e: any) => void) | undefined; data?: ((e: any) => void) | undefined; tiledataloading?: ((e: any) => void) | undefined; sourcedataloading?: ((e: any) => void) | undefined; styledataloading?: ((e: any) => void) | undefined; sourcedata?: ((e: any) => void) | undefined; styledata?: ((e: any) => void) | undefined; styleimagemissing?: ((e: any) => void) | undefined; dataabort?: ((e: any) => void) | undefined; sourcedataabort?: ((e: any) => void) | undefined; boxzoomcancel?: ((e: any) => void) | undefined; boxzoomstart?: ((e: any) => void) | undefined; boxzoomend?: ((e: any) => void) | undefined; touchcancel?: ((e: any) => void) | undefined; touchmove?: ((e: any) => void) | undefined; touchend?: ((e: any) => void) | undefined; touchstart?: ((e: any) => void) | undefined; click?: ((e: any) => void) | undefined; contextmenu?: ((e: any) => void) | undefined; dblclick?: ((e: any) => void) | undefined; mousemove?: ((e: any) => void) | undefined; mouseup?: ((e: any) => void) | undefined; mousedown?: ((e: any) => void) | undefined; mouseout?: ((e: any) => void) | undefined; mouseover?: ((e: any) => void) | undefined; movestart?: ((e: any) => void) | undefined; move?: ((e: any) => void) | undefined; moveend?: ((e: any) => void) | undefined; zoomstart?: ((e: any) => void) | undefined; zoom?: ((e: any) => void) | undefined; zoomend?: ((e: any) => void) | undefined; rotatestart?: ((e: any) => void) | undefined; rotate?: ((e: any) => void) | undefined; rotateend?: ((e: any) => void) | undefined; dragstart?: ((e: any) => void) | undefined; drag?: ((e: any) => void) | undefined; dragend?: ((e: any) => void) | undefined; pitchstart?: ((e: any) => void) | undefined; pitch?: ((e: any) => void) | undefined; pitchend?: ((e: any) => void) | undefined; wheel?: ((e: any) => void) | undefined; terrain?: ((e: any) => void) | undefined; }; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3135,7 +3500,9 @@ "type": "string", "tags": [], "label": "layer", - "description": [], + "description": [ + "The ID of a style layer or a listener if no ID is provided. Event will only be triggered if its location\nis within a visible feature in this layer. The event will have a `features` property containing\nan array of the matching features. If `layerIdOrListener` is not supplied, the event will not have a `features` property.\nPlease note that many event types are not compatible with the optional `layerIdOrListener` parameter." + ], "signature": [ "string" ], @@ -3275,7 +3642,7 @@ "\nAdds a listener that will be called only once to a specified event type.\n\n\nAdds a listener that will be called only once to a specified event type occurring on features in a specified style layer.\n" ], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" + "{ (type: T, layer: string, listener?: ((ev: maplibregl.MapLayerEventType[T] & Object) => void) | undefined): this | Promise; (type: T, listener?: ((ev: maplibregl.MapEventType[T] & Object) => void) | undefined): Promise | this; (type: string, listener?: maplibregl.Listener | undefined): Promise | this; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3304,7 +3671,9 @@ "type": "string", "tags": [], "label": "layer", - "description": [], + "description": [ + "The ID of a style layer or a listener if no ID is provided. Only events whose location is within a visible\nfeature in this layer will trigger the listener. The event will have a `features` property containing\nan array of the matching features." + ], "signature": [ "string" ], @@ -3323,12 +3692,12 @@ "The function to be called when the event is fired.\nThe listener function is called with the data object passed to `fire`,\nextended with `target` and `type` properties." ], "signature": [ - "(ev: maplibregl.MapLayerEventType[T] & Object) => void" + "((ev: maplibregl.MapLayerEventType[T] & Object) => void) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [ @@ -3343,7 +3712,7 @@ "label": "once", "description": [], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" + "{ (type: T, layer: string, listener?: ((ev: maplibregl.MapLayerEventType[T] & Object) => void) | undefined): this | Promise; (type: T, listener?: ((ev: maplibregl.MapEventType[T] & Object) => void) | undefined): Promise | this; (type: string, listener?: maplibregl.Listener | undefined): Promise | this; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3372,12 +3741,12 @@ "label": "listener", "description": [], "signature": [ - "(ev: maplibregl.MapEventType[T] & Object) => void" + "((ev: maplibregl.MapEventType[T] & Object) => void) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] @@ -3390,7 +3759,7 @@ "label": "once", "description": [], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" + "{ (type: T, layer: string, listener?: ((ev: maplibregl.MapLayerEventType[T] & Object) => void) | undefined): this | Promise; (type: T, listener?: ((ev: maplibregl.MapEventType[T] & Object) => void) | undefined): Promise | this; (type: string, listener?: maplibregl.Listener | undefined): Promise | this; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3419,12 +3788,12 @@ "label": "listener", "description": [], "signature": [ - "maplibregl.Listener" + "maplibregl.Listener | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] @@ -3473,7 +3842,9 @@ "type": "string", "tags": [], "label": "layer", - "description": [], + "description": [ + "The layer ID or listener previously used to install the listener." + ], "signature": [ "string" ], @@ -3610,7 +3981,7 @@ "\nReturns an array of MapGeoJSONFeature objects\nrepresenting visible features that satisfy the query parameters.\n" ], "signature": [ - "(geometry?: maplibregl.PointLike | [maplibregl.PointLike, maplibregl.PointLike] | undefined, options?: any) => maplibregl.MapGeoJSONFeature[]" + "(geometryOrOptions?: maplibregl.PointLike | [maplibregl.PointLike, maplibregl.PointLike] | maplibregl.QueryRenderedFeaturesOptions | undefined, options?: maplibregl.QueryRenderedFeaturesOptions | undefined) => maplibregl.MapGeoJSONFeature[]" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3621,12 +3992,12 @@ "id": "def-common.Map.queryRenderedFeatures.$1", "type": "CompoundType", "tags": [], - "label": "geometry", + "label": "geometryOrOptions", "description": [ - "- The geometry of the query region:\neither a single point or southwest and northeast points describing a bounding box.\nOmitting this parameter (i.e. calling {@link MapqueryRenderedFeatures } with zero arguments,\nor with only a `options` argument) is equivalent to passing a bounding box encompassing the entire\nmap viewport." + "(optional) The geometry of the query region:\neither a single point or southwest and northeast points describing a bounding box.\nOmitting this parameter (i.e. calling {@link MapqueryRenderedFeatures } with zero arguments,\nor with only a `options` argument) is equivalent to passing a bounding box encompassing the entire\nmap viewport.\nThe geometryOrOptions can receive a QueryRenderedFeaturesOptions only to support a situation where the function receives only one parameter which is the options parameter." ], "signature": [ - "maplibregl.PointLike | [maplibregl.PointLike, maplibregl.PointLike] | undefined" + "maplibregl.PointLike | [maplibregl.PointLike, maplibregl.PointLike] | maplibregl.QueryRenderedFeaturesOptions | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3636,23 +4007,23 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.queryRenderedFeatures.$2", - "type": "Any", + "type": "Object", "tags": [], "label": "options", "description": [ - "Options object." + "(optional) Options object." ], "signature": [ - "any" + "maplibregl.QueryRenderedFeaturesOptions | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [ - "An array of MapGeoJSONFeature objects.\n\nThe `properties` value of each returned feature object contains the properties of its source feature. For GeoJSON sources, only\nstring and numeric property values are supported (i.e. `null`, `Array`, and `Object` values are not supported).\n\nEach feature includes top-level `layer`, `source`, and `sourceLayer` properties. The `layer` property is an object\nrepresenting the style layer to which the feature belongs. Layout and paint properties in this object contain values\nwhich are fully evaluated for the given zoom level and feature.\n\nOnly features that are currently rendered are included. Some features will **not** be included, like:\n\n- Features from layers whose `visibility` property is `\"none\"`.\n- Features from layers whose zoom range excludes the current zoom level.\n- Symbol features that have been hidden due to text or icon collision.\n\nFeatures from all other layers are included, including features that may have no visible\ncontribution to the rendered result; for example, because the layer's opacity or color alpha component is set to\n0.\n\nThe topmost rendered feature appears first in the returned array, and subsequent features are sorted by\ndescending z-order. Features that are rendered multiple times (due to wrapping across the antimeridian at low\nzoom levels) are returned only once (though subject to the following caveat).\n\nBecause features come from tiled vector data or GeoJSON data that is converted to tiles internally, feature\ngeometries may be split or duplicated across tile boundaries and, as a result, features may appear multiple\ntimes in query results. For example, suppose there is a highway running through the bounding rectangle of a query.\nThe results of the query will be those parts of the highway that lie within the map tiles covering the bounding\nrectangle, even if the highway extends into other tiles, and the portion of the highway within each map tile\nwill be returned as a separate feature. Similarly, a point feature near a tile boundary may appear in multiple\ntiles due to tile buffering." + "An array of MapGeoJSONFeature objects.\n\nThe `properties` value of each returned feature object contains the properties of its source feature. For GeoJSON sources, only\nstring and numeric property values are supported (i.e. `null`, `Array`, and `Object` values are not supported).\n\nEach feature includes top-level `layer`, `source`, and `sourceLayer` properties. The `layer` property is an object\nrepresenting the style layer to which the feature belongs. Layout and paint properties in this object contain values\nwhich are fully evaluated for the given zoom level and feature.\n\nOnly features that are currently rendered are included. Some features will **not** be included, like:\n\n- Features from layers whose `visibility` property is `\"none\"`.\n- Features from layers whose zoom range excludes the current zoom level.\n- Symbol features that have been hidden due to text or icon collision.\n\nFeatures from all other layers are included, including features that may have no visible\ncontribution to the rendered result; for example, because the layer's opacity or color alpha component is set to\n0.\n\nThe topmost rendered feature appears first in the returned array, and subsequent features are sorted by\ndescending z-order. Features that are rendered multiple times (due to wrapping across the antemeridian at low\nzoom levels) are returned only once (though subject to the following caveat).\n\nBecause features come from tiled vector data or GeoJSON data that is converted to tiles internally, feature\ngeometries may be split or duplicated across tile boundaries and, as a result, features may appear multiple\ntimes in query results. For example, suppose there is a highway running through the bounding rectangle of a query.\nThe results of the query will be those parts of the highway that lie within the map tiles covering the bounding\nrectangle, even if the highway extends into other tiles, and the portion of the highway within each map tile\nwill be returned as a separate feature. Similarly, a point feature near a tile boundary may appear in multiple\ntiles due to tile buffering." ] }, { @@ -3665,7 +4036,7 @@ "\nReturns an array of MapGeoJSONFeature objects\nrepresenting features within the specified vector tile or GeoJSON source that satisfy the query parameters.\n" ], "signature": [ - "(sourceId: string, parameters?: { sourceLayer: string; filter: any[]; validate?: boolean | undefined; } | null | undefined) => maplibregl.MapGeoJSONFeature[]" + "(sourceId: string, parameters?: { sourceLayer?: string | undefined; filter?: maplibregl.FilterSpecification | undefined; validate?: boolean | undefined; } | null | undefined) => maplibregl.MapGeoJSONFeature[]" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3698,7 +4069,7 @@ "Options object." ], "signature": [ - "{ sourceLayer: string; filter: any[]; validate?: boolean | undefined; } | null | undefined" + "{ sourceLayer?: string | undefined; filter?: maplibregl.FilterSpecification | undefined; validate?: boolean | undefined; } | null | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3720,7 +4091,7 @@ "\nUpdates the map's MapLibre style object with a new value.\n\nIf a style is already set when this is used and options.diff is set to true, the map renderer will attempt to compare the given style\nagainst the map's current state and perform only the changes necessary to make the map style match the desired state. Changes in sprites\n(images used for icons and patterns) and glyphs (fonts for label text) **cannot** be diffed. If the sprites or fonts used in the current\nstyle and the given style are different in any way, the map renderer will force a full update, removing the current style and building\nthe given one from scratch.\n\n" ], "signature": [ - "(style: string | maplibregl.StyleSpecification | null, options?: ({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined) => this" + "(style: string | maplibregl.StyleSpecification | null, options?: (maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined) => this" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3733,7 +4104,7 @@ "tags": [], "label": "style", "description": [ - "A JSON object conforming to the schema described in the\n[MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/), or a URL to such JSON." + "A JSON object conforming to the schema described in the\n[MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/), or a URL to such JSON." ], "signature": [ "string | maplibregl.StyleSpecification | null" @@ -3753,7 +4124,7 @@ "Options object." ], "signature": [ - "({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined" + "(maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3843,7 +4214,7 @@ "label": "_updateStyle", "description": [], "signature": [ - "(style: string | maplibregl.StyleSpecification | null, options?: ({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined) => this" + "(style: string | maplibregl.StyleSpecification | null, options?: (maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined) => this" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3872,7 +4243,7 @@ "label": "options", "description": [], "signature": [ - "({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined" + "(maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3906,7 +4277,7 @@ "label": "_diffStyle", "description": [], "signature": [ - "(style: string | maplibregl.StyleSpecification, options?: ({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined) => void" + "(style: string | maplibregl.StyleSpecification, options?: (maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined) => void" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3935,7 +4306,7 @@ "label": "options", "description": [], "signature": [ - "({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined" + "(maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3953,7 +4324,7 @@ "label": "_updateDiff", "description": [], "signature": [ - "(style: maplibregl.StyleSpecification, options?: ({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined) => void" + "(style: maplibregl.StyleSpecification, options?: (maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined) => void" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3982,7 +4353,7 @@ "label": "options", "description": [], "signature": [ - "({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined" + "(maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -4075,7 +4446,7 @@ "tags": [], "label": "source", "description": [ - "The source object, conforming to the\nMapLibre Style Specification's [source definition](https://maplibre.org/maplibre-gl-js-docs/style-spec/#sources) or\n{@link CanvasSourceOptions }." + "The source object, conforming to the\nMapLibre Style Specification's [source definition](https://maplibre.org/maplibre-style-spec/#sources) or\n{@link CanvasSourceOptions }." ], "signature": [ "maplibregl.SourceSpecification" @@ -4128,6 +4499,64 @@ "A Boolean indicating whether the source is loaded." ] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setTerrain", + "type": "Function", + "tags": [], + "label": "setTerrain", + "description": [ + "\nLoads a 3D terrain mesh, based on a \"raster-dem\" source." + ], + "signature": [ + "(options: maplibregl.TerrainSpecification) => maplibregl.Map" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setTerrain.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "Options object." + ], + "signature": [ + "maplibregl.TerrainSpecification" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "`this`" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getTerrain", + "type": "Function", + "tags": [], + "label": "getTerrain", + "description": [ + "\nGet the terrain-options if terrain is loaded" + ], + "signature": [ + "() => maplibregl.TerrainSpecification" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [ + "the TerrainSpecification passed to setTerrain" + ] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.areTilesLoaded", @@ -4230,7 +4659,7 @@ "\nRemoves a source from the map's style.\n" ], "signature": [ - "(id: string) => this" + "(id: string) => maplibregl.Map" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -4297,7 +4726,7 @@ } ], "returnComment": [ - "The style source with the specified ID or `undefined` if the ID\ncorresponds to no existing sources.\nThe shape of the object varies by source type.\nA list of options for each source type is available on the MapLibre Style Specification's\n[Sources](https://maplibre.org/maplibre-gl-js-docs/style-spec/sources/) page." + "The style source with the specified ID or `undefined` if the ID\ncorresponds to no existing sources.\nThe shape of the object varies by source type.\nA list of options for each source type is available on the MapLibre Style Specification's\n[Sources](https://maplibre.org/maplibre-style-spec/sources/) page." ] }, { @@ -4310,7 +4739,7 @@ ], "label": "addImage", "description": [ - "\nAdd an image to the style. This image can be displayed on the map like any other icon in the style's\nsprite using the image's ID with\n[`icon-image`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layout-symbol-icon-image),\n[`background-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-background-background-pattern),\n[`fill-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-fill-fill-pattern),\nor [`line-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-line-line-pattern).\nA {@link Map.event:error} event will be fired if there is not enough space in the sprite to add this image.\n" + "\nAdd an image to the style. This image can be displayed on the map like any other icon in the style's\nsprite using the image's ID with\n[`icon-image`](https://maplibre.org/maplibre-style-spec/#layout-symbol-icon-image),\n[`background-pattern`](https://maplibre.org/maplibre-style-spec/#paint-background-background-pattern),\n[`fill-pattern`](https://maplibre.org/maplibre-style-spec/#paint-fill-fill-pattern),\nor [`line-pattern`](https://maplibre.org/maplibre-style-spec/#paint-line-line-pattern).\nA {@link Map.event:error} event will be fired if there is not enough space in the sprite to add this image.\n" ], "signature": [ "(id: string, image: HTMLImageElement | ImageBitmap | ImageData | { width: number; height: number; data: Uint8Array | Uint8ClampedArray; } | maplibregl.StyleImageInterface, { pixelRatio, sdf, stretchX, stretchY, content }?: Partial | undefined) => this" @@ -4378,7 +4807,7 @@ "tags": [], "label": "updateImage", "description": [ - "\nUpdate an existing image in a style. This image can be displayed on the map like any other icon in the style's\nsprite using the image's ID with\n[`icon-image`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layout-symbol-icon-image),\n[`background-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-background-background-pattern),\n[`fill-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-fill-fill-pattern),\nor [`line-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-line-line-pattern).\n" + "\nUpdate an existing image in a style. This image can be displayed on the map like any other icon in the style's\nsprite using the image's ID with\n[`icon-image`](https://maplibre.org/maplibre-style-spec/#layout-symbol-icon-image),\n[`background-pattern`](https://maplibre.org/maplibre-style-spec/#paint-background-background-pattern),\n[`fill-pattern`](https://maplibre.org/maplibre-style-spec/#paint-fill-fill-pattern),\nor [`line-pattern`](https://maplibre.org/maplibre-style-spec/#paint-line-line-pattern).\n" ], "signature": [ "(id: string, image: HTMLImageElement | ImageBitmap | ImageData | maplibregl.StyleImageInterface | { width: number; height: number; data: Uint8Array | Uint8ClampedArray; }) => this" @@ -4424,6 +4853,44 @@ ], "returnComment": [] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getImage", + "type": "Function", + "tags": [], + "label": "getImage", + "description": [ + "\nReturns an image, specified by ID, currently available in the map.\nThis includes both images from the style's original sprite\nand any images that have been added at runtime using {@link Map#addImage}.\n" + ], + "signature": [ + "(id: string) => maplibregl.StyleImage" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getImage.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of the image." + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "An image in the map with the specified ID." + ] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.hasImage", @@ -4584,10 +5051,10 @@ ], "label": "addLayer", "description": [ - "\nAdds a [MapLibre style layer](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layers)\nto the map's style.\n\nA layer defines how data from a specified source will be styled. Read more about layer types\nand available paint and layout properties in the [MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layers).\n" + "\nAdds a [MapLibre style layer](https://maplibre.org/maplibre-style-spec/#layers)\nto the map's style.\n\nA layer defines how data from a specified source will be styled. Read more about layer types\nand available paint and layout properties in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/#layers).\n\nTODO: JSDoc can't pass @param {(LayerSpecification & {source?: string | SourceSpecification}) | CustomLayerInterface} layer The layer to add," ], "signature": [ - "(layer: maplibregl.LayerSpecification | maplibregl.CustomLayerInterface, beforeId?: string | undefined) => this" + "(layer: (maplibregl.LayerSpecification & { source?: string | maplibregl.SourceSpecification | undefined; }) | maplibregl.CustomLayerInterface, beforeId?: string | undefined) => this" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -4600,10 +5067,10 @@ "tags": [], "label": "layer", "description": [ - "The layer to add, conforming to either the MapLibre Style Specification's [layer definition](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layers) or, less commonly, the {@link CustomLayerInterface } specification.\nThe MapLibre Style Specification's layer definition is appropriate for most layers." + "conforming to either the MapLibre Style Specification's [layer definition](https://maplibre.org/maplibre-style-spec/#layers) or,\nless commonly, the {@link CustomLayerInterface } specification.\nThe MapLibre Style Specification's layer definition is appropriate for most layers." ], "signature": [ - "maplibregl.LayerSpecification | maplibregl.CustomLayerInterface" + "(maplibregl.LayerSpecification & { source?: string | maplibregl.SourceSpecification | undefined; }) | maplibregl.CustomLayerInterface" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -4773,7 +5240,7 @@ "tags": [], "label": "setLayerZoomRange", "description": [ - "\nSets the zoom extent for the specified style layer. The zoom extent includes the\n[minimum zoom level](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layer-minzoom)\nand [maximum zoom level](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layer-maxzoom))\nat which the layer will be rendered.\n\nNote: For style layers using vector sources, style layers cannot be rendered at zoom levels lower than the\nminimum zoom level of the _source layer_ because the data does not exist at those zoom levels. If the minimum\nzoom level of the source layer is higher than the minimum zoom level defined in the style layer, the style\nlayer will not be rendered at all zoom levels in the zoom range.\n" + "\nSets the zoom extent for the specified style layer. The zoom extent includes the\n[minimum zoom level](https://maplibre.org/maplibre-style-spec/#layer-minzoom)\nand [maximum zoom level](https://maplibre.org/maplibre-style-spec/#layer-maxzoom))\nat which the layer will be rendered.\n\nNote: For style layers using vector sources, style layers cannot be rendered at zoom levels lower than the\nminimum zoom level of the _source layer_ because the data does not exist at those zoom levels. If the minimum\nzoom level of the source layer is higher than the minimum zoom level defined in the style layer, the style\nlayer will not be rendered at all zoom levels in the zoom range.\n" ], "signature": [ "(layerId: string, minzoom: number, maxzoom: number) => this" @@ -4880,7 +5347,7 @@ "tags": [], "label": "filter", "description": [ - "The filter, conforming to the MapLibre Style Specification's\n[filter definition](https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#filter). If `null` or `undefined` is provided, the function removes any existing filter from the layer." + "The filter, conforming to the MapLibre Style Specification's\n[filter definition](https://maplibre.org/maplibre-style-spec/layers/#filter). If `null` or `undefined` is provided, the function removes any existing filter from the layer." ], "signature": [ "maplibregl.FilterSpecification | null | undefined" @@ -5010,7 +5477,7 @@ "tags": [], "label": "value", "description": [ - "The value of the paint property to set.\nMust be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/)." + "The value of the paint property to set.\nMust be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/)." ], "signature": [ "any" @@ -5154,7 +5621,7 @@ "tags": [], "label": "value", "description": [ - "The value of the layout property. Must be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/)." + "The value of the layout property. Must be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/)." ], "signature": [ "any" @@ -5166,20 +5633,264 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map.setLayoutProperty.$4", - "type": "Object", + "id": "def-common.Map.setLayoutProperty.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "Options object." + ], + "signature": [ + "maplibregl.StyleSetterOptions | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [ + "`this`" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getLayoutProperty", + "type": "Function", + "tags": [], + "label": "getLayoutProperty", + "description": [ + "\nReturns the value of a layout property in the specified style layer.\n" + ], + "signature": [ + "(layerId: string, name: string) => any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getLayoutProperty.$1", + "type": "string", + "tags": [], + "label": "layerId", + "description": [ + "The ID of the layer to get the layout property from." + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getLayoutProperty.$2", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "The name of the layout property to get." + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "The value of the specified layout property." + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setGlyphs", + "type": "Function", + "tags": [], + "label": "setGlyphs", + "description": [ + "\nSets the value of the style's glyphs property.\n" + ], + "signature": [ + "(glyphsUrl: string | null, options?: maplibregl.StyleSetterOptions | undefined) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setGlyphs.$1", + "type": "CompoundType", + "tags": [], + "label": "glyphsUrl", + "description": [ + "Glyph URL to set. Must conform to the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/glyphs/)." + ], + "signature": [ + "string | null" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setGlyphs.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "Options object." + ], + "signature": [ + "maplibregl.StyleSetterOptions | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [ + "`this`" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getGlyphs", + "type": "Function", + "tags": [], + "label": "getGlyphs", + "description": [ + "\nReturns the value of the style's glyphs URL\n" + ], + "signature": [ + "() => string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [ + "glyphs Style's glyphs url" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.addSprite", + "type": "Function", + "tags": [ + "fires" + ], + "label": "addSprite", + "description": [ + "\nAdds a sprite to the map's style.\n" + ], + "signature": [ + "(id: string, url: string, options?: maplibregl.StyleSetterOptions | undefined) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.addSprite.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of the sprite to add. Must not conflict with existing sprites." + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.addSprite.$2", + "type": "string", + "tags": [], + "label": "url", + "description": [ + "The URL to load the sprite from" + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.addSprite.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "Options object." + ], + "signature": [ + "maplibregl.StyleSetterOptions | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [ + "`this`" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.removeSprite", + "type": "Function", + "tags": [ + "fires" + ], + "label": "removeSprite", + "description": [ + "\nRemoves the sprite from the map's style.\n" + ], + "signature": [ + "(id: string) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.removeSprite.$1", + "type": "string", "tags": [], - "label": "options", + "label": "id", "description": [ - "Options object." + "The ID of the sprite to remove. If the sprite is declared as a single URL, the ID must be \"default\"." ], "signature": [ - "maplibregl.StyleSetterOptions | undefined" + "string" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": false + "isRequired": true } ], "returnComment": [ @@ -5188,15 +5899,35 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map.getLayoutProperty", + "id": "def-common.Map.getSprite", "type": "Function", "tags": [], - "label": "getLayoutProperty", + "label": "getSprite", "description": [ - "\nReturns the value of a layout property in the specified style layer.\n" + "\nReturns the as-is value of the style's sprite.\n" ], "signature": [ - "(layerId: string, name: string) => any" + "() => { id: string; url: string; }[]" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [ + "style's sprite url or a list of id-url pairs" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setSprite", + "type": "Function", + "tags": [], + "label": "setSprite", + "description": [ + "\nSets the value of the style's sprite property.\n" + ], + "signature": [ + "(spriteUrl: string | null, options?: maplibregl.StyleSetterOptions | undefined) => this" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -5204,41 +5935,41 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map.getLayoutProperty.$1", - "type": "string", + "id": "def-common.Map.setSprite.$1", + "type": "CompoundType", "tags": [], - "label": "layerId", + "label": "spriteUrl", "description": [ - "The ID of the layer to get the layout property from." + "Sprite URL to set." ], "signature": [ - "string" + "string | null" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map.getLayoutProperty.$2", - "type": "string", + "id": "def-common.Map.setSprite.$2", + "type": "Object", "tags": [], - "label": "name", + "label": "options", "description": [ - "The name of the layout property to get." + "Options object." ], "signature": [ - "string" + "maplibregl.StyleSetterOptions | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [ - "The value of the specified layout property." + "`this`" ] }, { @@ -5264,7 +5995,7 @@ "tags": [], "label": "light", "description": [ - "Light properties to set. Must conform to the [MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/#light)." + "Light properties to set. Must conform to the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/#light)." ], "signature": [ "maplibregl.LightSpecification" @@ -5325,7 +6056,7 @@ ], "label": "setFeatureState", "description": [ - "\nSets the `state` of a feature.\nA feature's `state` is a set of user-defined key-value pairs that are assigned to a feature at runtime.\nWhen using this method, the `state` object is merged with any existing key-value pairs in the feature's state.\nFeatures are identified by their `feature.id` attribute, which can be any number or string.\n\nThis method can only be used with sources that have a `feature.id` attribute. The `feature.id` attribute can be defined in three ways:\n- For vector or GeoJSON sources, including an `id` attribute in the original data file.\n- For vector or GeoJSON sources, using the [`promoteId`](https://maplibre.org/maplibre-gl-js-docs/style-spec/sources/#vector-promoteId) option at the time the source is defined.\n- For GeoJSON sources, using the [`generateId`](https://maplibre.org/maplibre-gl-js-docs/style-spec/sources/#geojson-generateId) option to auto-assign an `id` based on the feature's index in the source data. If you change feature data using `map.getSource('some id').setData(..)`, you may need to re-apply state taking into account updated `id` values.\n\n_Note: You can use the [`feature-state` expression](https://maplibre.org/maplibre-gl-js-docs/style-spec/expressions/#feature-state) to access the values in a feature's state object for the purposes of styling._\n" + "\nSets the `state` of a feature.\nA feature's `state` is a set of user-defined key-value pairs that are assigned to a feature at runtime.\nWhen using this method, the `state` object is merged with any existing key-value pairs in the feature's state.\nFeatures are identified by their `feature.id` attribute, which can be any number or string.\n\nThis method can only be used with sources that have a `feature.id` attribute. The `feature.id` attribute can be defined in three ways:\n- For vector or GeoJSON sources, including an `id` attribute in the original data file.\n- For vector or GeoJSON sources, using the [`promoteId`](https://maplibre.org/maplibre-style-spec/sources/#vector-promoteId) option at the time the source is defined.\n- For GeoJSON sources, using the [`generateId`](https://maplibre.org/maplibre-style-spec/sources/#geojson-generateId) option to auto-assign an `id` based on the feature's index in the source data. If you change feature data using `map.getSource('some id').setData(..)`, you may need to re-apply state taking into account updated `id` values.\n\n_Note: You can use the [`feature-state` expression](https://maplibre.org/maplibre-style-spec/expressions/#feature-state) to access the values in a feature's state object for the purposes of styling._\n" ], "signature": [ "(feature: maplibregl.FeatureIdentifier, state: any) => this" @@ -5431,7 +6162,7 @@ "tags": [], "label": "getFeatureState", "description": [ - "\nGets the `state` of a feature.\nA feature's `state` is a set of user-defined key-value pairs that are assigned to a feature at runtime.\nFeatures are identified by their `feature.id` attribute, which can be any number or string.\n\n_Note: To access the values in a feature's state object for the purposes of styling the feature, use the [`feature-state` expression](https://maplibre.org/maplibre-gl-js-docs/style-spec/expressions/#feature-state)._\n" + "\nGets the `state` of a feature.\nA feature's `state` is a set of user-defined key-value pairs that are assigned to a feature at runtime.\nFeatures are identified by their `feature.id` attribute, which can be any number or string.\n\n_Note: To access the values in a feature's state object for the purposes of styling the feature, use the [`feature-state` expression](https://maplibre.org/maplibre-style-spec/expressions/#feature-state)._\n" ], "signature": [ "(feature: maplibregl.FeatureIdentifier) => any" @@ -5560,6 +6291,70 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._cooperativeGesturesOnWheel", + "type": "Function", + "tags": [], + "label": "_cooperativeGesturesOnWheel", + "description": [], + "signature": [ + "(event: WheelEvent) => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._cooperativeGesturesOnWheel.$1", + "type": "Object", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "WheelEvent" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._setupCooperativeGestures", + "type": "Function", + "tags": [], + "label": "_setupCooperativeGestures", + "description": [], + "signature": [ + "() => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._destroyCooperativeGestures", + "type": "Function", + "tags": [], + "label": "_destroyCooperativeGestures", + "description": [], + "signature": [ + "() => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map._resizeCanvas", @@ -5734,6 +6529,68 @@ ], "returnComment": [] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._onCooperativeGesture", + "type": "Function", + "tags": [], + "label": "_onCooperativeGesture", + "description": [], + "signature": [ + "(event: any, metaPress: any, touches: any) => boolean" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._onCooperativeGesture.$1", + "type": "Any", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._onCooperativeGesture.$2", + "type": "Any", + "tags": [], + "label": "metaPress", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._onCooperativeGesture.$3", + "type": "Any", + "tags": [], + "label": "touches", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.loaded", @@ -5979,38 +6836,6 @@ "children": [], "returnComment": [] }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map._onWindowResize", - "type": "Function", - "tags": [], - "label": "_onWindowResize", - "description": [], - "signature": [ - "(event: maplibregl.Event) => void" - ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map._onWindowResize.$1", - "type": "Object", - "tags": [], - "label": "event", - "description": [], - "signature": [ - "maplibregl.Event" - ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.showTileBoundaries", @@ -6173,50 +6998,36 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map._setCacheLimits", + "id": "def-common.Map.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nReturns the package version of the library" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getCameraTargetElevation", "type": "Function", "tags": [], - "label": "_setCacheLimits", - "description": [], + "label": "getCameraTargetElevation", + "description": [ + "\nReturns the elevation for the point where the camera is looking.\nThis value corresponds to:\n\"meters above sea level\" * \"exaggeration\"" + ], "signature": [ - "(limit: number, checkThreshold: number) => void" + "() => number" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map._setCacheLimits.$1", - "type": "number", - "tags": [], - "label": "limit", - "description": [], - "signature": [ - "number" - ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map._setCacheLimits.$2", - "type": "number", - "tags": [], - "label": "checkThreshold", - "description": [], - "signature": [ - "number" - ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] + "children": [], + "returnComment": [ + "* The elevation." + ] } ], "initialIsOpen": false @@ -7794,7 +8605,7 @@ "\nCalled during a render frame allowing the layer to draw into the GL context.\n\nThe layer can assume blending and depth state is set to allow the layer to properly\nblend and clip other layers. The layer cannot make any other assumptions about the\ncurrent GL state.\n\nIf the layer needs to render to a texture, it should implement the `prerender` method\nto do this and only use the `render` method for drawing directly into the main framebuffer.\n\nThe blend function is set to `gl.blendFunc(gl.ONE, gl.ONE_MINUS_SRC_ALPHA)`. This expects\ncolors to be provided in premultiplied alpha form where the `r`, `g` and `b` values are already\nmultiplied by the `a` value. If you are unable to provide colors in premultiplied form you\nmay want to change the blend function to\n`gl.blendFuncSeparate(gl.SRC_ALPHA, gl.ONE_MINUS_SRC_ALPHA, gl.ONE, gl.ONE_MINUS_SRC_ALPHA)`.\n" ], "signature": [ - "(gl: WebGLRenderingContext, matrix: ", + "(gl: WebGLRenderingContext | WebGL2RenderingContext, matrix: ", "mat4", ") => void" ], @@ -7806,14 +8617,14 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.CustomLayerInterface.render.$1", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "gl", "description": [ "The map's gl context." ], "signature": [ - "WebGLRenderingContext" + "WebGLRenderingContext | WebGL2RenderingContext" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -7873,7 +8684,7 @@ "\nOptional method called when the layer has been added to the Map with {@link Map#addLayer}. This\ngives the layer a chance to initialize gl resources and register event listeners.\n" ], "signature": [ - "((map: maplibregl.Map, gl: WebGLRenderingContext) => void) | undefined" + "((map: maplibregl.Map, gl: WebGLRenderingContext | WebGL2RenderingContext) => void) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -7899,14 +8710,14 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.CustomLayerInterface.onAdd.$2", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "gl", "description": [ "The gl context for the map." ], "signature": [ - "WebGLRenderingContext" + "WebGLRenderingContext | WebGL2RenderingContext" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -7931,7 +8742,7 @@ "\nOptional method called when the layer has been removed from the Map with {@link Map#removeLayer}. This\ngives the layer a chance to clean up gl resources and event listeners.\n" ], "signature": [ - "((map: maplibregl.Map, gl: WebGLRenderingContext) => void) | undefined" + "((map: maplibregl.Map, gl: WebGLRenderingContext | WebGL2RenderingContext) => void) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -7957,14 +8768,14 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.CustomLayerInterface.onRemove.$2", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "gl", "description": [ "The gl context for the map." ], "signature": [ - "WebGLRenderingContext" + "WebGLRenderingContext | WebGL2RenderingContext" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -7985,7 +8796,7 @@ "label": "MapSourceDataEvent", "description": [], "signature": [ - "maplibregl.MapSourceDataEvent extends maplibregl.MapLibreEvent" + "maplibregl.MapSourceDataEvent extends maplibregl.MapLibreEvent" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -8049,7 +8860,7 @@ "label": "sourceDataType", "description": [], "signature": [ - "\"metadata\" | \"content\"" + "\"metadata\" | \"content\" | \"visibility\" | \"idle\"" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -8602,9 +9413,9 @@ "label": "FilterSpecification", "description": [], "signature": [ - "[\"at\", number, (string | number)[]] | [\"get\", string, (Record | undefined)?] | [\"has\", string, (Record | undefined)?] | [\"in\", ...maplibregl.FilterSpecificationInputType[], maplibregl.FilterSpecificationInputType | maplibregl.FilterSpecificationInputType[]] | [\"index-of\", maplibregl.FilterSpecificationInputType, maplibregl.FilterSpecificationInputType | maplibregl.FilterSpecificationInputType[]] | [\"length\", string | string[]] | [\"slice\", string | string[], number] | [\"!\", maplibregl.FilterSpecification] | [\"!=\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\"<\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\"<=\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\"==\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\">\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\">=\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\"all\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"any\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"case\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"coalesce\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"match\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"within\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"!in\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"!has\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"none\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | (string | maplibregl.FilterSpecification)[]" + "maplibregl.ExpressionFilterSpecification | maplibregl.LegacyFilterSpecification" ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "path": "node_modules/@maplibre/maplibre-gl-style-spec/dist/index.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -8619,7 +9430,7 @@ "signature": [ "maplibregl.FillLayerSpecification | maplibregl.LineLayerSpecification | maplibregl.SymbolLayerSpecification | maplibregl.CircleLayerSpecification | maplibregl.HeatmapLayerSpecification | maplibregl.FillExtrusionLayerSpecification | maplibregl.RasterLayerSpecification | maplibregl.HillshadeLayerSpecification | maplibregl.BackgroundLayerSpecification" ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "path": "node_modules/@maplibre/maplibre-gl-style-spec/dist/index.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -8632,7 +9443,7 @@ "label": "MapEvent", "description": [], "signature": [ - "\"error\" | \"remove\" | \"data\" | \"move\" | \"render\" | \"rotate\" | \"resize\" | \"zoom\" | \"idle\" | \"mousedown\" | \"mouseup\" | \"mouseover\" | \"mousemove\" | \"click\" | \"dblclick\" | \"mouseenter\" | \"mouseleave\" | \"mouseout\" | \"contextmenu\" | \"wheel\" | \"touchstart\" | \"touchend\" | \"touchmove\" | \"touchcancel\" | \"movestart\" | \"moveend\" | \"dragstart\" | \"drag\" | \"dragend\" | \"zoomstart\" | \"zoomend\" | \"rotatestart\" | \"rotateend\" | \"pitchstart\" | \"pitch\" | \"pitchend\" | \"boxzoomstart\" | \"boxzoomend\" | \"boxzoomcancel\" | \"webglcontextlost\" | \"webglcontextrestored\" | \"load\" | \"styledata\" | \"sourcedata\" | \"dataloading\" | \"styledataloading\" | \"sourcedataloading\" | \"styleimagemissing\" | \"style.load\" | \"dataabort\" | \"sourcedataabort\"" + "\"error\" | \"remove\" | \"data\" | \"move\" | \"render\" | \"rotate\" | \"resize\" | \"zoom\" | \"idle\" | \"mousedown\" | \"mouseup\" | \"mouseover\" | \"mousemove\" | \"click\" | \"dblclick\" | \"mouseenter\" | \"mouseleave\" | \"mouseout\" | \"contextmenu\" | \"wheel\" | \"touchstart\" | \"touchend\" | \"touchmove\" | \"touchcancel\" | \"movestart\" | \"moveend\" | \"dragstart\" | \"drag\" | \"dragend\" | \"zoomstart\" | \"zoomend\" | \"rotatestart\" | \"rotateend\" | \"pitchstart\" | \"pitch\" | \"pitchend\" | \"boxzoomstart\" | \"boxzoomend\" | \"boxzoomcancel\" | \"webglcontextlost\" | \"webglcontextrestored\" | \"load\" | \"styledata\" | \"sourcedata\" | \"dataloading\" | \"styledataloading\" | \"sourcedataloading\" | \"styleimagemissing\" | \"style.load\" | \"terrain\" | \"dataabort\" | \"sourcedataabort\"" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -8647,7 +9458,7 @@ "label": "MapGeoJSONFeature", "description": [], "signature": [ - "maplibregl.GeoJSONFeature & { layer: Omit & { source: string; }; source: string; sourceLayer?: string | undefined; state: { [key: string]: any; }; }" + "maplibregl.GeoJSONFeature & { layer: (Omit | Omit | Omit | Omit | Omit | Omit | Omit | Omit | Omit) & { source: string; }; source: string; sourceLayer?: string | undefined; state: { [key: string]: any; }; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -8677,7 +9488,7 @@ "label": "MapOptions", "description": [], "signature": [ - "{ hash?: string | boolean | undefined; interactive?: boolean | undefined; container: string | HTMLElement; bearingSnap?: number | undefined; attributionControl?: boolean | undefined; customAttribution?: string | string[] | undefined; maplibreLogo?: boolean | undefined; logoPosition?: maplibregl.ControlPosition | undefined; failIfMajorPerformanceCaveat?: boolean | undefined; preserveDrawingBuffer?: boolean | undefined; antialias?: boolean | undefined; refreshExpiredTiles?: boolean | undefined; maxBounds?: maplibregl.LngLatBoundsLike | undefined; scrollZoom?: boolean | undefined; minZoom?: number | null | undefined; maxZoom?: number | null | undefined; minPitch?: number | null | undefined; maxPitch?: number | null | undefined; boxZoom?: boolean | undefined; dragRotate?: boolean | undefined; dragPan?: boolean | maplibregl.DragPanOptions | undefined; keyboard?: boolean | undefined; doubleClickZoom?: boolean | undefined; touchZoomRotate?: boolean | undefined; touchPitch?: boolean | undefined; trackResize?: boolean | undefined; center?: maplibregl.LngLatLike | undefined; zoom?: number | undefined; bearing?: number | undefined; pitch?: number | undefined; renderWorldCopies?: boolean | undefined; maxTileCacheSize?: number | undefined; transformRequest?: maplibregl.RequestTransformFunction | undefined; locale?: any; fadeDuration?: number | undefined; crossSourceCollisions?: boolean | undefined; collectResourceTiming?: boolean | undefined; clickTolerance?: number | undefined; bounds?: maplibregl.LngLatBoundsLike | undefined; fitBoundsOptions?: Object | undefined; localIdeographFontFamily?: string | undefined; style: string | maplibregl.StyleSpecification; pitchWithRotate?: boolean | undefined; pixelRatio?: number | undefined; }" + "{ hash?: string | boolean | undefined; interactive?: boolean | undefined; container: string | HTMLElement; bearingSnap?: number | undefined; attributionControl?: boolean | undefined; customAttribution?: string | string[] | undefined; maplibreLogo?: boolean | undefined; logoPosition?: maplibregl.ControlPosition | undefined; failIfMajorPerformanceCaveat?: boolean | undefined; preserveDrawingBuffer?: boolean | undefined; antialias?: boolean | undefined; refreshExpiredTiles?: boolean | undefined; maxBounds?: maplibregl.LngLatBoundsLike | undefined; scrollZoom?: boolean | undefined; minZoom?: number | null | undefined; maxZoom?: number | null | undefined; minPitch?: number | null | undefined; maxPitch?: number | null | undefined; boxZoom?: boolean | undefined; dragRotate?: boolean | undefined; dragPan?: boolean | maplibregl.DragPanOptions | undefined; keyboard?: boolean | undefined; doubleClickZoom?: boolean | undefined; touchZoomRotate?: boolean | undefined; touchPitch?: boolean | undefined; cooperativeGestures?: boolean | maplibregl.GestureOptions | undefined; trackResize?: boolean | undefined; center?: maplibregl.LngLatLike | undefined; zoom?: number | undefined; bearing?: number | undefined; pitch?: number | undefined; renderWorldCopies?: boolean | undefined; maxTileCacheSize?: number | undefined; maxTileCacheZoomLevels?: number | undefined; transformRequest?: maplibregl.RequestTransformFunction | undefined; transformCameraUpdate?: maplibregl.CameraUpdateTransformFunction | undefined; locale?: any; fadeDuration?: number | undefined; crossSourceCollisions?: boolean | undefined; collectResourceTiming?: boolean | undefined; clickTolerance?: number | undefined; bounds?: maplibregl.LngLatBoundsLike | undefined; fitBoundsOptions?: Object | undefined; localIdeographFontFamily?: string | undefined; style: string | maplibregl.StyleSpecification; pitchWithRotate?: boolean | undefined; pixelRatio?: number | undefined; validateStyle?: boolean | undefined; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -8729,7 +9540,7 @@ "signature": [ "maplibregl.VectorSourceSpecification | maplibregl.RasterSourceSpecification | maplibregl.RasterDEMSourceSpecification | maplibregl.GeoJSONSourceSpecification | maplibregl.VideoSourceSpecification | maplibregl.ImageSourceSpecification" ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "path": "node_modules/@maplibre/maplibre-gl-style-spec/dist/index.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -8742,9 +9553,9 @@ "label": "StyleSpecification", "description": [], "signature": [ - "{ version: 8; name?: string | undefined; metadata?: unknown; center?: number[] | undefined; zoom?: number | undefined; bearing?: number | undefined; pitch?: number | undefined; light?: maplibregl.LightSpecification | undefined; sources: { [_: string]: maplibregl.SourceSpecification; }; sprite?: string | undefined; glyphs?: string | undefined; transition?: maplibregl.TransitionSpecification | undefined; layers: maplibregl.LayerSpecification[]; }" + "{ version: 8; name?: string | undefined; metadata?: unknown; center?: number[] | undefined; zoom?: number | undefined; bearing?: number | undefined; pitch?: number | undefined; light?: maplibregl.LightSpecification | undefined; terrain?: maplibregl.TerrainSpecification | undefined; sources: { [_: string]: maplibregl.SourceSpecification; }; sprite?: maplibregl.SpriteSpecification | undefined; glyphs?: string | undefined; transition?: maplibregl.TransitionSpecification | undefined; layers: maplibregl.LayerSpecification[]; }" ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "path": "node_modules/@maplibre/maplibre-gl-style-spec/dist/index.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index 5147299e37663..ea1b02a2bc783 100644 --- a/api_docs/kbn_mapbox_gl.mdx +++ b/api_docs/kbn_mapbox_gl.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-mapbox-gl title: "@kbn/mapbox-gl" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/mapbox-gl plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] --- import kbnMapboxGlObj from './kbn_mapbox_gl.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 535 | 1 | 1 | 0 | +| 582 | 1 | 1 | 0 | ## Common diff --git a/api_docs/kbn_maps_vector_tile_utils.mdx b/api_docs/kbn_maps_vector_tile_utils.mdx index 51b5793e598f9..2496b975e6f52 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: 2023-06-30 +date: 2023-07-18 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 f7d230fc98359..d21276b86474c 100644 --- a/api_docs/kbn_ml_agg_utils.mdx +++ b/api_docs/kbn_ml_agg_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-agg-utils title: "@kbn/ml-agg-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-agg-utils plugin -date: 2023-06-30 +date: 2023-07-18 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 79858ac6c6b98..19c1529e9262c 100644 --- a/api_docs/kbn_ml_anomaly_utils.mdx +++ b/api_docs/kbn_ml_anomaly_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-anomaly-utils title: "@kbn/ml-anomaly-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-anomaly-utils plugin -date: 2023-06-30 +date: 2023-07-18 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_data_frame_analytics_utils.mdx b/api_docs/kbn_ml_data_frame_analytics_utils.mdx index 404c6677a8d45..3bfbe00bf1b83 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: 2023-06-30 +date: 2023-07-18 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 3cf0bd8fc0b5f..8c8ffdf5d8671 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: 2023-06-30 +date: 2023-07-18 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 fcc436bd1a59e..2850121a538a8 100644 --- a/api_docs/kbn_ml_date_picker.mdx +++ b/api_docs/kbn_ml_date_picker.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-date-picker title: "@kbn/ml-date-picker" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-date-picker plugin -date: 2023-06-30 +date: 2023-07-18 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 ceb975a261cc3..7a0ae5a8021eb 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: 2023-06-30 +date: 2023-07-18 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 4183652a9393a..397520d54bec0 100644 --- a/api_docs/kbn_ml_error_utils.mdx +++ b/api_docs/kbn_ml_error_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-error-utils title: "@kbn/ml-error-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-error-utils plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-error-utils'] --- import kbnMlErrorUtilsObj from './kbn_ml_error_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_is_defined.mdx b/api_docs/kbn_ml_is_defined.mdx index 58ba1539b3081..244ce8df445d3 100644 --- a/api_docs/kbn_ml_is_defined.mdx +++ b/api_docs/kbn_ml_is_defined.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-is-defined title: "@kbn/ml-is-defined" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-is-defined plugin -date: 2023-06-30 +date: 2023-07-18 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 2d2f89cdd9335..fd7c50d37c492 100644 --- a/api_docs/kbn_ml_is_populated_object.mdx +++ b/api_docs/kbn_ml_is_populated_object.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-is-populated-object title: "@kbn/ml-is-populated-object" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-is-populated-object plugin -date: 2023-06-30 +date: 2023-07-18 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 850f72a2d8a25..594214ff10eae 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: 2023-06-30 +date: 2023-07-18 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 49e2245c6a7a5..2f80171afd8e7 100644 --- a/api_docs/kbn_ml_local_storage.mdx +++ b/api_docs/kbn_ml_local_storage.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-local-storage title: "@kbn/ml-local-storage" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-local-storage plugin -date: 2023-06-30 +date: 2023-07-18 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 3e9f27b990006..e700e10c96623 100644 --- a/api_docs/kbn_ml_nested_property.mdx +++ b/api_docs/kbn_ml_nested_property.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-nested-property title: "@kbn/ml-nested-property" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-nested-property plugin -date: 2023-06-30 +date: 2023-07-18 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 c56e7b9337574..4385e070b3b60 100644 --- a/api_docs/kbn_ml_number_utils.mdx +++ b/api_docs/kbn_ml_number_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-number-utils title: "@kbn/ml-number-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-number-utils plugin -date: 2023-06-30 +date: 2023-07-18 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 48d8e0fbc1f91..abe9adccc2e5d 100644 --- a/api_docs/kbn_ml_query_utils.mdx +++ b/api_docs/kbn_ml_query_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-query-utils title: "@kbn/ml-query-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-query-utils plugin -date: 2023-06-30 +date: 2023-07-18 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 8c5c2c7b50af1..6aa3d179c9add 100644 --- a/api_docs/kbn_ml_random_sampler_utils.mdx +++ b/api_docs/kbn_ml_random_sampler_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-random-sampler-utils title: "@kbn/ml-random-sampler-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-random-sampler-utils plugin -date: 2023-06-30 +date: 2023-07-18 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 e666f90f6b589..5530d80b160e2 100644 --- a/api_docs/kbn_ml_route_utils.mdx +++ b/api_docs/kbn_ml_route_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-route-utils title: "@kbn/ml-route-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-route-utils plugin -date: 2023-06-30 +date: 2023-07-18 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 e12985330e7f7..7250b10841b2a 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: 2023-06-30 +date: 2023-07-18 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 81b53da1eeec3..dddd29729ded5 100644 --- a/api_docs/kbn_ml_string_hash.mdx +++ b/api_docs/kbn_ml_string_hash.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-string-hash title: "@kbn/ml-string-hash" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-string-hash plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-string-hash'] --- import kbnMlStringHashObj from './kbn_ml_string_hash.devdocs.json'; diff --git a/api_docs/kbn_ml_trained_models_utils.mdx b/api_docs/kbn_ml_trained_models_utils.mdx index 322b7df40f21c..3b0518a68b30a 100644 --- a/api_docs/kbn_ml_trained_models_utils.mdx +++ b/api_docs/kbn_ml_trained_models_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-trained-models-utils title: "@kbn/ml-trained-models-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-trained-models-utils plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-trained-models-utils'] --- import kbnMlTrainedModelsUtilsObj from './kbn_ml_trained_models_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_url_state.mdx b/api_docs/kbn_ml_url_state.mdx index a0dee28b430bb..ee17a3da0da35 100644 --- a/api_docs/kbn_ml_url_state.mdx +++ b/api_docs/kbn_ml_url_state.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-url-state title: "@kbn/ml-url-state" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-url-state plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-url-state'] --- import kbnMlUrlStateObj from './kbn_ml_url_state.devdocs.json'; diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index 3609f9c080732..b841cd732b752 100644 --- a/api_docs/kbn_monaco.mdx +++ b/api_docs/kbn_monaco.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-monaco title: "@kbn/monaco" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/monaco plugin -date: 2023-06-30 +date: 2023-07-18 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 e5d61420d7f78..55356b25c9e94 100644 --- a/api_docs/kbn_object_versioning.mdx +++ b/api_docs/kbn_object_versioning.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-object-versioning title: "@kbn/object-versioning" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/object-versioning plugin -date: 2023-06-30 +date: 2023-07-18 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 4299751793d51..df113093293f2 100644 --- a/api_docs/kbn_observability_alert_details.mdx +++ b/api_docs/kbn_observability_alert_details.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-observability-alert-details title: "@kbn/observability-alert-details" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/observability-alert-details plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/observability-alert-details'] --- import kbnObservabilityAlertDetailsObj from './kbn_observability_alert_details.devdocs.json'; diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index 7fd8398aa88f7..8b3799c11488e 100644 --- a/api_docs/kbn_optimizer.mdx +++ b/api_docs/kbn_optimizer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer title: "@kbn/optimizer" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/optimizer plugin -date: 2023-06-30 +date: 2023-07-18 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 23af54fccf240..af8ea5b150bb8 100644 --- a/api_docs/kbn_optimizer_webpack_helpers.mdx +++ b/api_docs/kbn_optimizer_webpack_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer-webpack-helpers title: "@kbn/optimizer-webpack-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/optimizer-webpack-helpers plugin -date: 2023-06-30 +date: 2023-07-18 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 7cd16c465206b..d4560a8b1dcac 100644 --- a/api_docs/kbn_osquery_io_ts_types.mdx +++ b/api_docs/kbn_osquery_io_ts_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-osquery-io-ts-types title: "@kbn/osquery-io-ts-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/osquery-io-ts-types plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/osquery-io-ts-types'] --- import kbnOsqueryIoTsTypesObj from './kbn_osquery_io_ts_types.devdocs.json'; diff --git a/api_docs/kbn_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx index 4492c48928260..833e5d23f9e63 100644 --- a/api_docs/kbn_performance_testing_dataset_extractor.mdx +++ b/api_docs/kbn_performance_testing_dataset_extractor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-performance-testing-dataset-extractor title: "@kbn/performance-testing-dataset-extractor" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/performance-testing-dataset-extractor plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/performance-testing-dataset-extractor'] --- import kbnPerformanceTestingDatasetExtractorObj from './kbn_performance_testing_dataset_extractor.devdocs.json'; diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index ff9a96c9e9bca..640696bc9cd84 100644 --- a/api_docs/kbn_plugin_generator.mdx +++ b/api_docs/kbn_plugin_generator.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-generator title: "@kbn/plugin-generator" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/plugin-generator plugin -date: 2023-06-30 +date: 2023-07-18 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 b8368fa20e46a..5df36dfe851f1 100644 --- a/api_docs/kbn_plugin_helpers.mdx +++ b/api_docs/kbn_plugin_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-helpers title: "@kbn/plugin-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/plugin-helpers plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] --- import kbnPluginHelpersObj from './kbn_plugin_helpers.devdocs.json'; diff --git a/api_docs/kbn_random_sampling.mdx b/api_docs/kbn_random_sampling.mdx index cc67c47f1bc56..aa845874f9163 100644 --- a/api_docs/kbn_random_sampling.mdx +++ b/api_docs/kbn_random_sampling.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-random-sampling title: "@kbn/random-sampling" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/random-sampling plugin -date: 2023-06-30 +date: 2023-07-18 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 9c530b7779f8b..e0ba6a9d76140 100644 --- a/api_docs/kbn_react_field.mdx +++ b/api_docs/kbn_react_field.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-field title: "@kbn/react-field" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/react-field plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] --- import kbnReactFieldObj from './kbn_react_field.devdocs.json'; diff --git a/api_docs/kbn_repo_file_maps.mdx b/api_docs/kbn_repo_file_maps.mdx index a8f3d0a8052f9..e34253f96c37f 100644 --- a/api_docs/kbn_repo_file_maps.mdx +++ b/api_docs/kbn_repo_file_maps.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-file-maps title: "@kbn/repo-file-maps" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-file-maps plugin -date: 2023-06-30 +date: 2023-07-18 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 bbae305f56b89..1912f7331e31d 100644 --- a/api_docs/kbn_repo_linter.mdx +++ b/api_docs/kbn_repo_linter.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-linter title: "@kbn/repo-linter" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-linter plugin -date: 2023-06-30 +date: 2023-07-18 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 ad629e2e80480..8c120096b3cfc 100644 --- a/api_docs/kbn_repo_path.mdx +++ b/api_docs/kbn_repo_path.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-path title: "@kbn/repo-path" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-path plugin -date: 2023-06-30 +date: 2023-07-18 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 ee4a70da1444e..5494ee371ab0e 100644 --- a/api_docs/kbn_repo_source_classifier.mdx +++ b/api_docs/kbn_repo_source_classifier.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-source-classifier title: "@kbn/repo-source-classifier" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-source-classifier plugin -date: 2023-06-30 +date: 2023-07-18 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 e627c153b06f5..91a64c7e59dcd 100644 --- a/api_docs/kbn_reporting_common.mdx +++ b/api_docs/kbn_reporting_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-common title: "@kbn/reporting-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/reporting-common plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-common'] --- import kbnReportingCommonObj from './kbn_reporting_common.devdocs.json'; diff --git a/api_docs/kbn_rison.mdx b/api_docs/kbn_rison.mdx index 87a9a08671452..f6ff4470530e2 100644 --- a/api_docs/kbn_rison.mdx +++ b/api_docs/kbn_rison.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rison title: "@kbn/rison" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/rison plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rison'] --- import kbnRisonObj from './kbn_rison.devdocs.json'; diff --git a/api_docs/kbn_rrule.devdocs.json b/api_docs/kbn_rrule.devdocs.json new file mode 100644 index 0000000000000..849f4cc2f8ff7 --- /dev/null +++ b/api_docs/kbn_rrule.devdocs.json @@ -0,0 +1,273 @@ +{ + "id": "@kbn/rrule", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [ + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.RRule", + "type": "Class", + "tags": [], + "label": "RRule", + "description": [], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.RRule.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.RRule.Unnamed.$1", + "type": "CompoundType", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Options" + ], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.RRule.between", + "type": "Function", + "tags": [], + "label": "between", + "description": [], + "signature": [ + "(start: Date, end: Date) => Date[]" + ], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.RRule.between.$1", + "type": "Object", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "Date" + ], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.RRule.between.$2", + "type": "Object", + "tags": [], + "label": "end", + "description": [], + "signature": [ + "Date" + ], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.RRule.before", + "type": "Function", + "tags": [], + "label": "before", + "description": [], + "signature": [ + "(dt: Date) => Date" + ], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.RRule.before.$1", + "type": "Object", + "tags": [], + "label": "dt", + "description": [], + "signature": [ + "Date" + ], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.RRule.after", + "type": "Function", + "tags": [], + "label": "after", + "description": [], + "signature": [ + "(dt: Date) => Date | null" + ], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.RRule.after.$1", + "type": "Object", + "tags": [], + "label": "dt", + "description": [], + "signature": [ + "Date" + ], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.RRule.all", + "type": "Function", + "tags": [], + "label": "all", + "description": [], + "signature": [ + "(limit?: number) => AllResult" + ], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.RRule.all.$1", + "type": "number", + "tags": [], + "label": "limit", + "description": [], + "signature": [ + "number" + ], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [ + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.Frequency", + "type": "Enum", + "tags": [], + "label": "Frequency", + "description": [], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.Weekday", + "type": "Enum", + "tags": [], + "label": "Weekday", + "description": [], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.ConstructorOptions", + "type": "Type", + "tags": [], + "label": "ConstructorOptions", + "description": [], + "signature": [ + "Omit & { byweekday?: (string | number)[] | null | undefined; wkst?: number | \"MO\" | \"TU\" | \"WE\" | \"TH\" | \"FR\" | \"SA\" | \"SU\" | null | undefined; }" + ], + "path": "packages/kbn-rrule/rrule.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/rrule", + "id": "def-common.WeekdayStr", + "type": "Type", + "tags": [], + "label": "WeekdayStr", + "description": [], + "signature": [ + "\"MO\" | \"TU\" | \"WE\" | \"TH\" | \"FR\" | \"SA\" | \"SU\"" + ], + "path": "packages/kbn-rrule/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_rrule.mdx b/api_docs/kbn_rrule.mdx new file mode 100644 index 0000000000000..a963fb2c13d00 --- /dev/null +++ b/api_docs/kbn_rrule.mdx @@ -0,0 +1,36 @@ +--- +#### +#### 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: kibKbnRrulePluginApi +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: 2023-07-18 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rrule'] +--- +import kbnRruleObj from './kbn_rrule.devdocs.json'; + + + +Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 16 | 0 | 16 | 1 | + +## Common + +### Classes + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index 7a5fac77e05f9..ab3c2f99ce552 100644 --- a/api_docs/kbn_rule_data_utils.mdx +++ b/api_docs/kbn_rule_data_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rule-data-utils title: "@kbn/rule-data-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/rule-data-utils plugin -date: 2023-06-30 +date: 2023-07-18 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 02407a5984e2b..38db827c5bd0c 100644 --- a/api_docs/kbn_saved_objects_settings.mdx +++ b/api_docs/kbn_saved_objects_settings.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-saved-objects-settings title: "@kbn/saved-objects-settings" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/saved-objects-settings plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/saved-objects-settings'] --- import kbnSavedObjectsSettingsObj from './kbn_saved_objects_settings.devdocs.json'; diff --git a/api_docs/kbn_security_solution_side_nav.mdx b/api_docs/kbn_security_solution_side_nav.mdx index 13c1d7da7e2f0..e928099455e41 100644 --- a/api_docs/kbn_security_solution_side_nav.mdx +++ b/api_docs/kbn_security_solution_side_nav.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-side-nav title: "@kbn/security-solution-side-nav" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-solution-side-nav plugin -date: 2023-06-30 +date: 2023-07-18 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 89fe6d2bd164f..b44824a27b141 100644 --- a/api_docs/kbn_security_solution_storybook_config.mdx +++ b/api_docs/kbn_security_solution_storybook_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-storybook-config title: "@kbn/security-solution-storybook-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-solution-storybook-config plugin -date: 2023-06-30 +date: 2023-07-18 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 9c9daeef2a640..33367b8ba6757 100644 --- a/api_docs/kbn_securitysolution_autocomplete.mdx +++ b/api_docs/kbn_securitysolution_autocomplete.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-autocomplete title: "@kbn/securitysolution-autocomplete" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-autocomplete plugin -date: 2023-06-30 +date: 2023-07-18 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 f32526c450d3d..949f92ae3bbd2 100644 --- a/api_docs/kbn_securitysolution_data_table.mdx +++ b/api_docs/kbn_securitysolution_data_table.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-data-table title: "@kbn/securitysolution-data-table" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-data-table plugin -date: 2023-06-30 +date: 2023-07-18 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 3c9938634b490..f25f592aff9df 100644 --- a/api_docs/kbn_securitysolution_ecs.mdx +++ b/api_docs/kbn_securitysolution_ecs.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-ecs title: "@kbn/securitysolution-ecs" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-ecs plugin -date: 2023-06-30 +date: 2023-07-18 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 4268bd21f81af..f84c4ce714003 100644 --- a/api_docs/kbn_securitysolution_es_utils.mdx +++ b/api_docs/kbn_securitysolution_es_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-es-utils title: "@kbn/securitysolution-es-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-es-utils plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_securitysolution_exception_list_components.devdocs.json index 4eda6d4e6ce6a..4c81017a0980b 100644 --- a/api_docs/kbn_securitysolution_exception_list_components.devdocs.json +++ b/api_docs/kbn_securitysolution_exception_list_components.devdocs.json @@ -834,7 +834,7 @@ "label": "formattedDateComponent", "description": [], "signature": [ - "\"symbol\" | \"object\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"source\" | \"desc\" | \"filter\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"slot\" | \"style\" | \"title\" | \"meta\" | \"pattern\" | \"template\" | \"main\" | \"a\" | \"abbr\" | \"address\" | \"area\" | \"article\" | \"aside\" | \"audio\" | \"b\" | \"base\" | \"bdi\" | \"bdo\" | \"blockquote\" | \"body\" | \"br\" | \"button\" | \"canvas\" | \"caption\" | \"cite\" | \"code\" | \"col\" | \"colgroup\" | \"data\" | \"datalist\" | \"dd\" | \"del\" | \"details\" | \"dfn\" | \"dialog\" | \"div\" | \"dl\" | \"dt\" | \"em\" | \"embed\" | \"fieldset\" | \"figcaption\" | \"figure\" | \"footer\" | \"form\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"header\" | \"hgroup\" | \"hr\" | \"html\" | \"i\" | \"iframe\" | \"img\" | \"input\" | \"ins\" | \"kbd\" | \"keygen\" | \"label\" | \"legend\" | \"li\" | \"mark\" | \"menu\" | \"menuitem\" | \"meter\" | \"nav\" | \"noindex\" | \"noscript\" | \"ol\" | \"optgroup\" | \"option\" | \"output\" | \"p\" | \"param\" | \"picture\" | \"pre\" | \"progress\" | \"q\" | \"rp\" | \"rt\" | \"ruby\" | \"s\" | \"samp\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"summary\" | \"table\" | \"tbody\" | \"td\" | \"textarea\" | \"tfoot\" | \"th\" | \"thead\" | \"time\" | \"tr\" | \"track\" | \"u\" | \"ul\" | \"var\" | \"video\" | \"wbr\" | \"webview\" | \"svg\" | \"animate\" | \"animateMotion\" | \"animateTransform\" | \"circle\" | \"clipPath\" | \"defs\" | \"ellipse\" | \"feBlend\" | \"feColorMatrix\" | \"feComponentTransfer\" | \"feComposite\" | \"feConvolveMatrix\" | \"feDiffuseLighting\" | \"feDisplacementMap\" | \"feDistantLight\" | \"feDropShadow\" | \"feFlood\" | \"feFuncA\" | \"feFuncB\" | \"feFuncG\" | \"feFuncR\" | \"feGaussianBlur\" | \"feImage\" | \"feMerge\" | \"feMergeNode\" | \"feMorphology\" | \"feOffset\" | \"fePointLight\" | \"feSpecularLighting\" | \"feSpotLight\" | \"feTile\" | \"feTurbulence\" | \"foreignObject\" | \"g\" | \"image\" | \"line\" | \"linearGradient\" | \"marker\" | \"mask\" | \"metadata\" | \"mpath\" | \"path\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"stop\" | \"switch\" | \"textPath\" | \"tspan\" | \"use\" | \"view\"" + "\"symbol\" | \"object\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"source\" | \"desc\" | \"filter\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"slot\" | \"style\" | \"title\" | \"meta\" | \"pattern\" | \"summary\" | \"template\" | \"main\" | \"a\" | \"abbr\" | \"address\" | \"area\" | \"article\" | \"aside\" | \"audio\" | \"b\" | \"base\" | \"bdi\" | \"bdo\" | \"blockquote\" | \"body\" | \"br\" | \"button\" | \"canvas\" | \"caption\" | \"cite\" | \"code\" | \"col\" | \"colgroup\" | \"data\" | \"datalist\" | \"dd\" | \"del\" | \"details\" | \"dfn\" | \"dialog\" | \"div\" | \"dl\" | \"dt\" | \"em\" | \"embed\" | \"fieldset\" | \"figcaption\" | \"figure\" | \"footer\" | \"form\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"header\" | \"hgroup\" | \"hr\" | \"html\" | \"i\" | \"iframe\" | \"img\" | \"input\" | \"ins\" | \"kbd\" | \"keygen\" | \"label\" | \"legend\" | \"li\" | \"mark\" | \"menu\" | \"menuitem\" | \"meter\" | \"nav\" | \"noindex\" | \"noscript\" | \"ol\" | \"optgroup\" | \"option\" | \"output\" | \"p\" | \"param\" | \"picture\" | \"pre\" | \"progress\" | \"q\" | \"rp\" | \"rt\" | \"ruby\" | \"s\" | \"samp\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"table\" | \"tbody\" | \"td\" | \"textarea\" | \"tfoot\" | \"th\" | \"thead\" | \"time\" | \"tr\" | \"track\" | \"u\" | \"ul\" | \"var\" | \"video\" | \"wbr\" | \"webview\" | \"svg\" | \"animate\" | \"animateMotion\" | \"animateTransform\" | \"circle\" | \"clipPath\" | \"defs\" | \"ellipse\" | \"feBlend\" | \"feColorMatrix\" | \"feComponentTransfer\" | \"feComposite\" | \"feConvolveMatrix\" | \"feDiffuseLighting\" | \"feDisplacementMap\" | \"feDistantLight\" | \"feDropShadow\" | \"feFlood\" | \"feFuncA\" | \"feFuncB\" | \"feFuncG\" | \"feFuncR\" | \"feGaussianBlur\" | \"feImage\" | \"feMerge\" | \"feMergeNode\" | \"feMorphology\" | \"feOffset\" | \"fePointLight\" | \"feSpecularLighting\" | \"feSpotLight\" | \"feTile\" | \"feTurbulence\" | \"foreignObject\" | \"g\" | \"image\" | \"line\" | \"linearGradient\" | \"marker\" | \"mask\" | \"metadata\" | \"mpath\" | \"path\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"stop\" | \"switch\" | \"textPath\" | \"tspan\" | \"use\" | \"view\"" ], "path": "packages/kbn-securitysolution-exception-list-components/src/exception_item_card/meta/index.tsx", "deprecated": false, @@ -848,7 +848,7 @@ "label": "securityLinkAnchorComponent", "description": [], "signature": [ - "\"symbol\" | \"object\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"source\" | \"desc\" | \"filter\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"slot\" | \"style\" | \"title\" | \"meta\" | \"pattern\" | \"template\" | \"main\" | \"a\" | \"abbr\" | \"address\" | \"area\" | \"article\" | \"aside\" | \"audio\" | \"b\" | \"base\" | \"bdi\" | \"bdo\" | \"blockquote\" | \"body\" | \"br\" | \"button\" | \"canvas\" | \"caption\" | \"cite\" | \"code\" | \"col\" | \"colgroup\" | \"data\" | \"datalist\" | \"dd\" | \"del\" | \"details\" | \"dfn\" | \"dialog\" | \"div\" | \"dl\" | \"dt\" | \"em\" | \"embed\" | \"fieldset\" | \"figcaption\" | \"figure\" | \"footer\" | \"form\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"header\" | \"hgroup\" | \"hr\" | \"html\" | \"i\" | \"iframe\" | \"img\" | \"input\" | \"ins\" | \"kbd\" | \"keygen\" | \"label\" | \"legend\" | \"li\" | \"mark\" | \"menu\" | \"menuitem\" | \"meter\" | \"nav\" | \"noindex\" | \"noscript\" | \"ol\" | \"optgroup\" | \"option\" | \"output\" | \"p\" | \"param\" | \"picture\" | \"pre\" | \"progress\" | \"q\" | \"rp\" | \"rt\" | \"ruby\" | \"s\" | \"samp\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"summary\" | \"table\" | \"tbody\" | \"td\" | \"textarea\" | \"tfoot\" | \"th\" | \"thead\" | \"time\" | \"tr\" | \"track\" | \"u\" | \"ul\" | \"var\" | \"video\" | \"wbr\" | \"webview\" | \"svg\" | \"animate\" | \"animateMotion\" | \"animateTransform\" | \"circle\" | \"clipPath\" | \"defs\" | \"ellipse\" | \"feBlend\" | \"feColorMatrix\" | \"feComponentTransfer\" | \"feComposite\" | \"feConvolveMatrix\" | \"feDiffuseLighting\" | \"feDisplacementMap\" | \"feDistantLight\" | \"feDropShadow\" | \"feFlood\" | \"feFuncA\" | \"feFuncB\" | \"feFuncG\" | \"feFuncR\" | \"feGaussianBlur\" | \"feImage\" | \"feMerge\" | \"feMergeNode\" | \"feMorphology\" | \"feOffset\" | \"fePointLight\" | \"feSpecularLighting\" | \"feSpotLight\" | \"feTile\" | \"feTurbulence\" | \"foreignObject\" | \"g\" | \"image\" | \"line\" | \"linearGradient\" | \"marker\" | \"mask\" | \"metadata\" | \"mpath\" | \"path\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"stop\" | \"switch\" | \"textPath\" | \"tspan\" | \"use\" | \"view\"" + "\"symbol\" | \"object\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"source\" | \"desc\" | \"filter\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"slot\" | \"style\" | \"title\" | \"meta\" | \"pattern\" | \"summary\" | \"template\" | \"main\" | \"a\" | \"abbr\" | \"address\" | \"area\" | \"article\" | \"aside\" | \"audio\" | \"b\" | \"base\" | \"bdi\" | \"bdo\" | \"blockquote\" | \"body\" | \"br\" | \"button\" | \"canvas\" | \"caption\" | \"cite\" | \"code\" | \"col\" | \"colgroup\" | \"data\" | \"datalist\" | \"dd\" | \"del\" | \"details\" | \"dfn\" | \"dialog\" | \"div\" | \"dl\" | \"dt\" | \"em\" | \"embed\" | \"fieldset\" | \"figcaption\" | \"figure\" | \"footer\" | \"form\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"header\" | \"hgroup\" | \"hr\" | \"html\" | \"i\" | \"iframe\" | \"img\" | \"input\" | \"ins\" | \"kbd\" | \"keygen\" | \"label\" | \"legend\" | \"li\" | \"mark\" | \"menu\" | \"menuitem\" | \"meter\" | \"nav\" | \"noindex\" | \"noscript\" | \"ol\" | \"optgroup\" | \"option\" | \"output\" | \"p\" | \"param\" | \"picture\" | \"pre\" | \"progress\" | \"q\" | \"rp\" | \"rt\" | \"ruby\" | \"s\" | \"samp\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"table\" | \"tbody\" | \"td\" | \"textarea\" | \"tfoot\" | \"th\" | \"thead\" | \"time\" | \"tr\" | \"track\" | \"u\" | \"ul\" | \"var\" | \"video\" | \"wbr\" | \"webview\" | \"svg\" | \"animate\" | \"animateMotion\" | \"animateTransform\" | \"circle\" | \"clipPath\" | \"defs\" | \"ellipse\" | \"feBlend\" | \"feColorMatrix\" | \"feComponentTransfer\" | \"feComposite\" | \"feConvolveMatrix\" | \"feDiffuseLighting\" | \"feDisplacementMap\" | \"feDistantLight\" | \"feDropShadow\" | \"feFlood\" | \"feFuncA\" | \"feFuncB\" | \"feFuncG\" | \"feFuncR\" | \"feGaussianBlur\" | \"feImage\" | \"feMerge\" | \"feMergeNode\" | \"feMorphology\" | \"feOffset\" | \"fePointLight\" | \"feSpecularLighting\" | \"feSpotLight\" | \"feTile\" | \"feTurbulence\" | \"foreignObject\" | \"g\" | \"image\" | \"line\" | \"linearGradient\" | \"marker\" | \"mask\" | \"metadata\" | \"mpath\" | \"path\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"stop\" | \"switch\" | \"textPath\" | \"tspan\" | \"use\" | \"view\"" ], "path": "packages/kbn-securitysolution-exception-list-components/src/exception_item_card/meta/index.tsx", "deprecated": false, @@ -987,7 +987,7 @@ "label": "securityLinkAnchorComponent", "description": [], "signature": [ - "\"symbol\" | \"object\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"source\" | \"desc\" | \"filter\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"slot\" | \"style\" | \"title\" | \"meta\" | \"pattern\" | \"template\" | \"main\" | \"a\" | \"abbr\" | \"address\" | \"area\" | \"article\" | \"aside\" | \"audio\" | \"b\" | \"base\" | \"bdi\" | \"bdo\" | \"blockquote\" | \"body\" | \"br\" | \"button\" | \"canvas\" | \"caption\" | \"cite\" | \"code\" | \"col\" | \"colgroup\" | \"data\" | \"datalist\" | \"dd\" | \"del\" | \"details\" | \"dfn\" | \"dialog\" | \"div\" | \"dl\" | \"dt\" | \"em\" | \"embed\" | \"fieldset\" | \"figcaption\" | \"figure\" | \"footer\" | \"form\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"header\" | \"hgroup\" | \"hr\" | \"html\" | \"i\" | \"iframe\" | \"img\" | \"input\" | \"ins\" | \"kbd\" | \"keygen\" | \"label\" | \"legend\" | \"li\" | \"mark\" | \"menu\" | \"menuitem\" | \"meter\" | \"nav\" | \"noindex\" | \"noscript\" | \"ol\" | \"optgroup\" | \"option\" | \"output\" | \"p\" | \"param\" | \"picture\" | \"pre\" | \"progress\" | \"q\" | \"rp\" | \"rt\" | \"ruby\" | \"s\" | \"samp\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"summary\" | \"table\" | \"tbody\" | \"td\" | \"textarea\" | \"tfoot\" | \"th\" | \"thead\" | \"time\" | \"tr\" | \"track\" | \"u\" | \"ul\" | \"var\" | \"video\" | \"wbr\" | \"webview\" | \"svg\" | \"animate\" | \"animateMotion\" | \"animateTransform\" | \"circle\" | \"clipPath\" | \"defs\" | \"ellipse\" | \"feBlend\" | \"feColorMatrix\" | \"feComponentTransfer\" | \"feComposite\" | \"feConvolveMatrix\" | \"feDiffuseLighting\" | \"feDisplacementMap\" | \"feDistantLight\" | \"feDropShadow\" | \"feFlood\" | \"feFuncA\" | \"feFuncB\" | \"feFuncG\" | \"feFuncR\" | \"feGaussianBlur\" | \"feImage\" | \"feMerge\" | \"feMergeNode\" | \"feMorphology\" | \"feOffset\" | \"fePointLight\" | \"feSpecularLighting\" | \"feSpotLight\" | \"feTile\" | \"feTurbulence\" | \"foreignObject\" | \"g\" | \"image\" | \"line\" | \"linearGradient\" | \"marker\" | \"mask\" | \"metadata\" | \"mpath\" | \"path\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"stop\" | \"switch\" | \"textPath\" | \"tspan\" | \"use\" | \"view\"" + "\"symbol\" | \"object\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"source\" | \"desc\" | \"filter\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"slot\" | \"style\" | \"title\" | \"meta\" | \"pattern\" | \"summary\" | \"template\" | \"main\" | \"a\" | \"abbr\" | \"address\" | \"area\" | \"article\" | \"aside\" | \"audio\" | \"b\" | \"base\" | \"bdi\" | \"bdo\" | \"blockquote\" | \"body\" | \"br\" | \"button\" | \"canvas\" | \"caption\" | \"cite\" | \"code\" | \"col\" | \"colgroup\" | \"data\" | \"datalist\" | \"dd\" | \"del\" | \"details\" | \"dfn\" | \"dialog\" | \"div\" | \"dl\" | \"dt\" | \"em\" | \"embed\" | \"fieldset\" | \"figcaption\" | \"figure\" | \"footer\" | \"form\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"header\" | \"hgroup\" | \"hr\" | \"html\" | \"i\" | \"iframe\" | \"img\" | \"input\" | \"ins\" | \"kbd\" | \"keygen\" | \"label\" | \"legend\" | \"li\" | \"mark\" | \"menu\" | \"menuitem\" | \"meter\" | \"nav\" | \"noindex\" | \"noscript\" | \"ol\" | \"optgroup\" | \"option\" | \"output\" | \"p\" | \"param\" | \"picture\" | \"pre\" | \"progress\" | \"q\" | \"rp\" | \"rt\" | \"ruby\" | \"s\" | \"samp\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"table\" | \"tbody\" | \"td\" | \"textarea\" | \"tfoot\" | \"th\" | \"thead\" | \"time\" | \"tr\" | \"track\" | \"u\" | \"ul\" | \"var\" | \"video\" | \"wbr\" | \"webview\" | \"svg\" | \"animate\" | \"animateMotion\" | \"animateTransform\" | \"circle\" | \"clipPath\" | \"defs\" | \"ellipse\" | \"feBlend\" | \"feColorMatrix\" | \"feComponentTransfer\" | \"feComposite\" | \"feConvolveMatrix\" | \"feDiffuseLighting\" | \"feDisplacementMap\" | \"feDistantLight\" | \"feDropShadow\" | \"feFlood\" | \"feFuncA\" | \"feFuncB\" | \"feFuncG\" | \"feFuncR\" | \"feGaussianBlur\" | \"feImage\" | \"feMerge\" | \"feMergeNode\" | \"feMorphology\" | \"feOffset\" | \"fePointLight\" | \"feSpecularLighting\" | \"feSpotLight\" | \"feTile\" | \"feTurbulence\" | \"foreignObject\" | \"g\" | \"image\" | \"line\" | \"linearGradient\" | \"marker\" | \"mask\" | \"metadata\" | \"mpath\" | \"path\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"stop\" | \"switch\" | \"textPath\" | \"tspan\" | \"use\" | \"view\"" ], "path": "packages/kbn-securitysolution-exception-list-components/src/exception_item_card/exception_item_card.tsx", "deprecated": false, @@ -1001,7 +1001,7 @@ "label": "formattedDateComponent", "description": [], "signature": [ - "\"symbol\" | \"object\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"source\" | \"desc\" | \"filter\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"slot\" | \"style\" | \"title\" | \"meta\" | \"pattern\" | \"template\" | \"main\" | \"a\" | \"abbr\" | \"address\" | \"area\" | \"article\" | \"aside\" | \"audio\" | \"b\" | \"base\" | \"bdi\" | \"bdo\" | \"blockquote\" | \"body\" | \"br\" | \"button\" | \"canvas\" | \"caption\" | \"cite\" | \"code\" | \"col\" | \"colgroup\" | \"data\" | \"datalist\" | \"dd\" | \"del\" | \"details\" | \"dfn\" | \"dialog\" | \"div\" | \"dl\" | \"dt\" | \"em\" | \"embed\" | \"fieldset\" | \"figcaption\" | \"figure\" | \"footer\" | \"form\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"header\" | \"hgroup\" | \"hr\" | \"html\" | \"i\" | \"iframe\" | \"img\" | \"input\" | \"ins\" | \"kbd\" | \"keygen\" | \"label\" | \"legend\" | \"li\" | \"mark\" | \"menu\" | \"menuitem\" | \"meter\" | \"nav\" | \"noindex\" | \"noscript\" | \"ol\" | \"optgroup\" | \"option\" | \"output\" | \"p\" | \"param\" | \"picture\" | \"pre\" | \"progress\" | \"q\" | \"rp\" | \"rt\" | \"ruby\" | \"s\" | \"samp\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"summary\" | \"table\" | \"tbody\" | \"td\" | \"textarea\" | \"tfoot\" | \"th\" | \"thead\" | \"time\" | \"tr\" | \"track\" | \"u\" | \"ul\" | \"var\" | \"video\" | \"wbr\" | \"webview\" | \"svg\" | \"animate\" | \"animateMotion\" | \"animateTransform\" | \"circle\" | \"clipPath\" | \"defs\" | \"ellipse\" | \"feBlend\" | \"feColorMatrix\" | \"feComponentTransfer\" | \"feComposite\" | \"feConvolveMatrix\" | \"feDiffuseLighting\" | \"feDisplacementMap\" | \"feDistantLight\" | \"feDropShadow\" | \"feFlood\" | \"feFuncA\" | \"feFuncB\" | \"feFuncG\" | \"feFuncR\" | \"feGaussianBlur\" | \"feImage\" | \"feMerge\" | \"feMergeNode\" | \"feMorphology\" | \"feOffset\" | \"fePointLight\" | \"feSpecularLighting\" | \"feSpotLight\" | \"feTile\" | \"feTurbulence\" | \"foreignObject\" | \"g\" | \"image\" | \"line\" | \"linearGradient\" | \"marker\" | \"mask\" | \"metadata\" | \"mpath\" | \"path\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"stop\" | \"switch\" | \"textPath\" | \"tspan\" | \"use\" | \"view\"" + "\"symbol\" | \"object\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"source\" | \"desc\" | \"filter\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"slot\" | \"style\" | \"title\" | \"meta\" | \"pattern\" | \"summary\" | \"template\" | \"main\" | \"a\" | \"abbr\" | \"address\" | \"area\" | \"article\" | \"aside\" | \"audio\" | \"b\" | \"base\" | \"bdi\" | \"bdo\" | \"blockquote\" | \"body\" | \"br\" | \"button\" | \"canvas\" | \"caption\" | \"cite\" | \"code\" | \"col\" | \"colgroup\" | \"data\" | \"datalist\" | \"dd\" | \"del\" | \"details\" | \"dfn\" | \"dialog\" | \"div\" | \"dl\" | \"dt\" | \"em\" | \"embed\" | \"fieldset\" | \"figcaption\" | \"figure\" | \"footer\" | \"form\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"header\" | \"hgroup\" | \"hr\" | \"html\" | \"i\" | \"iframe\" | \"img\" | \"input\" | \"ins\" | \"kbd\" | \"keygen\" | \"label\" | \"legend\" | \"li\" | \"mark\" | \"menu\" | \"menuitem\" | \"meter\" | \"nav\" | \"noindex\" | \"noscript\" | \"ol\" | \"optgroup\" | \"option\" | \"output\" | \"p\" | \"param\" | \"picture\" | \"pre\" | \"progress\" | \"q\" | \"rp\" | \"rt\" | \"ruby\" | \"s\" | \"samp\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"table\" | \"tbody\" | \"td\" | \"textarea\" | \"tfoot\" | \"th\" | \"thead\" | \"time\" | \"tr\" | \"track\" | \"u\" | \"ul\" | \"var\" | \"video\" | \"wbr\" | \"webview\" | \"svg\" | \"animate\" | \"animateMotion\" | \"animateTransform\" | \"circle\" | \"clipPath\" | \"defs\" | \"ellipse\" | \"feBlend\" | \"feColorMatrix\" | \"feComponentTransfer\" | \"feComposite\" | \"feConvolveMatrix\" | \"feDiffuseLighting\" | \"feDisplacementMap\" | \"feDistantLight\" | \"feDropShadow\" | \"feFlood\" | \"feFuncA\" | \"feFuncB\" | \"feFuncG\" | \"feFuncR\" | \"feGaussianBlur\" | \"feImage\" | \"feMerge\" | \"feMergeNode\" | \"feMorphology\" | \"feOffset\" | \"fePointLight\" | \"feSpecularLighting\" | \"feSpotLight\" | \"feTile\" | \"feTurbulence\" | \"foreignObject\" | \"g\" | \"image\" | \"line\" | \"linearGradient\" | \"marker\" | \"mask\" | \"metadata\" | \"mpath\" | \"path\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"stop\" | \"switch\" | \"textPath\" | \"tspan\" | \"use\" | \"view\"" ], "path": "packages/kbn-securitysolution-exception-list-components/src/exception_item_card/exception_item_card.tsx", "deprecated": false, diff --git a/api_docs/kbn_securitysolution_exception_list_components.mdx b/api_docs/kbn_securitysolution_exception_list_components.mdx index ea9e79cec7dbf..27b11f2223d80 100644 --- a/api_docs/kbn_securitysolution_exception_list_components.mdx +++ b/api_docs/kbn_securitysolution_exception_list_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-exception-list-components title: "@kbn/securitysolution-exception-list-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-exception-list-components plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-exception-list-components'] --- import kbnSecuritysolutionExceptionListComponentsObj from './kbn_securitysolution_exception_list_components.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_grouping.mdx b/api_docs/kbn_securitysolution_grouping.mdx index e3ca628a7c42e..ee63c7a6daffe 100644 --- a/api_docs/kbn_securitysolution_grouping.mdx +++ b/api_docs/kbn_securitysolution_grouping.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-grouping title: "@kbn/securitysolution-grouping" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-grouping plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-grouping'] --- import kbnSecuritysolutionGroupingObj from './kbn_securitysolution_grouping.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index bcd97e2dd84ef..2ad67989f762e 100644 --- a/api_docs/kbn_securitysolution_hook_utils.mdx +++ b/api_docs/kbn_securitysolution_hook_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-hook-utils title: "@kbn/securitysolution-hook-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-hook-utils plugin -date: 2023-06-30 +date: 2023-07-18 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 d928173ce5440..85484a75160d4 100644 --- a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-alerting-types title: "@kbn/securitysolution-io-ts-alerting-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-alerting-types plugin -date: 2023-06-30 +date: 2023-07-18 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 bf4e174dfded9..0ed3a46e1735d 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_list_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-list-types title: "@kbn/securitysolution-io-ts-list-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-list-types plugin -date: 2023-06-30 +date: 2023-07-18 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 911ffe07505e0..2bb46408669a3 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-types title: "@kbn/securitysolution-io-ts-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-types plugin -date: 2023-06-30 +date: 2023-07-18 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 b21fbeff5c570..7df14ad4ebb27 100644 --- a/api_docs/kbn_securitysolution_io_ts_utils.mdx +++ b/api_docs/kbn_securitysolution_io_ts_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-utils title: "@kbn/securitysolution-io-ts-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-utils plugin -date: 2023-06-30 +date: 2023-07-18 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 f443ca6f68e2f..2d0ed0476a115 100644 --- a/api_docs/kbn_securitysolution_list_api.mdx +++ b/api_docs/kbn_securitysolution_list_api.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-api title: "@kbn/securitysolution-list-api" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-api plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_securitysolution_list_constants.devdocs.json index 86b382c6bc5a0..90a4d358f937e 100644 --- a/api_docs/kbn_securitysolution_list_constants.devdocs.json +++ b/api_docs/kbn_securitysolution_list_constants.devdocs.json @@ -720,14 +720,6 @@ "deprecated": true, "trackAdoption": false, "references": [ - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts" - }, { "plugin": "lists", "path": "x-pack/plugins/lists/server/services/exception_lists/create_endpoint_trusted_apps_list.ts" @@ -744,6 +736,14 @@ "plugin": "lists", "path": "x-pack/plugins/lists/common/schemas/response/exception_list_schema.mock.ts" }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts" + }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/scripts/endpoint/trusted_apps/index.ts" @@ -776,6 +776,38 @@ "deprecated": true, "trackAdoption": false, "references": [ + { + "plugin": "lists", + "path": "x-pack/plugins/lists/server/services/exception_lists/create_endpoint_trusted_apps_list.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/server/services/exception_lists/create_endpoint_trusted_apps_list.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/server/services/exception_lists/create_endpoint_trusted_apps_list.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/server/saved_objects/migrations.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/server/saved_objects/migrations.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/server/saved_objects/migrations.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/common/schemas/response/exception_list_schema.mock.ts" + }, + { + "plugin": "lists", + "path": "x-pack/plugins/lists/common/schemas/response/exception_list_schema.mock.ts" + }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/management/pages/policy/view/policy_hooks.ts" @@ -804,30 +836,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/management/pages/trusted_apps/service/api_client.ts" }, - { - "plugin": "lists", - "path": "x-pack/plugins/lists/server/services/exception_lists/create_endpoint_trusted_apps_list.ts" - }, - { - "plugin": "lists", - "path": "x-pack/plugins/lists/server/services/exception_lists/create_endpoint_trusted_apps_list.ts" - }, - { - "plugin": "lists", - "path": "x-pack/plugins/lists/server/services/exception_lists/create_endpoint_trusted_apps_list.ts" - }, - { - "plugin": "lists", - "path": "x-pack/plugins/lists/server/saved_objects/migrations.ts" - }, - { - "plugin": "lists", - "path": "x-pack/plugins/lists/server/saved_objects/migrations.ts" - }, - { - "plugin": "lists", - "path": "x-pack/plugins/lists/server/saved_objects/migrations.ts" - }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/endpoint/lib/artifacts/lists.ts" @@ -856,14 +864,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lists_integration/endpoint/validators/trusted_app_validator.ts" }, - { - "plugin": "lists", - "path": "x-pack/plugins/lists/common/schemas/response/exception_list_schema.mock.ts" - }, - { - "plugin": "lists", - "path": "x-pack/plugins/lists/common/schemas/response/exception_list_schema.mock.ts" - }, { "plugin": "lists", "path": "x-pack/plugins/lists/server/saved_objects/migrations.test.ts" @@ -1036,14 +1036,6 @@ "deprecated": true, "trackAdoption": false, "references": [ - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts" - }, { "plugin": "lists", "path": "x-pack/plugins/lists/server/services/exception_lists/create_endpoint_trusted_apps_list.ts" @@ -1060,6 +1052,14 @@ "plugin": "lists", "path": "x-pack/plugins/lists/common/schemas/response/exception_list_schema.mock.ts" }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/management/pages/trusted_apps/constants.ts" + }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/scripts/endpoint/trusted_apps/index.ts" diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index 81e2ff61db05c..f01ae49271bee 100644 --- a/api_docs/kbn_securitysolution_list_constants.mdx +++ b/api_docs/kbn_securitysolution_list_constants.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-constants title: "@kbn/securitysolution-list-constants" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-constants plugin -date: 2023-06-30 +date: 2023-07-18 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 097841300a909..ed46db572a71e 100644 --- a/api_docs/kbn_securitysolution_list_hooks.mdx +++ b/api_docs/kbn_securitysolution_list_hooks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-hooks title: "@kbn/securitysolution-list-hooks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-hooks plugin -date: 2023-06-30 +date: 2023-07-18 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 341bb67f0408f..2a34031c64414 100644 --- a/api_docs/kbn_securitysolution_list_utils.mdx +++ b/api_docs/kbn_securitysolution_list_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-utils title: "@kbn/securitysolution-list-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-utils plugin -date: 2023-06-30 +date: 2023-07-18 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 307a04514254f..833e80c0265cc 100644 --- a/api_docs/kbn_securitysolution_rules.mdx +++ b/api_docs/kbn_securitysolution_rules.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-rules title: "@kbn/securitysolution-rules" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-rules plugin -date: 2023-06-30 +date: 2023-07-18 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 fcd16e9555d1c..4bb38c00b4db3 100644 --- a/api_docs/kbn_securitysolution_t_grid.mdx +++ b/api_docs/kbn_securitysolution_t_grid.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-t-grid title: "@kbn/securitysolution-t-grid" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-t-grid plugin -date: 2023-06-30 +date: 2023-07-18 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 77a10967c2f88..00024bfe762a0 100644 --- a/api_docs/kbn_securitysolution_utils.mdx +++ b/api_docs/kbn_securitysolution_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-utils title: "@kbn/securitysolution-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-utils plugin -date: 2023-06-30 +date: 2023-07-18 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 abbf73d8236c6..da8ca754e9e14 100644 --- a/api_docs/kbn_server_http_tools.mdx +++ b/api_docs/kbn_server_http_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-server-http-tools title: "@kbn/server-http-tools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/server-http-tools plugin -date: 2023-06-30 +date: 2023-07-18 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 c24b60a20f957..9a2bd2caea73b 100644 --- a/api_docs/kbn_server_route_repository.mdx +++ b/api_docs/kbn_server_route_repository.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository title: "@kbn/server-route-repository" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/server-route-repository plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository'] --- import kbnServerRouteRepositoryObj from './kbn_server_route_repository.devdocs.json'; diff --git a/api_docs/kbn_serverless_project_switcher.mdx b/api_docs/kbn_serverless_project_switcher.mdx index 175977dbb6e22..4ec8cbac25b21 100644 --- a/api_docs/kbn_serverless_project_switcher.mdx +++ b/api_docs/kbn_serverless_project_switcher.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-project-switcher title: "@kbn/serverless-project-switcher" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/serverless-project-switcher plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-project-switcher'] --- import kbnServerlessProjectSwitcherObj from './kbn_serverless_project_switcher.devdocs.json'; diff --git a/api_docs/kbn_serverless_storybook_config.mdx b/api_docs/kbn_serverless_storybook_config.mdx index 21a2e8c25e275..da7cbbdc7cf36 100644 --- a/api_docs/kbn_serverless_storybook_config.mdx +++ b/api_docs/kbn_serverless_storybook_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-storybook-config title: "@kbn/serverless-storybook-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/serverless-storybook-config plugin -date: 2023-06-30 +date: 2023-07-18 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 35505d2bd1a9a..0b5f344ae9a5f 100644 --- a/api_docs/kbn_shared_svg.mdx +++ b/api_docs/kbn_shared_svg.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-svg title: "@kbn/shared-svg" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-svg plugin -date: 2023-06-30 +date: 2023-07-18 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 04dc5f3adbc90..4e5b3c59bc1eb 100644 --- a/api_docs/kbn_shared_ux_avatar_solution.mdx +++ b/api_docs/kbn_shared_ux_avatar_solution.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-avatar-solution title: "@kbn/shared-ux-avatar-solution" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-avatar-solution plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-avatar-solution'] --- import kbnSharedUxAvatarSolutionObj from './kbn_shared_ux_avatar_solution.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx b/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx index c369b145a8f0e..187d11cc620d2 100644 --- a/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx +++ b/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-avatar-user-profile-components title: "@kbn/shared-ux-avatar-user-profile-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-avatar-user-profile-components plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-avatar-user-profile-components'] --- import kbnSharedUxAvatarUserProfileComponentsObj from './kbn_shared_ux_avatar_user_profile_components.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx index 3f567e4cff42a..c1466cd7b7f1e 100644 --- a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx +++ b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-exit-full-screen title: "@kbn/shared-ux-button-exit-full-screen" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-button-exit-full-screen plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-exit-full-screen'] --- import kbnSharedUxButtonExitFullScreenObj from './kbn_shared_ux_button_exit_full_screen.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx b/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx index c52d19e9d35f6..2bae77b0afbe3 100644 --- a/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx +++ b/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-exit-full-screen-mocks title: "@kbn/shared-ux-button-exit-full-screen-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-button-exit-full-screen-mocks plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-exit-full-screen-mocks'] --- import kbnSharedUxButtonExitFullScreenMocksObj from './kbn_shared_ux_button_exit_full_screen_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_button_toolbar.devdocs.json b/api_docs/kbn_shared_ux_button_toolbar.devdocs.json index 40debaa698553..c7dad0c8c07b9 100644 --- a/api_docs/kbn_shared_ux_button_toolbar.devdocs.json +++ b/api_docs/kbn_shared_ux_button_toolbar.devdocs.json @@ -29,7 +29,7 @@ "\nA button that acts to add an item from the library to a solution, typically through a modal." ], "signature": [ - "({ onClick, ...rest }: ", + "({ onClick, size, ...rest }: ", { "pluginId": "@kbn/shared-ux-button-toolbar", "scope": "common", @@ -48,7 +48,7 @@ "id": "def-common.AddFromLibraryButton.$1", "type": "Object", "tags": [], - "label": "{ onClick, ...rest }", + "label": "{ onClick, size = 'm', ...rest }", "description": [], "signature": [ { @@ -78,7 +78,7 @@ "\nA group of buttons each performing an action, represented by an icon." ], "signature": [ - "({ buttons, legend }: ", + "({ buttons, legend, buttonSize }: ", { "pluginId": "@kbn/shared-ux-button-toolbar", "scope": "common", @@ -97,7 +97,7 @@ "id": "def-common.IconButtonGroup.$1", "type": "Object", "tags": [], - "label": "{ buttons, legend }", + "label": "{ buttons, legend, buttonSize = 'm' }", "description": [], "signature": [ { @@ -176,7 +176,7 @@ "label": "ToolbarButton", "description": [], "signature": [ - "({ label, type, iconSide, ...rest }: React.PropsWithChildren<", + "({ label, type, iconSide, size, ...rest }: React.PropsWithChildren<", { "pluginId": "@kbn/shared-ux-button-toolbar", "scope": "common", @@ -195,7 +195,7 @@ "id": "def-common.ToolbarButton.$1", "type": "CompoundType", "tags": [], - "label": "{\n label,\n type = 'empty',\n iconSide = 'left',\n ...rest\n}", + "label": "{\n label,\n type = 'empty',\n iconSide = 'left',\n size = 'm',\n ...rest\n}", "description": [], "signature": [ "React.PropsWithChildren<", @@ -227,7 +227,7 @@ "\nA button which opens a popover of additional actions within the toolbar." ], "signature": [ - "({ type, label, iconType, children, ...popover }: ", + "({ type, label, iconType, size, children, ...popover }: ", { "pluginId": "@kbn/shared-ux-button-toolbar", "scope": "common", @@ -246,7 +246,7 @@ "id": "def-common.ToolbarPopover.$1", "type": "CompoundType", "tags": [], - "label": "{ type, label, iconType, children, ...popover }", + "label": "{\n type,\n label,\n iconType,\n size = 'm',\n children,\n ...popover\n}", "description": [], "signature": [ { @@ -411,6 +411,22 @@ "path": "packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-toolbar", + "id": "def-common.Props.buttonSize", + "type": "CompoundType", + "tags": [], + "label": "buttonSize", + "description": [ + "Button size" + ], + "signature": [ + "\"m\" | \"compressed\" | \"s\" | undefined" + ], + "path": "packages/shared-ux/button_toolbar/src/buttons/icon_button_group/icon_button_group.tsx", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -434,7 +450,7 @@ }, " extends Pick<", "EuiButtonPropsForButton", - ", \"onClick\" | \"data-test-subj\" | \"iconType\" | \"iconSide\">" + ", \"onClick\" | \"data-test-subj\" | \"iconType\" | \"size\" | \"iconSide\">" ], "path": "packages/shared-ux/button_toolbar/src/buttons/toolbar_button/toolbar_button.tsx", "deprecated": false, @@ -509,7 +525,7 @@ "label": "Props", "description": [], "signature": [ - "{ onClick?: React.MouseEventHandler | undefined; 'data-test-subj'?: string | undefined; iconSide?: ", + "{ onClick?: React.MouseEventHandler | undefined; 'data-test-subj'?: string | undefined; size?: \"m\" | \"s\" | undefined; iconSide?: ", "ButtonContentIconSide", "; }" ], @@ -553,7 +569,7 @@ "section": "def-common.Props", "text": "Props" }, - "> | (({ type, label, iconType, children, ...popover }: ", + "> | (({ type, label, iconType, size, children, ...popover }: ", { "pluginId": "@kbn/shared-ux-button-toolbar", "scope": "common", diff --git a/api_docs/kbn_shared_ux_button_toolbar.mdx b/api_docs/kbn_shared_ux_button_toolbar.mdx index 0eb23afa59705..e4b8ae20b3844 100644 --- a/api_docs/kbn_shared_ux_button_toolbar.mdx +++ b/api_docs/kbn_shared_ux_button_toolbar.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-toolbar title: "@kbn/shared-ux-button-toolbar" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-button-toolbar plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-toolbar'] --- import kbnSharedUxButtonToolbarObj from './kbn_shared_ux_button_toolbar.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 | |-------------------|-----------|------------------------|-----------------| -| 27 | 0 | 10 | 0 | +| 28 | 0 | 10 | 0 | ## Common diff --git a/api_docs/kbn_shared_ux_card_no_data.devdocs.json b/api_docs/kbn_shared_ux_card_no_data.devdocs.json index d2aec052294cd..2695858e37907 100644 --- a/api_docs/kbn_shared_ux_card_no_data.devdocs.json +++ b/api_docs/kbn_shared_ux_card_no_data.devdocs.json @@ -184,7 +184,7 @@ "\nProps for the `NoDataCard` sevice-connected component." ], "signature": [ - "{ prefix?: string | undefined; id?: string | undefined; defaultValue?: string | number | readonly string[] | undefined; security?: string | undefined; children?: React.ReactNode; description?: React.ReactNode; category?: string | undefined; onChange?: React.FormEventHandler | undefined; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; className?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; hidden?: boolean | undefined; lang?: string | undefined; placeholder?: string | undefined; slot?: string | undefined; spellCheck?: Booleanish | undefined; style?: React.CSSProperties | undefined; tabIndex?: number | undefined; title?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; translate?: \"yes\" | \"no\" | undefined; radioGroup?: string | undefined; role?: React.AriaRole | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; property?: string | undefined; resource?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCapitalize?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"search\" | \"none\" | \"text\" | \"url\" | \"tel\" | \"email\" | \"numeric\" | \"decimal\" | undefined; is?: string | undefined; 'aria-activedescendant'?: string | undefined; 'aria-atomic'?: Booleanish | undefined; 'aria-autocomplete'?: \"none\" | \"list\" | \"inline\" | \"both\" | undefined; 'aria-busy'?: Booleanish | undefined; 'aria-checked'?: boolean | \"true\" | \"false\" | \"mixed\" | undefined; 'aria-colcount'?: number | undefined; 'aria-colindex'?: number | undefined; 'aria-colspan'?: number | undefined; 'aria-controls'?: string | undefined; 'aria-current'?: boolean | \"page\" | \"date\" | \"time\" | \"true\" | \"false\" | \"step\" | \"location\" | undefined; 'aria-describedby'?: string | undefined; 'aria-details'?: string | undefined; 'aria-disabled'?: Booleanish | undefined; 'aria-dropeffect'?: \"execute\" | \"link\" | \"none\" | \"copy\" | \"move\" | \"popup\" | undefined; 'aria-errormessage'?: string | undefined; 'aria-expanded'?: Booleanish | undefined; 'aria-flowto'?: string | undefined; 'aria-grabbed'?: Booleanish | undefined; 'aria-haspopup'?: boolean | \"dialog\" | \"menu\" | \"true\" | \"false\" | \"grid\" | \"listbox\" | \"tree\" | undefined; 'aria-hidden'?: Booleanish | undefined; 'aria-invalid'?: boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" | undefined; 'aria-keyshortcuts'?: string | undefined; 'aria-label'?: string | undefined; 'aria-labelledby'?: string | undefined; 'aria-level'?: number | undefined; 'aria-live'?: \"off\" | \"assertive\" | \"polite\" | undefined; 'aria-modal'?: Booleanish | undefined; 'aria-multiline'?: Booleanish | undefined; 'aria-multiselectable'?: Booleanish | undefined; 'aria-orientation'?: \"horizontal\" | \"vertical\" | undefined; 'aria-owns'?: string | undefined; 'aria-placeholder'?: string | undefined; 'aria-posinset'?: number | undefined; 'aria-pressed'?: boolean | \"true\" | \"false\" | \"mixed\" | undefined; 'aria-readonly'?: Booleanish | undefined; 'aria-relevant'?: \"text\" | \"all\" | \"additions\" | \"additions removals\" | \"additions text\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" | undefined; 'aria-required'?: Booleanish | undefined; 'aria-roledescription'?: string | undefined; 'aria-rowcount'?: number | undefined; 'aria-rowindex'?: number | undefined; 'aria-rowspan'?: number | undefined; 'aria-selected'?: Booleanish | undefined; 'aria-setsize'?: number | undefined; 'aria-sort'?: \"none\" | \"ascending\" | \"descending\" | \"other\" | undefined; 'aria-valuemax'?: number | undefined; 'aria-valuemin'?: number | undefined; 'aria-valuenow'?: number | undefined; 'aria-valuetext'?: string | undefined; dangerouslySetInnerHTML?: { __html: string; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChangeCapture?: React.FormEventHandler | undefined; onBeforeInput?: React.FormEventHandler | undefined; onBeforeInputCapture?: React.FormEventHandler | undefined; onInput?: React.FormEventHandler | undefined; onInputCapture?: React.FormEventHandler | undefined; onReset?: React.FormEventHandler | undefined; onResetCapture?: React.FormEventHandler | undefined; onSubmit?: React.FormEventHandler | undefined; onSubmitCapture?: React.FormEventHandler | undefined; onInvalid?: React.FormEventHandler | undefined; onInvalidCapture?: React.FormEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onError?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDown?: React.KeyboardEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClick?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerEnterCapture?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerLeaveCapture?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; hasBorder?: boolean | undefined; paddingSize?: \"m\" | \"none\" | \"s\" | \"xs\" | \"l\" | \"xl\" | undefined; 'data-test-subj'?: string | undefined; css?: ", + "{ prefix?: string | undefined; id?: string | undefined; defaultValue?: string | number | readonly string[] | undefined; security?: string | undefined; children?: React.ReactNode; description?: React.ReactNode; category?: string | undefined; onChange?: React.FormEventHandler | undefined; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; className?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; hidden?: boolean | undefined; lang?: string | undefined; placeholder?: string | undefined; slot?: string | undefined; spellCheck?: Booleanish | undefined; style?: React.CSSProperties | undefined; tabIndex?: number | undefined; title?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; translate?: \"yes\" | \"no\" | undefined; radioGroup?: string | undefined; role?: React.AriaRole | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; property?: string | undefined; resource?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCapitalize?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"search\" | \"none\" | \"text\" | \"url\" | \"tel\" | \"email\" | \"numeric\" | \"decimal\" | undefined; is?: string | undefined; 'aria-activedescendant'?: string | undefined; 'aria-atomic'?: Booleanish | undefined; 'aria-autocomplete'?: \"none\" | \"list\" | \"inline\" | \"both\" | undefined; 'aria-busy'?: Booleanish | undefined; 'aria-checked'?: boolean | \"true\" | \"false\" | \"mixed\" | undefined; 'aria-colcount'?: number | undefined; 'aria-colindex'?: number | undefined; 'aria-colspan'?: number | undefined; 'aria-controls'?: string | undefined; 'aria-current'?: boolean | \"page\" | \"date\" | \"true\" | \"false\" | \"time\" | \"step\" | \"location\" | undefined; 'aria-describedby'?: string | undefined; 'aria-details'?: string | undefined; 'aria-disabled'?: Booleanish | undefined; 'aria-dropeffect'?: \"execute\" | \"link\" | \"none\" | \"copy\" | \"move\" | \"popup\" | undefined; 'aria-errormessage'?: string | undefined; 'aria-expanded'?: Booleanish | undefined; 'aria-flowto'?: string | undefined; 'aria-grabbed'?: Booleanish | undefined; 'aria-haspopup'?: boolean | \"true\" | \"false\" | \"dialog\" | \"menu\" | \"grid\" | \"listbox\" | \"tree\" | undefined; 'aria-hidden'?: Booleanish | undefined; 'aria-invalid'?: boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" | undefined; 'aria-keyshortcuts'?: string | undefined; 'aria-label'?: string | undefined; 'aria-labelledby'?: string | undefined; 'aria-level'?: number | undefined; 'aria-live'?: \"off\" | \"assertive\" | \"polite\" | undefined; 'aria-modal'?: Booleanish | undefined; 'aria-multiline'?: Booleanish | undefined; 'aria-multiselectable'?: Booleanish | undefined; 'aria-orientation'?: \"horizontal\" | \"vertical\" | undefined; 'aria-owns'?: string | undefined; 'aria-placeholder'?: string | undefined; 'aria-posinset'?: number | undefined; 'aria-pressed'?: boolean | \"true\" | \"false\" | \"mixed\" | undefined; 'aria-readonly'?: Booleanish | undefined; 'aria-relevant'?: \"text\" | \"all\" | \"additions\" | \"additions removals\" | \"additions text\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" | undefined; 'aria-required'?: Booleanish | undefined; 'aria-roledescription'?: string | undefined; 'aria-rowcount'?: number | undefined; 'aria-rowindex'?: number | undefined; 'aria-rowspan'?: number | undefined; 'aria-selected'?: Booleanish | undefined; 'aria-setsize'?: number | undefined; 'aria-sort'?: \"none\" | \"ascending\" | \"descending\" | \"other\" | undefined; 'aria-valuemax'?: number | undefined; 'aria-valuemin'?: number | undefined; 'aria-valuenow'?: number | undefined; 'aria-valuetext'?: string | undefined; dangerouslySetInnerHTML?: { __html: string; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChangeCapture?: React.FormEventHandler | undefined; onBeforeInput?: React.FormEventHandler | undefined; onBeforeInputCapture?: React.FormEventHandler | undefined; onInput?: React.FormEventHandler | undefined; onInputCapture?: React.FormEventHandler | undefined; onReset?: React.FormEventHandler | undefined; onResetCapture?: React.FormEventHandler | undefined; onSubmit?: React.FormEventHandler | undefined; onSubmitCapture?: React.FormEventHandler | undefined; onInvalid?: React.FormEventHandler | undefined; onInvalidCapture?: React.FormEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onError?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDown?: React.KeyboardEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClick?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerEnterCapture?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerLeaveCapture?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; hasBorder?: boolean | undefined; paddingSize?: \"m\" | \"none\" | \"s\" | \"xs\" | \"l\" | \"xl\" | undefined; 'data-test-subj'?: string | undefined; css?: ", "Interpolation", "<", "Theme", diff --git a/api_docs/kbn_shared_ux_card_no_data.mdx b/api_docs/kbn_shared_ux_card_no_data.mdx index 17f6c66d58c89..ff2966d2ed8b8 100644 --- a/api_docs/kbn_shared_ux_card_no_data.mdx +++ b/api_docs/kbn_shared_ux_card_no_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-card-no-data title: "@kbn/shared-ux-card-no-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-card-no-data plugin -date: 2023-06-30 +date: 2023-07-18 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 eeb6f991db1d3..f0e7cb5fb8809 100644 --- a/api_docs/kbn_shared_ux_card_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_card_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-card-no-data-mocks title: "@kbn/shared-ux-card-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-card-no-data-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 cbb0de7496c59..a8da7eb218d38 100644 --- a/api_docs/kbn_shared_ux_chrome_navigation.mdx +++ b/api_docs/kbn_shared_ux_chrome_navigation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-chrome-navigation title: "@kbn/shared-ux-chrome-navigation" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-chrome-navigation plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-chrome-navigation'] --- import kbnSharedUxChromeNavigationObj from './kbn_shared_ux_chrome_navigation.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_context.mdx b/api_docs/kbn_shared_ux_file_context.mdx index fe577411235cb..975c535415e17 100644 --- a/api_docs/kbn_shared_ux_file_context.mdx +++ b/api_docs/kbn_shared_ux_file_context.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-context title: "@kbn/shared-ux-file-context" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-context plugin -date: 2023-06-30 +date: 2023-07-18 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 858151006d8ce..a89051e651529 100644 --- a/api_docs/kbn_shared_ux_file_image.mdx +++ b/api_docs/kbn_shared_ux_file_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-image title: "@kbn/shared-ux-file-image" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-image plugin -date: 2023-06-30 +date: 2023-07-18 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 247be558cbcef..5d08a6619e6a5 100644 --- a/api_docs/kbn_shared_ux_file_image_mocks.mdx +++ b/api_docs/kbn_shared_ux_file_image_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-image-mocks title: "@kbn/shared-ux-file-image-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-image-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 dbf4cef7d443b..45446207d31b7 100644 --- a/api_docs/kbn_shared_ux_file_mocks.mdx +++ b/api_docs/kbn_shared_ux_file_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-mocks title: "@kbn/shared-ux-file-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 ac3367f429743..c7397985b5bbf 100644 --- a/api_docs/kbn_shared_ux_file_picker.mdx +++ b/api_docs/kbn_shared_ux_file_picker.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-picker title: "@kbn/shared-ux-file-picker" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-picker plugin -date: 2023-06-30 +date: 2023-07-18 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 e2ed1b93b8fd3..509fffbc03b23 100644 --- a/api_docs/kbn_shared_ux_file_types.mdx +++ b/api_docs/kbn_shared_ux_file_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-types title: "@kbn/shared-ux-file-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-types plugin -date: 2023-06-30 +date: 2023-07-18 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 2d77fc33b7d0f..08b8a433077d7 100644 --- a/api_docs/kbn_shared_ux_file_upload.mdx +++ b/api_docs/kbn_shared_ux_file_upload.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-upload title: "@kbn/shared-ux-file-upload" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-upload plugin -date: 2023-06-30 +date: 2023-07-18 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 a11a68075dc78..931eea5f28e80 100644 --- a/api_docs/kbn_shared_ux_file_util.mdx +++ b/api_docs/kbn_shared_ux_file_util.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-util title: "@kbn/shared-ux-file-util" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-util plugin -date: 2023-06-30 +date: 2023-07-18 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 7b4d15989dbd4..1ac4df2987ed9 100644 --- a/api_docs/kbn_shared_ux_link_redirect_app.mdx +++ b/api_docs/kbn_shared_ux_link_redirect_app.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-link-redirect-app title: "@kbn/shared-ux-link-redirect-app" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-link-redirect-app plugin -date: 2023-06-30 +date: 2023-07-18 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 f7aafa18bf14d..b3061ee1b3f87 100644 --- a/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx +++ b/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-link-redirect-app-mocks title: "@kbn/shared-ux-link-redirect-app-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-link-redirect-app-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 5e009794043e1..a3483d05cdcbd 100644 --- a/api_docs/kbn_shared_ux_markdown.mdx +++ b/api_docs/kbn_shared_ux_markdown.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-markdown title: "@kbn/shared-ux-markdown" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-markdown plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_shared_ux_markdown_mocks.devdocs.json index 074dcd8a7da49..43b6136a46ddc 100644 --- a/api_docs/kbn_shared_ux_markdown_mocks.devdocs.json +++ b/api_docs/kbn_shared_ux_markdown_mocks.devdocs.json @@ -433,7 +433,7 @@ "label": "getServices", "description": [], "signature": [ - "() => { prefix?: string | undefined; value?: string | undefined; id?: string | undefined; defaultValue?: string | number | readonly string[] | undefined; security?: string | undefined; children?: React.ReactNode; onChange?: ((value: string) => void) | undefined; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; className?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; hidden?: boolean | undefined; lang?: string | undefined; placeholder?: string | undefined; slot?: string | undefined; spellCheck?: Booleanish | undefined; style?: React.CSSProperties | undefined; tabIndex?: number | undefined; title?: string | undefined; translate?: \"yes\" | \"no\" | undefined; radioGroup?: string | undefined; role?: React.AriaRole | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; property?: string | undefined; resource?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCapitalize?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; color?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"search\" | \"none\" | \"text\" | \"url\" | \"tel\" | \"email\" | \"numeric\" | \"decimal\" | undefined; is?: string | undefined; 'aria-activedescendant'?: string | undefined; 'aria-atomic'?: Booleanish | undefined; 'aria-autocomplete'?: \"none\" | \"list\" | \"inline\" | \"both\" | undefined; 'aria-busy'?: Booleanish | undefined; 'aria-checked'?: boolean | \"true\" | \"false\" | \"mixed\" | undefined; 'aria-colcount'?: number | undefined; 'aria-colindex'?: number | undefined; 'aria-colspan'?: number | undefined; 'aria-controls'?: string | undefined; 'aria-current'?: boolean | \"page\" | \"date\" | \"time\" | \"true\" | \"false\" | \"step\" | \"location\" | undefined; 'aria-describedby'?: string | undefined; 'aria-details'?: string | undefined; 'aria-disabled'?: Booleanish | undefined; 'aria-dropeffect'?: \"execute\" | \"link\" | \"none\" | \"copy\" | \"move\" | \"popup\" | undefined; 'aria-errormessage'?: string | undefined; 'aria-expanded'?: Booleanish | undefined; 'aria-flowto'?: string | undefined; 'aria-grabbed'?: Booleanish | undefined; 'aria-haspopup'?: boolean | \"dialog\" | \"menu\" | \"true\" | \"false\" | \"grid\" | \"listbox\" | \"tree\" | undefined; 'aria-hidden'?: Booleanish | undefined; 'aria-invalid'?: boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" | undefined; 'aria-keyshortcuts'?: string | undefined; 'aria-label'?: string | undefined; 'aria-labelledby'?: string | undefined; 'aria-level'?: number | undefined; 'aria-live'?: \"off\" | \"assertive\" | \"polite\" | undefined; 'aria-modal'?: Booleanish | undefined; 'aria-multiline'?: Booleanish | undefined; 'aria-multiselectable'?: Booleanish | undefined; 'aria-orientation'?: \"horizontal\" | \"vertical\" | undefined; 'aria-owns'?: string | undefined; 'aria-placeholder'?: string | undefined; 'aria-posinset'?: number | undefined; 'aria-pressed'?: boolean | \"true\" | \"false\" | \"mixed\" | undefined; 'aria-readonly'?: Booleanish | undefined; 'aria-relevant'?: \"text\" | \"all\" | \"additions\" | \"additions removals\" | \"additions text\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" | undefined; 'aria-required'?: Booleanish | undefined; 'aria-roledescription'?: string | undefined; 'aria-rowcount'?: number | undefined; 'aria-rowindex'?: number | undefined; 'aria-rowspan'?: number | undefined; 'aria-selected'?: Booleanish | undefined; 'aria-setsize'?: number | undefined; 'aria-sort'?: \"none\" | \"ascending\" | \"descending\" | \"other\" | undefined; 'aria-valuemax'?: number | undefined; 'aria-valuemin'?: number | undefined; 'aria-valuenow'?: number | undefined; 'aria-valuetext'?: string | undefined; dangerouslySetInnerHTML?: { __html: string; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChangeCapture?: React.FormEventHandler | undefined; onBeforeInput?: React.FormEventHandler | undefined; onBeforeInputCapture?: React.FormEventHandler | undefined; onInput?: React.FormEventHandler | undefined; onInputCapture?: React.FormEventHandler | undefined; onReset?: React.FormEventHandler | undefined; onResetCapture?: React.FormEventHandler | undefined; onSubmit?: React.FormEventHandler | undefined; onSubmitCapture?: React.FormEventHandler | undefined; onInvalid?: React.FormEventHandler | undefined; onInvalidCapture?: React.FormEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onError?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDown?: React.KeyboardEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClick?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerEnterCapture?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerLeaveCapture?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; 'data-test-subj'?: string | undefined; css?: ", + "() => { prefix?: string | undefined; value?: string | undefined; id?: string | undefined; defaultValue?: string | number | readonly string[] | undefined; security?: string | undefined; children?: React.ReactNode; onChange?: ((value: string) => void) | undefined; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; className?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; hidden?: boolean | undefined; lang?: string | undefined; placeholder?: string | undefined; slot?: string | undefined; spellCheck?: Booleanish | undefined; style?: React.CSSProperties | undefined; tabIndex?: number | undefined; title?: string | undefined; translate?: \"yes\" | \"no\" | undefined; radioGroup?: string | undefined; role?: React.AriaRole | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; property?: string | undefined; resource?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCapitalize?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; color?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"search\" | \"none\" | \"text\" | \"url\" | \"tel\" | \"email\" | \"numeric\" | \"decimal\" | undefined; is?: string | undefined; 'aria-activedescendant'?: string | undefined; 'aria-atomic'?: Booleanish | undefined; 'aria-autocomplete'?: \"none\" | \"list\" | \"inline\" | \"both\" | undefined; 'aria-busy'?: Booleanish | undefined; 'aria-checked'?: boolean | \"true\" | \"false\" | \"mixed\" | undefined; 'aria-colcount'?: number | undefined; 'aria-colindex'?: number | undefined; 'aria-colspan'?: number | undefined; 'aria-controls'?: string | undefined; 'aria-current'?: boolean | \"page\" | \"date\" | \"true\" | \"false\" | \"time\" | \"step\" | \"location\" | undefined; 'aria-describedby'?: string | undefined; 'aria-details'?: string | undefined; 'aria-disabled'?: Booleanish | undefined; 'aria-dropeffect'?: \"execute\" | \"link\" | \"none\" | \"copy\" | \"move\" | \"popup\" | undefined; 'aria-errormessage'?: string | undefined; 'aria-expanded'?: Booleanish | undefined; 'aria-flowto'?: string | undefined; 'aria-grabbed'?: Booleanish | undefined; 'aria-haspopup'?: boolean | \"true\" | \"false\" | \"dialog\" | \"menu\" | \"grid\" | \"listbox\" | \"tree\" | undefined; 'aria-hidden'?: Booleanish | undefined; 'aria-invalid'?: boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" | undefined; 'aria-keyshortcuts'?: string | undefined; 'aria-label'?: string | undefined; 'aria-labelledby'?: string | undefined; 'aria-level'?: number | undefined; 'aria-live'?: \"off\" | \"assertive\" | \"polite\" | undefined; 'aria-modal'?: Booleanish | undefined; 'aria-multiline'?: Booleanish | undefined; 'aria-multiselectable'?: Booleanish | undefined; 'aria-orientation'?: \"horizontal\" | \"vertical\" | undefined; 'aria-owns'?: string | undefined; 'aria-placeholder'?: string | undefined; 'aria-posinset'?: number | undefined; 'aria-pressed'?: boolean | \"true\" | \"false\" | \"mixed\" | undefined; 'aria-readonly'?: Booleanish | undefined; 'aria-relevant'?: \"text\" | \"all\" | \"additions\" | \"additions removals\" | \"additions text\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" | undefined; 'aria-required'?: Booleanish | undefined; 'aria-roledescription'?: string | undefined; 'aria-rowcount'?: number | undefined; 'aria-rowindex'?: number | undefined; 'aria-rowspan'?: number | undefined; 'aria-selected'?: Booleanish | undefined; 'aria-setsize'?: number | undefined; 'aria-sort'?: \"none\" | \"ascending\" | \"descending\" | \"other\" | undefined; 'aria-valuemax'?: number | undefined; 'aria-valuemin'?: number | undefined; 'aria-valuenow'?: number | undefined; 'aria-valuetext'?: string | undefined; dangerouslySetInnerHTML?: { __html: string; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChangeCapture?: React.FormEventHandler | undefined; onBeforeInput?: React.FormEventHandler | undefined; onBeforeInputCapture?: React.FormEventHandler | undefined; onInput?: React.FormEventHandler | undefined; onInputCapture?: React.FormEventHandler | undefined; onReset?: React.FormEventHandler | undefined; onResetCapture?: React.FormEventHandler | undefined; onSubmit?: React.FormEventHandler | undefined; onSubmitCapture?: React.FormEventHandler | undefined; onInvalid?: React.FormEventHandler | undefined; onInvalidCapture?: React.FormEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onError?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDown?: React.KeyboardEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClick?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerEnterCapture?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerLeaveCapture?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; 'data-test-subj'?: string | undefined; css?: ", "Interpolation", "<", "Theme", diff --git a/api_docs/kbn_shared_ux_markdown_mocks.mdx b/api_docs/kbn_shared_ux_markdown_mocks.mdx index 98bbbd98e3067..1be5f57bd500f 100644 --- a/api_docs/kbn_shared_ux_markdown_mocks.mdx +++ b/api_docs/kbn_shared_ux_markdown_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-markdown-mocks title: "@kbn/shared-ux-markdown-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-markdown-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 e2048cf8bf66c..ae09367ebe927 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data title: "@kbn/shared-ux-page-analytics-no-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-analytics-no-data plugin -date: 2023-06-30 +date: 2023-07-18 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 41baeb7fc84ef..be61ca25fea4f 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data-mocks title: "@kbn/shared-ux-page-analytics-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-analytics-no-data-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 a77471c0ebd2b..2f47a195f3fa0 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data title: "@kbn/shared-ux-page-kibana-no-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-no-data plugin -date: 2023-06-30 +date: 2023-07-18 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 a20da4872dce3..a1aae3ed7b58c 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data-mocks title: "@kbn/shared-ux-page-kibana-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-no-data-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 67eb3fdc9d2da..3f7b5d597676b 100644 --- a/api_docs/kbn_shared_ux_page_kibana_template.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_template.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-template title: "@kbn/shared-ux-page-kibana-template" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-template plugin -date: 2023-06-30 +date: 2023-07-18 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 5b09648ce1025..94d84c88bc43e 100644 --- a/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-template-mocks title: "@kbn/shared-ux-page-kibana-template-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-template-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 f34e531d7be38..0803eb22adc0a 100644 --- a/api_docs/kbn_shared_ux_page_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_no_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data title: "@kbn/shared-ux-page-no-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data plugin -date: 2023-06-30 +date: 2023-07-18 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 784c60782d1b6..a27af2bbd5e81 100644 --- a/api_docs/kbn_shared_ux_page_no_data_config.mdx +++ b/api_docs/kbn_shared_ux_page_no_data_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-config title: "@kbn/shared-ux-page-no-data-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data-config plugin -date: 2023-06-30 +date: 2023-07-18 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 463881879d1d6..4c59157c78995 100644 --- a/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-config-mocks title: "@kbn/shared-ux-page-no-data-config-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data-config-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 a7ea6142f14a4..917a08da1770d 100644 --- a/api_docs/kbn_shared_ux_page_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-mocks title: "@kbn/shared-ux-page-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 a9aee4d9a0987..769be2671c9bb 100644 --- a/api_docs/kbn_shared_ux_page_solution_nav.mdx +++ b/api_docs/kbn_shared_ux_page_solution_nav.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-solution-nav title: "@kbn/shared-ux-page-solution-nav" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-solution-nav plugin -date: 2023-06-30 +date: 2023-07-18 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 7a28991b6db2f..2f763776bb45c 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx +++ b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views title: "@kbn/shared-ux-prompt-no-data-views" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-prompt-no-data-views plugin -date: 2023-06-30 +date: 2023-07-18 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 4b9d7785fb315..ee1c69433f5ce 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx +++ b/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views-mocks title: "@kbn/shared-ux-prompt-no-data-views-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-prompt-no-data-views-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 7768c002563e0..451602b0280b2 100644 --- a/api_docs/kbn_shared_ux_prompt_not_found.mdx +++ b/api_docs/kbn_shared_ux_prompt_not_found.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-not-found title: "@kbn/shared-ux-prompt-not-found" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-prompt-not-found plugin -date: 2023-06-30 +date: 2023-07-18 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 0a4267873f834..e55a9e5a87fd7 100644 --- a/api_docs/kbn_shared_ux_router.mdx +++ b/api_docs/kbn_shared_ux_router.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-router title: "@kbn/shared-ux-router" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-router plugin -date: 2023-06-30 +date: 2023-07-18 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 460135a134d2a..012225de120a6 100644 --- a/api_docs/kbn_shared_ux_router_mocks.mdx +++ b/api_docs/kbn_shared_ux_router_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-router-mocks title: "@kbn/shared-ux-router-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-router-mocks plugin -date: 2023-06-30 +date: 2023-07-18 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 33d552a1318eb..4a0db34a2bcf7 100644 --- a/api_docs/kbn_shared_ux_storybook_config.mdx +++ b/api_docs/kbn_shared_ux_storybook_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook-config title: "@kbn/shared-ux-storybook-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-storybook-config plugin -date: 2023-06-30 +date: 2023-07-18 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 149982eb03f10..d43c306da505c 100644 --- a/api_docs/kbn_shared_ux_storybook_mock.mdx +++ b/api_docs/kbn_shared_ux_storybook_mock.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook-mock title: "@kbn/shared-ux-storybook-mock" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-storybook-mock plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook-mock'] --- import kbnSharedUxStorybookMockObj from './kbn_shared_ux_storybook_mock.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx index 1cbc67ee4a11e..ad470b123cf87 100644 --- a/api_docs/kbn_shared_ux_utility.mdx +++ b/api_docs/kbn_shared_ux_utility.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-utility title: "@kbn/shared-ux-utility" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-utility plugin -date: 2023-06-30 +date: 2023-07-18 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 6737f47fdf96f..d7a3e97fed452 100644 --- a/api_docs/kbn_slo_schema.devdocs.json +++ b/api_docs/kbn_slo_schema.devdocs.json @@ -535,7 +535,7 @@ "label": "CreateSLOInput", "description": [], "signature": [ - "{ name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; 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; } | undefined; tags?: string[] | undefined; }" + "{ name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: 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; } | undefined; tags?: string[] | undefined; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -550,7 +550,7 @@ "label": "CreateSLOParams", "description": [], "signature": [ - "{ name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: ", + "{ name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -695,7 +695,7 @@ "label": "FindSLOResponse", "description": [], "signature": [ - "{ page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }" + "{ page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -725,7 +725,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 | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; }" + "{ indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -770,7 +770,22 @@ "label": "GetSLOResponse", "description": [], "signature": [ - "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }" + "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }" + ], + "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/slo-schema", + "id": "def-common.HistogramIndicator", + "type": "Type", + "tags": [], + "label": "HistogramIndicator", + "description": [], + "signature": [ + "{ type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -800,7 +815,7 @@ "label": "Indicator", "description": [], "signature": [ - "{ type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }" + "{ type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -815,7 +830,7 @@ "label": "IndicatorType", "description": [], "signature": [ - "\"sli.apm.transactionDuration\" | \"sli.apm.transactionErrorRate\" | \"sli.kql.custom\" | \"sli.metric.custom\"" + "\"sli.apm.transactionDuration\" | \"sli.apm.transactionErrorRate\" | \"sli.kql.custom\" | \"sli.metric.custom\" | \"sli.histogram.custom\"" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -860,7 +875,7 @@ "label": "MetricCustomIndicator", "description": [], "signature": [ - "{ type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }" + "{ type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -875,7 +890,7 @@ "label": "SLOResponse", "description": [], "signature": [ - "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }" + "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -890,7 +905,7 @@ "label": "SLOWithSummaryResponse", "description": [], "signature": [ - "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }" + "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -1004,7 +1019,7 @@ "label": "UpdateSLOInput", "description": [], "signature": [ - "{ name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; } | undefined; timeWindow?: { duration: string; 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; } | undefined; tags?: string[] | undefined; }" + "{ name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: 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; } | undefined; tags?: string[] | undefined; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -1019,7 +1034,7 @@ "label": "UpdateSLOParams", "description": [], "signature": [ - "{ name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; } | undefined; timeWindow?: { duration: ", + "{ name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; } | undefined; timeWindow?: { duration: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -1074,7 +1089,7 @@ "label": "UpdateSLOResponse", "description": [], "signature": [ - "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }" + "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -1738,6 +1753,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -1745,13 +1762,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -1759,11 +1782,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; timeWindow: ", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -2394,6 +2493,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -2401,13 +2502,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -2415,11 +2522,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; timeWindow: ", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -2684,6 +2867,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -2691,13 +2876,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -2705,11 +2896,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; }>; }>" + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; }>; }>" ], "path": "x-pack/packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -2970,6 +3237,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -2977,13 +3246,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -2991,34 +3266,110 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; timeWindow: ", - "UnionC", - "<[", + "; }>; }>, ", "TypeC", - "<{ duration: ", - "Type", - "<", - { - "pluginId": "@kbn/slo-schema", - "scope": "common", - "docId": "kibKbnSloSchemaPluginApi", - "section": "def-common.Duration", - "text": "Duration" - }, - ", string, unknown>; type: ", + "<{ type: ", "LiteralC", - "<\"rolling\">; }>, ", + "<\"sli.histogram.custom\">; params: ", "TypeC", - "<{ duration: ", - "Type", - "<", - { - "pluginId": "@kbn/slo-schema", - "scope": "common", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; timeWindow: ", + "UnionC", + "<[", + "TypeC", + "<{ duration: ", + "Type", + "<", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", + "docId": "kibKbnSloSchemaPluginApi", + "section": "def-common.Duration", + "text": "Duration" + }, + ", string, unknown>; type: ", + "LiteralC", + "<\"rolling\">; }>, ", + "TypeC", + "<{ duration: ", + "Type", + "<", + { + "pluginId": "@kbn/slo-schema", + "scope": "common", "docId": "kibKbnSloSchemaPluginApi", "section": "def-common.Duration", "text": "Duration" @@ -3118,6 +3469,108 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/slo-schema", + "id": "def-common.histogramIndicatorSchema", + "type": "Object", + "tags": [], + "label": "histogramIndicatorSchema", + "description": [], + "signature": [ + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>" + ], + "path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/slo-schema", + "id": "def-common.histogramIndicatorTypeSchema", + "type": "Object", + "tags": [], + "label": "histogramIndicatorTypeSchema", + "description": [], + "signature": [ + "LiteralC", + "<\"sli.histogram.custom\">" + ], + "path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/slo-schema", "id": "def-common.historicalSummarySchema", @@ -3306,6 +3759,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -3313,13 +3768,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -3327,11 +3788,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>" + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>" ], "path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts", "deprecated": false, @@ -3371,7 +3908,9 @@ "LiteralC", "<\"sli.kql.custom\">, ", "LiteralC", - "<\"sli.metric.custom\">]>" + "<\"sli.metric.custom\">, ", + "LiteralC", + "<\"sli.histogram.custom\">]>" ], "path": "x-pack/packages/kbn-slo-schema/src/schema/indicators.ts", "deprecated": false, @@ -3466,6 +4005,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -3473,13 +4014,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -3487,7 +4034,11 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", @@ -3841,6 +4392,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -3848,13 +4401,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -3862,11 +4421,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; timeWindow: ", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -4089,6 +4724,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -4096,13 +4733,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -4110,11 +4753,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; timeWindow: ", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -4339,32 +5058,116 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", + "StringC", + "; }>; timestampField: ", + "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", "TypeC", - "<{ name: ", + "<{ field: ", "StringC", "; aggregation: ", - "KeyofC", - "<{ sum: boolean; }>; field: ", - "StringC", - "; }>>; equation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", "StringC", - "; }>; total: ", + "; }>]>, ", + "IntersectionC", + "<[", "TypeC", - "<{ metrics: ", - "ArrayC", - "<", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", "TypeC", - "<{ name: ", + "<{ field: ", "StringC", "; aggregation: ", - "KeyofC", - "<{ sum: boolean; }>; field: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", "StringC", - "; }>>; equation: ", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", "StringC", - "; }>; timestampField: ", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", "StringC", - "; }>; }>]>; timeWindow: ", + "; }>]>]>; }>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -4615,6 +5418,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -4622,13 +5427,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -4636,11 +5447,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; timeWindow: ", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -5263,6 +6150,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -5270,13 +6159,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -5284,11 +6179,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; timeWindow: ", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -5503,6 +6474,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -5510,13 +6483,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -5524,11 +6503,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; timeWindow: ", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", diff --git a/api_docs/kbn_slo_schema.mdx b/api_docs/kbn_slo_schema.mdx index b085b172ac32e..8f349ec9bffdb 100644 --- a/api_docs/kbn_slo_schema.mdx +++ b/api_docs/kbn_slo_schema.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-slo-schema title: "@kbn/slo-schema" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/slo-schema plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/slo-schema'] --- import kbnSloSchemaObj from './kbn_slo_schema.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/actionable-observability](https://github.com/orgs/elastic/team | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 123 | 0 | 123 | 0 | +| 126 | 0 | 126 | 0 | ## Common diff --git a/api_docs/kbn_some_dev_log.mdx b/api_docs/kbn_some_dev_log.mdx index d7269e4f87a70..05c653c1387ac 100644 --- a/api_docs/kbn_some_dev_log.mdx +++ b/api_docs/kbn_some_dev_log.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-some-dev-log title: "@kbn/some-dev-log" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/some-dev-log plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/some-dev-log'] --- import kbnSomeDevLogObj from './kbn_some_dev_log.devdocs.json'; diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index 3ee76d8ce57bb..bd49cd228f030 100644 --- a/api_docs/kbn_std.mdx +++ b/api_docs/kbn_std.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-std title: "@kbn/std" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/std plugin -date: 2023-06-30 +date: 2023-07-18 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 8951131d9c1b3..69dfc7a643350 100644 --- a/api_docs/kbn_stdio_dev_helpers.mdx +++ b/api_docs/kbn_stdio_dev_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-stdio-dev-helpers title: "@kbn/stdio-dev-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/stdio-dev-helpers plugin -date: 2023-06-30 +date: 2023-07-18 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 94802cce7aabc..3578cc469364c 100644 --- a/api_docs/kbn_storybook.mdx +++ b/api_docs/kbn_storybook.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-storybook title: "@kbn/storybook" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/storybook plugin -date: 2023-06-30 +date: 2023-07-18 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 b9c5a4ed5a588..509030762b523 100644 --- a/api_docs/kbn_telemetry_tools.mdx +++ b/api_docs/kbn_telemetry_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-telemetry-tools title: "@kbn/telemetry-tools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/telemetry-tools plugin -date: 2023-06-30 +date: 2023-07-18 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 a28269b45d0fc..9fb40ee693332 100644 --- a/api_docs/kbn_test.mdx +++ b/api_docs/kbn_test.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test title: "@kbn/test" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/test plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] --- import kbnTestObj from './kbn_test.devdocs.json'; diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index 56e27ec9a1ea4..778190dbcc68c 100644 --- a/api_docs/kbn_test_jest_helpers.mdx +++ b/api_docs/kbn_test_jest_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test-jest-helpers title: "@kbn/test-jest-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/test-jest-helpers plugin -date: 2023-06-30 +date: 2023-07-18 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 02d2aadd706f9..9b5cf264dc543 100644 --- a/api_docs/kbn_test_subj_selector.mdx +++ b/api_docs/kbn_test_subj_selector.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test-subj-selector title: "@kbn/test-subj-selector" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/test-subj-selector plugin -date: 2023-06-30 +date: 2023-07-18 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.mdx b/api_docs/kbn_text_based_editor.mdx index 5daf28cd7d244..6836e37a2b6d0 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: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/text-based-editor'] --- import kbnTextBasedEditorObj from './kbn_text_based_editor.devdocs.json'; diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index 7ee9dd44938f0..a37127c1df535 100644 --- a/api_docs/kbn_tooling_log.mdx +++ b/api_docs/kbn_tooling_log.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-tooling-log title: "@kbn/tooling-log" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/tooling-log plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] --- import kbnToolingLogObj from './kbn_tooling_log.devdocs.json'; diff --git a/api_docs/kbn_ts_projects.mdx b/api_docs/kbn_ts_projects.mdx index 6104ee6e57500..e6ad644efc097 100644 --- a/api_docs/kbn_ts_projects.mdx +++ b/api_docs/kbn_ts_projects.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ts-projects title: "@kbn/ts-projects" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ts-projects plugin -date: 2023-06-30 +date: 2023-07-18 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 f57367798f2aa..99d8a3be6eafb 100644 --- a/api_docs/kbn_typed_react_router_config.mdx +++ b/api_docs/kbn_typed_react_router_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-typed-react-router-config title: "@kbn/typed-react-router-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/typed-react-router-config plugin -date: 2023-06-30 +date: 2023-07-18 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 032c531cca7f6..91320501c8c49 100644 --- a/api_docs/kbn_ui_actions_browser.mdx +++ b/api_docs/kbn_ui_actions_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-actions-browser title: "@kbn/ui-actions-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ui-actions-browser plugin -date: 2023-06-30 +date: 2023-07-18 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 d9303de280b06..c21357cf59ca9 100644 --- a/api_docs/kbn_ui_shared_deps_src.mdx +++ b/api_docs/kbn_ui_shared_deps_src.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-shared-deps-src title: "@kbn/ui-shared-deps-src" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ui-shared-deps-src plugin -date: 2023-06-30 +date: 2023-07-18 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 a6390418bffdc..75053d55c6053 100644 --- a/api_docs/kbn_ui_theme.mdx +++ b/api_docs/kbn_ui_theme.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-theme title: "@kbn/ui-theme" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ui-theme plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] --- import kbnUiThemeObj from './kbn_ui_theme.devdocs.json'; diff --git a/api_docs/kbn_unified_field_list.devdocs.json b/api_docs/kbn_unified_field_list.devdocs.json index 5987f7c246030..b3f519f7e2897 100644 --- a/api_docs/kbn_unified_field_list.devdocs.json +++ b/api_docs/kbn_unified_field_list.devdocs.json @@ -831,6 +831,80 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.getSearchMode", + "type": "Function", + "tags": [], + "label": "getSearchMode", + "description": [ + "\nDetermines current search mode" + ], + "signature": [ + "(query: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.AggregateQuery", + "text": "AggregateQuery" + }, + " | undefined) => ", + { + "pluginId": "@kbn/unified-field-list", + "scope": "common", + "docId": "kibKbnUnifiedFieldListPluginApi", + "section": "def-common.SearchMode", + "text": "SearchMode" + }, + " | undefined" + ], + "path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.getSearchMode.$1", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.AggregateQuery", + "text": "AggregateQuery" + }, + " | undefined" + ], + "path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/unified-field-list", "id": "def-common.getVisualizeInformation", @@ -1034,7 +1108,15 @@ "section": "def-common.Filter", "text": "Filter" }, - "[]; fromDate: string; toDate: string; }" + "[]; fromDate: string; toDate: string; searchMode: ", + { + "pluginId": "@kbn/unified-field-list", + "scope": "common", + "docId": "kibKbnUnifiedFieldListPluginApi", + "section": "def-common.SearchMode", + "text": "SearchMode" + }, + "; }" ], "path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts", "deprecated": false, @@ -1429,6 +1511,90 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.UnifiedFieldListSidebarContainer", + "type": "Function", + "tags": [], + "label": "UnifiedFieldListSidebarContainer", + "description": [], + "signature": [ + "React.ForwardRefExoticComponent & { services: Omit<", + { + "pluginId": "@kbn/unified-field-list", + "scope": "common", + "docId": "kibKbnUnifiedFieldListPluginApi", + "section": "def-common.FieldStatsServices", + "text": "FieldStatsServices" + }, + ", \"uiSettings\"> & { core: ", + { + "pluginId": "@kbn/core-lifecycle-browser", + "scope": "common", + "docId": "kibKbnCoreLifecycleBrowserPluginApi", + "section": "def-common.CoreStart", + "text": "CoreStart" + }, + "; } & { uiActions?: ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.UiActionsStart", + "text": "UiActionsStart" + }, + " | undefined; } & { dataViewFieldEditor?: ", + { + "pluginId": "dataViewFieldEditor", + "scope": "public", + "docId": "kibDataViewFieldEditorPluginApi", + "section": "def-public.PluginStart", + "text": "PluginStart" + }, + " | undefined; }; getCreationOptions: () => ", + "UnifiedFieldListSidebarContainerCreationOptions", + "; isSidebarCollapsed?: boolean | undefined; prependInFlyout?: (() => React.ReactNode) | undefined; variant?: \"responsive\" | \"button-and-flyout-always\" | \"list-always\" | undefined; onSelectedFieldFilter?: ((field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + ") => boolean) | undefined; onFieldEdited?: ((options?: { removedFieldName?: string | undefined; editedFieldName?: string | undefined; } | undefined) => Promise) | undefined; } & React.RefAttributes<", + { + "pluginId": "@kbn/unified-field-list", + "scope": "common", + "docId": "kibKbnUnifiedFieldListPluginApi", + "section": "def-common.UnifiedFieldListSidebarContainerApi", + "text": "UnifiedFieldListSidebarContainerApi" + }, + ">>" + ], + "path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/index.tsx", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.UnifiedFieldListSidebarContainer.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/unified-field-list", "id": "def-common.useExistingFieldsFetcher", @@ -1634,7 +1800,7 @@ "\nMemorizes current query, filters and absolute date range" ], "signature": [ - "({ data, listenToSearchSessionUpdates, }: ", + "({ data, timeRangeUpdatesType, }: ", { "pluginId": "@kbn/unified-field-list", "scope": "common", @@ -1660,7 +1826,7 @@ "id": "def-common.useQuerySubscriber.$1", "type": "Object", "tags": [], - "label": "{\n data,\n listenToSearchSessionUpdates = true,\n}", + "label": "{\n data,\n timeRangeUpdatesType = 'search-session',\n}", "description": [], "signature": [ { @@ -4709,51 +4875,12 @@ "label": "onOverrideFieldGroupDetails", "description": [], "signature": [ - "((groupName: ", - { - "pluginId": "@kbn/unified-field-list", - "scope": "common", - "docId": "kibKbnUnifiedFieldListPluginApi", - "section": "def-common.FieldsGroupNames", - "text": "FieldsGroupNames" - }, - ") => Partial<", - { - "pluginId": "@kbn/unified-field-list", - "scope": "common", - "docId": "kibKbnUnifiedFieldListPluginApi", - "section": "def-common.FieldsGroupDetails", - "text": "FieldsGroupDetails" - }, - "> | null | undefined) | undefined" + "OverrideFieldGroupDetails", + " | undefined" ], "path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts", "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/unified-field-list", - "id": "def-common.GroupedFieldsParams.onOverrideFieldGroupDetails.$1", - "type": "Enum", - "tags": [], - "label": "groupName", - "description": [], - "signature": [ - { - "pluginId": "@kbn/unified-field-list", - "scope": "common", - "docId": "kibKbnUnifiedFieldListPluginApi", - "section": "def-common.FieldsGroupNames", - "text": "FieldsGroupNames" - } - ], - "path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "@kbn/unified-field-list", @@ -4974,13 +5101,16 @@ }, { "parentPluginId": "@kbn/unified-field-list", - "id": "def-common.QuerySubscriberParams.listenToSearchSessionUpdates", + "id": "def-common.QuerySubscriberParams.timeRangeUpdatesType", "type": "CompoundType", "tags": [], - "label": "listenToSearchSessionUpdates", - "description": [], + "label": "timeRangeUpdatesType", + "description": [ + "\nPass `timefilter` only if you are not using search sessions for the global search" + ], "signature": [ - "boolean | undefined" + "TimeRangeUpdatesType", + " | undefined" ], "path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts", "deprecated": false, @@ -5079,6 +5209,27 @@ "path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.QuerySubscriberResult.searchMode", + "type": "CompoundType", + "tags": [], + "label": "searchMode", + "description": [], + "signature": [ + { + "pluginId": "@kbn/unified-field-list", + "scope": "common", + "docId": "kibKbnUnifiedFieldListPluginApi", + "section": "def-common.SearchMode", + "text": "SearchMode" + }, + " | undefined" + ], + "path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -5191,6 +5342,109 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.UnifiedFieldListSidebarContainerApi", + "type": "Interface", + "tags": [], + "label": "UnifiedFieldListSidebarContainerApi", + "description": [], + "path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.UnifiedFieldListSidebarContainerApi.refetchFieldsExistenceInfo", + "type": "Function", + "tags": [], + "label": "refetchFieldsExistenceInfo", + "description": [], + "signature": [ + "(dataViewId?: string | undefined) => Promise" + ], + "path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.UnifiedFieldListSidebarContainerApi.refetchFieldsExistenceInfo.$1", + "type": "string", + "tags": [], + "label": "dataViewId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.UnifiedFieldListSidebarContainerApi.closeFieldListFlyout", + "type": "Function", + "tags": [], + "label": "closeFieldListFlyout", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.UnifiedFieldListSidebarContainerApi.createField", + "type": "Function", + "tags": [], + "label": "createField", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.UnifiedFieldListSidebarContainerApi.editField", + "type": "Function", + "tags": [], + "label": "editField", + "description": [], + "signature": [ + "((fieldName: string) => void) | undefined" + ], + "path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.UnifiedFieldListSidebarContainerApi.deleteField", + "type": "Function", + "tags": [], + "label": "deleteField", + "description": [], + "signature": [ + "((fieldName: string) => void) | undefined" + ], + "path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/unified-field-list", "id": "def-common.VisualizeInformation", @@ -5483,6 +5737,80 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.SearchMode", + "type": "Type", + "tags": [], + "label": "SearchMode", + "description": [], + "signature": [ + "\"documents\" | \"text-based\"" + ], + "path": "packages/kbn-unified-field-list/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/unified-field-list", + "id": "def-common.UnifiedFieldListSidebarContainerProps", + "type": "Type", + "tags": [], + "label": "UnifiedFieldListSidebarContainerProps", + "description": [], + "signature": [ + "Omit<", + "UnifiedFieldListSidebarCustomizableProps", + ", \"services\"> & { services: Omit<", + { + "pluginId": "@kbn/unified-field-list", + "scope": "common", + "docId": "kibKbnUnifiedFieldListPluginApi", + "section": "def-common.FieldStatsServices", + "text": "FieldStatsServices" + }, + ", \"uiSettings\"> & { core: ", + { + "pluginId": "@kbn/core-lifecycle-browser", + "scope": "common", + "docId": "kibKbnCoreLifecycleBrowserPluginApi", + "section": "def-common.CoreStart", + "text": "CoreStart" + }, + "; } & { uiActions?: ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.UiActionsStart", + "text": "UiActionsStart" + }, + " | undefined; } & { dataViewFieldEditor?: ", + { + "pluginId": "dataViewFieldEditor", + "scope": "public", + "docId": "kibDataViewFieldEditorPluginApi", + "section": "def-public.PluginStart", + "text": "PluginStart" + }, + " | undefined; }; getCreationOptions: () => ", + "UnifiedFieldListSidebarContainerCreationOptions", + "; isSidebarCollapsed?: boolean | undefined; prependInFlyout?: (() => React.ReactNode) | undefined; variant?: \"responsive\" | \"button-and-flyout-always\" | \"list-always\" | undefined; onSelectedFieldFilter?: ((field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + ") => boolean) | undefined; onFieldEdited?: ((options?: { removedFieldName?: string | undefined; editedFieldName?: string | undefined; } | undefined) => Promise) | undefined; }" + ], + "path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false } ], "objects": [] diff --git a/api_docs/kbn_unified_field_list.mdx b/api_docs/kbn_unified_field_list.mdx index 3a57dc997ac59..74f9d98fb3c6d 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: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/unified-field-list'] --- import kbnUnifiedFieldListObj from './kbn_unified_field_list.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 293 | 0 | 267 | 5 | +| 306 | 0 | 277 | 9 | ## Common diff --git a/api_docs/kbn_url_state.mdx b/api_docs/kbn_url_state.mdx index d20cd31a79a8f..7df4ed3cc75eb 100644 --- a/api_docs/kbn_url_state.mdx +++ b/api_docs/kbn_url_state.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-url-state title: "@kbn/url-state" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/url-state plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/url-state'] --- import kbnUrlStateObj from './kbn_url_state.devdocs.json'; diff --git a/api_docs/kbn_user_profile_components.mdx b/api_docs/kbn_user_profile_components.mdx index f677f876d2f8e..661ebd2b29200 100644 --- a/api_docs/kbn_user_profile_components.mdx +++ b/api_docs/kbn_user_profile_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-user-profile-components title: "@kbn/user-profile-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/user-profile-components plugin -date: 2023-06-30 +date: 2023-07-18 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 95b56c597ae28..f3e6648cf6609 100644 --- a/api_docs/kbn_utility_types.mdx +++ b/api_docs/kbn_utility_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types title: "@kbn/utility-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/utility-types plugin -date: 2023-06-30 +date: 2023-07-18 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.devdocs.json b/api_docs/kbn_utility_types_jest.devdocs.json index 78dfcb9ccd830..9d6394e780ac4 100644 --- a/api_docs/kbn_utility_types_jest.devdocs.json +++ b/api_docs/kbn_utility_types_jest.devdocs.json @@ -38,7 +38,7 @@ "section": "def-common.DeeplyMockedKeys", "text": "DeeplyMockedKeys" }, - "[] : T[P] extends (...args: any[]) => any ? jest.MockInstance, Parameters> : T[P] extends object ? ", + "[] : T[P] extends (...args: any[]) => any ? jest.MockInstance, Parameters, any> : T[P] extends object ? ", { "pluginId": "@kbn/utility-types-jest", "scope": "common", diff --git a/api_docs/kbn_utility_types_jest.mdx b/api_docs/kbn_utility_types_jest.mdx index c46479a9ff44d..47e6d5f7920a9 100644 --- a/api_docs/kbn_utility_types_jest.mdx +++ b/api_docs/kbn_utility_types_jest.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types-jest title: "@kbn/utility-types-jest" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/utility-types-jest plugin -date: 2023-06-30 +date: 2023-07-18 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 9813607dc45aa..c0fcebd583608 100644 --- a/api_docs/kbn_utils.mdx +++ b/api_docs/kbn_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utils title: "@kbn/utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/utils plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utils'] --- import kbnUtilsObj from './kbn_utils.devdocs.json'; diff --git a/api_docs/kbn_yarn_lock_validator.mdx b/api_docs/kbn_yarn_lock_validator.mdx index 36757ad29f0f3..346c1196c961e 100644 --- a/api_docs/kbn_yarn_lock_validator.mdx +++ b/api_docs/kbn_yarn_lock_validator.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-yarn-lock-validator title: "@kbn/yarn-lock-validator" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/yarn-lock-validator plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/yarn-lock-validator'] --- import kbnYarnLockValidatorObj from './kbn_yarn_lock_validator.devdocs.json'; diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx index e794ae8bd88ba..a696d5baf5445 100644 --- a/api_docs/kibana_overview.mdx +++ b/api_docs/kibana_overview.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaOverview title: "kibanaOverview" image: https://source.unsplash.com/400x175/?github description: API docs for the kibanaOverview plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview'] --- import kibanaOverviewObj from './kibana_overview.devdocs.json'; diff --git a/api_docs/kibana_react.devdocs.json b/api_docs/kibana_react.devdocs.json index d566b58672683..bdd6084a32efc 100644 --- a/api_docs/kibana_react.devdocs.json +++ b/api_docs/kibana_react.devdocs.json @@ -1304,18 +1304,6 @@ "plugin": "observability", "path": "x-pack/plugins/observability/public/application/index.tsx" }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx" - }, { "plugin": "fleet", "path": "x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx" @@ -1352,6 +1340,18 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/public/applications/fleet/app.tsx" }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx" + }, { "plugin": "apm", "path": "x-pack/plugins/apm/public/components/routing/app_root/index.tsx" @@ -1885,6 +1885,30 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.useKibanaTheme", + "type": "Function", + "tags": [], + "label": "useKibanaTheme", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-theme-browser", + "scope": "common", + "docId": "kibKbnCoreThemeBrowserPluginApi", + "section": "def-common.CoreTheme", + "text": "CoreTheme" + } + ], + "path": "src/plugins/kibana_react/public/theme/use_theme.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "kibanaReact", "id": "def-public.useUiSetting", diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index 1cc1cc3031f0d..574684d60f3b7 100644 --- a/api_docs/kibana_react.mdx +++ b/api_docs/kibana_react.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaReact title: "kibanaReact" image: https://source.unsplash.com/400x175/?github description: API docs for the kibanaReact plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact'] --- import kibanaReactObj from './kibana_react.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 | |-------------------|-----------|------------------------|-----------------| -| 184 | 1 | 153 | 5 | +| 185 | 1 | 154 | 5 | ## Client diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index 25766d27a39fe..8372dee9c1396 100644 --- a/api_docs/kibana_utils.mdx +++ b/api_docs/kibana_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaUtils title: "kibanaUtils" image: https://source.unsplash.com/400x175/?github description: API docs for the kibanaUtils plugin -date: 2023-06-30 +date: 2023-07-18 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 5e648fe9f9299..7e6618b635024 100644 --- a/api_docs/kubernetes_security.mdx +++ b/api_docs/kubernetes_security.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kubernetesSecurity title: "kubernetesSecurity" image: https://source.unsplash.com/400x175/?github description: API docs for the kubernetesSecurity plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kubernetesSecurity'] --- import kubernetesSecurityObj from './kubernetes_security.devdocs.json'; diff --git a/api_docs/lens.devdocs.json b/api_docs/lens.devdocs.json index a3dca011ebc79..c2f213c20e516 100644 --- a/api_docs/lens.devdocs.json +++ b/api_docs/lens.devdocs.json @@ -312,6 +312,119 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.isTextBasedLanguage", + "type": "Function", + "tags": [], + "label": "isTextBasedLanguage", + "description": [], + "signature": [ + "() => boolean | undefined" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.getTextBasedLanguage", + "type": "Function", + "tags": [], + "label": "getTextBasedLanguage", + "description": [], + "signature": [ + "() => string | undefined" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.updateVisualization", + "type": "Function", + "tags": [], + "label": "updateVisualization", + "description": [], + "signature": [ + "(datasourceState: unknown, visualizationState: unknown) => Promise" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.updateVisualization.$1", + "type": "Unknown", + "tags": [], + "label": "datasourceState", + "description": [], + "signature": [ + "unknown" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.updateVisualization.$2", + "type": "Unknown", + "tags": [], + "label": "visualizationState", + "description": [], + "signature": [ + "unknown" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.openConfingPanel", + "type": "Function", + "tags": [], + "label": "openConfingPanel", + "description": [], + "signature": [ + "(startDependencies: ", + "LensPluginStartDependencies", + ") => Promise" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.openConfingPanel.$1", + "type": "Object", + "tags": [], + "label": "startDependencies", + "description": [], + "signature": [ + "LensPluginStartDependencies" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "lens", "id": "def-public.Embeddable.initializeSavedVis", @@ -3183,6 +3296,28 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "lens", + "id": "def-public.LensPublicStart.EditLensConfigPanelApi", + "type": "Function", + "tags": [ + "experimental" + ], + "label": "EditLensConfigPanelApi", + "description": [ + "\nReact component which can be used to embed a Lens Visualization Config Panel Component.\n\nThis API might undergo breaking changes even in minor versions.\n" + ], + "signature": [ + "() => Promise<", + "EditLensConfigPanelComponent", + ">" + ], + "path": "x-pack/plugins/lens/public/plugin.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "lens", "id": "def-public.LensPublicStart.navigateToPrefilledEditor", @@ -5812,7 +5947,9 @@ "signature": [ "((layerId: string, state: T, setState: ", "StateSetter", - ", isSaveable?: boolean | undefined) => ", + ", registerLibraryAnnotationGroup: ", + "RegisterLibraryAnnotationGroupFunction", + ", isSaveable?: boolean | undefined) => ", "LayerAction", "[]) | undefined" ], @@ -5869,6 +6006,21 @@ { "parentPluginId": "lens", "id": "def-public.Visualization.getSupportedActionsForLayer.$4", + "type": "Function", + "tags": [], + "label": "registerLibraryAnnotationGroup", + "description": [], + "signature": [ + "RegisterLibraryAnnotationGroupFunction" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "lens", + "id": "def-public.Visualization.getSupportedActionsForLayer.$5", "type": "CompoundType", "tags": [], "label": "isSaveable", @@ -5884,6 +6036,55 @@ ], "returnComment": [] }, + { + "parentPluginId": "lens", + "id": "def-public.Visualization.getCustomRemoveLayerText", + "type": "Function", + "tags": [], + "label": "getCustomRemoveLayerText", + "description": [ + "\nThis method is a clunky solution to the problem, but I'm banking on the confirm modal being removed\nwith undo/redo anyways" + ], + "signature": [ + "((layerId: string, state: T) => { title?: string | undefined; description?: string | undefined; } | undefined) | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Visualization.getCustomRemoveLayerText.$1", + "type": "string", + "tags": [], + "label": "layerId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "lens", + "id": "def-public.Visualization.getCustomRemoveLayerText.$2", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "T" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "lens", "id": "def-public.Visualization.getLayerType", @@ -6106,17 +6307,19 @@ }, { "parentPluginId": "lens", - "id": "def-public.Visualization.renderLayerHeader", + "id": "def-public.Visualization.LayerHeaderComponent", "type": "Function", "tags": [], - "label": "renderLayerHeader", + "label": "LayerHeaderComponent", "description": [ "\nHeader rendered as layer title. This can be used for both static and dynamic content like\nfor extra configurability, such as for switch chart type" ], "signature": [ - "((domElement: Element, props: ", + "((props: ", "VisualizationLayerWidgetProps", - ") => void | ((cleanupElement: Element) => void)) | undefined" + ") => React.ReactElement<", + "VisualizationLayerWidgetProps", + ", string | React.JSXElementConstructor> | null) | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -6124,22 +6327,7 @@ "children": [ { "parentPluginId": "lens", - "id": "def-public.Visualization.renderLayerHeader.$1", - "type": "Object", - "tags": [], - "label": "domElement", - "description": [], - "signature": [ - "Element" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "lens", - "id": "def-public.Visualization.renderLayerHeader.$2", + "id": "def-public.Visualization.LayerHeaderComponent.$1", "type": "CompoundType", "tags": [], "label": "props", @@ -6158,17 +6346,19 @@ }, { "parentPluginId": "lens", - "id": "def-public.Visualization.renderLayerPanel", + "id": "def-public.Visualization.LayerPanelComponent", "type": "Function", "tags": [], - "label": "renderLayerPanel", + "label": "LayerPanelComponent", "description": [ "\nLayer panel content rendered. This can be used to render a custom content below the title,\nlike a custom dataview switch" ], "signature": [ - "((domElement: Element, props: ", + "((props: ", + "VisualizationLayerWidgetProps", + ") => React.ReactElement<", "VisualizationLayerWidgetProps", - ") => void | ((cleanupElement: Element) => void)) | undefined" + ", string | React.JSXElementConstructor> | null) | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -6176,22 +6366,7 @@ "children": [ { "parentPluginId": "lens", - "id": "def-public.Visualization.renderLayerPanel.$1", - "type": "Object", - "tags": [], - "label": "domElement", - "description": [], - "signature": [ - "Element" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "lens", - "id": "def-public.Visualization.renderLayerPanel.$2", + "id": "def-public.Visualization.LayerPanelComponent.$1", "type": "CompoundType", "tags": [], "label": "props", @@ -6210,17 +6385,19 @@ }, { "parentPluginId": "lens", - "id": "def-public.Visualization.renderToolbar", + "id": "def-public.Visualization.ToolbarComponent", "type": "Function", "tags": [], - "label": "renderToolbar", + "label": "ToolbarComponent", "description": [ "\nToolbar rendered above the visualization. This is meant to be used to provide chart-level\nsettings for the visualization." ], "signature": [ - "((domElement: Element, props: ", + "((props: ", + "VisualizationToolbarProps", + ") => React.ReactElement<", "VisualizationToolbarProps", - ") => void | ((cleanupElement: Element) => void)) | undefined" + ", string | React.JSXElementConstructor> | null) | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -6228,22 +6405,7 @@ "children": [ { "parentPluginId": "lens", - "id": "def-public.Visualization.renderToolbar.$1", - "type": "Object", - "tags": [], - "label": "domElement", - "description": [], - "signature": [ - "Element" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "lens", - "id": "def-public.Visualization.renderToolbar.$2", + "id": "def-public.Visualization.ToolbarComponent.$1", "type": "Object", "tags": [], "label": "props", @@ -6349,9 +6511,9 @@ "; source: ", { "pluginId": "@kbn/dom-drag-drop", - "scope": "public", + "scope": "common", "docId": "kibKbnDomDragDropPluginApi", - "section": "def-public.DragDropIdentifier", + "section": "def-common.DragDropIdentifier", "text": "DragDropIdentifier" }, "; frame: ", @@ -6359,9 +6521,9 @@ "; dropType: ", { "pluginId": "@kbn/dom-drag-drop", - "scope": "public", + "scope": "common", "docId": "kibKbnDomDragDropPluginApi", - "section": "def-public.DropType", + "section": "def-common.DropType", "text": "DropType" }, "; group?: ", @@ -6488,9 +6650,9 @@ ") => { dropTypes: ", { "pluginId": "@kbn/dom-drag-drop", - "scope": "public", + "scope": "common", "docId": "kibKbnDomDragDropPluginApi", - "section": "def-public.DropType", + "section": "def-common.DropType", "text": "DropType" }, "[]; nextLabel?: string | undefined; } | undefined) | undefined" @@ -6557,15 +6719,17 @@ }, { "parentPluginId": "lens", - "id": "def-public.Visualization.renderLayerSettings", + "id": "def-public.Visualization.LayerSettingsComponent", "type": "Function", "tags": [], - "label": "renderLayerSettings", + "label": "LayerSettingsComponent", "description": [], "signature": [ - "((domElement: Element, props: ", + "((props: ", "VisualizationConfigProps", - " & { setState(newState: T | ((currState: T) => T)): void; panelRef: React.MutableRefObject; } & { section: \"data\" | \"appearance\"; }) => void | ((cleanupElement: Element) => void)) | undefined" + " & { setState(newState: T | ((currState: T) => T)): void; panelRef: React.MutableRefObject; } & { section: \"data\" | \"appearance\"; }) => React.ReactElement<", + "VisualizationLayerSettingsProps", + ", string | React.JSXElementConstructor> | null) | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -6573,22 +6737,7 @@ "children": [ { "parentPluginId": "lens", - "id": "def-public.Visualization.renderLayerSettings.$1", - "type": "Object", - "tags": [], - "label": "domElement", - "description": [], - "signature": [ - "Element" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "lens", - "id": "def-public.Visualization.renderLayerSettings.$2", + "id": "def-public.Visualization.LayerSettingsComponent.$1", "type": "CompoundType", "tags": [], "label": "props", @@ -6607,17 +6756,19 @@ }, { "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionEditor", + "id": "def-public.Visualization.DimensionEditorComponent", "type": "Function", "tags": [], - "label": "renderDimensionEditor", + "label": "DimensionEditorComponent", "description": [ "\nAdditional editor that gets rendered inside the dimension popover in the \"appearance\" section.\nThis can be used to configure dimension-specific options" ], "signature": [ - "((domElement: Element, props: ", + "((props: ", + "VisualizationDimensionEditorProps", + ") => React.ReactElement<", "VisualizationDimensionEditorProps", - ") => void | ((cleanupElement: Element) => void)) | undefined" + ", string | React.JSXElementConstructor> | null) | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -6625,22 +6776,7 @@ "children": [ { "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionEditor.$1", - "type": "Object", - "tags": [], - "label": "domElement", - "description": [], - "signature": [ - "Element" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionEditor.$2", + "id": "def-public.Visualization.DimensionEditorComponent.$1", "type": "CompoundType", "tags": [], "label": "props", @@ -6659,17 +6795,19 @@ }, { "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionEditorAdditionalSection", + "id": "def-public.Visualization.DimensionEditorAdditionalSectionComponent", "type": "Function", "tags": [], - "label": "renderDimensionEditorAdditionalSection", + "label": "DimensionEditorAdditionalSectionComponent", "description": [ "\nAdditional editor that gets rendered inside the dimension popover in an additional section below \"appearance\".\nThis can be used to configure dimension-specific options" ], "signature": [ - "((domElement: Element, props: ", + "((props: ", "VisualizationDimensionEditorProps", - ") => void | ((cleanupElement: Element) => void)) | undefined" + ") => React.ReactElement<", + "VisualizationDimensionEditorProps", + ", string | React.JSXElementConstructor> | null) | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -6677,22 +6815,7 @@ "children": [ { "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionEditorAdditionalSection.$1", - "type": "Object", - "tags": [], - "label": "domElement", - "description": [], - "signature": [ - "Element" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionEditorAdditionalSection.$2", + "id": "def-public.Visualization.DimensionEditorAdditionalSectionComponent.$1", "type": "CompoundType", "tags": [], "label": "props", @@ -6711,17 +6834,19 @@ }, { "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionEditorDataExtra", + "id": "def-public.Visualization.DimensionEditorDataExtraComponent", "type": "Function", "tags": [], - "label": "renderDimensionEditorDataExtra", + "label": "DimensionEditorDataExtraComponent", "description": [ "\nAdditional editor that gets rendered inside the data section.\nThis can be used to configure dimension-specific options" ], "signature": [ - "((domElement: Element, props: ", + "((props: ", + "VisualizationDimensionEditorProps", + ") => React.ReactElement<", "VisualizationDimensionEditorProps", - ") => void | ((cleanupElement: Element) => void)) | undefined" + ", string | React.JSXElementConstructor> | null) | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -6729,22 +6854,7 @@ "children": [ { "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionEditorDataExtra.$1", - "type": "Object", - "tags": [], - "label": "domElement", - "description": [], - "signature": [ - "Element" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionEditorDataExtra.$2", + "id": "def-public.Visualization.DimensionEditorDataExtraComponent.$1", "type": "CompoundType", "tags": [], "label": "props", @@ -6763,15 +6873,15 @@ }, { "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionTrigger", + "id": "def-public.Visualization.DimensionTriggerComponent", "type": "Function", "tags": [], - "label": "renderDimensionTrigger", + "label": "DimensionTriggerComponent", "description": [ "\nRenders dimension trigger. Used only for noDatasource layers" ], "signature": [ - "((props: { columnId: string; label: string; hideTooltip?: boolean | undefined; }) => JSX.Element | null) | undefined" + "((props: { columnId: string; label: string; hideTooltip?: boolean | undefined; }) => React.ReactElement<{ columnId: string; label: string; hideTooltip?: boolean | undefined; }, string | React.JSXElementConstructor> | null) | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -6779,7 +6889,7 @@ "children": [ { "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionTrigger.$1", + "id": "def-public.Visualization.DimensionTriggerComponent.$1", "type": "Object", "tags": [], "label": "props", @@ -6790,7 +6900,7 @@ "children": [ { "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionTrigger.$1.columnId", + "id": "def-public.Visualization.DimensionTriggerComponent.$1.columnId", "type": "string", "tags": [], "label": "columnId", @@ -6801,7 +6911,7 @@ }, { "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionTrigger.$1.label", + "id": "def-public.Visualization.DimensionTriggerComponent.$1.label", "type": "string", "tags": [], "label": "label", @@ -6812,7 +6922,7 @@ }, { "parentPluginId": "lens", - "id": "def-public.Visualization.renderDimensionTrigger.$1.hideTooltip", + "id": "def-public.Visualization.DimensionTriggerComponent.$1.hideTooltip", "type": "CompoundType", "tags": [], "label": "hideTooltip", @@ -6837,27 +6947,7 @@ "label": "getAddLayerButtonComponent", "description": [], "signature": [ - "((props: { supportedLayers: ", - "VisualizationLayerDescription", - "[]; addLayer: ", - "AddLayerFunction", - "; ensureIndexPattern: (specOrId: string | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ") => Promise; registerLibraryAnnotationGroup: (groupInfo: { id: string; group: ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationGroupConfig", - "text": "EventAnnotationGroupConfig" - }, - "; }) => void; }) => JSX.Element | null) | undefined" + "((props: AddLayerButtonProps) => React.ReactElement> | null) | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -6870,203 +6960,13 @@ "tags": [], "label": "props", "description": [], + "signature": [ + "AddLayerButtonProps" + ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "lens", - "id": "def-public.Visualization.getAddLayerButtonComponent.$1.supportedLayers", - "type": "Array", - "tags": [], - "label": "supportedLayers", - "description": [], - "signature": [ - "VisualizationLayerDescription", - "[]" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "lens", - "id": "def-public.Visualization.getAddLayerButtonComponent.$1.addLayer", - "type": "Function", - "tags": [], - "label": "addLayer", - "description": [], - "signature": [ - "(layerType: ", - "LayerType", - ", extraArg?: unknown, ignoreInitialValues?: boolean | undefined) => void" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "lens", - "id": "def-public.Visualization.getAddLayerButtonComponent.$1.addLayer.$1", - "type": "CompoundType", - "tags": [], - "label": "layerType", - "description": [], - "signature": [ - "\"data\" | \"annotations\" | \"metricTrendline\" | \"referenceLine\"" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "lens", - "id": "def-public.Visualization.getAddLayerButtonComponent.$1.addLayer.$2", - "type": "Uncategorized", - "tags": [], - "label": "extraArg", - "description": [], - "signature": [ - "T | undefined" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "lens", - "id": "def-public.Visualization.getAddLayerButtonComponent.$1.addLayer.$3", - "type": "CompoundType", - "tags": [], - "label": "ignoreInitialValues", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false - } - ] - }, - { - "parentPluginId": "lens", - "id": "def-public.Visualization.getAddLayerButtonComponent.$1.ensureIndexPattern", - "type": "Function", - "tags": [], - "label": "ensureIndexPattern", - "description": [], - "signature": [ - "(specOrId: string | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - ") => Promise" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "lens", - "id": "def-public.Visualization.getAddLayerButtonComponent.$1.ensureIndexPattern.$1", - "type": "CompoundType", - "tags": [], - "label": "specOrId", - "description": [], - "signature": [ - "string | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - } - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "lens", - "id": "def-public.Visualization.getAddLayerButtonComponent.$1.registerLibraryAnnotationGroup", - "type": "Function", - "tags": [], - "label": "registerLibraryAnnotationGroup", - "description": [], - "signature": [ - "(groupInfo: { id: string; group: ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationGroupConfig", - "text": "EventAnnotationGroupConfig" - }, - "; }) => void" - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "lens", - "id": "def-public.Visualization.getAddLayerButtonComponent.$1.registerLibraryAnnotationGroup.$1", - "type": "Object", - "tags": [], - "label": "groupInfo", - "description": [], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "lens", - "id": "def-public.Visualization.getAddLayerButtonComponent.$1.registerLibraryAnnotationGroup.$1.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "lens", - "id": "def-public.Visualization.getAddLayerButtonComponent.$1.registerLibraryAnnotationGroup.$1.group", - "type": "Object", - "tags": [], - "label": "group", - "description": [], - "signature": [ - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationGroupConfig", - "text": "EventAnnotationGroupConfig" - } - ], - "path": "x-pack/plugins/lens/public/types.ts", - "deprecated": false, - "trackAdoption": false - } - ] - } - ], - "returnComment": [] - } - ] + "isRequired": true } ], "returnComment": [] @@ -8593,7 +8493,7 @@ "CustomXDomain", " | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ", "LegendStrategy", - " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>>) | undefined" + " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> & Partial>) | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", "deprecated": false, diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index 2d6aeddb76182..345edf69dfb80 100644 --- a/api_docs/lens.mdx +++ b/api_docs/lens.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/lens title: "lens" image: https://source.unsplash.com/400x175/?github description: API docs for the lens plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] --- import lensObj from './lens.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 622 | 0 | 527 | 58 | +| 616 | 0 | 519 | 61 | ## Client diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index f804fffc159a2..1f99ec42829fc 100644 --- a/api_docs/license_api_guard.mdx +++ b/api_docs/license_api_guard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licenseApiGuard title: "licenseApiGuard" image: https://source.unsplash.com/400x175/?github description: API docs for the licenseApiGuard plugin -date: 2023-06-30 +date: 2023-07-18 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 658e0af2a18ce..da55979194656 100644 --- a/api_docs/license_management.mdx +++ b/api_docs/license_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licenseManagement title: "licenseManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the licenseManagement plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement'] --- import licenseManagementObj from './license_management.devdocs.json'; diff --git a/api_docs/licensing.devdocs.json b/api_docs/licensing.devdocs.json index 327f43e2c4f79..e78f38fff12e2 100644 --- a/api_docs/licensing.devdocs.json +++ b/api_docs/licensing.devdocs.json @@ -343,7 +343,7 @@ "\nThe state of checking the results of a license type meeting the license minimum." ], "signature": [ - "\"invalid\" | \"unavailable\" | \"valid\" | \"expired\"" + "\"valid\" | \"invalid\" | \"unavailable\" | \"expired\"" ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": false, @@ -542,6 +542,26 @@ "plugin": "apm", "path": "x-pack/plugins/apm/common/license_check.test.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/common/services/agent_policy_config.test.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/common/services/agent_policy_config.test.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/agent_policy_watch.test.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/agent_policy_watch.test.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/agent_policy_watch.test.ts" + }, { "plugin": "security", "path": "x-pack/plugins/security/common/licensing/license_service.test.ts" @@ -695,7 +715,7 @@ "label": "LicenseCheckState", "description": [], "signature": [ - "\"invalid\" | \"unavailable\" | \"valid\" | \"expired\"" + "\"valid\" | \"invalid\" | \"unavailable\" | \"expired\"" ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": false, @@ -798,6 +818,10 @@ "plugin": "ml", "path": "x-pack/plugins/ml/public/plugin.ts" }, + { + "plugin": "profiling", + "path": "x-pack/plugins/profiling/public/components/contexts/license/license_context.tsx" + }, { "plugin": "apm", "path": "x-pack/plugins/apm/public/context/license/license_context.tsx" @@ -833,10 +857,6 @@ { "plugin": "watcher", "path": "x-pack/plugins/watcher/public/plugin.ts" - }, - { - "plugin": "profiling", - "path": "x-pack/plugins/profiling/public/components/contexts/license/license_context.tsx" } ] }, @@ -1578,7 +1598,7 @@ "\nThe state of checking the results of a license type meeting the license minimum." ], "signature": [ - "\"invalid\" | \"unavailable\" | \"valid\" | \"expired\"" + "\"valid\" | \"invalid\" | \"unavailable\" | \"expired\"" ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": false, @@ -1827,6 +1847,26 @@ "plugin": "apm", "path": "x-pack/plugins/apm/common/license_check.test.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/common/services/agent_policy_config.test.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/common/services/agent_policy_config.test.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/agent_policy_watch.test.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/agent_policy_watch.test.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/agent_policy_watch.test.ts" + }, { "plugin": "security", "path": "x-pack/plugins/security/common/licensing/license_service.test.ts" @@ -2027,7 +2067,7 @@ "label": "LicenseCheckState", "description": [], "signature": [ - "\"invalid\" | \"unavailable\" | \"valid\" | \"expired\"" + "\"valid\" | \"invalid\" | \"unavailable\" | \"expired\"" ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": false, @@ -2150,14 +2190,6 @@ "plugin": "remoteClusters", "path": "x-pack/plugins/remote_clusters/server/plugin.ts" }, - { - "plugin": "osquery", - "path": "x-pack/plugins/osquery/server/handlers/action/create_action_service.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts" - }, { "plugin": "graph", "path": "x-pack/plugins/graph/server/plugin.ts" @@ -2170,6 +2202,10 @@ "plugin": "mapsEms", "path": "src/plugins/maps_ems/server/index.ts" }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/server/handlers/action/create_action_service.ts" + }, { "plugin": "painlessLab", "path": "x-pack/plugins/painless_lab/server/services/license.ts" @@ -2182,6 +2218,10 @@ "plugin": "searchprofiler", "path": "x-pack/plugins/searchprofiler/server/plugin.ts" }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts" + }, { "plugin": "snapshotRestore", "path": "x-pack/plugins/snapshot_restore/server/services/license.ts" diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index afdf76d7d70ab..a42fc429ffcb2 100644 --- a/api_docs/licensing.mdx +++ b/api_docs/licensing.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licensing title: "licensing" image: https://source.unsplash.com/400x175/?github description: API docs for the licensing plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] --- import licensingObj from './licensing.devdocs.json'; diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index c6a99e06ba8e1..1f421c1bc023b 100644 --- a/api_docs/lists.mdx +++ b/api_docs/lists.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/lists title: "lists" image: https://source.unsplash.com/400x175/?github description: API docs for the lists plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] --- import listsObj from './lists.devdocs.json'; diff --git a/api_docs/logs_shared.devdocs.json b/api_docs/logs_shared.devdocs.json new file mode 100644 index 0000000000000..6d5d01ce5a739 --- /dev/null +++ b/api_docs/logs_shared.devdocs.json @@ -0,0 +1,7632 @@ +{ + "id": "logsShared", + "client": { + "classes": [], + "functions": [ + { + "parentPluginId": "logsShared", + "id": "def-public.getLogViewReferenceFromUrl", + "type": "Function", + "tags": [], + "label": "getLogViewReferenceFromUrl", + "description": [], + "signature": [ + "({ logViewKey, sourceIdKey, toastsService, urlStateStorage, }: LogViewUrlStateDependencies) => { 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; }; })[]; }; } | null" + ], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/url_state_storage_service.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.getLogViewReferenceFromUrl.$1", + "type": "Object", + "tags": [], + "label": "{\n logViewKey,\n sourceIdKey,\n toastsService,\n urlStateStorage,\n}", + "description": [], + "signature": [ + "LogViewUrlStateDependencies" + ], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/url_state_storage_service.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.initializeFromUrl", + "type": "Function", + "tags": [], + "label": "initializeFromUrl", + "description": [], + "signature": [ + "({ logViewKey, sourceIdKey, toastsService, urlStateStorage, }: LogViewUrlStateDependencies) => ", + "InvokeCreator", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", any, any, ", + "LogViewEvent", + ">" + ], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/url_state_storage_service.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.initializeFromUrl.$1", + "type": "Object", + "tags": [], + "label": "{\n logViewKey = defaultLogViewKey,\n sourceIdKey = defaultLegacySourceIdKey,\n toastsService,\n urlStateStorage,\n }", + "description": [], + "signature": [ + "LogViewUrlStateDependencies" + ], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/url_state_storage_service.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.listenForUrlChanges", + "type": "Function", + "tags": [], + "label": "listenForUrlChanges", + "description": [], + "signature": [ + "({ urlStateStorage, logViewKey, }: { urlStateStorage: ", + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.IKbnUrlStateStorage", + "text": "IKbnUrlStateStorage" + }, + "; logViewKey?: string | undefined; }) => ", + "InvokeCreator", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", any, any, ", + "LogViewEvent", + ">" + ], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/url_state_storage_service.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.listenForUrlChanges.$1", + "type": "Object", + "tags": [], + "label": "{\n urlStateStorage,\n logViewKey = defaultLogViewKey,\n }", + "description": [], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/url_state_storage_service.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.listenForUrlChanges.$1.urlStateStorage", + "type": "Object", + "tags": [], + "label": "urlStateStorage", + "description": [], + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.IKbnUrlStateStorage", + "text": "IKbnUrlStateStorage" + } + ], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/url_state_storage_service.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.listenForUrlChanges.$1.logViewKey", + "type": "string", + "tags": [], + "label": "logViewKey", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/url_state_storage_service.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogColumnHeader", + "type": "Function", + "tags": [], + "label": "LogColumnHeader", + "description": [], + "signature": [ + "(props: any) => JSX.Element" + ], + "path": "x-pack/plugins/logs_shared/public/index.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogColumnHeader.$1", + "type": "Any", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/common/dynamic.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogColumnHeadersWrapper", + "type": "Function", + "tags": [], + "label": "LogColumnHeadersWrapper", + "description": [], + "signature": [ + "(props: any) => JSX.Element" + ], + "path": "x-pack/plugins/logs_shared/public/index.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogColumnHeadersWrapper.$1", + "type": "Any", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/common/dynamic.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryColumn", + "type": "Function", + "tags": [], + "label": "LogEntryColumn", + "description": [], + "signature": [ + "(props: any) => JSX.Element" + ], + "path": "x-pack/plugins/logs_shared/public/index.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryColumn.$1", + "type": "Any", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/common/dynamic.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryContextMenu", + "type": "Function", + "tags": [], + "label": "LogEntryContextMenu", + "description": [], + "signature": [ + "(props: any) => JSX.Element" + ], + "path": "x-pack/plugins/logs_shared/public/index.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryContextMenu.$1", + "type": "Any", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/common/dynamic.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryFieldColumn", + "type": "Function", + "tags": [], + "label": "LogEntryFieldColumn", + "description": [], + "signature": [ + "(props: any) => JSX.Element" + ], + "path": "x-pack/plugins/logs_shared/public/index.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryFieldColumn.$1", + "type": "Any", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/common/dynamic.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryFlyout", + "type": "Function", + "tags": [], + "label": "LogEntryFlyout", + "description": [], + "signature": [ + "({ logEntryId, onCloseFlyout, onSetFieldFilter, logViewReference, }: ", + "LogEntryFlyoutProps", + ") => JSX.Element" + ], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_entry_flyout/log_entry_flyout.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryFlyout.$1", + "type": "Object", + "tags": [], + "label": "{\n logEntryId,\n onCloseFlyout,\n onSetFieldFilter,\n logViewReference,\n}", + "description": [], + "signature": [ + "LogEntryFlyoutProps" + ], + "path": "x-pack/plugins/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.LogEntryMessageColumn", + "type": "Function", + "tags": [], + "label": "LogEntryMessageColumn", + "description": [], + "signature": [ + "(props: any) => JSX.Element" + ], + "path": "x-pack/plugins/logs_shared/public/index.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryMessageColumn.$1", + "type": "Any", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/common/dynamic.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryRowWrapper", + "type": "Function", + "tags": [], + "label": "LogEntryRowWrapper", + "description": [], + "signature": [ + "(props: any) => JSX.Element" + ], + "path": "x-pack/plugins/logs_shared/public/index.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryRowWrapper.$1", + "type": "Any", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/common/dynamic.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryTimestampColumn", + "type": "Function", + "tags": [], + "label": "LogEntryTimestampColumn", + "description": [], + "signature": [ + "(props: any) => JSX.Element" + ], + "path": "x-pack/plugins/logs_shared/public/index.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryTimestampColumn.$1", + "type": "Any", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/common/dynamic.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogHighlightsStateProvider", + "type": "Function", + "tags": [], + "label": "LogHighlightsStateProvider", + "description": [], + "signature": [ + "React.FunctionComponent>" + ], + "path": "x-pack/plugins/logs_shared/public/containers/logs/log_highlights/log_highlights.tsx", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogHighlightsStateProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogHighlightsStateProvider.$2", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogPositionStateProvider", + "type": "Function", + "tags": [], + "label": "LogPositionStateProvider", + "description": [], + "signature": [ + "React.FunctionComponent & { value: { hasLogViewIndices: \"initialized\"; }; }; logStreamPageCallbacks: ", + "LogStreamPageCallbacks", + "; }>>" + ], + "path": "x-pack/plugins/logs_shared/public/containers/logs/log_position/use_log_position.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogPositionStateProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogPositionStateProvider.$2", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogStream", + "type": "Function", + "tags": [], + "label": "LogStream", + "description": [], + "signature": [ + "(props: any) => JSX.Element" + ], + "path": "x-pack/plugins/logs_shared/public/index.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogStream.$1", + "type": "Any", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/common/dynamic.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogStreamProvider", + "type": "Function", + "tags": [], + "label": "LogStreamProvider", + "description": [], + "signature": [ + "React.FunctionComponent>" + ], + "path": "x-pack/plugins/logs_shared/public/containers/logs/log_stream/index.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogStreamProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogStreamProvider.$2", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogViewProvider", + "type": "Function", + "tags": [], + "label": "LogViewProvider", + "description": [], + "signature": [ + "React.FunctionComponent | undefined; updateContextInUrl?: ((context: ", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), _event: ", + "LogViewEvent", + ") => void) | undefined; listenForUrlChanges?: ", + "InvokeCreator", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", any, any, ", + "LogViewEvent", + "> | undefined; }>>" + ], + "path": "x-pack/plugins/logs_shared/public/hooks/use_log_view.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogViewProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogViewProvider.$2", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.ScrollableLogTextStreamView", + "type": "Function", + "tags": [], + "label": "ScrollableLogTextStreamView", + "description": [], + "signature": [ + "(props: any) => JSX.Element" + ], + "path": "x-pack/plugins/logs_shared/public/index.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.ScrollableLogTextStreamView.$1", + "type": "Any", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/common/dynamic.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.updateContextInUrl", + "type": "Function", + "tags": [], + "label": "updateContextInUrl", + "description": [], + "signature": [ + "({ urlStateStorage, logViewKey }: LogViewUrlStateDependencies) => (context: ", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), _event: ", + "LogViewEvent", + ") => void" + ], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/url_state_storage_service.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.updateContextInUrl.$1", + "type": "Object", + "tags": [], + "label": "{ urlStateStorage, logViewKey = defaultLogViewKey }", + "description": [], + "signature": [ + "LogViewUrlStateDependencies" + ], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/url_state_storage_service.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.useColumnWidths", + "type": "Function", + "tags": [], + "label": "useColumnWidths", + "description": [ + "\nThis hook calculates the column widths based on the given configuration. It\ndepends on the `CharacterDimensionsProbe` it returns being rendered so it can\nmeasure the monospace character size." + ], + "signature": [ + "({ columnConfigurations, scale, timeFormat, }: { columnConfigurations: ", + "LogColumnRenderConfiguration", + "[]; scale: ", + "TextScale", + "; timeFormat?: ", + "TimeFormat", + " | undefined; }) => { columnWidths: ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogEntryColumnWidths", + "text": "LogEntryColumnWidths" + }, + "; CharacterDimensionsProbe: () => JSX.Element; }" + ], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_text_stream/log_entry_column.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.useColumnWidths.$1", + "type": "Object", + "tags": [], + "label": "{\n columnConfigurations,\n scale,\n timeFormat = 'time',\n}", + "description": [], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_text_stream/log_entry_column.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.useColumnWidths.$1.columnConfigurations", + "type": "Array", + "tags": [], + "label": "columnConfigurations", + "description": [], + "signature": [ + "LogColumnRenderConfiguration", + "[]" + ], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_text_stream/log_entry_column.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.useColumnWidths.$1.scale", + "type": "CompoundType", + "tags": [], + "label": "scale", + "description": [], + "signature": [ + "\"small\" | \"medium\" | \"large\"" + ], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_text_stream/log_entry_column.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.useColumnWidths.$1.timeFormat", + "type": "CompoundType", + "tags": [], + "label": "timeFormat", + "description": [], + "signature": [ + "TimeFormat", + " | undefined" + ], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_text_stream/log_entry_column.tsx", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "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/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/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", + "type": "Function", + "tags": [], + "label": "useLogHighlightsStateContext", + "description": [], + "signature": [ + "() => { highlightTerms: string[]; setHighlightTerms: React.Dispatch>; logEntryHighlights: ({ topCursor: null; bottomCursor: null; entries: { id: string; index: string; cursor: { time: number; tiebreaker: number; }; columns: ({ columnId: string; timestamp: number; } | { columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; } | { columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; })[]; context: {} | { 'container.id': string; } | { 'host.name': string; 'log.file.path': string; }; }[]; } | { topCursor: { time: number; tiebreaker: number; }; bottomCursor: { time: number; tiebreaker: number; }; entries: { id: string; index: string; cursor: { time: number; tiebreaker: number; }; columns: ({ columnId: string; timestamp: number; } | { columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; } | { columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; })[]; context: {} | { 'container.id': string; } | { 'host.name': string; 'log.file.path': string; }; }[]; })[]; logEntryHighlightsById: Record; logSummaryHighlights: { start: number; end: number; buckets: ({ start: number; end: number; entriesCount: number; } & { representativeKey: { time: number; tiebreaker: number; }; })[]; }[]; loadLogEntryHighlightsRequest: ", + "PromiseState", + "<{ data: ({ topCursor: null; bottomCursor: null; entries: { id: string; index: string; cursor: { time: number; tiebreaker: number; }; columns: ({ columnId: string; timestamp: number; } | { columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; } | { columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; })[]; context: {} | { 'container.id': string; } | { 'host.name': string; 'log.file.path': string; }; }[]; } | { topCursor: { time: number; tiebreaker: number; }; bottomCursor: { time: number; tiebreaker: number; }; entries: { id: string; index: string; cursor: { time: number; tiebreaker: number; }; columns: ({ columnId: string; timestamp: number; } | { columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; } | { columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; })[]; context: {} | { 'container.id': string; } | { 'host.name': string; 'log.file.path': string; }; }[]; })[]; }, unknown>; loadLogSummaryHighlightsRequest: ", + "PromiseState", + "<{ data: { start: number; end: number; buckets: ({ start: number; end: number; entriesCount: number; } & { representativeKey: { time: number; tiebreaker: number; }; })[]; }[]; }, unknown>; currentHighlightKey: ", + "UniqueTimeKey", + " | null; hasPreviousHighlight: boolean; hasNextHighlight: boolean; goToPreviousHighlight: () => void; goToNextHighlight: () => void; }" + ], + "path": "x-pack/plugins/logs_shared/public/containers/logs/log_highlights/log_highlights.tsx", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.useLogPositionStateContext", + "type": "Function", + "tags": [], + "label": "useLogPositionStateContext", + "description": [], + "signature": [ + "() => DateRange & { targetPosition: TimeKeyOrNull; isStreaming: boolean; firstVisiblePosition: TimeKeyOrNull; pagesBeforeStart: number; pagesAfterEnd: number; visibleMidpoint: TimeKeyOrNull; visibleMidpointTime: number | null; visibleTimeInterval: { start: number; end: number; } | null; } & ", + "LogPositionCallbacks" + ], + "path": "x-pack/plugins/logs_shared/public/containers/logs/log_position/use_log_position.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.useLogStreamContext", + "type": "Function", + "tags": [], + "label": "useLogStreamContext", + "description": [], + "signature": [ + "() => { fetchEntries: () => void; fetchNextEntries: FetchPageCallback; fetchPreviousEntries: FetchPageCallback; fetchNewestEntries: () => void; isLoadingMore: boolean; isReloading: boolean; entries: { id: string; index: string; cursor: { time: number; tiebreaker: number; }; columns: ({ columnId: string; timestamp: number; } | { columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; } | { columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; })[]; context: {} | { 'container.id': string; } | { 'host.name': string; 'log.file.path': string; }; }[]; topCursor: { time: number; tiebreaker: number; } | null; bottomCursor: { time: number; tiebreaker: number; } | null; hasMoreBefore: boolean; hasMoreAfter: boolean; lastLoadedTime?: Date | undefined; }" + ], + "path": "x-pack/plugins/logs_shared/public/containers/logs/log_stream/index.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "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/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/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/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/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/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", + "type": "Function", + "tags": [], + "label": "useLogView", + "description": [], + "signature": [ + "({ initialLogViewReference, logViews, useDevTools, initializeFromUrl, updateContextInUrl, listenForUrlChanges, }: { initialLogViewReference?: { 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; }; })[]; }; } | undefined; logViews: ", + "ILogViewsClient", + "; useDevTools?: boolean | undefined; initializeFromUrl?: ", + "InvokeCreator", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", any, any, ", + "LogViewEvent", + "> | undefined; updateContextInUrl?: ((context: ", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), _event: ", + "LogViewEvent", + ") => void) | undefined; listenForUrlChanges?: ", + "InvokeCreator", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", any, any, ", + "LogViewEvent", + "> | undefined; }) => { logViewStateService: ", + "Interpreter", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), any, ", + "LogViewEvent", + ", ", + "LogViewTypestate", + ", ", + "ResolveTypegenMeta", + "<", + "TypegenDisabled", + ", ", + "LogViewEvent", + ", ", + "BaseActionObject", + ", ", + "ServiceMap", + ">>; logViewStateNotifications: ", + "NotificationChannel", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewNotificationEvent", + "text": "LogViewNotificationEvent" + }, + ">; hasFailedLoading: boolean; hasFailedLoadingLogView: boolean; hasFailedLoadingLogViewStatus: boolean; hasFailedResolvingLogView: boolean; latestLoadLogViewFailures: Error[]; isUninitialized: boolean; isLoading: boolean; isLoadingLogView: boolean; isLoadingLogViewStatus: boolean; isResolvingLogView: boolean; 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; }; })[]; }; }; logView: ({ id: string; origin: \"inline\" | \"internal\" | \"stored\" | \"infra-source-stored\" | \"infra-source-internal\" | \"infra-source-fallback\"; 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; }; })[]; }; } & { updatedAt?: number | undefined; version?: string | undefined; }) | undefined; resolvedLogView: ", + { + "pluginId": "logsShared", + "scope": "common", + "docId": "kibLogsSharedPluginApi", + "section": "def-common.ResolvedLogView", + "text": "ResolvedLogView" + }, + " | undefined; logViewStatus: { index: \"missing\" | \"unknown\" | \"empty\" | \"available\"; } | undefined; derivedDataView: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined; isInlineLogView: boolean; isPersistedLogView: boolean; load: () => ", + "State", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", any, ", + "LogViewTypestate", + ", ", + "ResolveTypegenMeta", + "<", + "TypegenDisabled", + ", ", + "LogViewEvent", + ", ", + "BaseActionObject", + ", ", + "ServiceMap", + ">>; retry: () => ", + "State", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", any, ", + "LogViewTypestate", + ", ", + "ResolveTypegenMeta", + "<", + "TypegenDisabled", + ", ", + "LogViewEvent", + ", ", + "BaseActionObject", + ", ", + "ServiceMap", + ">>; update: (logViewAttributes: Partial<{ 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; }; })[]; }>) => Promise; changeLogViewReference: (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; }; })[]; }; }) => void; revertToDefaultLogView: () => void; }" + ], + "path": "x-pack/plugins/logs_shared/public/hooks/use_log_view.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.useLogView.$1", + "type": "Object", + "tags": [], + "label": "{\n initialLogViewReference,\n logViews,\n useDevTools = isDevMode(),\n initializeFromUrl,\n updateContextInUrl,\n listenForUrlChanges,\n}", + "description": [], + "path": "x-pack/plugins/logs_shared/public/hooks/use_log_view.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.useLogView.$1.initialLogViewReference", + "type": "CompoundType", + "tags": [], + "label": "initialLogViewReference", + "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; }; })[]; }; } | undefined" + ], + "path": "x-pack/plugins/logs_shared/public/hooks/use_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.useLogView.$1.logViews", + "type": "Object", + "tags": [], + "label": "logViews", + "description": [], + "signature": [ + "ILogViewsClient" + ], + "path": "x-pack/plugins/logs_shared/public/hooks/use_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.useLogView.$1.useDevTools", + "type": "CompoundType", + "tags": [], + "label": "useDevTools", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/logs_shared/public/hooks/use_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.useLogView.$1.initializeFromUrl", + "type": "Function", + "tags": [], + "label": "initializeFromUrl", + "description": [], + "signature": [ + "InvokeCreator", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", any, any, ", + "LogViewEvent", + "> | undefined" + ], + "path": "x-pack/plugins/logs_shared/public/hooks/use_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.useLogView.$1.updateContextInUrl", + "type": "Function", + "tags": [], + "label": "updateContextInUrl", + "description": [], + "signature": [ + "((context: ", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), _event: ", + "LogViewEvent", + ") => void) | undefined" + ], + "path": "x-pack/plugins/logs_shared/public/hooks/use_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.useLogView.$1.listenForUrlChanges", + "type": "Function", + "tags": [], + "label": "listenForUrlChanges", + "description": [], + "signature": [ + "InvokeCreator", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", any, any, ", + "LogViewEvent", + "> | undefined" + ], + "path": "x-pack/plugins/logs_shared/public/hooks/use_log_view.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.useLogViewContext", + "type": "Function", + "tags": [], + "label": "useLogViewContext", + "description": [], + "signature": [ + "() => { logViewStateService: ", + "Interpreter", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), any, ", + "LogViewEvent", + ", ", + "LogViewTypestate", + ", ", + "ResolveTypegenMeta", + "<", + "TypegenDisabled", + ", ", + "LogViewEvent", + ", ", + "BaseActionObject", + ", ", + "ServiceMap", + ">>; logViewStateNotifications: ", + "NotificationChannel", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewNotificationEvent", + "text": "LogViewNotificationEvent" + }, + ">; hasFailedLoading: boolean; hasFailedLoadingLogView: boolean; hasFailedLoadingLogViewStatus: boolean; hasFailedResolvingLogView: boolean; latestLoadLogViewFailures: Error[]; isUninitialized: boolean; isLoading: boolean; isLoadingLogView: boolean; isLoadingLogViewStatus: boolean; isResolvingLogView: boolean; 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; }; })[]; }; }; logView: ({ id: string; origin: \"inline\" | \"internal\" | \"stored\" | \"infra-source-stored\" | \"infra-source-internal\" | \"infra-source-fallback\"; 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; }; })[]; }; } & { updatedAt?: number | undefined; version?: string | undefined; }) | undefined; resolvedLogView: ", + { + "pluginId": "logsShared", + "scope": "common", + "docId": "kibLogsSharedPluginApi", + "section": "def-common.ResolvedLogView", + "text": "ResolvedLogView" + }, + " | undefined; logViewStatus: { index: \"missing\" | \"unknown\" | \"empty\" | \"available\"; } | undefined; derivedDataView: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined; isInlineLogView: boolean; isPersistedLogView: boolean; load: () => ", + "State", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", any, ", + "LogViewTypestate", + ", ", + "ResolveTypegenMeta", + "<", + "TypegenDisabled", + ", ", + "LogViewEvent", + ", ", + "BaseActionObject", + ", ", + "ServiceMap", + ">>; retry: () => ", + "State", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", any, ", + "LogViewTypestate", + ", ", + "ResolveTypegenMeta", + "<", + "TypegenDisabled", + ", ", + "LogViewEvent", + ", ", + "BaseActionObject", + ", ", + "ServiceMap", + ">>; update: (logViewAttributes: Partial<{ 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; }; })[]; }>) => Promise; changeLogViewReference: (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; }; })[]; }; }) => void; revertToDefaultLogView: () => void; }" + ], + "path": "x-pack/plugins/logs_shared/public/hooks/use_log_view.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.WithSummary", + "type": "Function", + "tags": [], + "label": "WithSummary", + "description": [], + "signature": [ + "({ serializedParsedQuery, children }: ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.WithSummaryProps", + "text": "WithSummaryProps" + }, + ") => ", + "RendererResult" + ], + "path": "x-pack/plugins/logs_shared/public/containers/logs/log_summary/with_summary.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.WithSummary.$1", + "type": "Object", + "tags": [], + "label": "{ serializedParsedQuery, children }", + "description": [], + "signature": [ + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.WithSummaryProps", + "text": "WithSummaryProps" + } + ], + "path": "x-pack/plugins/logs_shared/public/containers/logs/log_summary/with_summary.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryColumnWidths", + "type": "Interface", + "tags": [], + "label": "LogEntryColumnWidths", + "description": [], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_text_stream/log_entry_column.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryColumnWidths.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[columnId: string]: LogEntryColumnWidth", + "description": [], + "signature": [ + "[columnId: string]: ", + "LogEntryColumnWidth" + ], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_text_stream/log_entry_column.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryColumnWidths.iconColumnId", + "type": "Object", + "tags": [], + "label": "[iconColumnId]", + "description": [], + "signature": [ + "{ baseWidth: string; growWeight: number; shrinkWeight: number; }" + ], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_text_stream/log_entry_column.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryStreamItem", + "type": "Interface", + "tags": [], + "label": "LogEntryStreamItem", + "description": [], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_text_stream/item.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryStreamItem.kind", + "type": "string", + "tags": [], + "label": "kind", + "description": [], + "signature": [ + "\"logEntry\"" + ], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_text_stream/item.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryStreamItem.logEntry", + "type": "Object", + "tags": [], + "label": "logEntry", + "description": [], + "signature": [ + "{ id: string; index: string; cursor: { time: number; tiebreaker: number; }; columns: ({ columnId: string; timestamp: number; } | { columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; } | { columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; })[]; context: {} | { 'container.id': string; } | { 'host.name': string; 'log.file.path': string; }; }" + ], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_text_stream/item.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogEntryStreamItem.highlights", + "type": "Array", + "tags": [], + "label": "highlights", + "description": [], + "signature": [ + "{ id: string; index: string; cursor: { time: number; tiebreaker: number; }; columns: ({ columnId: string; timestamp: number; } | { columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; } | { columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; })[]; context: {} | { 'container.id': string; } | { 'host.name': string; 'log.file.path': string; }; }[]" + ], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_text_stream/item.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogsSharedClientSetupDeps", + "type": "Interface", + "tags": [], + "label": "LogsSharedClientSetupDeps", + "description": [], + "path": "x-pack/plugins/logs_shared/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogsSharedClientStartDeps", + "type": "Interface", + "tags": [], + "label": "LogsSharedClientStartDeps", + "description": [], + "path": "x-pack/plugins/logs_shared/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogsSharedClientStartDeps.data", + "type": "Object", + "tags": [], + "label": "data", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStart", + "text": "DataPublicPluginStart" + } + ], + "path": "x-pack/plugins/logs_shared/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogsSharedClientStartDeps.dataViews", + "type": "Object", + "tags": [], + "label": "dataViews", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "public", + "docId": "kibDataViewsPluginApi", + "section": "def-public.DataViewsServicePublic", + "text": "DataViewsServicePublic" + } + ], + "path": "x-pack/plugins/logs_shared/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogsSharedClientStartDeps.uiActions", + "type": "Object", + "tags": [], + "label": "uiActions", + "description": [], + "signature": [ + "{ readonly addTriggerAction: (triggerId: string, action: ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.ActionDefinition", + "text": "ActionDefinition" + }, + ") => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: (definition: ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.ActionDefinition", + "text": "ActionDefinition" + }, + ") => ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "; readonly registerTrigger: (trigger: ", + { + "pluginId": "@kbn/ui-actions-browser", + "scope": "common", + "docId": "kibKbnUiActionsBrowserPluginApi", + "section": "def-common.Trigger", + "text": "Trigger" + }, + ") => void; readonly unregisterAction: (actionId: string) => void; readonly getTrigger: (triggerId: string) => ", + "TriggerContract", + "; readonly hasAction: (actionId: string) => boolean; readonly getAction: (id: string) => ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "; readonly getTriggerActions: (triggerId: string) => ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "[]; readonly getTriggerCompatibleActions: (triggerId: string, context: object) => Promise<", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise; readonly clear: () => void; readonly fork: () => ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.UiActionsService", + "text": "UiActionsService" + }, + "; }" + ], + "path": "x-pack/plugins/logs_shared/public/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogStreamProps", + "type": "Interface", + "tags": [], + "label": "LogStreamProps", + "description": [], + "signature": [ + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogStreamProps", + "text": "LogStreamProps" + }, + " extends LogStreamContentProps" + ], + "path": "x-pack/plugins/logs_shared/public/components/log_stream/log_stream.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogStreamProps.height", + "type": "CompoundType", + "tags": [], + "label": "height", + "description": [], + "signature": [ + "string | number | undefined" + ], + "path": "x-pack/plugins/logs_shared/public/components/log_stream/log_stream.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogViewContextWithError", + "type": "Interface", + "tags": [], + "label": "LogViewContextWithError", + "description": [], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogViewContextWithError.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogViewContextWithResolvedLogView", + "type": "Interface", + "tags": [], + "label": "LogViewContextWithResolvedLogView", + "description": [], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogViewContextWithResolvedLogView.resolvedLogView", + "type": "Object", + "tags": [], + "label": "resolvedLogView", + "description": [], + "signature": [ + { + "pluginId": "logsShared", + "scope": "common", + "docId": "kibLogsSharedPluginApi", + "section": "def-common.ResolvedLogView", + "text": "ResolvedLogView" + } + ], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.WithSummaryProps", + "type": "Interface", + "tags": [], + "label": "WithSummaryProps", + "description": [], + "path": "x-pack/plugins/logs_shared/public/containers/logs/log_summary/with_summary.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.WithSummaryProps.serializedParsedQuery", + "type": "CompoundType", + "tags": [], + "label": "serializedParsedQuery", + "description": [], + "signature": [ + "string | null" + ], + "path": "x-pack/plugins/logs_shared/public/containers/logs/log_summary/with_summary.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.WithSummaryProps.children", + "type": "Function", + "tags": [], + "label": "children", + "description": [], + "signature": [ + "(args: { buckets: { start: number; end: number; entriesCount: number; }[]; start: number | null; end: number | null; }) => ", + "RendererResult" + ], + "path": "x-pack/plugins/logs_shared/public/containers/logs/log_summary/with_summary.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.WithSummaryProps.children.$1", + "type": "Uncategorized", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "RenderArgs" + ], + "path": "x-pack/plugins/logs_shared/public/utils/typed_react.tsx", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "logsShared", + "id": "def-public.iconColumnId", + "type": "Uncategorized", + "tags": [], + "label": "iconColumnId", + "description": [], + "signature": [ + "typeof ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.iconColumnId", + "text": "iconColumnId" + } + ], + "path": "x-pack/plugins/logs_shared/public/components/logging/log_text_stream/log_entry_column.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogSummaryBuckets", + "type": "Type", + "tags": [], + "label": "LogSummaryBuckets", + "description": [], + "signature": [ + "{ start: number; end: number; entriesCount: number; }[]" + ], + "path": "x-pack/plugins/logs_shared/public/containers/logs/log_summary/log_summary.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogViewNotificationChannel", + "type": "Type", + "tags": [], + "label": "LogViewNotificationChannel", + "description": [], + "signature": [ + "NotificationChannel", + "<", + "LogViewContextWithReference", + " | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithResolvedLogView", + "text": "LogViewContextWithResolvedLogView" + }, + " & ", + "LogViewContextWithStatus", + ") | (", + "LogViewContextWithReference", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + ") | (", + "LogViewContextWithReference", + " & ", + "LogViewContextWithLogView", + " & ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewContextWithError", + "text": "LogViewContextWithError" + }, + "), ", + "LogViewEvent", + ", ", + { + "pluginId": "logsShared", + "scope": "public", + "docId": "kibLogsSharedPluginApi", + "section": "def-public.LogViewNotificationEvent", + "text": "LogViewNotificationEvent" + }, + ">" + ], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-public.LogViewNotificationEvent", + "type": "Type", + "tags": [], + "label": "LogViewNotificationEvent", + "description": [], + "signature": [ + "{ type: \"LOADING_LOG_VIEW_STARTED\"; 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; }; })[]; }; }; } | { type: \"LOADING_LOG_VIEW_SUCCEEDED\"; resolvedLogView: ", + { + "pluginId": "logsShared", + "scope": "common", + "docId": "kibLogsSharedPluginApi", + "section": "def-common.ResolvedLogView", + "text": "ResolvedLogView" + }, + "; status: { index: \"missing\" | \"unknown\" | \"empty\" | \"available\"; }; } | { type: \"LOADING_LOG_VIEW_FAILED\"; error: Error; }" + ], + "path": "x-pack/plugins/logs_shared/public/observability_logs/log_view_state/src/notifications.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "parentPluginId": "logsShared", + "id": "def-public.LogsSharedClientSetupExports", + "type": "Interface", + "tags": [], + "label": "LogsSharedClientSetupExports", + "description": [], + "path": "x-pack/plugins/logs_shared/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogsSharedClientSetupExports.logViews", + "type": "Object", + "tags": [], + "label": "logViews", + "description": [], + "signature": [ + "LogViewsServiceSetup" + ], + "path": "x-pack/plugins/logs_shared/public/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "logsShared", + "id": "def-public.LogsSharedClientStartExports", + "type": "Interface", + "tags": [], + "label": "LogsSharedClientStartExports", + "description": [], + "path": "x-pack/plugins/logs_shared/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-public.LogsSharedClientStartExports.logViews", + "type": "Object", + "tags": [], + "label": "logViews", + "description": [], + "signature": [ + "LogViewsServiceStart" + ], + "path": "x-pack/plugins/logs_shared/public/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [ + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain", + "type": "Class", + "tags": [], + "label": "LogsSharedLogEntriesDomain", + "description": [], + "signature": [ + { + "pluginId": "logsShared", + "scope": "server", + "docId": "kibLogsSharedPluginApi", + "section": "def-server.LogsSharedLogEntriesDomain", + "text": "LogsSharedLogEntriesDomain" + }, + " implements ", + { + "pluginId": "logsShared", + "scope": "server", + "docId": "kibLogsSharedPluginApi", + "section": "def-server.ILogsSharedLogEntriesDomain", + "text": "ILogsSharedLogEntriesDomain" + } + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "adapter", + "description": [], + "signature": [ + "LogEntriesAdapter" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "libs", + "description": [], + "signature": [ + "Pick<", + "LogsSharedBackendLibs", + ", \"framework\" | \"getStartServices\">" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntriesAround", + "type": "Function", + "tags": [], + "label": "getLogEntriesAround", + "description": [], + "signature": [ + "(requestContext: ", + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", logView: { 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; }; })[]; }; }, params: ", + "LogEntriesAroundParams", + ", columnOverrides?: ({ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; })[] | undefined) => Promise<{ entries: { id: string; index: string; cursor: { time: number; tiebreaker: number; }; columns: ({ columnId: string; timestamp: number; } | { columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; } | { columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; })[]; context: {} | { 'container.id': string; } | { 'host.name': string; 'log.file.path': string; }; }[]; hasMoreBefore?: boolean | undefined; hasMoreAfter?: boolean | undefined; }>" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntriesAround.$1", + "type": "Object", + "tags": [], + "label": "requestContext", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + } + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntriesAround.$2", + "type": "CompoundType", + "tags": [], + "label": "logView", + "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/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntriesAround.$3", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "LogEntriesAroundParams" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntriesAround.$4", + "type": "Array", + "tags": [], + "label": "columnOverrides", + "description": [], + "signature": [ + "({ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; })[] | undefined" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntries", + "type": "Function", + "tags": [], + "label": "getLogEntries", + "description": [], + "signature": [ + "(requestContext: ", + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", logView: { 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; }; })[]; }; }, params: ", + "LogEntriesParams", + ", columnOverrides?: ({ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; })[] | undefined) => Promise<{ entries: { id: string; index: string; cursor: { time: number; tiebreaker: number; }; columns: ({ columnId: string; timestamp: number; } | { columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; } | { columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; })[]; context: {} | { 'container.id': string; } | { 'host.name': string; 'log.file.path': string; }; }[]; hasMoreBefore?: boolean | undefined; hasMoreAfter?: boolean | undefined; }>" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntries.$1", + "type": "Object", + "tags": [], + "label": "requestContext", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + } + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntries.$2", + "type": "CompoundType", + "tags": [], + "label": "logView", + "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/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntries.$3", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "LogEntriesParams" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntries.$4", + "type": "Array", + "tags": [], + "label": "columnOverrides", + "description": [], + "signature": [ + "({ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; })[] | undefined" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryBucketsBetween", + "type": "Function", + "tags": [], + "label": "getLogSummaryBucketsBetween", + "description": [], + "signature": [ + "(requestContext: ", + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", logView: { 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; }; })[]; }; }, start: number, end: number, bucketSize: number, filterQuery?: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonObject", + "text": "JsonObject" + }, + " | undefined) => Promise<{ start: number; end: number; entriesCount: number; }[]>" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryBucketsBetween.$1", + "type": "Object", + "tags": [], + "label": "requestContext", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + } + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryBucketsBetween.$2", + "type": "CompoundType", + "tags": [], + "label": "logView", + "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/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryBucketsBetween.$3", + "type": "number", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryBucketsBetween.$4", + "type": "number", + "tags": [], + "label": "end", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryBucketsBetween.$5", + "type": "number", + "tags": [], + "label": "bucketSize", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryBucketsBetween.$6", + "type": "Object", + "tags": [], + "label": "filterQuery", + "description": [], + "signature": [ + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonObject", + "text": "JsonObject" + }, + " | undefined" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween", + "type": "Function", + "tags": [], + "label": "getLogSummaryHighlightBucketsBetween", + "description": [], + "signature": [ + "(requestContext: ", + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", logView: { 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, endTimestamp: number, bucketSize: number, highlightQueries: string[], filterQuery?: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonObject", + "text": "JsonObject" + }, + " | undefined) => Promise<({ start: number; end: number; entriesCount: number; } & { representativeKey: { time: number; tiebreaker: number; }; })[][]>" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$1", + "type": "Object", + "tags": [], + "label": "requestContext", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + } + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$2", + "type": "CompoundType", + "tags": [], + "label": "logView", + "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/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$3", + "type": "number", + "tags": [], + "label": "startTimestamp", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$4", + "type": "number", + "tags": [], + "label": "endTimestamp", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$5", + "type": "number", + "tags": [], + "label": "bucketSize", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$6", + "type": "Array", + "tags": [], + "label": "highlightQueries", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$7", + "type": "Object", + "tags": [], + "label": "filterQuery", + "description": [], + "signature": [ + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonObject", + "text": "JsonObject" + }, + " | undefined" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntryDatasets", + "type": "Function", + "tags": [], + "label": "getLogEntryDatasets", + "description": [], + "signature": [ + "(requestContext: ", + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", timestampField: string, indexName: string, startTime: number, endTime: number, runtimeMappings: ", + "MappingRuntimeFields", + ") => Promise" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntryDatasets.$1", + "type": "Object", + "tags": [], + "label": "requestContext", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + } + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntryDatasets.$2", + "type": "string", + "tags": [], + "label": "timestampField", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntryDatasets.$3", + "type": "string", + "tags": [], + "label": "indexName", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntryDatasets.$4", + "type": "number", + "tags": [], + "label": "startTime", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntryDatasets.$5", + "type": "number", + "tags": [], + "label": "endTime", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedLogEntriesDomain.getLogEntryDatasets.$6", + "type": "Object", + "tags": [], + "label": "runtimeMappings", + "description": [], + "signature": [ + "MappingRuntimeFields" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain", + "type": "Interface", + "tags": [], + "label": "ILogsSharedLogEntriesDomain", + "description": [], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntriesAround", + "type": "Function", + "tags": [], + "label": "getLogEntriesAround", + "description": [], + "signature": [ + "(requestContext: ", + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", logView: { 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; }; })[]; }; }, params: ", + "LogEntriesAroundParams", + ", columnOverrides?: ({ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; })[] | undefined) => Promise<{ entries: { id: string; index: string; cursor: { time: number; tiebreaker: number; }; columns: ({ columnId: string; timestamp: number; } | { columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; } | { columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; })[]; context: {} | { 'container.id': string; } | { 'host.name': string; 'log.file.path': string; }; }[]; hasMoreBefore?: boolean | undefined; hasMoreAfter?: boolean | undefined; }>" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntriesAround.$1", + "type": "Object", + "tags": [], + "label": "requestContext", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + } + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntriesAround.$2", + "type": "CompoundType", + "tags": [], + "label": "logView", + "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/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntriesAround.$3", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "LogEntriesAroundParams" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntriesAround.$4", + "type": "Array", + "tags": [], + "label": "columnOverrides", + "description": [], + "signature": [ + "({ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; })[] | undefined" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntries", + "type": "Function", + "tags": [], + "label": "getLogEntries", + "description": [], + "signature": [ + "(requestContext: ", + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", logView: { 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; }; })[]; }; }, params: ", + "LogEntriesParams", + ", columnOverrides?: ({ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; })[] | undefined) => Promise<{ entries: { id: string; index: string; cursor: { time: number; tiebreaker: number; }; columns: ({ columnId: string; timestamp: number; } | { columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; } | { columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; })[]; context: {} | { 'container.id': string; } | { 'host.name': string; 'log.file.path': string; }; }[]; hasMoreBefore?: boolean | undefined; hasMoreAfter?: boolean | undefined; }>" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntries.$1", + "type": "Object", + "tags": [], + "label": "requestContext", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + } + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntries.$2", + "type": "CompoundType", + "tags": [], + "label": "logView", + "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/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntries.$3", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "LogEntriesParams" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntries.$4", + "type": "Array", + "tags": [], + "label": "columnOverrides", + "description": [], + "signature": [ + "({ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; })[] | undefined" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryBucketsBetween", + "type": "Function", + "tags": [], + "label": "getLogSummaryBucketsBetween", + "description": [], + "signature": [ + "(requestContext: ", + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", logView: { 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; }; })[]; }; }, start: number, end: number, bucketSize: number, filterQuery?: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonObject", + "text": "JsonObject" + }, + " | undefined) => Promise<{ start: number; end: number; entriesCount: number; }[]>" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryBucketsBetween.$1", + "type": "Object", + "tags": [], + "label": "requestContext", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + } + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryBucketsBetween.$2", + "type": "CompoundType", + "tags": [], + "label": "logView", + "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/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryBucketsBetween.$3", + "type": "number", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryBucketsBetween.$4", + "type": "number", + "tags": [], + "label": "end", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryBucketsBetween.$5", + "type": "number", + "tags": [], + "label": "bucketSize", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryBucketsBetween.$6", + "type": "Object", + "tags": [], + "label": "filterQuery", + "description": [], + "signature": [ + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonObject", + "text": "JsonObject" + }, + " | undefined" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween", + "type": "Function", + "tags": [], + "label": "getLogSummaryHighlightBucketsBetween", + "description": [], + "signature": [ + "(requestContext: ", + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", logView: { 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, endTimestamp: number, bucketSize: number, highlightQueries: string[], filterQuery?: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonObject", + "text": "JsonObject" + }, + " | undefined) => Promise<({ start: number; end: number; entriesCount: number; } & { representativeKey: { time: number; tiebreaker: number; }; })[][]>" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$1", + "type": "Object", + "tags": [], + "label": "requestContext", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + } + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$2", + "type": "CompoundType", + "tags": [], + "label": "logView", + "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/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$3", + "type": "number", + "tags": [], + "label": "startTimestamp", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$4", + "type": "number", + "tags": [], + "label": "endTimestamp", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$5", + "type": "number", + "tags": [], + "label": "bucketSize", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$6", + "type": "Array", + "tags": [], + "label": "highlightQueries", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogSummaryHighlightBucketsBetween.$7", + "type": "Object", + "tags": [], + "label": "filterQuery", + "description": [], + "signature": [ + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonObject", + "text": "JsonObject" + }, + " | undefined" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntryDatasets", + "type": "Function", + "tags": [], + "label": "getLogEntryDatasets", + "description": [], + "signature": [ + "(requestContext: ", + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ", timestampField: string, indexName: string, startTime: number, endTime: number, runtimeMappings: ", + "MappingRuntimeFields", + ") => Promise" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntryDatasets.$1", + "type": "Object", + "tags": [], + "label": "requestContext", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-request-handler-context-server", + "scope": "common", + "docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi", + "section": "def-common.RequestHandlerContext", + "text": "RequestHandlerContext" + } + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntryDatasets.$2", + "type": "string", + "tags": [], + "label": "timestampField", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntryDatasets.$3", + "type": "string", + "tags": [], + "label": "indexName", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntryDatasets.$4", + "type": "number", + "tags": [], + "label": "startTime", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntryDatasets.$5", + "type": "number", + "tags": [], + "label": "endTime", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-server.ILogsSharedLogEntriesDomain.getLogEntryDatasets.$6", + "type": "Object", + "tags": [], + "label": "runtimeMappings", + "description": [], + "signature": [ + "MappingRuntimeFields" + ], + "path": "x-pack/plugins/logs_shared/server/lib/domains/log_entries_domain/log_entries_domain.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "logsShared", + "id": "def-server.logViewSavedObjectName", + "type": "string", + "tags": [], + "label": "logViewSavedObjectName", + "description": [], + "signature": [ + "\"infrastructure-monitoring-log-view\"" + ], + "path": "x-pack/plugins/logs_shared/server/saved_objects/log_view/log_view_saved_object.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedPluginSetup", + "type": "Interface", + "tags": [], + "label": "LogsSharedPluginSetup", + "description": [], + "signature": [ + { + "pluginId": "logsShared", + "scope": "server", + "docId": "kibLogsSharedPluginApi", + "section": "def-server.LogsSharedPluginSetup", + "text": "LogsSharedPluginSetup" + }, + " extends ", + "LogsSharedDomainLibs" + ], + "path": "x-pack/plugins/logs_shared/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedPluginSetup.logViews", + "type": "Object", + "tags": [], + "label": "logViews", + "description": [], + "signature": [ + "LogViewsServiceSetup" + ], + "path": "x-pack/plugins/logs_shared/server/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedPluginSetup.registerUsageCollectorActions", + "type": "Function", + "tags": [], + "label": "registerUsageCollectorActions", + "description": [], + "signature": [ + "(usageCollector: ", + "UsageCollector", + ") => void" + ], + "path": "x-pack/plugins/logs_shared/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedPluginSetup.registerUsageCollectorActions.$1", + "type": "Object", + "tags": [], + "label": "usageCollector", + "description": [], + "signature": [ + "UsageCollector" + ], + "path": "x-pack/plugins/logs_shared/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedPluginStart", + "type": "Interface", + "tags": [], + "label": "LogsSharedPluginStart", + "description": [], + "path": "x-pack/plugins/logs_shared/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-server.LogsSharedPluginStart.logViews", + "type": "Object", + "tags": [], + "label": "logViews", + "description": [], + "signature": [ + "LogViewsServiceStart" + ], + "path": "x-pack/plugins/logs_shared/server/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [ + { + "parentPluginId": "logsShared", + "id": "def-common.FetchLogViewError", + "type": "Class", + "tags": [], + "label": "FetchLogViewError", + "description": [], + "signature": [ + { + "pluginId": "logsShared", + "scope": "common", + "docId": "kibLogsSharedPluginApi", + "section": "def-common.FetchLogViewError", + "text": "FetchLogViewError" + }, + " extends Error" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/errors.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-common.FetchLogViewError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/errors.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-common.FetchLogViewError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/errors.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-common.FetchLogViewError.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "cause", + "description": [], + "signature": [ + "Error | undefined" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/errors.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.FetchLogViewStatusError", + "type": "Class", + "tags": [], + "label": "FetchLogViewStatusError", + "description": [], + "signature": [ + { + "pluginId": "logsShared", + "scope": "common", + "docId": "kibLogsSharedPluginApi", + "section": "def-common.FetchLogViewStatusError", + "text": "FetchLogViewStatusError" + }, + " extends Error" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/errors.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-common.FetchLogViewStatusError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/errors.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-common.FetchLogViewStatusError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/errors.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-common.FetchLogViewStatusError.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "cause", + "description": [], + "signature": [ + "Error | undefined" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/errors.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.ResolveLogViewError", + "type": "Class", + "tags": [], + "label": "ResolveLogViewError", + "description": [], + "signature": [ + { + "pluginId": "logsShared", + "scope": "common", + "docId": "kibLogsSharedPluginApi", + "section": "def-common.ResolveLogViewError", + "text": "ResolveLogViewError" + }, + " extends Error" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/errors.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-common.ResolveLogViewError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/errors.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-common.ResolveLogViewError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/errors.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "logsShared", + "id": "def-common.ResolveLogViewError.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "cause", + "description": [], + "signature": [ + "Error | undefined" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/errors.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "logsShared", + "id": "def-common.getLogEntryCursorFromHit", + "type": "Function", + "tags": [], + "label": "getLogEntryCursorFromHit", + "description": [], + "signature": [ + "(hit: { sort: [number, number]; }) => { time: number; tiebreaker: number; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry_cursor.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-common.getLogEntryCursorFromHit.$1", + "type": "Object", + "tags": [], + "label": "hit", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry_cursor.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-common.getLogEntryCursorFromHit.$1.sort", + "type": "Object", + "tags": [], + "label": "sort", + "description": [], + "signature": [ + "[number, number]" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry_cursor.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "logsShared", + "id": "def-common.ResolvedLogView", + "type": "Interface", + "tags": [], + "label": "ResolvedLogView", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-common.ResolvedLogView.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.ResolvedLogView.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.ResolvedLogView.indices", + "type": "string", + "tags": [], + "label": "indices", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.ResolvedLogView.timestampField", + "type": "string", + "tags": [], + "label": "timestampField", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.ResolvedLogView.tiebreakerField", + "type": "string", + "tags": [], + "label": "tiebreakerField", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.ResolvedLogView.messageField", + "type": "Array", + "tags": [], + "label": "messageField", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.ResolvedLogView.fields", + "type": "Array", + "tags": [], + "label": "fields", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.ResolvedLogView.runtimeMappings", + "type": "Object", + "tags": [], + "label": "runtimeMappings", + "description": [], + "signature": [ + "{ [x: string]: ", + "MappingRuntimeField", + "; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.ResolvedLogView.columns", + "type": "Array", + "tags": [], + "label": "columns", + "description": [], + "signature": [ + "({ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; })[]" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.ResolvedLogView.dataViewReference", + "type": "Object", + "tags": [], + "label": "dataViewReference", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "logsShared", + "id": "def-common.defaultFilterStateKey", + "type": "string", + "tags": [], + "label": "defaultFilterStateKey", + "description": [], + "signature": [ + "\"logFilter\"" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.defaultPositionStateKey", + "type": "string", + "tags": [], + "label": "defaultPositionStateKey", + "description": [], + "signature": [ + "\"logPosition\"" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LOG_ENTRIES_HIGHLIGHTS_PATH", + "type": "string", + "tags": [], + "label": "LOG_ENTRIES_HIGHLIGHTS_PATH", + "description": [], + "signature": [ + "\"/api/log_entries/highlights\"" + ], + "path": "x-pack/plugins/logs_shared/common/http_api/log_entries/v1/highlights.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LOG_ENTRIES_SUMMARY_PATH", + "type": "string", + "tags": [], + "label": "LOG_ENTRIES_SUMMARY_PATH", + "description": [], + "signature": [ + "\"/api/log_entries/summary\"" + ], + "path": "x-pack/plugins/logs_shared/common/http_api/log_entries/v1/summary.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogColumn", + "type": "Type", + "tags": [], + "label": "LogColumn", + "description": [], + "signature": [ + "{ columnId: string; timestamp: number; } | { columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; } | { columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogDataViewReference", + "type": "Type", + "tags": [], + "label": "LogDataViewReference", + "description": [], + "signature": [ + "{ type: \"data_view\"; dataViewId: string; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogEntriesSummaryBucket", + "type": "Type", + "tags": [], + "label": "LogEntriesSummaryBucket", + "description": [], + "signature": [ + "{ start: number; end: number; entriesCount: number; }" + ], + "path": "x-pack/plugins/logs_shared/common/http_api/log_entries/v1/summary.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogEntriesSummaryHighlightsBucket", + "type": "Type", + "tags": [], + "label": "LogEntriesSummaryHighlightsBucket", + "description": [], + "signature": [ + "{ start: number; end: number; entriesCount: number; } & { representativeKey: { time: number; tiebreaker: number; }; }" + ], + "path": "x-pack/plugins/logs_shared/common/http_api/log_entries/v1/summary_highlights.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogEntry", + "type": "Type", + "tags": [], + "label": "LogEntry", + "description": [], + "signature": [ + "{ id: string; index: string; cursor: { time: number; tiebreaker: number; }; columns: ({ columnId: string; timestamp: number; } | { columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; } | { columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; })[]; context: {} | { 'container.id': string; } | { 'host.name': string; 'log.file.path': string; }; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogEntryAfterCursor", + "type": "Type", + "tags": [], + "label": "LogEntryAfterCursor", + "description": [], + "signature": [ + "{ after: { time: number; tiebreaker: number; } | \"first\"; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry_cursor.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogEntryAroundCursor", + "type": "Type", + "tags": [], + "label": "LogEntryAroundCursor", + "description": [], + "signature": [ + "{ center: { time: number; tiebreaker: number; }; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry_cursor.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogEntryBeforeCursor", + "type": "Type", + "tags": [], + "label": "LogEntryBeforeCursor", + "description": [], + "signature": [ + "{ before: { time: number; tiebreaker: number; } | \"last\"; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry_cursor.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogEntryContext", + "type": "Type", + "tags": [], + "label": "LogEntryContext", + "description": [], + "signature": [ + "{} | { 'container.id': string; } | { 'host.name': string; 'log.file.path': string; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogEntryCursor", + "type": "Type", + "tags": [], + "label": "LogEntryCursor", + "description": [], + "signature": [ + "{ time: number; tiebreaker: number; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry_cursor.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogEntryField", + "type": "Type", + "tags": [], + "label": "LogEntryField", + "description": [], + "signature": [ + "{ field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogEntryTime", + "type": "Type", + "tags": [], + "label": "LogEntryTime", + "description": [], + "signature": [ + "{ time: number; tiebreaker: number; } & { gid?: string | undefined; fromAutoReload?: boolean | undefined; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogFieldColumn", + "type": "Type", + "tags": [], + "label": "LogFieldColumn", + "description": [], + "signature": [ + "{ columnId: string; field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogIndexNameReference", + "type": "Type", + "tags": [], + "label": "LogIndexNameReference", + "description": [], + "signature": [ + "{ type: \"index_name\"; indexName: string; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogIndexReference", + "type": "Type", + "tags": [], + "label": "LogIndexReference", + "description": [], + "signature": [ + "{ type: \"data_view\"; dataViewId: string; } | { type: \"index_name\"; indexName: string; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogMessageColumn", + "type": "Type", + "tags": [], + "label": "LogMessageColumn", + "description": [], + "signature": [ + "{ columnId: string; message: ({ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; })[]; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogMessageConstantPart", + "type": "Type", + "tags": [], + "label": "LogMessageConstantPart", + "description": [], + "signature": [ + "{ constant: string; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogMessageFieldPart", + "type": "Type", + "tags": [], + "label": "LogMessageFieldPart", + "description": [], + "signature": [ + "{ field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogMessagePart", + "type": "Type", + "tags": [], + "label": "LogMessagePart", + "description": [], + "signature": [ + "{ constant: string; } | { field: string; value: ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + "; highlights: string[]; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogTimestampColumn", + "type": "Type", + "tags": [], + "label": "LogTimestampColumn", + "description": [], + "signature": [ + "{ columnId: string; timestamp: number; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogView", + "type": "Type", + "tags": [], + "label": "LogView", + "description": [], + "signature": [ + "{ id: string; origin: \"inline\" | \"internal\" | \"stored\" | \"infra-source-stored\" | \"infra-source-internal\" | \"infra-source-fallback\"; 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; }; })[]; }; } & { updatedAt?: number | undefined; version?: string | undefined; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogViewAttributes", + "type": "Type", + "tags": [], + "label": "LogViewAttributes", + "description": [], + "signature": [ + "{ 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/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogViewColumnConfiguration", + "type": "Type", + "tags": [], + "label": "LogViewColumnConfiguration", + "description": [], + "signature": [ + "{ timestampColumn: { id: string; }; } | { messageColumn: { id: string; }; } | { fieldColumn: { id: string; } & { field: string; }; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogViewReference", + "type": "Type", + "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/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.LogViewStatus", + "type": "Type", + "tags": [], + "label": "LogViewStatus", + "description": [], + "signature": [ + "{ index: \"missing\" | \"unknown\" | \"empty\" | \"available\"; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.PersistedLogViewReference", + "type": "Type", + "tags": [], + "label": "PersistedLogViewReference", + "description": [], + "signature": [ + "{ logViewId: string; type: \"log-view-reference\"; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.ResolvedLogViewField", + "type": "Type", + "tags": [], + "label": "ResolvedLogViewField", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.DataViewFieldBase", + "text": "DataViewFieldBase" + }, + " & { count?: number | undefined; conflictDescriptions?: Record | undefined; format?: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<{}, ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.SerializableRecord", + "text": "SerializableRecord" + }, + "> | undefined; esTypes?: string[] | undefined; searchable: boolean; aggregatable: boolean; readFromDocValues?: boolean | undefined; indexed?: boolean | undefined; customLabel?: string | undefined; runtimeField?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSpec", + "text": "RuntimeFieldSpec" + }, + " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: ", + "MappingTimeSeriesMetricType", + " | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; parentName?: string | undefined; }" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/resolved_log_view.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "logsShared", + "id": "def-common.DEFAULT_LOG_VIEW", + "type": "Object", + "tags": [], + "label": "DEFAULT_LOG_VIEW", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-common.DEFAULT_LOG_VIEW.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"log-view-reference\"" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.DEFAULT_LOG_VIEW.logViewId", + "type": "string", + "tags": [], + "label": "logViewId", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.DEFAULT_REFRESH_INTERVAL", + "type": "Object", + "tags": [], + "label": "DEFAULT_REFRESH_INTERVAL", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-common.DEFAULT_REFRESH_INTERVAL.pause", + "type": "boolean", + "tags": [], + "label": "pause", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.DEFAULT_REFRESH_INTERVAL.value", + "type": "number", + "tags": [], + "label": "value", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.defaultLogViewAttributes", + "type": "Object", + "tags": [], + "label": "defaultLogViewAttributes", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-common.defaultLogViewAttributes.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.defaultLogViewAttributes.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.defaultLogViewAttributes.logIndices", + "type": "Object", + "tags": [], + "label": "logIndices", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "logsShared", + "id": "def-common.defaultLogViewAttributes.logIndices.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"index_name\"" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.defaultLogViewAttributes.logIndices.indexName", + "type": "string", + "tags": [], + "label": "indexName", + "description": [], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "logsShared", + "id": "def-common.defaultLogViewAttributes.logColumns", + "type": "Array", + "tags": [], + "label": "logColumns", + "description": [], + "signature": [ + "({ timestampColumn: { id: string; }; } | { fieldColumn: { id: string; field: string; }; } | { messageColumn: { id: string; }; })[]" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/defaults.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logColumnRT", + "type": "Object", + "tags": [], + "label": "logColumnRT", + "description": [], + "signature": [ + "UnionC", + "<[", + "TypeC", + "<{ columnId: ", + "StringC", + "; timestamp: ", + "NumberC", + "; }>, ", + "TypeC", + "<{ columnId: ", + "StringC", + "; field: ", + "StringC", + "; value: ", + "Type", + "<", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", unknown>; highlights: ", + "ArrayC", + "<", + "StringC", + ">; }>, ", + "TypeC", + "<{ columnId: ", + "StringC", + "; message: ", + "ArrayC", + "<", + "UnionC", + "<[", + "TypeC", + "<{ constant: ", + "StringC", + "; }>, ", + "TypeC", + "<{ field: ", + "StringC", + "; value: ", + "Type", + "<", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", unknown>; highlights: ", + "ArrayC", + "<", + "StringC", + ">; }>]>>; }>]>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logDataViewReferenceRT", + "type": "Object", + "tags": [], + "label": "logDataViewReferenceRT", + "description": [], + "signature": [ + "TypeC", + "<{ type: ", + "LiteralC", + "<\"data_view\">; dataViewId: ", + "StringC", + "; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logEntriesHighlightsRequestRT", + "type": "Object", + "tags": [], + "label": "logEntriesHighlightsRequestRT", + "description": [], + "signature": [ + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ logView: ", + "UnionC", + "<[", + "TypeC", + "<{ logViewId: ", + "StringC", + "; type: ", + "LiteralC", + "<\"log-view-reference\">; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"log-view-inline\">; id: ", + "StringC", + "; attributes: ", + "ExactC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; description: ", + "StringC", + "; logIndices: ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"data_view\">; dataViewId: ", + "StringC", + "; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"index_name\">; indexName: ", + "StringC", + "; }>]>; logColumns: ", + "ArrayC", + "<", + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ timestampColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ messageColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ fieldColumn: ", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; }>>]>; }>>]>>; }>>; }>]>; startTimestamp: ", + "NumberC", + "; endTimestamp: ", + "NumberC", + "; highlightTerms: ", + "ArrayC", + "<", + "StringC", + ">; }>, ", + "PartialC", + "<{ query: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; size: ", + "NumberC", + "; columns: ", + "ArrayC", + "<", + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ timestampColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ messageColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ fieldColumn: ", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; }>>]>; }>>]>>; }>]>, ", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ logView: ", + "UnionC", + "<[", + "TypeC", + "<{ logViewId: ", + "StringC", + "; type: ", + "LiteralC", + "<\"log-view-reference\">; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"log-view-inline\">; id: ", + "StringC", + "; attributes: ", + "ExactC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; description: ", + "StringC", + "; logIndices: ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"data_view\">; dataViewId: ", + "StringC", + "; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"index_name\">; indexName: ", + "StringC", + "; }>]>; logColumns: ", + "ArrayC", + "<", + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ timestampColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ messageColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ fieldColumn: ", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; }>>]>; }>>]>>; }>>; }>]>; startTimestamp: ", + "NumberC", + "; endTimestamp: ", + "NumberC", + "; highlightTerms: ", + "ArrayC", + "<", + "StringC", + ">; }>, ", + "PartialC", + "<{ query: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; size: ", + "NumberC", + "; columns: ", + "ArrayC", + "<", + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ timestampColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ messageColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ fieldColumn: ", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; }>>]>; }>>]>>; }>]>, ", + "TypeC", + "<{ before: ", + "UnionC", + "<[", + "TypeC", + "<{ time: ", + "NumberC", + "; tiebreaker: ", + "NumberC", + "; }>, ", + "LiteralC", + "<\"last\">]>; }>]>, ", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ logView: ", + "UnionC", + "<[", + "TypeC", + "<{ logViewId: ", + "StringC", + "; type: ", + "LiteralC", + "<\"log-view-reference\">; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"log-view-inline\">; id: ", + "StringC", + "; attributes: ", + "ExactC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; description: ", + "StringC", + "; logIndices: ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"data_view\">; dataViewId: ", + "StringC", + "; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"index_name\">; indexName: ", + "StringC", + "; }>]>; logColumns: ", + "ArrayC", + "<", + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ timestampColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ messageColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ fieldColumn: ", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; }>>]>; }>>]>>; }>>; }>]>; startTimestamp: ", + "NumberC", + "; endTimestamp: ", + "NumberC", + "; highlightTerms: ", + "ArrayC", + "<", + "StringC", + ">; }>, ", + "PartialC", + "<{ query: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; size: ", + "NumberC", + "; columns: ", + "ArrayC", + "<", + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ timestampColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ messageColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ fieldColumn: ", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; }>>]>; }>>]>>; }>]>, ", + "TypeC", + "<{ after: ", + "UnionC", + "<[", + "TypeC", + "<{ time: ", + "NumberC", + "; tiebreaker: ", + "NumberC", + "; }>, ", + "LiteralC", + "<\"first\">]>; }>]>, ", + "IntersectionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ logView: ", + "UnionC", + "<[", + "TypeC", + "<{ logViewId: ", + "StringC", + "; type: ", + "LiteralC", + "<\"log-view-reference\">; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"log-view-inline\">; id: ", + "StringC", + "; attributes: ", + "ExactC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; description: ", + "StringC", + "; logIndices: ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"data_view\">; dataViewId: ", + "StringC", + "; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"index_name\">; indexName: ", + "StringC", + "; }>]>; logColumns: ", + "ArrayC", + "<", + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ timestampColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ messageColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ fieldColumn: ", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; }>>]>; }>>]>>; }>>; }>]>; startTimestamp: ", + "NumberC", + "; endTimestamp: ", + "NumberC", + "; highlightTerms: ", + "ArrayC", + "<", + "StringC", + ">; }>, ", + "PartialC", + "<{ query: ", + "UnionC", + "<[", + "StringC", + ", ", + "NullC", + "]>; size: ", + "NumberC", + "; columns: ", + "ArrayC", + "<", + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ timestampColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ messageColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ fieldColumn: ", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; }>>]>; }>>]>>; }>]>, ", + "TypeC", + "<{ center: ", + "TypeC", + "<{ time: ", + "NumberC", + "; tiebreaker: ", + "NumberC", + "; }>; }>]>]>" + ], + "path": "x-pack/plugins/logs_shared/common/http_api/log_entries/v1/highlights.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logEntriesHighlightsResponseRT", + "type": "Object", + "tags": [], + "label": "logEntriesHighlightsResponseRT", + "description": [], + "signature": [ + "TypeC", + "<{ data: ", + "ArrayC", + "<", + "UnionC", + "<[", + "TypeC", + "<{ topCursor: ", + "NullC", + "; bottomCursor: ", + "NullC", + "; entries: ", + "ArrayC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; index: ", + "StringC", + "; cursor: ", + "TypeC", + "<{ time: ", + "NumberC", + "; tiebreaker: ", + "NumberC", + "; }>; columns: ", + "ArrayC", + "<", + "UnionC", + "<[", + "TypeC", + "<{ columnId: ", + "StringC", + "; timestamp: ", + "NumberC", + "; }>, ", + "TypeC", + "<{ columnId: ", + "StringC", + "; field: ", + "StringC", + "; value: ", + "Type", + "<", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", unknown>; highlights: ", + "ArrayC", + "<", + "StringC", + ">; }>, ", + "TypeC", + "<{ columnId: ", + "StringC", + "; message: ", + "ArrayC", + "<", + "UnionC", + "<[", + "TypeC", + "<{ constant: ", + "StringC", + "; }>, ", + "TypeC", + "<{ field: ", + "StringC", + "; value: ", + "Type", + "<", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", unknown>; highlights: ", + "ArrayC", + "<", + "StringC", + ">; }>]>>; }>]>>; context: ", + "UnionC", + "<[", + "TypeC", + "<{}>, ", + "TypeC", + "<{ 'container.id': ", + "StringC", + "; }>, ", + "TypeC", + "<{ 'host.name': ", + "StringC", + "; 'log.file.path': ", + "StringC", + "; }>]>; }>>; }>, ", + "TypeC", + "<{ topCursor: ", + "TypeC", + "<{ time: ", + "NumberC", + "; tiebreaker: ", + "NumberC", + "; }>; bottomCursor: ", + "TypeC", + "<{ time: ", + "NumberC", + "; tiebreaker: ", + "NumberC", + "; }>; entries: ", + "ArrayC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; index: ", + "StringC", + "; cursor: ", + "TypeC", + "<{ time: ", + "NumberC", + "; tiebreaker: ", + "NumberC", + "; }>; columns: ", + "ArrayC", + "<", + "UnionC", + "<[", + "TypeC", + "<{ columnId: ", + "StringC", + "; timestamp: ", + "NumberC", + "; }>, ", + "TypeC", + "<{ columnId: ", + "StringC", + "; field: ", + "StringC", + "; value: ", + "Type", + "<", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", unknown>; highlights: ", + "ArrayC", + "<", + "StringC", + ">; }>, ", + "TypeC", + "<{ columnId: ", + "StringC", + "; message: ", + "ArrayC", + "<", + "UnionC", + "<[", + "TypeC", + "<{ constant: ", + "StringC", + "; }>, ", + "TypeC", + "<{ field: ", + "StringC", + "; value: ", + "Type", + "<", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", unknown>; highlights: ", + "ArrayC", + "<", + "StringC", + ">; }>]>>; }>]>>; context: ", + "UnionC", + "<[", + "TypeC", + "<{}>, ", + "TypeC", + "<{ 'container.id': ", + "StringC", + "; }>, ", + "TypeC", + "<{ 'host.name': ", + "StringC", + "; 'log.file.path': ", + "StringC", + "; }>]>; }>>; }>]>>; }>" + ], + "path": "x-pack/plugins/logs_shared/common/http_api/log_entries/v1/highlights.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logEntriesSummaryRequestRT", + "type": "Object", + "tags": [], + "label": "logEntriesSummaryRequestRT", + "description": [], + "signature": [ + "TypeC", + "<{ logView: ", + "UnionC", + "<[", + "TypeC", + "<{ logViewId: ", + "StringC", + "; type: ", + "LiteralC", + "<\"log-view-reference\">; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"log-view-inline\">; id: ", + "StringC", + "; attributes: ", + "ExactC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; description: ", + "StringC", + "; logIndices: ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"data_view\">; dataViewId: ", + "StringC", + "; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"index_name\">; indexName: ", + "StringC", + "; }>]>; logColumns: ", + "ArrayC", + "<", + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ timestampColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ messageColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ fieldColumn: ", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; }>>]>; }>>]>>; }>>; }>]>; startTimestamp: ", + "NumberC", + "; endTimestamp: ", + "NumberC", + "; bucketSize: ", + "NumberC", + "; query: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + ", ", + "NullC", + "]>; }>" + ], + "path": "x-pack/plugins/logs_shared/common/http_api/log_entries/v1/summary.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logEntriesSummaryResponseRT", + "type": "Object", + "tags": [], + "label": "logEntriesSummaryResponseRT", + "description": [], + "signature": [ + "TypeC", + "<{ data: ", + "TypeC", + "<{ start: ", + "NumberC", + "; end: ", + "NumberC", + "; buckets: ", + "ArrayC", + "<", + "TypeC", + "<{ start: ", + "NumberC", + "; end: ", + "NumberC", + "; entriesCount: ", + "NumberC", + "; }>>; }>; }>" + ], + "path": "x-pack/plugins/logs_shared/common/http_api/log_entries/v1/summary.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logEntryAfterCursorRT", + "type": "Object", + "tags": [], + "label": "logEntryAfterCursorRT", + "description": [], + "signature": [ + "TypeC", + "<{ after: ", + "UnionC", + "<[", + "TypeC", + "<{ time: ", + "NumberC", + "; tiebreaker: ", + "NumberC", + "; }>, ", + "LiteralC", + "<\"first\">]>; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry_cursor.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logEntryAroundCursorRT", + "type": "Object", + "tags": [], + "label": "logEntryAroundCursorRT", + "description": [], + "signature": [ + "TypeC", + "<{ center: ", + "TypeC", + "<{ time: ", + "NumberC", + "; tiebreaker: ", + "NumberC", + "; }>; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry_cursor.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logEntryBeforeCursorRT", + "type": "Object", + "tags": [], + "label": "logEntryBeforeCursorRT", + "description": [], + "signature": [ + "TypeC", + "<{ before: ", + "UnionC", + "<[", + "TypeC", + "<{ time: ", + "NumberC", + "; tiebreaker: ", + "NumberC", + "; }>, ", + "LiteralC", + "<\"last\">]>; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry_cursor.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logEntryContextRT", + "type": "Object", + "tags": [], + "label": "logEntryContextRT", + "description": [ + "\nfields" + ], + "signature": [ + "UnionC", + "<[", + "TypeC", + "<{}>, ", + "TypeC", + "<{ 'container.id': ", + "StringC", + "; }>, ", + "TypeC", + "<{ 'host.name': ", + "StringC", + "; 'log.file.path': ", + "StringC", + "; }>]>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logEntryCursorRT", + "type": "Object", + "tags": [], + "label": "logEntryCursorRT", + "description": [], + "signature": [ + "TypeC", + "<{ time: ", + "NumberC", + "; tiebreaker: ", + "NumberC", + "; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry_cursor.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logEntryFieldRT", + "type": "Object", + "tags": [], + "label": "logEntryFieldRT", + "description": [], + "signature": [ + "TypeC", + "<{ field: ", + "StringC", + "; value: ", + "Type", + "<", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", unknown>; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logEntryRT", + "type": "Object", + "tags": [], + "label": "logEntryRT", + "description": [ + "\nentry" + ], + "signature": [ + "TypeC", + "<{ id: ", + "StringC", + "; index: ", + "StringC", + "; cursor: ", + "TypeC", + "<{ time: ", + "NumberC", + "; tiebreaker: ", + "NumberC", + "; }>; columns: ", + "ArrayC", + "<", + "UnionC", + "<[", + "TypeC", + "<{ columnId: ", + "StringC", + "; timestamp: ", + "NumberC", + "; }>, ", + "TypeC", + "<{ columnId: ", + "StringC", + "; field: ", + "StringC", + "; value: ", + "Type", + "<", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", unknown>; highlights: ", + "ArrayC", + "<", + "StringC", + ">; }>, ", + "TypeC", + "<{ columnId: ", + "StringC", + "; message: ", + "ArrayC", + "<", + "UnionC", + "<[", + "TypeC", + "<{ constant: ", + "StringC", + "; }>, ", + "TypeC", + "<{ field: ", + "StringC", + "; value: ", + "Type", + "<", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", unknown>; highlights: ", + "ArrayC", + "<", + "StringC", + ">; }>]>>; }>]>>; context: ", + "UnionC", + "<[", + "TypeC", + "<{}>, ", + "TypeC", + "<{ 'container.id': ", + "StringC", + "; }>, ", + "TypeC", + "<{ 'host.name': ", + "StringC", + "; 'log.file.path': ", + "StringC", + "; }>]>; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logFieldColumnRT", + "type": "Object", + "tags": [], + "label": "logFieldColumnRT", + "description": [], + "signature": [ + "TypeC", + "<{ columnId: ", + "StringC", + "; field: ", + "StringC", + "; value: ", + "Type", + "<", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", unknown>; highlights: ", + "ArrayC", + "<", + "StringC", + ">; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logIndexNameReferenceRT", + "type": "Object", + "tags": [], + "label": "logIndexNameReferenceRT", + "description": [], + "signature": [ + "TypeC", + "<{ type: ", + "LiteralC", + "<\"index_name\">; indexName: ", + "StringC", + "; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logMessageColumnRT", + "type": "Object", + "tags": [], + "label": "logMessageColumnRT", + "description": [], + "signature": [ + "TypeC", + "<{ columnId: ", + "StringC", + "; message: ", + "ArrayC", + "<", + "UnionC", + "<[", + "TypeC", + "<{ constant: ", + "StringC", + "; }>, ", + "TypeC", + "<{ field: ", + "StringC", + "; value: ", + "Type", + "<", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", unknown>; highlights: ", + "ArrayC", + "<", + "StringC", + ">; }>]>>; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logMessageConstantPartRT", + "type": "Object", + "tags": [], + "label": "logMessageConstantPartRT", + "description": [ + "\nmessage parts" + ], + "signature": [ + "TypeC", + "<{ constant: ", + "StringC", + "; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logMessageFieldPartRT", + "type": "Object", + "tags": [], + "label": "logMessageFieldPartRT", + "description": [], + "signature": [ + "TypeC", + "<{ field: ", + "StringC", + "; value: ", + "Type", + "<", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", unknown>; highlights: ", + "ArrayC", + "<", + "StringC", + ">; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logMessagePartRT", + "type": "Object", + "tags": [], + "label": "logMessagePartRT", + "description": [], + "signature": [ + "UnionC", + "<[", + "TypeC", + "<{ constant: ", + "StringC", + "; }>, ", + "TypeC", + "<{ field: ", + "StringC", + "; value: ", + "Type", + "<", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", ", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.JsonArray", + "text": "JsonArray" + }, + ", unknown>; highlights: ", + "ArrayC", + "<", + "StringC", + ">; }>]>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logTimestampColumnRT", + "type": "Object", + "tags": [], + "label": "logTimestampColumnRT", + "description": [ + "\ncolumns" + ], + "signature": [ + "TypeC", + "<{ columnId: ", + "StringC", + "; timestamp: ", + "NumberC", + "; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_entry/log_entry.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logViewColumnConfigurationRT", + "type": "Object", + "tags": [], + "label": "logViewColumnConfigurationRT", + "description": [], + "signature": [ + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ timestampColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ messageColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ fieldColumn: ", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; }>>]>; }>>]>" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.logViewReferenceRT", + "type": "Object", + "tags": [], + "label": "logViewReferenceRT", + "description": [], + "signature": [ + "UnionC", + "<[", + "TypeC", + "<{ logViewId: ", + "StringC", + "; type: ", + "LiteralC", + "<\"log-view-reference\">; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"log-view-inline\">; id: ", + "StringC", + "; attributes: ", + "ExactC", + "<", + "TypeC", + "<{ name: ", + "StringC", + "; description: ", + "StringC", + "; logIndices: ", + "UnionC", + "<[", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"data_view\">; dataViewId: ", + "StringC", + "; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"index_name\">; indexName: ", + "StringC", + "; }>]>; logColumns: ", + "ArrayC", + "<", + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ timestampColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ messageColumn: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ fieldColumn: ", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "StringC", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; }>>]>; }>>]>>; }>>; }>]>" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "logsShared", + "id": "def-common.persistedLogViewReferenceRT", + "type": "Object", + "tags": [], + "label": "persistedLogViewReferenceRT", + "description": [], + "signature": [ + "TypeC", + "<{ logViewId: ", + "StringC", + "; type: ", + "LiteralC", + "<\"log-view-reference\">; }>" + ], + "path": "x-pack/plugins/logs_shared/common/log_views/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/logs_shared.mdx b/api_docs/logs_shared.mdx new file mode 100644 index 0000000000000..7e3b3fe90a1f9 --- /dev/null +++ b/api_docs/logs_shared.mdx @@ -0,0 +1,76 @@ +--- +#### +#### 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: kibLogsSharedPluginApi +slug: /kibana-dev-docs/api/logsShared +title: "logsShared" +image: https://source.unsplash.com/400x175/?github +description: API docs for the logsShared plugin +date: 2023-07-18 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'logsShared'] +--- +import logsSharedObj from './logs_shared.devdocs.json'; + +Exposes the shared components and APIs to access and visualize logs. + +Contact [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 269 | 10 | 256 | 27 | + +## Client + +### Setup + + +### Start + + +### Functions + + +### Interfaces + + +### Consts, variables and types + + +## Server + +### Setup + + +### Start + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + +## Common + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/management.devdocs.json b/api_docs/management.devdocs.json index 4ca34adc10ea7..61f282b25ee2c 100644 --- a/api_docs/management.devdocs.json +++ b/api_docs/management.devdocs.json @@ -804,6 +804,72 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "management", + "id": "def-public.ManagementStart.setLandingPageRedirect", + "type": "Function", + "tags": [], + "label": "setLandingPageRedirect", + "description": [], + "signature": [ + "(landingPageRedirect: string) => void" + ], + "path": "src/plugins/management/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "management", + "id": "def-public.ManagementStart.setLandingPageRedirect.$1", + "type": "string", + "tags": [], + "label": "landingPageRedirect", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/management/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "management", + "id": "def-public.ManagementStart.setupCardsNavigation", + "type": "Function", + "tags": [], + "label": "setupCardsNavigation", + "description": [], + "signature": [ + "({ enabled, hideLinksTo }: ", + "NavigationCardsSubject", + ") => void" + ], + "path": "src/plugins/management/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "management", + "id": "def-public.ManagementStart.setupCardsNavigation.$1", + "type": "Object", + "tags": [], + "label": "{ enabled, hideLinksTo }", + "description": [], + "signature": [ + "NavigationCardsSubject" + ], + "path": "src/plugins/management/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] } ], "lifecycle": "start", diff --git a/api_docs/management.mdx b/api_docs/management.mdx index b2a35b6b9817a..7189862b96a19 100644 --- a/api_docs/management.mdx +++ b/api_docs/management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/management title: "management" image: https://source.unsplash.com/400x175/?github description: API docs for the management plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] --- import managementObj from './management.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/platform-deployment-management](https://github.com/orgs/elasti | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 43 | 0 | 43 | 6 | +| 47 | 0 | 47 | 7 | ## Client diff --git a/api_docs/maps.devdocs.json b/api_docs/maps.devdocs.json index f1642150fc4a1..e732667d42150 100644 --- a/api_docs/maps.devdocs.json +++ b/api_docs/maps.devdocs.json @@ -1813,7 +1813,7 @@ "label": "mbFeature", "description": [], "signature": [ - "maplibregl.GeoJSONFeature & { layer: Omit & { source: string; }; source: string; sourceLayer?: string | undefined; state: { [key: string]: any; }; }" + "maplibregl.GeoJSONFeature & { layer: (Omit | Omit | Omit | Omit | Omit | Omit | Omit | Omit | Omit) & { source: string; }; source: string; sourceLayer?: string | undefined; state: { [key: string]: any; }; }" ], "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx", "deprecated": false, @@ -3406,56 +3406,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "maps", - "id": "def-public.PreIndexedShape", - "type": "Interface", - "tags": [], - "label": "PreIndexedShape", - "description": [], - "path": "x-pack/plugins/maps/common/elasticsearch_util/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "maps", - "id": "def-public.PreIndexedShape.index", - "type": "string", - "tags": [], - "label": "index", - "description": [], - "path": "x-pack/plugins/maps/common/elasticsearch_util/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "maps", - "id": "def-public.PreIndexedShape.id", - "type": "CompoundType", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | number" - ], - "path": "x-pack/plugins/maps/common/elasticsearch_util/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "maps", - "id": "def-public.PreIndexedShape.path", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "path": "x-pack/plugins/maps/common/elasticsearch_util/types.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "maps", "id": "def-public.RenderTooltipContentParams", diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index dad1b50e46330..06b797e993e40 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/maps title: "maps" image: https://source.unsplash.com/400x175/?github description: API docs for the maps plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] --- import mapsObj from './maps.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 266 | 0 | 265 | 28 | +| 262 | 0 | 261 | 28 | ## Client diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index 01e4450d3db40..20aed9c29a962 100644 --- a/api_docs/maps_ems.mdx +++ b/api_docs/maps_ems.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/mapsEms title: "mapsEms" image: https://source.unsplash.com/400x175/?github description: API docs for the mapsEms plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] --- import mapsEmsObj from './maps_ems.devdocs.json'; diff --git a/api_docs/ml.devdocs.json b/api_docs/ml.devdocs.json index 77287b57334ec..fbdfc504d747d 100644 --- a/api_docs/ml.devdocs.json +++ b/api_docs/ml.devdocs.json @@ -462,7 +462,7 @@ "label": "capabilities", "description": [], "signature": [ - "{ canGetJobs: boolean; canGetDatafeeds: boolean; canGetCalendars: boolean; canFindFileStructure: boolean; canGetDataFrameAnalytics: boolean; canGetAnnotations: boolean; canCreateAnnotation: boolean; canDeleteAnnotation: boolean; canUseMlAlerts: boolean; canGetTrainedModels: boolean; canTestTrainedModels: boolean; canGetFieldInfo: boolean; canGetMlInfo: boolean; canUseAiops: boolean; } & { canCreateJob: boolean; canDeleteJob: boolean; canOpenJob: boolean; canCloseJob: boolean; canResetJob: boolean; canUpdateJob: boolean; canForecastJob: boolean; canCreateDatafeed: boolean; canDeleteDatafeed: boolean; canStartStopDatafeed: boolean; canUpdateDatafeed: boolean; canPreviewDatafeed: boolean; canGetFilters: boolean; canCreateCalendar: boolean; canDeleteCalendar: boolean; canCreateFilter: boolean; canDeleteFilter: boolean; canCreateDataFrameAnalytics: boolean; canDeleteDataFrameAnalytics: boolean; canStartStopDataFrameAnalytics: boolean; canCreateMlAlerts: boolean; canUseMlAlerts: boolean; canViewMlNodes: boolean; canCreateTrainedModels: boolean; canDeleteTrainedModels: boolean; canStartStopTrainedModels: boolean; }" + "{ isADEnabled: boolean; isDFAEnabled: boolean; isNLPEnabled: boolean; } & { canGetJobs: boolean; canGetDatafeeds: boolean; canGetCalendars: boolean; canFindFileStructure: boolean; canGetDataFrameAnalytics: boolean; canGetAnnotations: boolean; canCreateAnnotation: boolean; canDeleteAnnotation: boolean; canUseMlAlerts: boolean; canGetTrainedModels: boolean; canTestTrainedModels: boolean; canGetFieldInfo: boolean; canGetMlInfo: boolean; canUseAiops: boolean; } & { canCreateJob: boolean; canDeleteJob: boolean; canOpenJob: boolean; canCloseJob: boolean; canResetJob: boolean; canUpdateJob: boolean; canForecastJob: boolean; canCreateDatafeed: boolean; canDeleteDatafeed: boolean; canStartStopDatafeed: boolean; canUpdateDatafeed: boolean; canPreviewDatafeed: boolean; canGetFilters: boolean; canCreateCalendar: boolean; canDeleteCalendar: boolean; canCreateFilter: boolean; canDeleteFilter: boolean; canCreateDataFrameAnalytics: boolean; canDeleteDataFrameAnalytics: boolean; canStartStopDataFrameAnalytics: boolean; canCreateMlAlerts: boolean; canUseMlAlerts: boolean; canViewMlNodes: boolean; canCreateTrainedModels: boolean; canDeleteTrainedModels: boolean; canStartStopTrainedModels: boolean; }" ], "path": "x-pack/plugins/ml/common/types/capabilities.ts", "deprecated": false, @@ -1651,7 +1651,7 @@ "label": "AlertingService", "description": [], "signature": [ - "{ preview: (args_0: Readonly<{} & { timeRange: string; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; sampleSize: number; }>) => Promise; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>) => Promise<{ context: ", + "{ preview: (args_0: Readonly<{} & { timeRange: string; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; sampleSize: number; }>) => Promise; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>, spaceId: string) => Promise<{ context: ", "AnomalyDetectionAlertContext", "; name: string; isHealthy: boolean; } | undefined>; }" ], @@ -1912,10 +1912,11 @@ "section": "def-common.KibanaRequest", "text": "KibanaRequest" }, - "): { preview: (args_0: Readonly<{} & { timeRange: string; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; sampleSize: number; }>) => Promise; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>) => Promise<{ context: ", + "): { preview: (args_0: Readonly<{} & { timeRange: string; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; sampleSize: number; }>) => Promise; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>, spaceId: string) => Promise<{ context: ", "AnomalyDetectionAlertContext", "; name: string; isHealthy: boolean; } | undefined>; }; } & ", - "TrainedModelsProvider" + "TrainedModelsProvider", + " & MlSetup" ], "path": "x-pack/plugins/ml/server/plugin.ts", "deprecated": false, diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index bb16b0f9297d3..3a20255aafcfa 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ml title: "ml" image: https://source.unsplash.com/400x175/?github description: API docs for the ml plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] --- import mlObj from './ml.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) for questi | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 150 | 3 | 64 | 33 | +| 150 | 3 | 64 | 32 | ## Client diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index 051fd4068fd1c..13c810a89e9a7 100644 --- a/api_docs/monitoring.mdx +++ b/api_docs/monitoring.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/monitoring title: "monitoring" image: https://source.unsplash.com/400x175/?github description: API docs for the monitoring plugin -date: 2023-06-30 +date: 2023-07-18 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 f1330e88a88df..12dbb8a983ed9 100644 --- a/api_docs/monitoring_collection.mdx +++ b/api_docs/monitoring_collection.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/monitoringCollection title: "monitoringCollection" image: https://source.unsplash.com/400x175/?github description: API docs for the monitoringCollection plugin -date: 2023-06-30 +date: 2023-07-18 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 64f059808d001..a634607bcadbd 100644 --- a/api_docs/navigation.mdx +++ b/api_docs/navigation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/navigation title: "navigation" image: https://source.unsplash.com/400x175/?github description: API docs for the navigation plugin -date: 2023-06-30 +date: 2023-07-18 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 4228c5757a399..b030db681f49a 100644 --- a/api_docs/newsfeed.mdx +++ b/api_docs/newsfeed.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/newsfeed title: "newsfeed" image: https://source.unsplash.com/400x175/?github description: API docs for the newsfeed plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed'] --- import newsfeedObj from './newsfeed.devdocs.json'; diff --git a/api_docs/notifications.mdx b/api_docs/notifications.mdx index d42daba287f87..6be1d3b6a40b2 100644 --- a/api_docs/notifications.mdx +++ b/api_docs/notifications.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/notifications title: "notifications" image: https://source.unsplash.com/400x175/?github description: API docs for the notifications plugin -date: 2023-06-30 +date: 2023-07-18 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 2c5fb9683753a..ec1e5f0bbe268 100644 --- a/api_docs/observability.devdocs.json +++ b/api_docs/observability.devdocs.json @@ -3060,6 +3060,40 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "observability", + "id": "def-public.SloEditLocatorParams", + "type": "Interface", + "tags": [], + "label": "SloEditLocatorParams", + "description": [], + "signature": [ + { + "pluginId": "observability", + "scope": "public", + "docId": "kibObservabilityPluginApi", + "section": "def-public.SloEditLocatorParams", + "text": "SloEditLocatorParams" + }, + " extends ", + "RecursivePartial", + "<", + "CreateSLOForm", + ">,", + { + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.SerializableRecord", + "text": "SerializableRecord" + } + ], + "path": "x-pack/plugins/observability/public/locators/slo_edit.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-public.Stat", @@ -4078,6 +4112,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "observability", + "id": "def-public.sloEditLocatorID", + "type": "string", + "tags": [], + "label": "sloEditLocatorID", + "description": [], + "signature": [ + "\"SLO_EDIT_LOCATOR\"" + ], + "path": "x-pack/plugins/observability/common/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-public.StringOrNull", @@ -4230,6 +4279,22 @@ }, "<", "SloDetailsLocatorParams", + ">; sloEditLocator: ", + { + "pluginId": "share", + "scope": "common", + "docId": "kibSharePluginApi", + "section": "def-common.LocatorPublic", + "text": "LocatorPublic" + }, + "<", + { + "pluginId": "observability", + "scope": "public", + "docId": "kibObservabilityPluginApi", + "section": "def-public.SloEditLocatorParams", + "text": "SloEditLocatorParams" + }, ">; getCoPilotService: () => ", "CoPilotService", "; }" @@ -4361,7 +4426,7 @@ "label": "createOrUpdateIndex", "description": [], "signature": [ - "({\n index,\n mappings,\n client,\n logger,\n}: { index: string; mappings: ", + "({\n index,\n mappings,\n settings,\n client,\n logger,\n}: { index: string; mappings: ", "MappingTypeMapping", " & { date_detection?: boolean | undefined; dynamic?: ", "MappingDynamicMapping", @@ -4381,7 +4446,9 @@ "MappingSourceField", " | undefined; runtime?: ", "MappingRuntimeFields", - " | undefined; }; client: ", + " | undefined; }; settings?: ", + "IndicesIndexSettings", + " | undefined; client: ", { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", @@ -4408,7 +4475,7 @@ "id": "def-server.createOrUpdateIndex.$1", "type": "Object", "tags": [], - "label": "{\n index,\n mappings,\n client,\n logger,\n}", + "label": "{\n index,\n mappings,\n settings,\n client,\n logger,\n}", "description": [], "path": "x-pack/plugins/observability/server/utils/create_or_update_index.ts", "deprecated": false, @@ -4458,6 +4525,21 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "observability", + "id": "def-server.createOrUpdateIndex.$1.settings", + "type": "CompoundType", + "tags": [], + "label": "settings", + "description": [], + "signature": [ + "IndicesIndexSettings", + " | undefined" + ], + "path": "x-pack/plugins/observability/server/utils/create_or_update_index.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "observability", "id": "def-server.createOrUpdateIndex.$1.client", @@ -7577,6 +7659,20 @@ "path": "x-pack/plugins/observability/server/routes/types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "observability", + "id": "def-server.ObservabilityRouteHandlerResources.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "{ readonly aiAssistant?: Readonly<{} & { enabled: boolean; feedback: Readonly<{} & { enabled: boolean; url: string; }>; provider: Readonly<{} & { openAI: Readonly<{} & { apiKey: string; model: string; }>; }> | Readonly<{} & { azureOpenAI: Readonly<{} & { apiKey: string; resourceName: string; deploymentId: string; }>; }>; }> | undefined; readonly enabled: boolean; readonly annotations: Readonly<{} & { index: string; enabled: boolean; }>; readonly unsafe: Readonly<{} & { alertDetails: Readonly<{} & { uptime: Readonly<{} & { enabled: boolean; }>; metrics: Readonly<{} & { enabled: boolean; }>; logs: Readonly<{} & { enabled: boolean; }>; }>; thresholdRule: Readonly<{} & { enabled: boolean; }>; }>; readonly thresholdRule: Readonly<{} & { groupByPageSize: number; }>; readonly compositeSlo: Readonly<{} & { enabled: boolean; }>; }" + ], + "path": "x-pack/plugins/observability/server/routes/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -7649,15 +7745,49 @@ "label": "ObservabilityAPIReturnType", "description": [], "signature": [ - "{ \"POST /internal/observability/copilot/prompts/profilingOptimizeFunction\": { endpoint: \"POST /internal/observability/copilot/prompts/profilingOptimizeFunction\"; params?: ", + "{ \"POST /internal/observability/copilot/prompts/{promptId}/track\": { endpoint: \"POST /internal/observability/copilot/prompts/{promptId}/track\"; params?: ", "TypeC", - "<{ body: ", + "<{ path: ", "TypeC", - "<{ library: ", + "<{ promptId: ", "StringC", - "; functionName: ", + "; }>; body: ", + "IntersectionC", + "<[", + "TypeC", + "<{ responseTime: ", + "NumberC", + "; messages: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "TypeC", + "<{ role: ", + "UnionC", + "<[", + "LiteralC", + "<\"system\">, ", + "LiteralC", + "<\"user\">, ", + "LiteralC", + "<\"assistant\">]>; content: ", "StringC", - "; }>; }> | undefined; handler: ({}: ", + "; }>, ", + "PartialC", + "<{ name: ", + "StringC", + "; }>]>>; response: ", + "StringC", + "; }>, ", + "PartialC", + "<{ feedbackAction: ", + "UnionC", + "<[", + "LiteralC", + "<\"thumbsup\">, ", + "LiteralC", + "<\"thumbsdown\">]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -7665,7 +7795,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - " & { params: { body: { library: string; functionName: string; }; }; }) => Promise; } & ", + " & { params: { path: { promptId: string; }; body: { responseTime: number; messages: ({ role: \"user\" | \"system\" | \"assistant\"; content: string; } & { name?: string | undefined; })[]; response: string; } & { feedbackAction?: \"thumbsup\" | \"thumbsdown\" | undefined; }; }; }) => Promise; } & ", { "pluginId": "observability", "scope": "server", @@ -7673,7 +7803,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - "; \"POST /internal/observability/copilot/prompts/profilingExplainFunction\": { endpoint: \"POST /internal/observability/copilot/prompts/profilingExplainFunction\"; params?: ", + "; \"POST /internal/observability/copilot/prompts/profilingOptimizeFunction\": { endpoint: \"POST /internal/observability/copilot/prompts/profilingOptimizeFunction\"; params?: ", "TypeC", "<{ body: ", "TypeC", @@ -8302,6 +8432,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -8309,13 +8441,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -8323,11 +8461,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; }>; }> | undefined; handler: ({}: ", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -8335,7 +8549,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - " & { params: { body: { indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; }; }; }) => Promise<{ date: string; sliValue: number; }[]>; } & ", + " & { params: { body: { indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; }; }; }) => Promise<{ date: string; sliValue: number; }[]>; } & ", { "pluginId": "observability", "scope": "server", @@ -8413,7 +8627,7 @@ "section": "def-common.SavedObject", "text": "SavedObject" }, - "<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; sloTransformStats: ", + "<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: 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; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; sloTransformStats: ", "TransformGetTransformStatsResponse", "; dataSample: string | ", "SearchResponse", @@ -8570,6 +8784,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -8577,13 +8793,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -8591,11 +8813,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; timeWindow: ", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -8685,7 +8983,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - " & { params: { path: { id: string; }; body: { name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; } | undefined; timeWindow?: { duration: ", + " & { params: { path: { id: string; }; body: { name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; } | undefined; timeWindow?: { duration: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -8725,7 +9023,7 @@ "section": "def-common.Duration", "text": "Duration" }, - " | undefined; } | undefined; tags?: string[] | undefined; }; }; }) => Promise<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; } & ", + " | undefined; } | undefined; tags?: string[] | undefined; }; }; }) => Promise<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -8747,7 +9045,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - " & { params: { path: { id: string; }; }; }) => Promise<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }>; } & ", + " & { params: { path: { id: string; }; }; }) => Promise<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -8787,7 +9085,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - " & { params?: { query?: { name?: string | undefined; indicatorTypes?: string[] | undefined; page?: string | undefined; perPage?: string | undefined; sortBy?: \"creationTime\" | \"indicatorType\" | undefined; sortDirection?: \"asc\" | \"desc\" | undefined; } | undefined; } | undefined; }) => Promise<{ page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }>; } & ", + " & { params?: { query?: { name?: string | undefined; indicatorTypes?: string[] | undefined; page?: string | undefined; perPage?: string | undefined; sortBy?: \"creationTime\" | \"indicatorType\" | undefined; sortDirection?: \"asc\" | \"desc\" | undefined; } | undefined; } | undefined; }) => Promise<{ page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -9006,6 +9304,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -9013,13 +9313,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -9027,11 +9333,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; timeWindow: ", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -9125,7 +9507,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - " & { params: { body: { name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: ", + " & { params: { body: { name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -9216,7 +9598,7 @@ "label": "ObservabilityConfig", "description": [], "signature": [ - "{ readonly aiAssistant?: Readonly<{} & { enabled: boolean; provider: Readonly<{} & { openAI: Readonly<{} & { apiKey: string; model: string; }>; }> | Readonly<{} & { azureOpenAI: Readonly<{} & { apiKey: string; resourceName: string; deploymentId: string; }>; }>; }> | undefined; readonly enabled: boolean; readonly annotations: Readonly<{} & { index: string; enabled: boolean; }>; readonly unsafe: Readonly<{} & { alertDetails: Readonly<{} & { uptime: Readonly<{} & { enabled: boolean; }>; metrics: Readonly<{} & { enabled: boolean; }>; logs: Readonly<{} & { enabled: boolean; }>; }>; thresholdRule: Readonly<{} & { enabled: boolean; }>; }>; readonly thresholdRule: Readonly<{} & { groupByPageSize: number; }>; readonly compositeSlo: Readonly<{} & { enabled: boolean; }>; }" + "{ readonly aiAssistant?: Readonly<{} & { enabled: boolean; feedback: Readonly<{} & { enabled: boolean; url: string; }>; provider: Readonly<{} & { openAI: Readonly<{} & { apiKey: string; model: string; }>; }> | Readonly<{} & { azureOpenAI: Readonly<{} & { apiKey: string; resourceName: string; deploymentId: string; }>; }>; }> | undefined; readonly enabled: boolean; readonly annotations: Readonly<{} & { index: string; enabled: boolean; }>; readonly unsafe: Readonly<{} & { alertDetails: Readonly<{} & { uptime: Readonly<{} & { enabled: boolean; }>; metrics: Readonly<{} & { enabled: boolean; }>; logs: Readonly<{} & { enabled: boolean; }>; }>; thresholdRule: Readonly<{} & { enabled: boolean; }>; }>; readonly thresholdRule: Readonly<{} & { groupByPageSize: number; }>; readonly compositeSlo: Readonly<{} & { enabled: boolean; }>; }" ], "path": "x-pack/plugins/observability/server/index.ts", "deprecated": false, @@ -9231,15 +9613,49 @@ "label": "ObservabilityServerRouteRepository", "description": [], "signature": [ - "{ \"POST /internal/observability/copilot/prompts/profilingOptimizeFunction\": { endpoint: \"POST /internal/observability/copilot/prompts/profilingOptimizeFunction\"; params?: ", + "{ \"POST /internal/observability/copilot/prompts/{promptId}/track\": { endpoint: \"POST /internal/observability/copilot/prompts/{promptId}/track\"; params?: ", "TypeC", - "<{ body: ", + "<{ path: ", "TypeC", - "<{ library: ", + "<{ promptId: ", "StringC", - "; functionName: ", + "; }>; body: ", + "IntersectionC", + "<[", + "TypeC", + "<{ responseTime: ", + "NumberC", + "; messages: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "TypeC", + "<{ role: ", + "UnionC", + "<[", + "LiteralC", + "<\"system\">, ", + "LiteralC", + "<\"user\">, ", + "LiteralC", + "<\"assistant\">]>; content: ", "StringC", - "; }>; }> | undefined; handler: ({}: ", + "; }>, ", + "PartialC", + "<{ name: ", + "StringC", + "; }>]>>; response: ", + "StringC", + "; }>, ", + "PartialC", + "<{ feedbackAction: ", + "UnionC", + "<[", + "LiteralC", + "<\"thumbsup\">, ", + "LiteralC", + "<\"thumbsdown\">]>; }>]>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -9247,7 +9663,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - " & { params: { body: { library: string; functionName: string; }; }; }) => Promise; } & ", + " & { params: { path: { promptId: string; }; body: { responseTime: number; messages: ({ role: \"user\" | \"system\" | \"assistant\"; content: string; } & { name?: string | undefined; })[]; response: string; } & { feedbackAction?: \"thumbsup\" | \"thumbsdown\" | undefined; }; }; }) => Promise; } & ", { "pluginId": "observability", "scope": "server", @@ -9255,7 +9671,7 @@ "section": "def-server.ObservabilityRouteCreateOptions", "text": "ObservabilityRouteCreateOptions" }, - "; \"POST /internal/observability/copilot/prompts/profilingExplainFunction\": { endpoint: \"POST /internal/observability/copilot/prompts/profilingExplainFunction\"; params?: ", + "; \"POST /internal/observability/copilot/prompts/profilingOptimizeFunction\": { endpoint: \"POST /internal/observability/copilot/prompts/profilingOptimizeFunction\"; params?: ", "TypeC", "<{ body: ", "TypeC", @@ -9884,6 +10300,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -9891,13 +10309,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -9905,11 +10329,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; }>; }> | undefined; handler: ({}: ", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; }>; }> | undefined; handler: ({}: ", { "pluginId": "observability", "scope": "server", @@ -9917,7 +10417,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - " & { params: { body: { indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; }; }; }) => Promise<{ date: string; sliValue: number; }[]>; } & ", + " & { params: { body: { indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; }; }; }) => Promise<{ date: string; sliValue: number; }[]>; } & ", { "pluginId": "observability", "scope": "server", @@ -9995,7 +10495,7 @@ "section": "def-common.SavedObject", "text": "SavedObject" }, - "<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { syncDelay: string; frequency: string; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; sloTransformStats: ", + "<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: 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; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; sloTransformStats: ", "TransformGetTransformStatsResponse", "; dataSample: string | ", "SearchResponse", @@ -10152,6 +10652,8 @@ "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -10159,13 +10661,19 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; total: ", "TypeC", "<{ metrics: ", "ArrayC", "<", + "IntersectionC", + "<[", "TypeC", "<{ name: ", "StringC", @@ -10173,11 +10681,87 @@ "KeyofC", "<{ sum: boolean; }>; field: ", "StringC", - "; }>>; equation: ", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", "StringC", "; }>; timestampField: ", "StringC", - "; }>; }>]>; timeWindow: ", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.histogram.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; timestampField: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; }>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -10267,7 +10851,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - " & { params: { path: { id: string; }; body: { name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; } | undefined; timeWindow?: { duration: ", + " & { params: { path: { id: string; }; body: { name?: string | undefined; description?: string | undefined; indicator?: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; } | undefined; timeWindow?: { duration: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -10307,7 +10891,7 @@ "section": "def-common.Duration", "text": "Duration" }, - " | undefined; } | undefined; tags?: string[] | undefined; }; }; }) => Promise<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; } & ", + " | undefined; } | undefined; tags?: string[] | undefined; }; }; }) => Promise<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -10329,7 +10913,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - " & { params: { path: { id: string; }; }; }) => Promise<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }>; } & ", + " & { params: { path: { id: string; }; }; }) => Promise<{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -10369,7 +10953,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - " & { params?: { query?: { name?: string | undefined; indicatorTypes?: string[] | undefined; page?: string | undefined; perPage?: string | undefined; sortBy?: \"creationTime\" | \"indicatorType\" | undefined; sortDirection?: \"asc\" | \"desc\" | undefined; } | undefined; } | undefined; }) => Promise<{ page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }>; } & ", + " & { params?: { query?: { name?: string | undefined; indicatorTypes?: string[] | undefined; page?: string | undefined; perPage?: string | undefined; sortBy?: \"creationTime\" | \"indicatorType\" | undefined; sortDirection?: \"asc\" | \"desc\" | undefined; } | undefined; } | undefined; }) => Promise<{ page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: string; type: \"rolling\"; } | { duration: string; type: \"calendarAligned\"; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }>; } & ", { "pluginId": "observability", "scope": "server", @@ -10565,55 +11149,139 @@ "TypeC", "<{ index: ", "StringC", - "; filter: ", + "; filter: ", + "StringC", + "; good: ", + "StringC", + "; total: ", + "StringC", + "; timestampField: ", + "StringC", + "; }>; }>, ", + "TypeC", + "<{ type: ", + "LiteralC", + "<\"sli.metric.custom\">; params: ", + "TypeC", + "<{ index: ", + "StringC", + "; filter: ", + "StringC", + "; good: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", + "StringC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>>; equation: ", + "StringC", + "; }>; total: ", + "TypeC", + "<{ metrics: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "TypeC", + "<{ name: ", + "StringC", + "; aggregation: ", + "KeyofC", + "<{ sum: boolean; }>; field: ", "StringC", - "; good: ", + "; }>, ", + "PartialC", + "<{ filter: ", "StringC", - "; total: ", + "; }>]>>; equation: ", "StringC", - "; timestampField: ", + "; }>; timestampField: ", "StringC", "; }>; }>, ", "TypeC", "<{ type: ", "LiteralC", - "<\"sli.metric.custom\">; params: ", + "<\"sli.histogram.custom\">; params: ", "TypeC", "<{ index: ", "StringC", + "; timestampField: ", + "StringC", "; filter: ", "StringC", "; good: ", + "UnionC", + "<[", + "IntersectionC", + "<[", "TypeC", - "<{ metrics: ", - "ArrayC", - "<", - "TypeC", - "<{ name: ", + "<{ field: ", "StringC", "; aggregation: ", - "KeyofC", - "<{ sum: boolean; }>; field: ", - "StringC", - "; }>>; equation: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", "StringC", - "; }>; total: ", + "; }>]>, ", + "IntersectionC", + "<[", "TypeC", - "<{ metrics: ", - "ArrayC", - "<", + "<{ field: ", + "StringC", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", + "StringC", + "; }>]>]>; total: ", + "UnionC", + "<[", + "IntersectionC", + "<[", "TypeC", - "<{ name: ", + "<{ field: ", "StringC", "; aggregation: ", - "KeyofC", - "<{ sum: boolean; }>; field: ", + "LiteralC", + "<\"value_count\">; }>, ", + "PartialC", + "<{ filter: ", "StringC", - "; }>>; equation: ", + "; }>]>, ", + "IntersectionC", + "<[", + "TypeC", + "<{ field: ", "StringC", - "; }>; timestampField: ", + "; aggregation: ", + "LiteralC", + "<\"range\">; from: ", + "NumberC", + "; to: ", + "NumberC", + "; }>, ", + "PartialC", + "<{ filter: ", "StringC", - "; }>; }>]>; timeWindow: ", + "; }>]>]>; }>; }>]>; timeWindow: ", "UnionC", "<[", "TypeC", @@ -10707,7 +11375,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - " & { params: { body: { name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; total: { metrics: { name: string; aggregation: \"sum\"; field: string; }[]; equation: string; }; timestampField: string; }; }; timeWindow: { duration: ", + " & { params: { body: { name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; index: string; } & { filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; timestampField: string; }; } | { type: \"sli.metric.custom\"; params: { index: string; filter: string; good: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; total: { metrics: ({ name: string; aggregation: \"sum\"; field: string; } & { filter?: string | undefined; })[]; equation: string; }; timestampField: string; }; } | { type: \"sli.histogram.custom\"; params: { index: string; timestampField: string; filter: string; good: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); total: ({ field: string; aggregation: \"value_count\"; } & { filter?: string | undefined; }) | ({ field: string; aggregation: \"range\"; from: number; to: number; } & { filter?: string | undefined; }); }; }; timeWindow: { duration: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -13769,6 +14437,117 @@ ], "returnComment": [], "initialIsOpen": false + }, + { + "parentPluginId": "observability", + "id": "def-common.loadCoPilotPrompts", + "type": "Function", + "tags": [], + "label": "loadCoPilotPrompts", + "description": [], + "signature": [ + "() => Promise<{ profilingOptimizeFunction: { params: ", + "TypeC", + "<{ library: ", + "StringC", + "; functionName: ", + "StringC", + "; }>; messages: (params: { library: string; functionName: string; }) => ", + "ChatCompletionRequestMessage", + "[]; }; apmExplainError: { params: ", + "IntersectionC", + "<[", + "TypeC", + "<{ serviceName: ", + "StringC", + "; languageName: ", + "StringC", + "; runtimeName: ", + "StringC", + "; runtimeVersion: ", + "StringC", + "; transactionName: ", + "StringC", + "; logStacktrace: ", + "StringC", + "; exceptionStacktrace: ", + "StringC", + "; }>, ", + "PartialC", + "<{ spanName: ", + "StringC", + "; }>]>; messages: (params: { serviceName: string; languageName: string; runtimeName: string; runtimeVersion: string; transactionName: string; logStacktrace: string; exceptionStacktrace: string; } & { spanName?: string | undefined; }) => ", + "ChatCompletionRequestMessage", + "[]; }; logsExplainMessage: { params: ", + "TypeC", + "<{ logEntry: ", + "TypeC", + "<{ fields: ", + "ArrayC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; value: ", + "ArrayC", + "<", + "AnyC", + ">; }>>; }>; }>; messages: (params: { logEntry: { fields: { field: string; value: any[]; }[]; }; }) => ", + "ChatCompletionRequestMessage", + "[]; }; logsFindSimilar: { params: ", + "TypeC", + "<{ logEntry: ", + "TypeC", + "<{ fields: ", + "ArrayC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; value: ", + "ArrayC", + "<", + "AnyC", + ">; }>>; }>; }>; messages: (params: { logEntry: { fields: { field: string; value: any[]; }[]; }; }) => ", + "ChatCompletionRequestMessage", + "[]; }; infraExplainProcess: { params: ", + "TypeC", + "<{ command: ", + "StringC", + "; }>; messages: (params: { command: string; }) => ", + "ChatCompletionRequestMessage", + "[]; }; explainLogSpike: { params: ", + "TypeC", + "<{ significantFieldValues: ", + "ArrayC", + "<", + "TypeC", + "<{ field: ", + "StringC", + "; value: ", + "UnionC", + "<[", + "StringC", + ", ", + "NumberC", + "]>; docCount: ", + "NumberC", + "; pValue: ", + "UnionC", + "<[", + "NumberC", + ", ", + "NullC", + "]>; }>>; }>; messages: (params: { significantFieldValues: { field: string; value: string | number; docCount: number; pValue: number | null; }[]; }) => ", + "ChatCompletionRequestMessage", + "[]; }; }>" + ], + "path": "x-pack/plugins/observability/common/co_pilot/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [], + "initialIsOpen": false } ], "interfaces": [ @@ -13891,7 +14670,7 @@ "tags": [], "label": "CoPilotPromptId", "description": [], - "path": "x-pack/plugins/observability/common/co_pilot.ts", + "path": "x-pack/plugins/observability/common/co_pilot/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -14407,6 +15186,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "observability", + "id": "def-common.sloEditLocatorID", + "type": "string", + "tags": [], + "label": "sloEditLocatorID", + "description": [], + "signature": [ + "\"SLO_EDIT_LOCATOR\"" + ], + "path": "x-pack/plugins/observability/common/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-common.sloFeatureId", @@ -14696,221 +15490,6 @@ "initialIsOpen": false } ], - "objects": [ - { - "parentPluginId": "observability", - "id": "def-common.coPilotPrompts", - "type": "Object", - "tags": [], - "label": "coPilotPrompts", - "description": [], - "path": "x-pack/plugins/observability/common/co_pilot.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "observability", - "id": "def-common.coPilotPrompts.CoPilotPromptId.ProfilingOptimizeFunction", - "type": "Object", - "tags": [], - "label": "[CoPilotPromptId.ProfilingOptimizeFunction]", - "description": [], - "signature": [ - "{ params: ", - "TypeC", - "<{ library: ", - "StringC", - "; functionName: ", - "StringC", - "; }>; messages: (params: { library: string; functionName: string; }) => ", - "ChatCompletionRequestMessage", - "[]; }" - ], - "path": "x-pack/plugins/observability/common/co_pilot.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-common.coPilotPrompts.CoPilotPromptId.ProfilingExplainFunction", - "type": "Object", - "tags": [], - "label": "[CoPilotPromptId.ProfilingExplainFunction]", - "description": [], - "signature": [ - "{ params: ", - "TypeC", - "<{ library: ", - "StringC", - "; functionName: ", - "StringC", - "; }>; messages: (params: { library: string; functionName: string; }) => ", - "ChatCompletionRequestMessage", - "[]; }" - ], - "path": "x-pack/plugins/observability/common/co_pilot.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-common.coPilotPrompts.CoPilotPromptId.ApmExplainError", - "type": "Object", - "tags": [], - "label": "[CoPilotPromptId.ApmExplainError]", - "description": [], - "signature": [ - "{ params: ", - "IntersectionC", - "<[", - "TypeC", - "<{ serviceName: ", - "StringC", - "; languageName: ", - "StringC", - "; runtimeName: ", - "StringC", - "; runtimeVersion: ", - "StringC", - "; transactionName: ", - "StringC", - "; logStacktrace: ", - "StringC", - "; exceptionStacktrace: ", - "StringC", - "; }>, ", - "PartialC", - "<{ spanName: ", - "StringC", - "; }>]>; messages: (params: { serviceName: string; languageName: string; runtimeName: string; runtimeVersion: string; transactionName: string; logStacktrace: string; exceptionStacktrace: string; } & { spanName?: string | undefined; }) => ", - "ChatCompletionRequestMessage", - "[]; }" - ], - "path": "x-pack/plugins/observability/common/co_pilot.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-common.coPilotPrompts.CoPilotPromptId.LogsExplainMessage", - "type": "Object", - "tags": [], - "label": "[CoPilotPromptId.LogsExplainMessage]", - "description": [], - "signature": [ - "{ params: ", - "TypeC", - "<{ logEntry: ", - "TypeC", - "<{ fields: ", - "ArrayC", - "<", - "TypeC", - "<{ field: ", - "StringC", - "; value: ", - "ArrayC", - "<", - "AnyC", - ">; }>>; }>; }>; messages: (params: { logEntry: { fields: { field: string; value: any[]; }[]; }; }) => ", - "ChatCompletionRequestMessage", - "[]; }" - ], - "path": "x-pack/plugins/observability/common/co_pilot.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-common.coPilotPrompts.CoPilotPromptId.LogsFindSimilar", - "type": "Object", - "tags": [], - "label": "[CoPilotPromptId.LogsFindSimilar]", - "description": [], - "signature": [ - "{ params: ", - "TypeC", - "<{ logEntry: ", - "TypeC", - "<{ fields: ", - "ArrayC", - "<", - "TypeC", - "<{ field: ", - "StringC", - "; value: ", - "ArrayC", - "<", - "AnyC", - ">; }>>; }>; }>; messages: (params: { logEntry: { fields: { field: string; value: any[]; }[]; }; }) => ", - "ChatCompletionRequestMessage", - "[]; }" - ], - "path": "x-pack/plugins/observability/common/co_pilot.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-common.coPilotPrompts.CoPilotPromptId.InfraExplainProcess", - "type": "Object", - "tags": [], - "label": "[CoPilotPromptId.InfraExplainProcess]", - "description": [], - "signature": [ - "{ params: ", - "TypeC", - "<{ command: ", - "StringC", - "; }>; messages: (params: { command: string; }) => ", - "ChatCompletionRequestMessage", - "[]; }" - ], - "path": "x-pack/plugins/observability/common/co_pilot.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "observability", - "id": "def-common.coPilotPrompts.CoPilotPromptId.ExplainLogSpike", - "type": "Object", - "tags": [], - "label": "[CoPilotPromptId.ExplainLogSpike]", - "description": [], - "signature": [ - "{ params: ", - "TypeC", - "<{ significantFieldValues: ", - "ArrayC", - "<", - "TypeC", - "<{ field: ", - "StringC", - "; value: ", - "UnionC", - "<[", - "StringC", - ", ", - "NumberC", - "]>; docCount: ", - "NumberC", - "; pValue: ", - "UnionC", - "<[", - "NumberC", - ", ", - "NullC", - "]>; }>>; }>; messages: (params: { significantFieldValues: { field: string; value: string | number; docCount: number; pValue: number | null; }[]; }) => ", - "ChatCompletionRequestMessage", - "[]; }" - ], - "path": "x-pack/plugins/observability/common/co_pilot.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - } - ] + "objects": [] } } \ No newline at end of file diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index f659ad371e458..e3991f30607e3 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observability title: "observability" image: https://source.unsplash.com/400x175/?github description: API docs for the observability plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability'] --- import observabilityObj from './observability.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/actionable-observability](https://github.com/orgs/elastic/team | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 526 | 45 | 518 | 18 | +| 524 | 45 | 516 | 19 | ## Client @@ -62,9 +62,6 @@ Contact [@elastic/actionable-observability](https://github.com/orgs/elastic/team ## Common -### Objects - - ### Functions diff --git a/api_docs/observability_onboarding.mdx b/api_docs/observability_onboarding.mdx index f537d38868270..3a9e4887551e1 100644 --- a/api_docs/observability_onboarding.mdx +++ b/api_docs/observability_onboarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityOnboarding title: "observabilityOnboarding" image: https://source.unsplash.com/400x175/?github description: API docs for the observabilityOnboarding plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityOnboarding'] --- import observabilityOnboardingObj from './observability_onboarding.devdocs.json'; diff --git a/api_docs/observability_shared.devdocs.json b/api_docs/observability_shared.devdocs.json index feb7bb8ca1537..2a32f416393dd 100644 --- a/api_docs/observability_shared.devdocs.json +++ b/api_docs/observability_shared.devdocs.json @@ -664,9 +664,31 @@ "label": "SectionLink", "description": [], "signature": [ - "(props: ", - "EuiListGroupItemProps", - ") => JSX.Element" + "({\n showNewBadge,\n ...props\n}: ", + "CommonProps", + " & Omit<(", + "DisambiguateSet", + "<(", + "DisambiguateSet", + ", Omit, \"href\">> & Omit, \"href\">) | (", + "DisambiguateSet", + ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes), React.HTMLAttributes> & React.HTMLAttributes) | (", + "DisambiguateSet", + ", (", + "DisambiguateSet", + ", Omit, \"href\">> & Omit, \"href\">) | (", + "DisambiguateSet", + ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes)> & ((", + "DisambiguateSet", + ", Omit, \"href\">> & Omit, \"href\">) | (", + "DisambiguateSet", + ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes))), \"color\" | \"onClick\" | \"rel\" | \"target\"> & { size?: \"m\" | \"s\" | \"xs\" | \"l\" | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; label: React.ReactNode; isActive?: boolean | undefined; isDisabled?: boolean | undefined; href?: string | undefined; target?: string | undefined; rel?: string | undefined; iconType?: ", + "IconType", + " | undefined; iconProps?: Omit<", + "EuiIconProps", + ", \"type\"> | undefined; icon?: React.ReactElement> | undefined; showToolTip?: boolean | undefined; extraAction?: ", + "EuiListGroupItemExtraActionProps", + " | undefined; onClick?: React.MouseEventHandler | undefined; wrapText?: boolean | undefined; buttonRef?: React.Ref | undefined; toolTipText?: string | undefined; } & { showNewBadge?: boolean | undefined; }) => JSX.Element" ], "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", "deprecated": false, @@ -677,10 +699,33 @@ "id": "def-public.SectionLink.$1", "type": "CompoundType", "tags": [], - "label": "props", + "label": "{\n showNewBadge,\n ...props\n}", "description": [], "signature": [ - "EuiListGroupItemProps" + "CommonProps", + " & Omit<(", + "DisambiguateSet", + "<(", + "DisambiguateSet", + ", Omit, \"href\">> & Omit, \"href\">) | (", + "DisambiguateSet", + ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes), React.HTMLAttributes> & React.HTMLAttributes) | (", + "DisambiguateSet", + ", (", + "DisambiguateSet", + ", Omit, \"href\">> & Omit, \"href\">) | (", + "DisambiguateSet", + ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes)> & ((", + "DisambiguateSet", + ", Omit, \"href\">> & Omit, \"href\">) | (", + "DisambiguateSet", + ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes))), \"color\" | \"onClick\" | \"rel\" | \"target\"> & { size?: \"m\" | \"s\" | \"xs\" | \"l\" | undefined; color?: \"text\" | \"subdued\" | \"primary\" | undefined; label: React.ReactNode; isActive?: boolean | undefined; isDisabled?: boolean | undefined; href?: string | undefined; target?: string | undefined; rel?: string | undefined; iconType?: ", + "IconType", + " | undefined; iconProps?: Omit<", + "EuiIconProps", + ", \"type\"> | undefined; icon?: React.ReactElement> | undefined; showToolTip?: boolean | undefined; extraAction?: ", + "EuiListGroupItemExtraActionProps", + " | undefined; onClick?: React.MouseEventHandler | undefined; wrapText?: boolean | undefined; buttonRef?: React.Ref | undefined; toolTipText?: string | undefined; } & { showNewBadge?: boolean | undefined; }" ], "path": "x-pack/plugins/observability_shared/public/components/section/section.tsx", "deprecated": false, @@ -876,6 +921,39 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "observabilityShared", + "id": "def-public.TechnicalPreviewBadge", + "type": "Function", + "tags": [], + "label": "TechnicalPreviewBadge", + "description": [], + "signature": [ + "({ icon = 'beaker', size, style }: Props) => JSX.Element" + ], + "path": "x-pack/plugins/observability_shared/public/components/technical_preview_badge/technical_preview_badge.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observabilityShared", + "id": "def-public.TechnicalPreviewBadge.$1", + "type": "CompoundType", + "tags": [], + "label": "{ icon = 'beaker', size, style }", + "description": [], + "signature": [ + "Props" + ], + "path": "x-pack/plugins/observability_shared/public/components/technical_preview_badge/technical_preview_badge.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "observabilityShared", "id": "def-public.useBreadcrumbs", diff --git a/api_docs/observability_shared.mdx b/api_docs/observability_shared.mdx index 70f73a7877b81..78a1f5e81fae7 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: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityShared'] --- import observabilitySharedObj from './observability_shared.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/observability-ui](https://github.com/orgs/elastic/teams/observ | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 266 | 1 | 265 | 11 | +| 268 | 1 | 267 | 11 | ## Client diff --git a/api_docs/osquery.devdocs.json b/api_docs/osquery.devdocs.json index 9b6da7eb49e58..d3d03ad153894 100644 --- a/api_docs/osquery.devdocs.json +++ b/api_docs/osquery.devdocs.json @@ -134,7 +134,7 @@ "LiveQueryQueryFieldProps", " & { formMethods: ", "UseFormReturn", - "<{ label: string; query: string; ecs_mapping: Record; }, any>; }) => JSX.Element) | undefined" + "<{ label: string; query: string; ecs_mapping: Record; }, any, undefined>; }) => JSX.Element) | undefined" ], "path": "x-pack/plugins/osquery/public/types.ts", "deprecated": false, diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index 003296222d067..bedd294382615 100644 --- a/api_docs/osquery.mdx +++ b/api_docs/osquery.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/osquery title: "osquery" image: https://source.unsplash.com/400x175/?github description: API docs for the osquery plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery'] --- import osqueryObj from './osquery.devdocs.json'; diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index 51ac1717b3c95..e65003ea414ae 100644 --- a/api_docs/plugin_directory.mdx +++ b/api_docs/plugin_directory.mdx @@ -7,7 +7,7 @@ id: kibDevDocsPluginDirectory slug: /kibana-dev-docs/api-meta/plugin-api-directory title: Directory description: Directory of public APIs available through plugins or packages. -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -15,34 +15,34 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Count | Plugins or Packages with a
public API | Number of teams | |--------------|----------|------------------------| -| 642 | 533 | 38 | +| 646 | 537 | 38 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 70934 | 544 | 60753 | 1406 | +| 71459 | 552 | 61221 | 1459 | ## Plugin Directory | Plugin name           | Maintaining team | Description | API Cnt | Any Cnt | Missing
comments | Missing
exports | |--------------|----------------|-----------|--------------|----------|---------------|--------| -| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 268 | 10 | 263 | 27 | +| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 272 | 10 | 267 | 27 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 36 | 1 | 32 | 2 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | AIOps plugin maintained by ML team. | 45 | 0 | 27 | 1 | -| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 635 | 1 | 611 | 47 | +| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 795 | 1 | 765 | 48 | | | [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) | The user interface for Elastic APM | 48 | 0 | 48 | 113 | | | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | Asset manager plugin for entity assets (inventory, topology, etc) | 3 | 0 | 3 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 9 | 0 | 9 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Considering using bfetch capabilities when fetching large amounts of data. This services supports batching HTTP requests and streaming responses back. | 91 | 1 | 75 | 2 | | | [@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 | 80 | 0 | 65 | 26 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 271 | 16 | 256 | 10 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 52 | 0 | 11 | 0 | +| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | The Case management system in Kibana | 80 | 0 | 65 | 27 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 268 | 16 | 253 | 10 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 61 | 0 | 13 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | Chat available on Elastic Cloud deployments for quicker assistance. | 3 | 0 | 2 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | This plugin exists as a workaround for using `cloudChat` plugin in plugins which can't have a direct dependency on security plugin. | 5 | 0 | 5 | 0 | | | [@elastic/platform-onboarding](https://github.com/orgs/elastic/teams/platform-onboarding) | Static migration page where self-managed users can see text/copy about migrating to Elastic Cloud | 8 | 1 | 8 | 1 | -| | [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/teams/sec-cloudnative-integrations) | Defend for containers (D4C) | 24 | 0 | 16 | 2 | +| | [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/teams/sec-cloudnative-integrations) | Defend for containers (D4C) | 52 | 0 | 43 | 2 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | Provides the necessary APIs to implement A/B testing scenarios, fetching the variations in configuration and reporting back metrics to track conversion rates of the experiments. | 12 | 0 | 0 | 0 | | cloudFullStory | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | When Kibana runs on Elastic Cloud, this plugin registers FullStory as a shipper for telemetry. | 0 | 0 | 0 | 0 | | cloudGainsight | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | When Kibana runs on Elastic Cloud, this plugin registers Gainsight as a shipper for telemetry. | 0 | 0 | 0 | 0 | @@ -56,24 +56,23 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@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 | 100 | 0 | 98 | 9 | | | [@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. | 3303 | 119 | 2579 | 27 | +| | [@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. | 3291 | 119 | 2571 | 27 | | | [@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 | 16 | 0 | 7 | 0 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | Reusable data view field editor across Kibana | 72 | 0 | 33 | 0 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | Data view management app | 2 | 0 | 2 | 0 | -| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | 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. | 1048 | 0 | 258 | 2 | +| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | 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. | 1009 | 0 | 243 | 2 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | The Data Visualizer tools help you understand your data, by analyzing the metrics and fields in a log file or an existing Elasticsearch index. | 28 | 3 | 24 | 0 | -| | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 10 | 0 | 8 | 2 | +| | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 12 | 0 | 10 | 3 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the Discover application and the saved search embeddable. | 97 | 0 | 71 | 14 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 37 | 0 | 35 | 2 | | discoverLogExplorer | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | This plugin exposes and registers Logs+ features. | 0 | 0 | 0 | 0 | | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | APIs used to assess the quality of data in Elasticsearch indexes | 2 | 0 | 0 | 0 | -| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds embeddables service to Kibana | 548 | 11 | 444 | 4 | +| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds embeddables service to Kibana | 532 | 11 | 434 | 7 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Extends embeddable plugin with more functionality | 14 | 0 | 14 | 0 | | | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides encryption and decryption utilities for saved objects containing sensitive information. | 51 | 0 | 44 | 0 | | | [@elastic/enterprise-search-frontend](https://github.com/orgs/elastic/teams/enterprise-search-frontend) | Adds dashboards for discovering and managing Enterprise Search products. | 10 | 0 | 10 | 0 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 115 | 3 | 111 | 3 | -| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | ESS customizations for Security Solution. | 6 | 0 | 6 | 0 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | The Event Annotation service contains expressions for event annotations | 234 | 30 | 234 | 4 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | The Event Annotation service contains expressions for event annotations | 236 | 30 | 236 | 4 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 116 | 0 | 116 | 11 | | | [@elastic/uptime](https://github.com/orgs/elastic/teams/uptime) | - | 141 | 1 | 141 | 14 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'error' renderer to expressions | 17 | 0 | 15 | 2 | @@ -95,7 +94,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | The file upload plugin contains components and services for uploading a file, analyzing its data, and then importing the data into an Elasticsearch index. Supported file types include CSV, TSV, newline-delimited JSON and GeoJSON. | 62 | 0 | 62 | 2 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | File upload, download, sharing, and serving over HTTP implementation in Kibana. | 239 | 0 | 24 | 9 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Simple UI for managing files in Kibana | 2 | 1 | 2 | 0 | -| | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1191 | 3 | 1075 | 36 | +| | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1182 | 3 | 1066 | 40 | | ftrApis | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 68 | 0 | 14 | 5 | | globalSearchBar | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 0 | 0 | 0 | 0 | @@ -107,38 +106,39 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Image embeddable | 3 | 0 | 3 | 1 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 4 | 0 | 4 | 0 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 177 | 0 | 172 | 3 | -| | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | This plugin visualizes data from Filebeat and Metricbeat, and integrates with other Observability solutions | 49 | 0 | 46 | 14 | +| | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | This plugin visualizes data from Filebeat and Metricbeat, and integrates with other Observability solutions | 44 | 0 | 41 | 11 | | ingestPipelines | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | | inputControlVis | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Input Control visualization to Kibana | 0 | 0 | 0 | 0 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | - | 123 | 2 | 96 | 4 | | | [@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/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) | - | 184 | 1 | 153 | 5 | +| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 185 | 1 | 154 | 5 | | kibanaUsageCollection | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | | | [@elastic/kibana-app-services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 609 | 3 | 416 | 9 | | | [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/teams/sec-cloudnative-integrations) | - | 5 | 0 | 5 | 1 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 622 | 0 | 527 | 58 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 616 | 0 | 519 | 61 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 8 | 0 | 8 | 0 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 4 | 0 | 4 | 1 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 117 | 0 | 42 | 10 | | | [@elastic/security-detection-engine](https://github.com/orgs/elastic/teams/security-detection-engine) | - | 210 | 0 | 94 | 51 | +| | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | Exposes the shared components and APIs to access and visualize logs. | 269 | 10 | 256 | 27 | | logstash | [@elastic/logstash](https://github.com/orgs/elastic/teams/logstash) | - | 0 | 0 | 0 | 0 | -| | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 43 | 0 | 43 | 6 | -| | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 266 | 0 | 265 | 28 | +| | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 47 | 0 | 47 | 7 | +| | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 262 | 0 | 261 | 28 | | | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 67 | 0 | 67 | 0 | -| | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the machine learning features provided by Elastic. | 150 | 3 | 64 | 33 | +| | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the machine learning features provided by Elastic. | 150 | 3 | 64 | 32 | | | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | - | 15 | 3 | 13 | 1 | | | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | - | 9 | 0 | 9 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 34 | 0 | 34 | 2 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 17 | 0 | 17 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 2 | 0 | 2 | 1 | -| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 526 | 45 | 518 | 18 | +| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 524 | 45 | 516 | 19 | | | [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) | - | 7 | 0 | 7 | 0 | -| | [@elastic/observability-ui](https://github.com/orgs/elastic/teams/observability-ui) | - | 266 | 1 | 265 | 11 | +| | [@elastic/observability-ui](https://github.com/orgs/elastic/teams/observability-ui) | - | 268 | 1 | 267 | 11 | | | [@elastic/security-defend-workflows](https://github.com/orgs/elastic/teams/security-defend-workflows) | - | 24 | 0 | 24 | 7 | | painlessLab | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 218 | 8 | 164 | 11 | -| | [@elastic/profiling-ui](https://github.com/orgs/elastic/teams/profiling-ui) | - | 16 | 2 | 16 | 0 | +| | [@elastic/profiling-ui](https://github.com/orgs/elastic/teams/profiling-ui) | - | 19 | 2 | 19 | 3 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 4 | 0 | 4 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Reporting Services enables applications to feature reports that the user can automate with Watcher and download later. | 38 | 0 | 18 | 3 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Currently PDF, PNG or CSV export types for the reporting plugin | 4 | 0 | 4 | 0 | @@ -150,16 +150,17 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 154 | 0 | 140 | 2 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 79 | 0 | 73 | 3 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 100 | 0 | 52 | 1 | -| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the definition and helper methods around saved searches, used by discover and visualizations. | 59 | 0 | 58 | 2 | +| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the definition and helper methods around saved searches, used by discover and visualizations. | 62 | 0 | 61 | 3 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 32 | 0 | 13 | 0 | | | [@elastic/kibana-reporting-services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Kibana Screenshotting Plugin | 27 | 0 | 8 | 5 | | searchprofiler | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | -| | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user. | 283 | 0 | 94 | 1 | -| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | - | 159 | 2 | 115 | 30 | +| | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user. | 287 | 0 | 96 | 2 | +| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | - | 176 | 2 | 132 | 30 | +| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | ESS customizations for Security Solution. | 6 | 0 | 6 | 0 | +| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | Serverless customizations for security. | 6 | 0 | 6 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | The core Serverless plugin, providing APIs to Serverless Project plugins. | 17 | 0 | 16 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Serverless customizations for observability. | 6 | 0 | 6 | 0 | | | [@elastic/enterprise-search-frontend](https://github.com/orgs/elastic/teams/enterprise-search-frontend) | Serverless customizations for search. | 6 | 0 | 6 | 0 | -| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | Serverless customizations for security. | 6 | 0 | 6 | 0 | | | [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/teams/sec-cloudnative-integrations) | - | 134 | 0 | 134 | 8 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Adds URL Service and sharing capabilities to Kibana | 119 | 0 | 60 | 10 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 22 | 1 | 22 | 1 | @@ -167,7 +168,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 14 | 0 | 14 | 3 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 4 | 0 | 4 | 1 | | synthetics | [@elastic/uptime](https://github.com/orgs/elastic/teams/uptime) | This plugin visualizes data from Synthetics and Heartbeat, and integrates with other Observability solutions. | 0 | 0 | 0 | 0 | -| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 85 | 0 | 43 | 6 | +| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 96 | 0 | 53 | 6 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 45 | 0 | 1 | 0 | | | [@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 | @@ -177,11 +178,11 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 257 | 1 | 213 | 22 | | | [@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 | | translations | [@elastic/kibana-localization](https://github.com/orgs/elastic/teams/kibana-localization) | - | 0 | 0 | 0 | 0 | -| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 547 | 11 | 521 | 49 | +| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 560 | 11 | 534 | 50 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Adds UI Actions service to Kibana | 144 | 2 | 102 | 9 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Extends UI Actions plugin with more functionality | 206 | 0 | 140 | 9 | -| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | The `unifiedHistogram` plugin provides UI components to create a layout including a resizable histogram and a main display. | 52 | 0 | 23 | 2 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Contains all the key functionality of Kibana's unified search experience.Contains all the key functionality of Kibana's unified search experience. | 137 | 2 | 100 | 20 | +| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | The `unifiedHistogram` plugin provides UI components to create a layout including a resizable histogram and a main display. | 53 | 0 | 23 | 2 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Contains all the key functionality of Kibana's unified search experience.Contains all the key functionality of Kibana's unified search experience. | 140 | 2 | 102 | 21 | | upgradeAssistant | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | | uptime | [@elastic/uptime](https://github.com/orgs/elastic/teams/uptime) | This plugin visualizes data from Heartbeat, and integrates with other Observability solutions. | 0 | 0 | 0 | 0 | | urlDrilldown | [@elastic/kibana-app-services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds drilldown implementations to Kibana | 0 | 0 | 0 | 0 | @@ -214,7 +215,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 58 | 0 | 2 | 0 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 16 | 0 | 15 | 0 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 24 | 0 | 24 | 0 | -| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 5 | 0 | 4 | 0 | +| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 8 | 0 | 7 | 1 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 73 | 0 | 73 | 2 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 98 | 0 | 0 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 19 | 0 | 0 | 0 | @@ -228,7 +229,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) | - | 11 | 0 | 11 | 0 | | | [@elastic/kibana-qa](https://github.com/orgs/elastic/teams/kibana-qa) | - | 12 | 0 | 12 | 0 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 19 | 0 | 17 | 0 | -| | [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) | - | 62 | 1 | 44 | 2 | +| | [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) | - | 62 | 1 | 44 | 3 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 11 | 0 | 8 | 0 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 78 | 0 | 78 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 7 | 0 | 2 | 0 | @@ -267,7 +268,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) | - | 16 | 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) | - | 157 | 0 | 61 | 0 | +| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 166 | 0 | 67 | 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 | @@ -307,13 +308,13 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 111 | 4 | 36 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 10 | 0 | 10 | 1 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 16 | 0 | 16 | 0 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 7 | 0 | 2 | 0 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 8 | 0 | 3 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 10 | 1 | 10 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 14 | 0 | 11 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 22 | 0 | 7 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 9 | 0 | 9 | 3 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 7 | 0 | 7 | 0 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 26 | 6 | 26 | 1 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 26 | 6 | 26 | 2 | | | [@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) | - | 447 | 1 | 178 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 58 | 0 | 52 | 6 | @@ -371,9 +372,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 73 | 0 | 40 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 26 | 0 | 23 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 4 | 0 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 123 | 0 | 89 | 46 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 124 | 0 | 90 | 46 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 12 | 0 | 12 | 0 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 535 | 1 | 115 | 4 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 548 | 1 | 122 | 4 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 69 | 0 | 69 | 4 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 14 | 0 | 14 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 36 | 0 | 6 | 0 | @@ -410,7 +411,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 44 | 0 | 43 | 0 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 5 | 0 | 5 | 0 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 5 | 0 | 5 | 0 | -| | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 4 | 0 | 4 | 2 | +| | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 4 | 0 | 4 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 3 | 0 | 3 | 0 | | | [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) | - | 3 | 0 | 3 | 0 | | | [@elastic/enterprise-search-frontend](https://github.com/orgs/elastic/teams/enterprise-search-frontend) | - | 4 | 0 | 4 | 0 | @@ -422,17 +423,17 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 101 | 0 | 85 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 15 | 0 | 9 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 27 | 2 | 24 | 0 | -| | [@elastic/docs](https://github.com/orgs/elastic/teams/docs) | - | 71 | 0 | 71 | 2 | +| | [@elastic/docs](https://github.com/orgs/elastic/teams/docs) | - | 72 | 0 | 72 | 2 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 1 | 0 | 1 | 0 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 52 | 0 | 34 | 4 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 39 | 0 | 26 | 5 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 19 | 0 | 11 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 35125 | 0 | 34718 | 0 | | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 13 | 2 | 5 | 0 | -| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | - | 84 | 4 | 64 | 3 | +| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | - | 64 | 2 | 45 | 3 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 4 | 0 | 4 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 27 | 0 | 14 | 1 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 7 | 0 | 3 | 0 | -| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 255 | 1 | 197 | 15 | +| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 253 | 1 | 194 | 15 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 12 | 0 | 12 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 2 | 0 | 1 | 0 | | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 33 | 0 | 13 | 3 | @@ -463,7 +464,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 27 | 0 | 1 | 2 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 8 | 0 | 8 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 6 | 0 | 1 | 1 | -| | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 535 | 1 | 1 | 0 | +| | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 10 | 0 | 10 | 1 | +| | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 2 | 0 | 0 | 0 | +| | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 582 | 1 | 1 | 0 | | | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 2 | 0 | 2 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 96 | 2 | 61 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 206 | 3 | 1 | 0 | @@ -502,6 +505,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 6 | 0 | 6 | 1 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 73 | 0 | 65 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 13 | 2 | 8 | 0 | +| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 16 | 0 | 16 | 1 | | | [@elastic/security-detections-response](https://github.com/orgs/elastic/teams/security-detections-response) | - | 107 | 0 | 104 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 2 | 0 | 2 | 0 | | | [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) | - | 41 | 0 | 35 | 0 | @@ -533,7 +537,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 40 | 0 | 3 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 8 | 0 | 4 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 13 | 0 | 9 | 0 | -| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 27 | 0 | 10 | 0 | +| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 28 | 0 | 10 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 10 | 0 | 4 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 32 | 0 | 28 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 45 | 0 | 36 | 4 | @@ -568,7 +572,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 2 | 0 | 0 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 15 | 0 | 4 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 9 | 0 | 3 | 0 | -| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 123 | 0 | 123 | 0 | +| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 126 | 0 | 126 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 20 | 0 | 12 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 102 | 2 | 65 | 1 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 4 | 0 | 2 | 0 | @@ -584,7 +588,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 49 | 2 | 35 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 47 | 0 | 38 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 7 | 0 | 6 | 0 | -| | [@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 | 293 | 0 | 267 | 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 | 306 | 0 | 277 | 9 | | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 4 | 0 | 0 | 0 | | | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | - | 58 | 0 | 5 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 36 | 0 | 15 | 1 | diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index 1eeb613f16ae5..53fd34d8451c2 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/presentationUtil title: "presentationUtil" image: https://source.unsplash.com/400x175/?github description: API docs for the presentationUtil plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] --- import presentationUtilObj from './presentation_util.devdocs.json'; diff --git a/api_docs/profiling.devdocs.json b/api_docs/profiling.devdocs.json index ffbf4ae66b115..f04ea1963d5d8 100644 --- a/api_docs/profiling.devdocs.json +++ b/api_docs/profiling.devdocs.json @@ -5,8 +5,115 @@ "functions": [], "interfaces": [], "enums": [], - "misc": [], - "objects": [] + "misc": [ + { + "parentPluginId": "profiling", + "id": "def-public.ProfilingLocators", + "type": "Type", + "tags": [], + "label": "ProfilingLocators", + "description": [], + "signature": [ + "{ flamegraphLocator: ", + { + "pluginId": "share", + "scope": "common", + "docId": "kibSharePluginApi", + "section": "def-common.LocatorPublic", + "text": "LocatorPublic" + }, + "<", + "FlamegraphLocatorParams", + ">; topNFunctionsLocator: ", + { + "pluginId": "share", + "scope": "common", + "docId": "kibSharePluginApi", + "section": "def-common.LocatorPublic", + "text": "LocatorPublic" + }, + "<", + "TopNFunctionsLocatorParams", + ">; stacktracesLocator: ", + { + "pluginId": "share", + "scope": "common", + "docId": "kibSharePluginApi", + "section": "def-common.LocatorPublic", + "text": "LocatorPublic" + }, + "<", + "StacktracesLocatorParams", + ">; }" + ], + "path": "x-pack/plugins/profiling/public/index.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "profiling", + "id": "def-public.ProfilingPluginSetup", + "type": "Type", + "tags": [], + "label": "ProfilingPluginSetup", + "description": [], + "signature": [ + "{ locators: { flamegraphLocator: ", + { + "pluginId": "share", + "scope": "common", + "docId": "kibSharePluginApi", + "section": "def-common.LocatorPublic", + "text": "LocatorPublic" + }, + "<", + "FlamegraphLocatorParams", + ">; topNFunctionsLocator: ", + { + "pluginId": "share", + "scope": "common", + "docId": "kibSharePluginApi", + "section": "def-common.LocatorPublic", + "text": "LocatorPublic" + }, + "<", + "TopNFunctionsLocatorParams", + ">; stacktracesLocator: ", + { + "pluginId": "share", + "scope": "common", + "docId": "kibSharePluginApi", + "section": "def-common.LocatorPublic", + "text": "LocatorPublic" + }, + "<", + "StacktracesLocatorParams", + ">; }; hasSetup: () => Promise; }" + ], + "path": "x-pack/plugins/profiling/public/plugin.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [], + "start": { + "parentPluginId": "profiling", + "id": "def-public.ProfilingPluginStart", + "type": "Type", + "tags": [], + "label": "ProfilingPluginStart", + "description": [], + "signature": [ + "void" + ], + "path": "x-pack/plugins/profiling/public/plugin.tsx", + "deprecated": false, + "trackAdoption": false, + "lifecycle": "start", + "initialIsOpen": true + } }, "server": { "classes": [], diff --git a/api_docs/profiling.mdx b/api_docs/profiling.mdx index bc9128a687c97..7582d5cd6f38b 100644 --- a/api_docs/profiling.mdx +++ b/api_docs/profiling.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/profiling title: "profiling" image: https://source.unsplash.com/400x175/?github description: API docs for the profiling plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'profiling'] --- import profilingObj from './profiling.devdocs.json'; @@ -21,7 +21,15 @@ Contact [@elastic/profiling-ui](https://github.com/orgs/elastic/teams/profiling- | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 16 | 2 | 16 | 0 | +| 19 | 2 | 19 | 3 | + +## Client + +### Start + + +### Consts, variables and types + ## Server diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index 8c6210ad985e6..a7b0e4fea1669 100644 --- a/api_docs/remote_clusters.mdx +++ b/api_docs/remote_clusters.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/remoteClusters title: "remoteClusters" image: https://source.unsplash.com/400x175/?github description: API docs for the remoteClusters plugin -date: 2023-06-30 +date: 2023-07-18 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 0ace0410ae071..270835a793835 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/reporting title: "reporting" image: https://source.unsplash.com/400x175/?github description: API docs for the reporting plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting'] --- import reportingObj from './reporting.devdocs.json'; diff --git a/api_docs/reporting_export_types.mdx b/api_docs/reporting_export_types.mdx index c2e8d52c452a0..75c235878db3c 100644 --- a/api_docs/reporting_export_types.mdx +++ b/api_docs/reporting_export_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/reportingExportTypes title: "reportingExportTypes" image: https://source.unsplash.com/400x175/?github description: API docs for the reportingExportTypes plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reportingExportTypes'] --- import reportingExportTypesObj from './reporting_export_types.devdocs.json'; diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx index 1f587ce70bc3e..2268d9e7091c2 100644 --- a/api_docs/rollup.mdx +++ b/api_docs/rollup.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/rollup title: "rollup" image: https://source.unsplash.com/400x175/?github description: API docs for the rollup plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup'] --- import rollupObj from './rollup.devdocs.json'; diff --git a/api_docs/rule_registry.devdocs.json b/api_docs/rule_registry.devdocs.json index 7e44746cb06d8..6ac7b0b8c383a 100644 --- a/api_docs/rule_registry.devdocs.json +++ b/api_docs/rule_registry.devdocs.json @@ -626,7 +626,7 @@ "label": "getBrowserFields", "description": [], "signature": [ - "({ indices, metaFields, allowNoIndex, }: { indices: string[]; metaFields: string[]; allowNoIndex: boolean; }) => Promise<", + "({ indices, metaFields, allowNoIndex, }: { indices: string[]; metaFields: string[]; allowNoIndex: boolean; }) => Promise<{ browserFields: ", { "pluginId": "ruleRegistry", "scope": "common", @@ -634,7 +634,15 @@ "section": "def-common.BrowserFields", "text": "BrowserFields" }, - ">" + "; fields: ", + { + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.FieldDescriptor", + "text": "FieldDescriptor" + }, + "[]; }>" ], "path": "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts", "deprecated": false, diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index 84ee443e918cb..291349a091432 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ruleRegistry title: "ruleRegistry" image: https://source.unsplash.com/400x175/?github description: API docs for the ruleRegistry plugin -date: 2023-06-30 +date: 2023-07-18 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 4dba794d349ef..9414250f6d0dc 100644 --- a/api_docs/runtime_fields.mdx +++ b/api_docs/runtime_fields.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/runtimeFields title: "runtimeFields" image: https://source.unsplash.com/400x175/?github description: API docs for the runtimeFields plugin -date: 2023-06-30 +date: 2023-07-18 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 09365c173b96d..8ec1300a7736b 100644 --- a/api_docs/saved_objects.mdx +++ b/api_docs/saved_objects.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjects title: "savedObjects" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjects plugin -date: 2023-06-30 +date: 2023-07-18 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 9855c48ba90d0..b3c91d5320846 100644 --- a/api_docs/saved_objects_finder.mdx +++ b/api_docs/saved_objects_finder.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsFinder title: "savedObjectsFinder" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsFinder plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsFinder'] --- import savedObjectsFinderObj from './saved_objects_finder.devdocs.json'; diff --git a/api_docs/saved_objects_management.devdocs.json b/api_docs/saved_objects_management.devdocs.json index 8a3496a40bb3a..e1a1f39f71718 100644 --- a/api_docs/saved_objects_management.devdocs.json +++ b/api_docs/saved_objects_management.devdocs.json @@ -294,7 +294,7 @@ "label": "euiColumn", "description": [], "signature": [ - "{ prefix?: string | undefined; scope?: string | undefined; id?: string | undefined; defaultValue?: string | number | readonly string[] | undefined; name: React.ReactNode; security?: string | undefined; children?: React.ReactNode; description?: string | undefined; onChange?: React.FormEventHandler | undefined; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; className?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; hidden?: boolean | undefined; lang?: string | undefined; placeholder?: string | undefined; slot?: string | undefined; spellCheck?: Booleanish | undefined; style?: React.CSSProperties | undefined; tabIndex?: number | undefined; title?: string | undefined; translate?: \"yes\" | \"no\" | undefined; radioGroup?: string | undefined; role?: React.AriaRole | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; property?: string | undefined; resource?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCapitalize?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; color?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"search\" | \"none\" | \"text\" | \"url\" | \"tel\" | \"email\" | \"numeric\" | \"decimal\" | undefined; is?: string | undefined; 'aria-activedescendant'?: string | undefined; 'aria-atomic'?: Booleanish | undefined; 'aria-autocomplete'?: \"none\" | \"list\" | \"inline\" | \"both\" | undefined; 'aria-busy'?: Booleanish | undefined; 'aria-checked'?: boolean | \"true\" | \"false\" | \"mixed\" | undefined; 'aria-colcount'?: number | undefined; 'aria-colindex'?: number | undefined; 'aria-colspan'?: number | undefined; 'aria-controls'?: string | undefined; 'aria-current'?: boolean | \"page\" | \"date\" | \"time\" | \"true\" | \"false\" | \"step\" | \"location\" | undefined; 'aria-describedby'?: string | undefined; 'aria-details'?: string | undefined; 'aria-disabled'?: Booleanish | undefined; 'aria-dropeffect'?: \"execute\" | \"link\" | \"none\" | \"copy\" | \"move\" | \"popup\" | undefined; 'aria-errormessage'?: string | undefined; 'aria-expanded'?: Booleanish | undefined; 'aria-flowto'?: string | undefined; 'aria-grabbed'?: Booleanish | undefined; 'aria-haspopup'?: boolean | \"dialog\" | \"menu\" | \"true\" | \"false\" | \"grid\" | \"listbox\" | \"tree\" | undefined; 'aria-hidden'?: Booleanish | undefined; 'aria-invalid'?: boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" | undefined; 'aria-keyshortcuts'?: string | undefined; 'aria-label'?: string | undefined; 'aria-labelledby'?: string | undefined; 'aria-level'?: number | undefined; 'aria-live'?: \"off\" | \"assertive\" | \"polite\" | undefined; 'aria-modal'?: Booleanish | undefined; 'aria-multiline'?: Booleanish | undefined; 'aria-multiselectable'?: Booleanish | undefined; 'aria-orientation'?: \"horizontal\" | \"vertical\" | undefined; 'aria-owns'?: string | undefined; 'aria-placeholder'?: string | undefined; 'aria-posinset'?: number | undefined; 'aria-pressed'?: boolean | \"true\" | \"false\" | \"mixed\" | undefined; 'aria-readonly'?: Booleanish | undefined; 'aria-relevant'?: \"text\" | \"all\" | \"additions\" | \"additions removals\" | \"additions text\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" | undefined; 'aria-required'?: Booleanish | undefined; 'aria-roledescription'?: string | undefined; 'aria-rowcount'?: number | undefined; 'aria-rowindex'?: number | undefined; 'aria-rowspan'?: number | undefined; 'aria-selected'?: Booleanish | undefined; 'aria-setsize'?: number | undefined; 'aria-sort'?: \"none\" | \"ascending\" | \"descending\" | \"other\" | undefined; 'aria-valuemax'?: number | undefined; 'aria-valuemin'?: number | undefined; 'aria-valuenow'?: number | undefined; 'aria-valuetext'?: string | undefined; dangerouslySetInnerHTML?: { __html: string; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChangeCapture?: React.FormEventHandler | undefined; onBeforeInput?: React.FormEventHandler | undefined; onBeforeInputCapture?: React.FormEventHandler | undefined; onInput?: React.FormEventHandler | undefined; onInputCapture?: React.FormEventHandler | undefined; onReset?: React.FormEventHandler | undefined; onResetCapture?: React.FormEventHandler | undefined; onSubmit?: React.FormEventHandler | undefined; onSubmitCapture?: React.FormEventHandler | undefined; onInvalid?: React.FormEventHandler | undefined; onInvalidCapture?: React.FormEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onError?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDown?: React.KeyboardEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClick?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerEnterCapture?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerLeaveCapture?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; 'data-test-subj'?: string | undefined; css?: ", + "{ prefix?: string | undefined; scope?: string | undefined; id?: string | undefined; defaultValue?: string | number | readonly string[] | undefined; name: React.ReactNode; security?: string | undefined; children?: React.ReactNode; description?: string | undefined; onChange?: React.FormEventHandler | undefined; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; className?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; hidden?: boolean | undefined; lang?: string | undefined; placeholder?: string | undefined; slot?: string | undefined; spellCheck?: Booleanish | undefined; style?: React.CSSProperties | undefined; tabIndex?: number | undefined; title?: string | undefined; translate?: \"yes\" | \"no\" | undefined; radioGroup?: string | undefined; role?: React.AriaRole | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; property?: string | undefined; resource?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCapitalize?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; color?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"search\" | \"none\" | \"text\" | \"url\" | \"tel\" | \"email\" | \"numeric\" | \"decimal\" | undefined; is?: string | undefined; 'aria-activedescendant'?: string | undefined; 'aria-atomic'?: Booleanish | undefined; 'aria-autocomplete'?: \"none\" | \"list\" | \"inline\" | \"both\" | undefined; 'aria-busy'?: Booleanish | undefined; 'aria-checked'?: boolean | \"true\" | \"false\" | \"mixed\" | undefined; 'aria-colcount'?: number | undefined; 'aria-colindex'?: number | undefined; 'aria-colspan'?: number | undefined; 'aria-controls'?: string | undefined; 'aria-current'?: boolean | \"page\" | \"date\" | \"true\" | \"false\" | \"time\" | \"step\" | \"location\" | undefined; 'aria-describedby'?: string | undefined; 'aria-details'?: string | undefined; 'aria-disabled'?: Booleanish | undefined; 'aria-dropeffect'?: \"execute\" | \"link\" | \"none\" | \"copy\" | \"move\" | \"popup\" | undefined; 'aria-errormessage'?: string | undefined; 'aria-expanded'?: Booleanish | undefined; 'aria-flowto'?: string | undefined; 'aria-grabbed'?: Booleanish | undefined; 'aria-haspopup'?: boolean | \"true\" | \"false\" | \"dialog\" | \"menu\" | \"grid\" | \"listbox\" | \"tree\" | undefined; 'aria-hidden'?: Booleanish | undefined; 'aria-invalid'?: boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" | undefined; 'aria-keyshortcuts'?: string | undefined; 'aria-label'?: string | undefined; 'aria-labelledby'?: string | undefined; 'aria-level'?: number | undefined; 'aria-live'?: \"off\" | \"assertive\" | \"polite\" | undefined; 'aria-modal'?: Booleanish | undefined; 'aria-multiline'?: Booleanish | undefined; 'aria-multiselectable'?: Booleanish | undefined; 'aria-orientation'?: \"horizontal\" | \"vertical\" | undefined; 'aria-owns'?: string | undefined; 'aria-placeholder'?: string | undefined; 'aria-posinset'?: number | undefined; 'aria-pressed'?: boolean | \"true\" | \"false\" | \"mixed\" | undefined; 'aria-readonly'?: Booleanish | undefined; 'aria-relevant'?: \"text\" | \"all\" | \"additions\" | \"additions removals\" | \"additions text\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" | undefined; 'aria-required'?: Booleanish | undefined; 'aria-roledescription'?: string | undefined; 'aria-rowcount'?: number | undefined; 'aria-rowindex'?: number | undefined; 'aria-rowspan'?: number | undefined; 'aria-selected'?: Booleanish | undefined; 'aria-setsize'?: number | undefined; 'aria-sort'?: \"none\" | \"ascending\" | \"descending\" | \"other\" | undefined; 'aria-valuemax'?: number | undefined; 'aria-valuemin'?: number | undefined; 'aria-valuenow'?: number | undefined; 'aria-valuetext'?: string | undefined; dangerouslySetInnerHTML?: { __html: string; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChangeCapture?: React.FormEventHandler | undefined; onBeforeInput?: React.FormEventHandler | undefined; onBeforeInputCapture?: React.FormEventHandler | undefined; onInput?: React.FormEventHandler | undefined; onInputCapture?: React.FormEventHandler | undefined; onReset?: React.FormEventHandler | undefined; onResetCapture?: React.FormEventHandler | undefined; onSubmit?: React.FormEventHandler | undefined; onSubmitCapture?: React.FormEventHandler | undefined; onInvalid?: React.FormEventHandler | undefined; onInvalidCapture?: React.FormEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onError?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDown?: React.KeyboardEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClick?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerEnterCapture?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerLeaveCapture?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; 'data-test-subj'?: string | undefined; css?: ", "Interpolation", "<", "Theme", diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx index a5ca9791cb2a1..54e12718c2a6b 100644 --- a/api_docs/saved_objects_management.mdx +++ b/api_docs/saved_objects_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsManagement title: "savedObjectsManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsManagement plugin -date: 2023-06-30 +date: 2023-07-18 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 08fa5f5248fb1..90c190899baf1 100644 --- a/api_docs/saved_objects_tagging.mdx +++ b/api_docs/saved_objects_tagging.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsTagging title: "savedObjectsTagging" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsTagging plugin -date: 2023-06-30 +date: 2023-07-18 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 21a0222377b4f..77c3cee39bb3c 100644 --- a/api_docs/saved_objects_tagging_oss.mdx +++ b/api_docs/saved_objects_tagging_oss.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsTaggingOss title: "savedObjectsTaggingOss" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsTaggingOss plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss'] --- import savedObjectsTaggingOssObj from './saved_objects_tagging_oss.devdocs.json'; diff --git a/api_docs/saved_search.devdocs.json b/api_docs/saved_search.devdocs.json index 439c10feb2525..76ccee3737299 100644 --- a/api_docs/saved_search.devdocs.json +++ b/api_docs/saved_search.devdocs.json @@ -215,9 +215,9 @@ "(savedSearchId: string) => Promise<", { "pluginId": "savedSearch", - "scope": "public", + "scope": "common", "docId": "kibSavedSearchPluginApi", - "section": "def-public.SavedSearch", + "section": "def-common.SavedSearch", "text": "SavedSearch" }, ">" @@ -255,9 +255,9 @@ "() => ", { "pluginId": "savedSearch", - "scope": "public", + "scope": "common", "docId": "kibSavedSearchPluginApi", - "section": "def-public.SavedSearch", + "section": "def-common.SavedSearch", "text": "SavedSearch" } ], @@ -543,6 +543,66 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "savedSearch", + "id": "def-common.getKibanaContextFn", + "type": "Function", + "tags": [], + "label": "getKibanaContextFn", + "description": [], + "signature": [ + "(getStartDependencies: (getKibanaRequest: (() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "common", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-common.KibanaRequest", + "text": "KibanaRequest" + }, + ") | undefined) => Promise<", + "KibanaContextStartDependencies", + ">) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ExpressionFunctionKibanaContext", + "text": "ExpressionFunctionKibanaContext" + } + ], + "path": "src/plugins/saved_search/common/expressions/kibana_context.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "savedSearch", + "id": "def-common.getKibanaContextFn.$1", + "type": "Function", + "tags": [], + "label": "getStartDependencies", + "description": [], + "signature": [ + "(getKibanaRequest: (() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "common", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-common.KibanaRequest", + "text": "KibanaRequest" + }, + ") | undefined) => Promise<", + "KibanaContextStartDependencies", + ">" + ], + "path": "src/plugins/saved_search/common/expressions/kibana_context.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "savedSearch", "id": "def-common.getSavedSearchFullPathUrl", @@ -714,7 +774,9 @@ "SearchResponse", ">>; setField: >>; history: ", + "SearchRequest", + "[]; setField: void; removeField: void; removeField: " + ], + "signature": [ + "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" + ], + "path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -983,6 +999,42 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false + }, + { + "parentPluginId": "security", + "id": "def-public.UpdateUserProfileHook", + "type": "Type", + "tags": [], + "label": "UpdateUserProfileHook", + "description": [], + "signature": [ + "(props?: Props | undefined) => { update: (data: ", + "UserProfileData", + ") => void; showSuccessNotification: (props: { isRefreshRequired: boolean; }) => void; isLoading: boolean; userProfileData?: ", + "UserProfileData", + " | null | undefined; }" + ], + "path": "x-pack/plugins/security/public/account_management/user_profile/use_update_user_profile.tsx", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "security", + "id": "def-public.UpdateUserProfileHook.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "Props | undefined" + ], + "path": "x-pack/plugins/security/public/account_management/user_profile/use_update_user_profile.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false } ], "objects": [], @@ -1110,14 +1162,10 @@ "\nA set of methods to work with Kibana user profiles." ], "signature": [ - "{ suggest: (data: D) => Promise; suggest: (path: string, params: ", { "pluginId": "security", @@ -1135,13 +1183,7 @@ "text": "UserProfile" }, "[]>; bulkGet: (params: ", { "pluginId": "security", @@ -1159,13 +1201,7 @@ "text": "UserProfile" }, "[]>; getCurrent: (params?: ", { "pluginId": "security", @@ -1182,7 +1218,35 @@ "section": "def-common.GetUserProfileResponse", "text": "GetUserProfileResponse" }, - ">; }" + ">; readonly userProfile$: ", + "Observable", + "<", + "UserProfileData", + " | null>; }" + ], + "path": "x-pack/plugins/security/public/plugin.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "security", + "id": "def-public.SecurityPluginStart.hooks", + "type": "Object", + "tags": [], + "label": "hooks", + "description": [ + "\nA set of hooks to work with Kibana user profiles" + ], + "signature": [ + "{ useUpdateUserProfile: ", + { + "pluginId": "security", + "scope": "public", + "docId": "kibSecurityPluginApi", + "section": "def-public.UpdateUserProfileHook", + "text": "UpdateUserProfileHook" + }, + "; }" ], "path": "x-pack/plugins/security/public/plugin.tsx", "deprecated": false, @@ -3199,6 +3263,10 @@ "plugin": "ml", "path": "x-pack/plugins/ml/server/routes/annotations.ts" }, + { + "plugin": "logstash", + "path": "x-pack/plugins/logstash/server/routes/pipeline/save.ts" + }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/request_context_factory.ts" @@ -3223,10 +3291,6 @@ "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts" }, - { - "plugin": "logstash", - "path": "x-pack/plugins/logstash/server/routes/pipeline/save.ts" - }, { "plugin": "cloudChat", "path": "x-pack/plugins/cloud_integrations/cloud_chat/server/routes/chat.ts" diff --git a/api_docs/security.mdx b/api_docs/security.mdx index 853737ae7926c..21ff3e3189c7b 100644 --- a/api_docs/security.mdx +++ b/api_docs/security.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/security title: "security" image: https://source.unsplash.com/400x175/?github description: API docs for the security plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security'] --- import securityObj from './security.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana- | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 283 | 0 | 94 | 1 | +| 287 | 0 | 96 | 2 | ## Client diff --git a/api_docs/security_solution.devdocs.json b/api_docs/security_solution.devdocs.json index 226389e31e6b9..c46a3f74b2516 100644 --- a/api_docs/security_solution.devdocs.json +++ b/api_docs/security_solution.devdocs.json @@ -101,7 +101,7 @@ "label": "experimentalFeatures", "description": [], "signature": [ - "{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly kubernetesEnabled: boolean; readonly chartEmbeddablesEnabled: boolean; readonly donutChartEmbeddablesEnabled: boolean; readonly alertsPreviewChartEmbeddablesEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly insightsRelatedAlertsByProcessAncestry: boolean; readonly extendedRuleExecutionLoggingEnabled: boolean; readonly socTrendsEnabled: boolean; readonly responseActionsEnabled: boolean; readonly endpointResponseActionsEnabled: boolean; readonly alertDetailsPageEnabled: boolean; readonly responseActionUploadEnabled: boolean; readonly alertsPageChartsEnabled: boolean; readonly alertTypeEnabled: boolean; readonly securityFlyoutEnabled: boolean; readonly assistantEnabled: boolean; readonly alertsPageFiltersEnabled: boolean; readonly newUserDetailsFlyout: boolean; readonly detectionsCoverageOverview: boolean; readonly riskScoringPersistence: boolean; readonly riskScoringRoutesEnabled: boolean; }" + "{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly kubernetesEnabled: boolean; readonly chartEmbeddablesEnabled: boolean; readonly donutChartEmbeddablesEnabled: boolean; readonly alertsPreviewChartEmbeddablesEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly insightsRelatedAlertsByProcessAncestry: boolean; readonly extendedRuleExecutionLoggingEnabled: boolean; readonly socTrendsEnabled: boolean; readonly responseActionsEnabled: boolean; readonly endpointResponseActionsEnabled: boolean; readonly alertDetailsPageEnabled: boolean; readonly responseActionUploadEnabled: boolean; readonly alertsPageChartsEnabled: boolean; readonly alertTypeEnabled: boolean; readonly securityFlyoutEnabled: boolean; readonly alertsPageFiltersEnabled: boolean; readonly newUserDetailsFlyout: boolean; readonly detectionsCoverageOverview: boolean; readonly riskScoringPersistence: boolean; readonly riskScoringRoutesEnabled: boolean; }" ], "path": "x-pack/plugins/security_solution/public/plugin.tsx", "deprecated": false, @@ -634,6 +634,230 @@ ], "functions": [], "interfaces": [ + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink", + "type": "Interface", + "tags": [], + "label": "NavigationLink", + "description": [], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink.categories", + "type": "Object", + "tags": [], + "label": "categories", + "description": [], + "signature": [ + "readonly ", + { + "pluginId": "@kbn/security-solution-side-nav", + "scope": "common", + "docId": "kibKbnSecuritySolutionSideNavPluginApi", + "section": "def-common.LinkCategory", + "text": "LinkCategory" + }, + "<", + { + "pluginId": "securitySolution", + "scope": "common", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-common.SecurityPageName", + "text": "SecurityPageName" + }, + ">[] | undefined" + ], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink.disabled", + "type": "CompoundType", + "tags": [], + "label": "disabled", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink.id", + "type": "Enum", + "tags": [], + "label": "id", + "description": [], + "signature": [ + { + "pluginId": "securitySolution", + "scope": "common", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-common.SecurityPageName", + "text": "SecurityPageName" + } + ], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink.landingIcon", + "type": "CompoundType", + "tags": [], + "label": "landingIcon", + "description": [], + "signature": [ + "IconType", + " | undefined" + ], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink.landingImage", + "type": "string", + "tags": [], + "label": "landingImage", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink.links", + "type": "Array", + "tags": [], + "label": "links", + "description": [], + "signature": [ + { + "pluginId": "securitySolution", + "scope": "public", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-public.NavigationLink", + "text": "NavigationLink" + }, + "[] | undefined" + ], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink.sideNavIcon", + "type": "CompoundType", + "tags": [], + "label": "sideNavIcon", + "description": [], + "signature": [ + "IconType", + " | undefined" + ], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink.skipUrlState", + "type": "CompoundType", + "tags": [], + "label": "skipUrlState", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink.unauthorized", + "type": "CompoundType", + "tags": [], + "label": "unauthorized", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink.isBeta", + "type": "CompoundType", + "tags": [], + "label": "isBeta", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.NavigationLink.betaOptions", + "type": "Object", + "tags": [], + "label": "betaOptions", + "description": [], + "signature": [ + "{ text: string; } | undefined" + ], + "path": "x-pack/plugins/security_solution/public/common/links/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "securitySolution", "id": "def-public.TimelineModel", @@ -1565,7 +1789,7 @@ "label": "PageUpsellings", "description": [], "signature": [ - "{ administration?: React.ComponentType<{}> | undefined; alerts?: React.ComponentType<{}> | undefined; blocklist?: React.ComponentType<{}> | undefined; cases?: React.ComponentType<{}> | undefined; cases_configure?: React.ComponentType<{}> | undefined; cases_create?: React.ComponentType<{}> | undefined; \"cloud_security_posture-benchmarks\"?: React.ComponentType<{}> | undefined; \"cloud_security_posture-dashboard\"?: React.ComponentType<{}> | undefined; \"cloud_security_posture-findings\"?: React.ComponentType<{}> | undefined; \"cloud_security_posture-rules\"?: React.ComponentType<{}> | undefined; \"cloud_defend-policies\"?: React.ComponentType<{}> | undefined; dashboards?: React.ComponentType<{}> | undefined; data_quality?: React.ComponentType<{}> | undefined; detections?: React.ComponentType<{}> | undefined; detection_response?: React.ComponentType<{}> | undefined; endpoints?: React.ComponentType<{}> | undefined; event_filters?: React.ComponentType<{}> | undefined; exceptions?: React.ComponentType<{}> | undefined; explore?: React.ComponentType<{}> | undefined; host_isolation_exceptions?: React.ComponentType<{}> | undefined; hosts?: React.ComponentType<{}> | undefined; \"hosts-anomalies\"?: React.ComponentType<{}> | undefined; \"hosts-risk\"?: React.ComponentType<{}> | undefined; \"hosts-events\"?: React.ComponentType<{}> | undefined; investigate?: React.ComponentType<{}> | undefined; kubernetes?: React.ComponentType<{}> | undefined; get_started?: React.ComponentType<{}> | undefined; network?: React.ComponentType<{}> | undefined; \"network-anomalies\"?: React.ComponentType<{}> | undefined; \"network-dns\"?: React.ComponentType<{}> | undefined; \"network-events\"?: React.ComponentType<{}> | undefined; \"network-http\"?: React.ComponentType<{}> | undefined; \"network-tls\"?: React.ComponentType<{}> | undefined; \"\"?: React.ComponentType<{}> | undefined; overview?: React.ComponentType<{}> | undefined; policy?: React.ComponentType<{}> | undefined; response_actions_history?: React.ComponentType<{}> | undefined; rules?: React.ComponentType<{}> | undefined; \"rules-add\"?: React.ComponentType<{}> | undefined; \"rules-create\"?: React.ComponentType<{}> | undefined; \"rules-landing\"?: React.ComponentType<{}> | undefined; sessions?: React.ComponentType<{}> | undefined; \"threat_intelligence-indicators\"?: React.ComponentType<{}> | undefined; timelines?: React.ComponentType<{}> | undefined; \"timelines-templates\"?: React.ComponentType<{}> | undefined; trusted_apps?: React.ComponentType<{}> | undefined; uncommon_processes?: React.ComponentType<{}> | undefined; users?: React.ComponentType<{}> | undefined; \"users-anomalies\"?: React.ComponentType<{}> | undefined; \"users-authentications\"?: React.ComponentType<{}> | undefined; \"users-events\"?: React.ComponentType<{}> | undefined; \"users-risk\"?: React.ComponentType<{}> | undefined; \"entity-analytics\"?: React.ComponentType<{}> | undefined; \"coverage-overview\"?: React.ComponentType<{}> | undefined; }" + "{ administration?: React.ComponentType<{}> | undefined; alerts?: React.ComponentType<{}> | undefined; blocklist?: React.ComponentType<{}> | undefined; cases?: React.ComponentType<{}> | undefined; cases_configure?: React.ComponentType<{}> | undefined; cases_create?: React.ComponentType<{}> | undefined; \"cloud_security_posture-benchmarks\"?: React.ComponentType<{}> | undefined; \"cloud_security_posture-dashboard\"?: React.ComponentType<{}> | undefined; \"cloud_security_posture-findings\"?: React.ComponentType<{}> | undefined; \"cloud_security_posture-rules\"?: React.ComponentType<{}> | undefined; \"cloud_defend-policies\"?: React.ComponentType<{}> | undefined; dashboards?: React.ComponentType<{}> | undefined; data_quality?: React.ComponentType<{}> | undefined; detections?: React.ComponentType<{}> | undefined; detection_response?: React.ComponentType<{}> | undefined; endpoints?: React.ComponentType<{}> | undefined; event_filters?: React.ComponentType<{}> | undefined; exceptions?: React.ComponentType<{}> | undefined; explore?: React.ComponentType<{}> | undefined; host_isolation_exceptions?: React.ComponentType<{}> | undefined; hosts?: React.ComponentType<{}> | undefined; \"hosts-anomalies\"?: React.ComponentType<{}> | undefined; \"hosts-risk\"?: React.ComponentType<{}> | undefined; \"hosts-events\"?: React.ComponentType<{}> | undefined; investigate?: React.ComponentType<{}> | undefined; kubernetes?: React.ComponentType<{}> | undefined; get_started?: React.ComponentType<{}> | undefined; network?: React.ComponentType<{}> | undefined; \"network-anomalies\"?: React.ComponentType<{}> | undefined; \"network-dns\"?: React.ComponentType<{}> | undefined; \"network-events\"?: React.ComponentType<{}> | undefined; \"network-http\"?: React.ComponentType<{}> | undefined; \"network-tls\"?: React.ComponentType<{}> | undefined; \"\"?: React.ComponentType<{}> | undefined; overview?: React.ComponentType<{}> | undefined; policy?: React.ComponentType<{}> | undefined; response_actions_history?: React.ComponentType<{}> | undefined; rules?: React.ComponentType<{}> | undefined; \"rules-add\"?: React.ComponentType<{}> | undefined; \"rules-create\"?: React.ComponentType<{}> | undefined; \"rules-landing\"?: React.ComponentType<{}> | undefined; sessions?: React.ComponentType<{}> | undefined; \"threat_intelligence-indicators\"?: React.ComponentType<{}> | undefined; timelines?: React.ComponentType<{}> | undefined; \"timelines-templates\"?: React.ComponentType<{}> | undefined; trusted_apps?: React.ComponentType<{}> | undefined; uncommon_processes?: React.ComponentType<{}> | undefined; users?: React.ComponentType<{}> | undefined; \"users-anomalies\"?: React.ComponentType<{}> | undefined; \"users-authentications\"?: React.ComponentType<{}> | undefined; \"users-events\"?: React.ComponentType<{}> | undefined; \"users-risk\"?: React.ComponentType<{}> | undefined; \"entity-analytics\"?: React.ComponentType<{}> | undefined; \"entity-analytics-management\"?: React.ComponentType<{}> | undefined; \"coverage-overview\"?: React.ComponentType<{}> | undefined; }" ], "path": "x-pack/plugins/security_solution/public/common/lib/upsellings/types.ts", "deprecated": false, @@ -1679,7 +1903,13 @@ "() => ", "Observable", "<", - "NavigationLink", + { + "pluginId": "securitySolution", + "scope": "public", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-public.NavigationLink", + "text": "NavigationLink" + }, "[]>" ], "path": "x-pack/plugins/security_solution/public/types.ts", @@ -1751,6 +1981,26 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "securitySolution", + "id": "def-public.PluginStart.getBreadcrumbsNav$", + "type": "Function", + "tags": [], + "label": "getBreadcrumbsNav$", + "description": [], + "signature": [ + "() => ", + "Observable", + "<", + "BreadcrumbsNav", + ">" + ], + "path": "x-pack/plugins/security_solution/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] } ], "lifecycle": "start", @@ -2682,6 +2932,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "securitySolution", + "id": "def-common.APP_PATH", + "type": "string", + "tags": [], + "label": "APP_PATH", + "description": [], + "signature": [ + "\"/app/security\"" + ], + "path": "x-pack/plugins/security_solution/common/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "securitySolution", "id": "def-common.APP_UI_ID", @@ -2776,13 +3041,28 @@ "label": "ExperimentalFeatures", "description": [], "signature": [ - "{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly kubernetesEnabled: boolean; readonly chartEmbeddablesEnabled: boolean; readonly donutChartEmbeddablesEnabled: boolean; readonly alertsPreviewChartEmbeddablesEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly insightsRelatedAlertsByProcessAncestry: boolean; readonly extendedRuleExecutionLoggingEnabled: boolean; readonly socTrendsEnabled: boolean; readonly responseActionsEnabled: boolean; readonly endpointResponseActionsEnabled: boolean; readonly alertDetailsPageEnabled: boolean; readonly responseActionUploadEnabled: boolean; readonly alertsPageChartsEnabled: boolean; readonly alertTypeEnabled: boolean; readonly securityFlyoutEnabled: boolean; readonly assistantEnabled: boolean; readonly alertsPageFiltersEnabled: boolean; readonly newUserDetailsFlyout: boolean; readonly detectionsCoverageOverview: boolean; readonly riskScoringPersistence: boolean; readonly riskScoringRoutesEnabled: boolean; }" + "{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly kubernetesEnabled: boolean; readonly chartEmbeddablesEnabled: boolean; readonly donutChartEmbeddablesEnabled: boolean; readonly alertsPreviewChartEmbeddablesEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly insightsRelatedAlertsByProcessAncestry: boolean; readonly extendedRuleExecutionLoggingEnabled: boolean; readonly socTrendsEnabled: boolean; readonly responseActionsEnabled: boolean; readonly endpointResponseActionsEnabled: boolean; readonly alertDetailsPageEnabled: boolean; readonly responseActionUploadEnabled: boolean; readonly alertsPageChartsEnabled: boolean; readonly alertTypeEnabled: boolean; readonly securityFlyoutEnabled: boolean; readonly alertsPageFiltersEnabled: boolean; readonly newUserDetailsFlyout: boolean; readonly detectionsCoverageOverview: boolean; readonly riskScoringPersistence: boolean; readonly riskScoringRoutesEnabled: boolean; }" ], "path": "x-pack/plugins/security_solution/common/experimental_features.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "securitySolution", + "id": "def-common.MANAGE_PATH", + "type": "string", + "tags": [], + "label": "MANAGE_PATH", + "description": [], + "signature": [ + "\"/manage\"" + ], + "path": "x-pack/plugins/security_solution/common/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "securitySolution", "id": "def-common.SERVER_APP_ID", @@ -2829,7 +3109,7 @@ "\nA list of allowed values that can be used in `xpack.securitySolution.enableExperimental`.\nThis object is then used to validate and parse the value entered." ], "signature": [ - "{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly kubernetesEnabled: boolean; readonly chartEmbeddablesEnabled: boolean; readonly donutChartEmbeddablesEnabled: boolean; readonly alertsPreviewChartEmbeddablesEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly insightsRelatedAlertsByProcessAncestry: boolean; readonly extendedRuleExecutionLoggingEnabled: boolean; readonly socTrendsEnabled: boolean; readonly responseActionsEnabled: boolean; readonly endpointResponseActionsEnabled: boolean; readonly alertDetailsPageEnabled: boolean; readonly responseActionUploadEnabled: boolean; readonly alertsPageChartsEnabled: boolean; readonly alertTypeEnabled: boolean; readonly securityFlyoutEnabled: boolean; readonly assistantEnabled: boolean; readonly alertsPageFiltersEnabled: boolean; readonly newUserDetailsFlyout: boolean; readonly detectionsCoverageOverview: boolean; readonly riskScoringPersistence: boolean; readonly riskScoringRoutesEnabled: boolean; }" + "{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly kubernetesEnabled: boolean; readonly chartEmbeddablesEnabled: boolean; readonly donutChartEmbeddablesEnabled: boolean; readonly alertsPreviewChartEmbeddablesEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly insightsRelatedAlertsByProcessAncestry: boolean; readonly extendedRuleExecutionLoggingEnabled: boolean; readonly socTrendsEnabled: boolean; readonly responseActionsEnabled: boolean; readonly endpointResponseActionsEnabled: boolean; readonly alertDetailsPageEnabled: boolean; readonly responseActionUploadEnabled: boolean; readonly alertsPageChartsEnabled: boolean; readonly alertTypeEnabled: boolean; readonly securityFlyoutEnabled: boolean; readonly alertsPageFiltersEnabled: boolean; readonly newUserDetailsFlyout: boolean; readonly detectionsCoverageOverview: boolean; readonly riskScoringPersistence: boolean; readonly riskScoringRoutesEnabled: boolean; }" ], "path": "x-pack/plugins/security_solution/common/experimental_features.ts", "deprecated": false, diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index 48e99976757b0..a5aaef672275c 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/securitySolution title: "securitySolution" image: https://source.unsplash.com/400x175/?github description: API docs for the securitySolution plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution'] --- import securitySolutionObj from './security_solution.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/security-solution](https://github.com/orgs/elastic/teams/secur | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 159 | 2 | 115 | 30 | +| 176 | 2 | 132 | 30 | ## Client diff --git a/api_docs/security_solution_ess.devdocs.json b/api_docs/security_solution_ess.devdocs.json new file mode 100644 index 0000000000000..86a4acbd57322 --- /dev/null +++ b/api_docs/security_solution_ess.devdocs.json @@ -0,0 +1,114 @@ +{ + "id": "securitySolutionEss", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "parentPluginId": "securitySolutionEss", + "id": "def-public.SecuritySolutionEssPluginSetup", + "type": "Interface", + "tags": [], + "label": "SecuritySolutionEssPluginSetup", + "description": [], + "path": "x-pack/plugins/security_solution_ess/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "securitySolutionEss", + "id": "def-public.SecuritySolutionEssPluginStart", + "type": "Interface", + "tags": [], + "label": "SecuritySolutionEssPluginStart", + "description": [], + "path": "x-pack/plugins/security_solution_ess/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "parentPluginId": "securitySolutionEss", + "id": "def-server.SecuritySolutionEssPluginSetup", + "type": "Interface", + "tags": [], + "label": "SecuritySolutionEssPluginSetup", + "description": [], + "path": "x-pack/plugins/security_solution_ess/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "securitySolutionEss", + "id": "def-server.SecuritySolutionEssPluginStart", + "type": "Interface", + "tags": [], + "label": "SecuritySolutionEssPluginStart", + "description": [], + "path": "x-pack/plugins/security_solution_ess/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "securitySolutionEss", + "id": "def-common.PLUGIN_ID", + "type": "string", + "tags": [], + "label": "PLUGIN_ID", + "description": [], + "signature": [ + "\"securitySolutionEss\"" + ], + "path": "x-pack/plugins/security_solution_ess/common/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "securitySolutionEss", + "id": "def-common.PLUGIN_NAME", + "type": "string", + "tags": [], + "label": "PLUGIN_NAME", + "description": [], + "signature": [ + "\"securitySolutionEss\"" + ], + "path": "x-pack/plugins/security_solution_ess/common/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/security_solution_ess.mdx b/api_docs/security_solution_ess.mdx new file mode 100644 index 0000000000000..523978a3bfd78 --- /dev/null +++ b/api_docs/security_solution_ess.mdx @@ -0,0 +1,46 @@ +--- +#### +#### 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: kibSecuritySolutionEssPluginApi +slug: /kibana-dev-docs/api/securitySolutionEss +title: "securitySolutionEss" +image: https://source.unsplash.com/400x175/?github +description: API docs for the securitySolutionEss plugin +date: 2023-07-18 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolutionEss'] +--- +import securitySolutionEssObj from './security_solution_ess.devdocs.json'; + +ESS customizations for Security Solution. + +Contact [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 6 | 0 | 6 | 0 | + +## Client + +### Setup + + +### Start + + +## Server + +### Setup + + +### Start + + +## Common + +### Consts, variables and types + + diff --git a/api_docs/security_solution_serverless.devdocs.json b/api_docs/security_solution_serverless.devdocs.json new file mode 100644 index 0000000000000..39d3db16cf5da --- /dev/null +++ b/api_docs/security_solution_serverless.devdocs.json @@ -0,0 +1,114 @@ +{ + "id": "securitySolutionServerless", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "parentPluginId": "securitySolutionServerless", + "id": "def-public.SecuritySolutionServerlessPluginSetup", + "type": "Interface", + "tags": [], + "label": "SecuritySolutionServerlessPluginSetup", + "description": [], + "path": "x-pack/plugins/security_solution_serverless/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "securitySolutionServerless", + "id": "def-public.SecuritySolutionServerlessPluginStart", + "type": "Interface", + "tags": [], + "label": "SecuritySolutionServerlessPluginStart", + "description": [], + "path": "x-pack/plugins/security_solution_serverless/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "parentPluginId": "securitySolutionServerless", + "id": "def-server.SecuritySolutionServerlessPluginSetup", + "type": "Interface", + "tags": [], + "label": "SecuritySolutionServerlessPluginSetup", + "description": [], + "path": "x-pack/plugins/security_solution_serverless/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "securitySolutionServerless", + "id": "def-server.SecuritySolutionServerlessPluginStart", + "type": "Interface", + "tags": [], + "label": "SecuritySolutionServerlessPluginStart", + "description": [], + "path": "x-pack/plugins/security_solution_serverless/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "securitySolutionServerless", + "id": "def-common.PLUGIN_ID", + "type": "string", + "tags": [], + "label": "PLUGIN_ID", + "description": [], + "signature": [ + "\"securitySolutionServerless\"" + ], + "path": "x-pack/plugins/security_solution_serverless/common/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "securitySolutionServerless", + "id": "def-common.PLUGIN_NAME", + "type": "string", + "tags": [], + "label": "PLUGIN_NAME", + "description": [], + "signature": [ + "\"securitySolutionServerless\"" + ], + "path": "x-pack/plugins/security_solution_serverless/common/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/security_solution_serverless.mdx b/api_docs/security_solution_serverless.mdx new file mode 100644 index 0000000000000..e0d660d8399cb --- /dev/null +++ b/api_docs/security_solution_serverless.mdx @@ -0,0 +1,46 @@ +--- +#### +#### 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: kibSecuritySolutionServerlessPluginApi +slug: /kibana-dev-docs/api/securitySolutionServerless +title: "securitySolutionServerless" +image: https://source.unsplash.com/400x175/?github +description: API docs for the securitySolutionServerless plugin +date: 2023-07-18 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolutionServerless'] +--- +import securitySolutionServerlessObj from './security_solution_serverless.devdocs.json'; + +Serverless customizations for security. + +Contact [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 6 | 0 | 6 | 0 | + +## Client + +### Setup + + +### Start + + +## Server + +### Setup + + +### Start + + +## Common + +### Consts, variables and types + + diff --git a/api_docs/serverless.mdx b/api_docs/serverless.mdx index fa97a61d51f97..f1e8138a3fed2 100644 --- a/api_docs/serverless.mdx +++ b/api_docs/serverless.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/serverless title: "serverless" image: https://source.unsplash.com/400x175/?github description: API docs for the serverless plugin -date: 2023-06-30 +date: 2023-07-18 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 841267119dd75..f0637ce888617 100644 --- a/api_docs/serverless_observability.mdx +++ b/api_docs/serverless_observability.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/serverlessObservability title: "serverlessObservability" image: https://source.unsplash.com/400x175/?github description: API docs for the serverlessObservability plugin -date: 2023-06-30 +date: 2023-07-18 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 f4f8947f7fb95..4975a56821982 100644 --- a/api_docs/serverless_search.mdx +++ b/api_docs/serverless_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/serverlessSearch title: "serverlessSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the serverlessSearch plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'serverlessSearch'] --- import serverlessSearchObj from './serverless_search.devdocs.json'; diff --git a/api_docs/serverless_security.devdocs.json b/api_docs/serverless_security.devdocs.json deleted file mode 100644 index 058c09fd91360..0000000000000 --- a/api_docs/serverless_security.devdocs.json +++ /dev/null @@ -1,114 +0,0 @@ -{ - "id": "serverlessSecurity", - "client": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [], - "setup": { - "parentPluginId": "serverlessSecurity", - "id": "def-public.ServerlessSecurityPluginSetup", - "type": "Interface", - "tags": [], - "label": "ServerlessSecurityPluginSetup", - "description": [], - "path": "x-pack/plugins/serverless_security/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "lifecycle": "setup", - "initialIsOpen": true - }, - "start": { - "parentPluginId": "serverlessSecurity", - "id": "def-public.ServerlessSecurityPluginStart", - "type": "Interface", - "tags": [], - "label": "ServerlessSecurityPluginStart", - "description": [], - "path": "x-pack/plugins/serverless_security/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "lifecycle": "start", - "initialIsOpen": true - } - }, - "server": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [], - "setup": { - "parentPluginId": "serverlessSecurity", - "id": "def-server.ServerlessSecurityPluginSetup", - "type": "Interface", - "tags": [], - "label": "ServerlessSecurityPluginSetup", - "description": [], - "path": "x-pack/plugins/serverless_security/server/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "lifecycle": "setup", - "initialIsOpen": true - }, - "start": { - "parentPluginId": "serverlessSecurity", - "id": "def-server.ServerlessSecurityPluginStart", - "type": "Interface", - "tags": [], - "label": "ServerlessSecurityPluginStart", - "description": [], - "path": "x-pack/plugins/serverless_security/server/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "lifecycle": "start", - "initialIsOpen": true - } - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [ - { - "parentPluginId": "serverlessSecurity", - "id": "def-common.PLUGIN_ID", - "type": "string", - "tags": [], - "label": "PLUGIN_ID", - "description": [], - "signature": [ - "\"serverlessSecurity\"" - ], - "path": "x-pack/plugins/serverless_security/common/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "serverlessSecurity", - "id": "def-common.PLUGIN_NAME", - "type": "string", - "tags": [], - "label": "PLUGIN_NAME", - "description": [], - "signature": [ - "\"serverlessSecurity\"" - ], - "path": "x-pack/plugins/serverless_security/common/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - } - ], - "objects": [] - } -} \ No newline at end of file diff --git a/api_docs/serverless_security.mdx b/api_docs/serverless_security.mdx deleted file mode 100644 index 83f20833a9989..0000000000000 --- a/api_docs/serverless_security.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -#### -#### 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: kibServerlessSecurityPluginApi -slug: /kibana-dev-docs/api/serverlessSecurity -title: "serverlessSecurity" -image: https://source.unsplash.com/400x175/?github -description: API docs for the serverlessSecurity plugin -date: 2023-06-30 -tags: ['contributor', 'dev', 'apidocs', 'kibana', 'serverlessSecurity'] ---- -import serverlessSecurityObj from './serverless_security.devdocs.json'; - -Serverless customizations for security. - -Contact [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) for questions regarding this plugin. - -**Code health stats** - -| Public API count | Any count | Items lacking comments | Missing exports | -|-------------------|-----------|------------------------|-----------------| -| 6 | 0 | 6 | 0 | - -## Client - -### Setup - - -### Start - - -## Server - -### Setup - - -### Start - - -## Common - -### Consts, variables and types - - diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index 5b36b725abe61..9a06b39eecc30 100644 --- a/api_docs/session_view.mdx +++ b/api_docs/session_view.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/sessionView title: "sessionView" image: https://source.unsplash.com/400x175/?github description: API docs for the sessionView plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sessionView'] --- import sessionViewObj from './session_view.devdocs.json'; diff --git a/api_docs/share.mdx b/api_docs/share.mdx index 3c9dae710a208..333ba9bc9dc53 100644 --- a/api_docs/share.mdx +++ b/api_docs/share.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/share title: "share" image: https://source.unsplash.com/400x175/?github description: API docs for the share plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share'] --- import shareObj from './share.devdocs.json'; diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index d64d97325ed71..0730606b38753 100644 --- a/api_docs/snapshot_restore.mdx +++ b/api_docs/snapshot_restore.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/snapshotRestore title: "snapshotRestore" image: https://source.unsplash.com/400x175/?github description: API docs for the snapshotRestore plugin -date: 2023-06-30 +date: 2023-07-18 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 67ce44f89e682..97b799d9f9b00 100644 --- a/api_docs/spaces.mdx +++ b/api_docs/spaces.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/spaces title: "spaces" image: https://source.unsplash.com/400x175/?github description: API docs for the spaces plugin -date: 2023-06-30 +date: 2023-07-18 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 cb6387b7e76c0..cd7ca829ad628 100644 --- a/api_docs/stack_alerts.mdx +++ b/api_docs/stack_alerts.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/stackAlerts title: "stackAlerts" image: https://source.unsplash.com/400x175/?github description: API docs for the stackAlerts plugin -date: 2023-06-30 +date: 2023-07-18 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 fe24915d6997e..5c136b97e2b0f 100644 --- a/api_docs/stack_connectors.mdx +++ b/api_docs/stack_connectors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/stackConnectors title: "stackConnectors" image: https://source.unsplash.com/400x175/?github description: API docs for the stackConnectors plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackConnectors'] --- import stackConnectorsObj from './stack_connectors.devdocs.json'; diff --git a/api_docs/task_manager.devdocs.json b/api_docs/task_manager.devdocs.json index 2f01601dbcc8a..abdde3e96fa97 100644 --- a/api_docs/task_manager.devdocs.json +++ b/api_docs/task_manager.devdocs.json @@ -336,6 +336,40 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "taskManager", + "id": "def-server.createSkipError", + "type": "Function", + "tags": [], + "label": "createSkipError", + "description": [], + "signature": [ + "(error: Error) => ", + "DecoratedError" + ], + "path": "x-pack/plugins/task_manager/server/task_running/errors.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "taskManager", + "id": "def-server.createSkipError.$1", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "x-pack/plugins/task_manager/server/task_running/errors.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "taskManager", "id": "def-server.isEphemeralTaskRejectedDueToCapacityError", @@ -372,6 +406,42 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "taskManager", + "id": "def-server.isSkipError", + "type": "Function", + "tags": [], + "label": "isSkipError", + "description": [], + "signature": [ + "(error: Error | ", + "DecoratedError", + ") => boolean" + ], + "path": "x-pack/plugins/task_manager/server/task_running/errors.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "taskManager", + "id": "def-server.isSkipError.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error | ", + "DecoratedError" + ], + "path": "x-pack/plugins/task_manager/server/task_running/errors.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "taskManager", "id": "def-server.isUnrecoverableError", @@ -408,6 +478,54 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "taskManager", + "id": "def-server.throwRetryableError", + "type": "Function", + "tags": [], + "label": "throwRetryableError", + "description": [], + "signature": [ + "(error: Error, shouldRetry: boolean | Date) => void" + ], + "path": "x-pack/plugins/task_manager/server/task_running/errors.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "taskManager", + "id": "def-server.throwRetryableError.$1", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "x-pack/plugins/task_manager/server/task_running/errors.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "taskManager", + "id": "def-server.throwRetryableError.$2", + "type": "CompoundType", + "tags": [], + "label": "shouldRetry", + "description": [], + "signature": [ + "boolean | Date" + ], + "path": "x-pack/plugins/task_manager/server/task_running/errors.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "taskManager", "id": "def-server.throwUnrecoverableError", @@ -1072,6 +1190,22 @@ "path": "x-pack/plugins/task_manager/server/task.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "taskManager", + "id": "def-server.TaskInstance.numSkippedRuns", + "type": "number", + "tags": [], + "label": "numSkippedRuns", + "description": [ + "\nIndicates the number of skipped executions." + ], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/task_manager/server/task.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -1156,7 +1290,16 @@ "text": "RunContext" }, ") => ", - "CancellableTask" + "CancellableTask", + "<", + { + "pluginId": "taskManager", + "scope": "server", + "docId": "kibTaskManagerPluginApi", + "section": "def-server.ConcreteTaskInstance", + "text": "ConcreteTaskInstance" + }, + ">" ], "path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts", "deprecated": false, @@ -1238,6 +1381,48 @@ "path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "taskManager", + "id": "def-server.TaskRegisterDefinition.paramsSchema", + "type": "Object", + "tags": [], + "label": "paramsSchema", + "description": [], + "signature": [ + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.ObjectType", + "text": "ObjectType" + }, + " | undefined" + ], + "path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "taskManager", + "id": "def-server.TaskRegisterDefinition.indirectParamsSchema", + "type": "Object", + "tags": [], + "label": "indirectParamsSchema", + "description": [], + "signature": [ + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.ObjectType", + "text": "ObjectType" + }, + " | undefined" + ], + "path": "x-pack/plugins/task_manager/server/task_type_dictionary.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -1275,6 +1460,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "taskManager", + "id": "def-server.LoadIndirectParamsResult", + "type": "Type", + "tags": [], + "label": "LoadIndirectParamsResult", + "description": [], + "signature": [ + "{ data: T; error?: undefined; } | { data?: undefined; error: Error; }" + ], + "path": "x-pack/plugins/task_manager/server/task.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "taskManager", "id": "def-server.TaskDefinitionRegistry", @@ -1317,7 +1517,16 @@ "text": "RunContext" }, ") => ", - "CancellableTask" + "CancellableTask", + "<", + { + "pluginId": "taskManager", + "scope": "server", + "docId": "kibTaskManagerPluginApi", + "section": "def-server.ConcreteTaskInstance", + "text": "ConcreteTaskInstance" + }, + ">" ], "path": "x-pack/plugins/task_manager/server/task.ts", "deprecated": false, diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index 582f37104d947..f5a6b6619aa6d 100644 --- a/api_docs/task_manager.mdx +++ b/api_docs/task_manager.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/taskManager title: "taskManager" image: https://source.unsplash.com/400x175/?github description: API docs for the taskManager plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] --- import taskManagerObj from './task_manager.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 85 | 0 | 43 | 6 | +| 96 | 0 | 53 | 6 | ## Server diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index 24cf8c0959585..fcd2298ee82e9 100644 --- a/api_docs/telemetry.mdx +++ b/api_docs/telemetry.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetry title: "telemetry" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetry plugin -date: 2023-06-30 +date: 2023-07-18 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 35577ec87cc3c..f89c8e1073b7d 100644 --- a/api_docs/telemetry_collection_manager.mdx +++ b/api_docs/telemetry_collection_manager.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionManager title: "telemetryCollectionManager" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetryCollectionManager plugin -date: 2023-06-30 +date: 2023-07-18 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 db07655083e35..2428fa33744ad 100644 --- a/api_docs/telemetry_collection_xpack.mdx +++ b/api_docs/telemetry_collection_xpack.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionXpack title: "telemetryCollectionXpack" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetryCollectionXpack plugin -date: 2023-06-30 +date: 2023-07-18 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 765d85612f920..814d0f093cbe3 100644 --- a/api_docs/telemetry_management_section.mdx +++ b/api_docs/telemetry_management_section.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryManagementSection title: "telemetryManagementSection" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetryManagementSection plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection'] --- import telemetryManagementSectionObj from './telemetry_management_section.devdocs.json'; diff --git a/api_docs/text_based_languages.mdx b/api_docs/text_based_languages.mdx index f01d9a90cd443..9409362c65377 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: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'textBasedLanguages'] --- import textBasedLanguagesObj from './text_based_languages.devdocs.json'; diff --git a/api_docs/threat_intelligence.mdx b/api_docs/threat_intelligence.mdx index f1f950e32747e..ba6fe0c105e29 100644 --- a/api_docs/threat_intelligence.mdx +++ b/api_docs/threat_intelligence.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/threatIntelligence title: "threatIntelligence" image: https://source.unsplash.com/400x175/?github description: API docs for the threatIntelligence plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'threatIntelligence'] --- import threatIntelligenceObj from './threat_intelligence.devdocs.json'; diff --git a/api_docs/timelines.devdocs.json b/api_docs/timelines.devdocs.json index 62291ad0d1a6e..97a7ade6579d2 100644 --- a/api_docs/timelines.devdocs.json +++ b/api_docs/timelines.devdocs.json @@ -1556,14 +1556,6 @@ { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/detections/components/alerts_kpis/common/hooks.ts" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/detections/hooks/trigger_actions_alert_table/use_cell_actions.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/detections/hooks/trigger_actions_alert_table/use_cell_actions.tsx" } ], "children": [ diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index 2f36fbd5ebf85..f4e05f445b30a 100644 --- a/api_docs/timelines.mdx +++ b/api_docs/timelines.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/timelines title: "timelines" image: https://source.unsplash.com/400x175/?github description: API docs for the timelines plugin -date: 2023-06-30 +date: 2023-07-18 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 80a02b2c69b24..471e4a2de7b18 100644 --- a/api_docs/transform.mdx +++ b/api_docs/transform.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/transform title: "transform" image: https://source.unsplash.com/400x175/?github description: API docs for the transform plugin -date: 2023-06-30 +date: 2023-07-18 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 d883772477845..1d182a1424ca6 100644 --- a/api_docs/triggers_actions_ui.devdocs.json +++ b/api_docs/triggers_actions_ui.devdocs.json @@ -55,7 +55,7 @@ "label": "experimentalFeatures", "description": [], "signature": [ - "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly ruleTagFilter: boolean; readonly ruleStatusFilter: boolean; readonly rulesDetailLogs: boolean; readonly ruleUseExecutionStatus: boolean; }" + "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly ruleTagFilter: boolean; readonly ruleStatusFilter: boolean; readonly rulesDetailLogs: boolean; readonly ruleUseExecutionStatus: boolean; readonly ruleKqlBar: boolean; }" ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false, @@ -1786,6 +1786,53 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.validateActionFilterQuery", + "type": "Function", + "tags": [], + "label": "validateActionFilterQuery", + "description": [], + "signature": [ + "(actionItem: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleAction", + "text": "RuleAction" + }, + ") => string | null" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/value_validators.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.validateActionFilterQuery.$1", + "type": "Object", + "tags": [], + "label": "actionItem", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleAction", + "text": "RuleAction" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/value_validators.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.ValueExpression", @@ -2329,6 +2376,17 @@ "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ActionType.isSystemActionType", + "type": "boolean", + "tags": [], + "label": "isSystemActionType", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -5616,6 +5674,8 @@ "signature": [ "PreConfiguredActionConnector", " | ", + "SystemAction", + " | ", "UserConfiguredActionConnector", "" ], @@ -5806,9 +5866,9 @@ "EuiDataGridControlColumn", "[]; useFetchAlertsData: () => ", "FetchAlertData", - "; visibleColumns: string[]; 'data-test-subj': string; updatedAt: number; browserFields: any; onToggleColumn: (columnId: string) => void; onResetColumns: () => void; onColumnsChange: (columns: ", - "EuiDataGridColumn", - "[], visibleColumns: string[]) => void; onChangeVisibleColumns: (newColumns: string[]) => void; query: Pick<", + "; visibleColumns: string[]; 'data-test-subj': string; updatedAt: number; browserFields: any; onToggleColumn: (columnId: string) => void; onResetColumns: () => void; onChangeVisibleColumns: (newColumns: string[]) => void; onColumnResize?: ", + "EuiDataGridOnColumnResizeHandler", + " | undefined; query: Pick<", "QueryDslQueryContainer", ", \"ids\" | \"bool\">; controls?: ", "EuiDataGridToolBarAdditionalControlsOptions", @@ -8827,7 +8887,7 @@ "\nParses the string value used in `xpack.trigger_actions_ui.enableExperimental` kibana configuration,\nwhich should be a string of values delimited by a comma (`,`)\n" ], "signature": [ - "(configValue: string[]) => Readonly<{ rulesListDatagrid: boolean; internalAlertsTable: boolean; ruleTagFilter: boolean; ruleStatusFilter: boolean; rulesDetailLogs: boolean; ruleUseExecutionStatus: boolean; }>" + "(configValue: string[]) => Readonly<{ rulesListDatagrid: boolean; internalAlertsTable: boolean; ruleTagFilter: boolean; ruleStatusFilter: boolean; rulesDetailLogs: boolean; ruleUseExecutionStatus: boolean; ruleKqlBar: boolean; }>" ], "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", "deprecated": false, @@ -9427,7 +9487,7 @@ "label": "ExperimentalFeatures", "description": [], "signature": [ - "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly ruleTagFilter: boolean; readonly ruleStatusFilter: boolean; readonly rulesDetailLogs: boolean; readonly ruleUseExecutionStatus: boolean; }" + "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly ruleTagFilter: boolean; readonly ruleStatusFilter: boolean; readonly rulesDetailLogs: boolean; readonly ruleUseExecutionStatus: boolean; readonly ruleKqlBar: boolean; }" ], "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", "deprecated": false, @@ -9491,7 +9551,7 @@ "\nA list of allowed values that can be used in `xpack.trigger_actions_ui.enableExperimental`.\nThis object is then used to validate and parse the value entered." ], "signature": [ - "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly ruleTagFilter: boolean; readonly ruleStatusFilter: boolean; readonly rulesDetailLogs: boolean; readonly ruleUseExecutionStatus: boolean; }" + "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly ruleTagFilter: boolean; readonly ruleStatusFilter: boolean; readonly rulesDetailLogs: boolean; readonly ruleUseExecutionStatus: boolean; readonly ruleKqlBar: boolean; }" ], "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", "deprecated": false, @@ -9512,6 +9572,119 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.NORMALIZED_FIELD_TYPES", + "type": "Object", + "tags": [], + "label": "NORMALIZED_FIELD_TYPES", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/common/normalized_field_types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.NORMALIZED_FIELD_TYPES.long", + "type": "string", + "tags": [], + "label": "long", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/common/normalized_field_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.NORMALIZED_FIELD_TYPES.integer", + "type": "string", + "tags": [], + "label": "integer", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/common/normalized_field_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.NORMALIZED_FIELD_TYPES.short", + "type": "string", + "tags": [], + "label": "short", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/common/normalized_field_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.NORMALIZED_FIELD_TYPES.byte", + "type": "string", + "tags": [], + "label": "byte", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/common/normalized_field_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.NORMALIZED_FIELD_TYPES.double", + "type": "string", + "tags": [], + "label": "double", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/common/normalized_field_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.NORMALIZED_FIELD_TYPES.float", + "type": "string", + "tags": [], + "label": "float", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/common/normalized_field_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.NORMALIZED_FIELD_TYPES.half_float", + "type": "string", + "tags": [], + "label": "half_float", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/common/normalized_field_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.NORMALIZED_FIELD_TYPES.scaled_float", + "type": "string", + "tags": [], + "label": "scaled_float", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/common/normalized_field_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-common.NORMALIZED_FIELD_TYPES.unsigned_long", + "type": "string", + "tags": [], + "label": "unsigned_long", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/common/normalized_field_types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false } ] } diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index e9e1c36ee918f..2ffa0b4e97bba 100644 --- a/api_docs/triggers_actions_ui.mdx +++ b/api_docs/triggers_actions_ui.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/triggersActionsUi title: "triggersActionsUi" image: https://source.unsplash.com/400x175/?github description: API docs for the triggersActionsUi plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi'] --- import triggersActionsUiObj from './triggers_actions_ui.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 547 | 11 | 521 | 49 | +| 560 | 11 | 534 | 50 | ## Client diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index 1820485d397f6..32c8bb15f7c5d 100644 --- a/api_docs/ui_actions.mdx +++ b/api_docs/ui_actions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/uiActions title: "uiActions" image: https://source.unsplash.com/400x175/?github description: API docs for the uiActions plugin -date: 2023-06-30 +date: 2023-07-18 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 daecbdd0d463a..52ffda62e7d90 100644 --- a/api_docs/ui_actions_enhanced.mdx +++ b/api_docs/ui_actions_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/uiActionsEnhanced title: "uiActionsEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the uiActionsEnhanced plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] --- import uiActionsEnhancedObj from './ui_actions_enhanced.devdocs.json'; diff --git a/api_docs/unified_histogram.devdocs.json b/api_docs/unified_histogram.devdocs.json index 39768585d6aa5..5b5b6d13ef809 100644 --- a/api_docs/unified_histogram.devdocs.json +++ b/api_docs/unified_histogram.devdocs.json @@ -468,7 +468,7 @@ }, " | undefined; } & Pick<", "UnifiedHistogramLayoutProps", - ", \"children\" | \"className\" | \"query\" | \"filters\" | \"columns\" | \"timeRange\" | \"services\" | \"dataView\" | \"relativeTimeRange\" | \"resizeRef\" | \"appendHitsCounter\"> & React.RefAttributes<", + ", \"children\" | \"className\" | \"query\" | \"filters\" | \"columns\" | \"timeRange\" | \"dataView\" | \"services\" | \"relativeTimeRange\" | \"resizeRef\" | \"appendHitsCounter\"> & React.RefAttributes<", { "pluginId": "unifiedHistogram", "scope": "public", @@ -892,6 +892,30 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "unifiedHistogram", + "id": "def-public.UnifiedHistogramState.lensTablesAdapter", + "type": "Object", + "tags": [], + "label": "lensTablesAdapter", + "description": [ + "\nThe current Lens request table" + ], + "signature": [ + "Record | undefined" + ], + "path": "src/plugins/unified_histogram/public/container/services/state_service.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "unifiedHistogram", "id": "def-public.UnifiedHistogramState.timeInterval", @@ -1154,7 +1178,7 @@ }, " | undefined; } & Pick<", "UnifiedHistogramLayoutProps", - ", \"children\" | \"className\" | \"query\" | \"filters\" | \"columns\" | \"timeRange\" | \"services\" | \"dataView\" | \"relativeTimeRange\" | \"resizeRef\" | \"appendHitsCounter\">" + ", \"children\" | \"className\" | \"query\" | \"filters\" | \"columns\" | \"timeRange\" | \"dataView\" | \"services\" | \"relativeTimeRange\" | \"resizeRef\" | \"appendHitsCounter\">" ], "path": "src/plugins/unified_histogram/public/container/container.tsx", "deprecated": false, diff --git a/api_docs/unified_histogram.mdx b/api_docs/unified_histogram.mdx index 26e8b03a31ceb..eb85f4942b370 100644 --- a/api_docs/unified_histogram.mdx +++ b/api_docs/unified_histogram.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedHistogram title: "unifiedHistogram" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedHistogram plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedHistogram'] --- import unifiedHistogramObj from './unified_histogram.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 52 | 0 | 23 | 2 | +| 53 | 0 | 23 | 2 | ## Client diff --git a/api_docs/unified_search.devdocs.json b/api_docs/unified_search.devdocs.json index dc374dfc03971..0097e2c1de781 100644 --- a/api_docs/unified_search.devdocs.json +++ b/api_docs/unified_search.devdocs.json @@ -208,7 +208,7 @@ "section": "def-public.FilterItemsProps", "text": "FilterItemsProps" }, - ", \"indexPatterns\" | \"filters\" | \"readOnly\" | \"filtersForSuggestions\" | \"onFiltersUpdated\" | \"hiddenPanelOptions\" | \"timeRangeForSuggestionsOverride\"> & React.RefAttributes & React.RefAttributes, any, any>>) => JSX.Element" + ", \"filters\" | \"indexPatterns\" | \"readOnly\" | \"filtersForSuggestions\" | \"suggestionsAbstraction\" | \"onFiltersUpdated\" | \"hiddenPanelOptions\" | \"timeRangeForSuggestionsOverride\">, any, any>>) => JSX.Element" ], "path": "src/plugins/unified_search/public/filter_bar/index.tsx", "deprecated": false, @@ -238,7 +238,7 @@ "section": "def-public.FilterItemsProps", "text": "FilterItemsProps" }, - ", \"indexPatterns\" | \"filters\" | \"readOnly\" | \"filtersForSuggestions\" | \"onFiltersUpdated\" | \"hiddenPanelOptions\" | \"timeRangeForSuggestionsOverride\"> & React.RefAttributes & React.RefAttributes, any, any>>" + ", \"filters\" | \"indexPatterns\" | \"readOnly\" | \"filtersForSuggestions\" | \"suggestionsAbstraction\" | \"onFiltersUpdated\" | \"hiddenPanelOptions\" | \"timeRangeForSuggestionsOverride\">, any, any>>" ], "path": "src/plugins/unified_search/public/filter_bar/index.tsx", "deprecated": false, @@ -359,15 +359,7 @@ "label": "props", "description": [], "signature": [ - "{ isClearable?: boolean | undefined; placeholder?: string | undefined; isDisabled?: boolean | undefined; isLoading?: boolean | undefined; indexPatterns?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[] | undefined; query?: ", + "{ isClearable?: boolean | undefined; placeholder?: string | undefined; isDisabled?: boolean | undefined; isLoading?: boolean | undefined; query?: ", { "pluginId": "@kbn/es-query", "scope": "common", @@ -375,9 +367,7 @@ "section": "def-common.Query", "text": "Query" }, - " | QT | undefined; refreshInterval?: number | undefined; iconType?: ", - "IconType", - " | undefined; filters?: ", + " | QT | undefined; filters?: ", { "pluginId": "@kbn/es-query", "scope": "common", @@ -385,7 +375,17 @@ "section": "def-common.Filter", "text": "Filter" }, - "[] | undefined; dataTestSubj?: string | undefined; timeHistory?: ", + "[] | undefined; indexPatterns?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[] | undefined; refreshInterval?: number | undefined; iconType?: ", + "IconType", + " | undefined; dataTestSubj?: string | undefined; timeHistory?: ", { "pluginId": "data", "scope": "public", @@ -487,6 +487,8 @@ "OnSaveTextLanguageQueryProps", ") => void) | undefined; showSubmitButton?: boolean | undefined; submitButtonStyle?: \"full\" | \"auto\" | \"iconOnly\" | undefined; suggestionsSize?: ", "SuggestionsListSize", + " | undefined; suggestionsAbstraction?: ", + "SuggestionsAbstraction", " | undefined; isScreenshotMode?: boolean | undefined; submitOnBlur?: boolean | undefined; onFiltersUpdated?: ((filters: ", { "pluginId": "@kbn/es-query", @@ -1160,6 +1162,23 @@ "path": "src/plugins/unified_search/public/filter_bar/filter_item/filter_items.tsx", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.FilterItemsProps.suggestionsAbstraction", + "type": "Object", + "tags": [], + "label": "suggestionsAbstraction", + "description": [ + "Array of suggestion abstraction that controls the render of the field" + ], + "signature": [ + "SuggestionsAbstraction", + " | undefined" + ], + "path": "src/plugins/unified_search/public/filter_bar/filter_item/filter_items.tsx", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -1824,6 +1843,21 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QueryStringInputProps.suggestionsAbstraction", + "type": "Object", + "tags": [], + "label": "suggestionsAbstraction", + "description": [], + "signature": [ + "SuggestionsAbstraction", + " | undefined" + ], + "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "unifiedSearch", "id": "def-public.QueryStringInputProps.className", diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx index 9ca7e0c48c855..dac429d6ee5eb 100644 --- a/api_docs/unified_search.mdx +++ b/api_docs/unified_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedSearch title: "unifiedSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedSearch plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch'] --- import unifiedSearchObj from './unified_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 | |-------------------|-----------|------------------------|-----------------| -| 137 | 2 | 100 | 20 | +| 140 | 2 | 102 | 21 | ## Client diff --git a/api_docs/unified_search_autocomplete.devdocs.json b/api_docs/unified_search_autocomplete.devdocs.json index b74b1ff916d1f..bcd032d62256f 100644 --- a/api_docs/unified_search_autocomplete.devdocs.json +++ b/api_docs/unified_search_autocomplete.devdocs.json @@ -142,6 +142,21 @@ "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionGetFnArgs.suggestionsAbstraction", + "type": "Object", + "tags": [], + "label": "suggestionsAbstraction", + "description": [], + "signature": [ + "SuggestionsAbstraction", + " | undefined" + ], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx index 44e0532cc60b4..595c50dddc65a 100644 --- a/api_docs/unified_search_autocomplete.mdx +++ b/api_docs/unified_search_autocomplete.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedSearch-autocomplete title: "unifiedSearch.autocomplete" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedSearch.autocomplete plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] --- import unifiedSearchAutocompleteObj from './unified_search_autocomplete.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 | |-------------------|-----------|------------------------|-----------------| -| 137 | 2 | 100 | 20 | +| 140 | 2 | 102 | 21 | ## Client diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index 3eef30cddca4e..edb82255bb712 100644 --- a/api_docs/url_forwarding.mdx +++ b/api_docs/url_forwarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/urlForwarding title: "urlForwarding" image: https://source.unsplash.com/400x175/?github description: API docs for the urlForwarding plugin -date: 2023-06-30 +date: 2023-07-18 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 8fbcaf41c5412..5a54d0b6769ea 100644 --- a/api_docs/usage_collection.mdx +++ b/api_docs/usage_collection.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/usageCollection title: "usageCollection" image: https://source.unsplash.com/400x175/?github description: API docs for the usageCollection plugin -date: 2023-06-30 +date: 2023-07-18 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 84718215e6148..d3e34a9be9929 100644 --- a/api_docs/ux.mdx +++ b/api_docs/ux.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ux title: "ux" image: https://source.unsplash.com/400x175/?github description: API docs for the ux plugin -date: 2023-06-30 +date: 2023-07-18 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 3445683bb5db4..47fe8087268e5 100644 --- a/api_docs/vis_default_editor.mdx +++ b/api_docs/vis_default_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visDefaultEditor title: "visDefaultEditor" image: https://source.unsplash.com/400x175/?github description: API docs for the visDefaultEditor plugin -date: 2023-06-30 +date: 2023-07-18 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 5252022e72401..6d01fc34d315e 100644 --- a/api_docs/vis_type_gauge.mdx +++ b/api_docs/vis_type_gauge.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeGauge title: "visTypeGauge" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeGauge plugin -date: 2023-06-30 +date: 2023-07-18 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 75e41b1380b80..1ff6e28c7e103 100644 --- a/api_docs/vis_type_heatmap.mdx +++ b/api_docs/vis_type_heatmap.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeHeatmap title: "visTypeHeatmap" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeHeatmap plugin -date: 2023-06-30 +date: 2023-07-18 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 70cb5ba73fa29..1ab7fbe1b670a 100644 --- a/api_docs/vis_type_pie.mdx +++ b/api_docs/vis_type_pie.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypePie title: "visTypePie" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypePie plugin -date: 2023-06-30 +date: 2023-07-18 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 b677cc575d14b..74f8092fdcd2f 100644 --- a/api_docs/vis_type_table.mdx +++ b/api_docs/vis_type_table.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTable title: "visTypeTable" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeTable plugin -date: 2023-06-30 +date: 2023-07-18 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 342f57da12f1b..ea8c1274788cc 100644 --- a/api_docs/vis_type_timelion.mdx +++ b/api_docs/vis_type_timelion.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTimelion title: "visTypeTimelion" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeTimelion plugin -date: 2023-06-30 +date: 2023-07-18 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 ac3272a9bd92e..4497030e5b1b1 100644 --- a/api_docs/vis_type_timeseries.mdx +++ b/api_docs/vis_type_timeseries.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTimeseries title: "visTypeTimeseries" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeTimeseries plugin -date: 2023-06-30 +date: 2023-07-18 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 d7373253c1ba2..5cbab0bab9298 100644 --- a/api_docs/vis_type_vega.mdx +++ b/api_docs/vis_type_vega.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeVega title: "visTypeVega" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeVega plugin -date: 2023-06-30 +date: 2023-07-18 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 950bd297eb8be..da66abf77ea8e 100644 --- a/api_docs/vis_type_vislib.mdx +++ b/api_docs/vis_type_vislib.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeVislib title: "visTypeVislib" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeVislib plugin -date: 2023-06-30 +date: 2023-07-18 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 375a42ed70b70..94e0701062924 100644 --- a/api_docs/vis_type_xy.mdx +++ b/api_docs/vis_type_xy.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeXy title: "visTypeXy" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeXy plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] --- import visTypeXyObj from './vis_type_xy.devdocs.json'; diff --git a/api_docs/visualization_ui_components.mdx b/api_docs/visualization_ui_components.mdx index 835dfbe6bf1f4..0537213bd9cdf 100644 --- a/api_docs/visualization_ui_components.mdx +++ b/api_docs/visualization_ui_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visualizationUiComponents title: "visualizationUiComponents" image: https://source.unsplash.com/400x175/?github description: API docs for the visualizationUiComponents plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizationUiComponents'] --- import visualizationUiComponentsObj from './visualization_ui_components.devdocs.json'; diff --git a/api_docs/visualizations.devdocs.json b/api_docs/visualizations.devdocs.json index 75d59826bdfbe..8a706378ff23e 100644 --- a/api_docs/visualizations.devdocs.json +++ b/api_docs/visualizations.devdocs.json @@ -6390,7 +6390,15 @@ "section": "def-public.VisualizeInput", "text": "VisualizeInput" }, - ">) => void; render: (domNode: HTMLElement) => Promise; getFilters: () => Promise<", + ">) => void; openInspector: () => ", + { + "pluginId": "@kbn/core-mount-utils-browser", + "scope": "common", + "docId": "kibKbnCoreMountUtilsBrowserPluginApi", + "section": "def-common.OverlayRef", + "text": "OverlayRef" + }, + " | undefined; render: (domNode: HTMLElement) => Promise; getFilters: () => Promise<", { "pluginId": "@kbn/es-query", "scope": "common", @@ -6422,14 +6430,6 @@ "section": "def-common.Adapters", "text": "Adapters" }, - " | undefined; openInspector: () => ", - { - "pluginId": "@kbn/core-mount-utils-browser", - "scope": "common", - "docId": "kibKbnCoreMountUtilsBrowserPluginApi", - "section": "def-common.OverlayRef", - "text": "OverlayRef" - }, " | undefined; transferCustomizationsToUiState: () => void; hasInspector: () => boolean; onContainerLoading: () => void; onContainerData: () => void; onContainerRender: () => void; onContainerError: (error: ", { "pluginId": "expressions", diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index adcda94576e48..72ddb254498f0 100644 --- a/api_docs/visualizations.mdx +++ b/api_docs/visualizations.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visualizations title: "visualizations" image: https://source.unsplash.com/400x175/?github description: API docs for the visualizations plugin -date: 2023-06-30 +date: 2023-07-18 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] --- import visualizationsObj from './visualizations.devdocs.json'; diff --git a/config/serverless.oblt.yml b/config/serverless.oblt.yml index 9f34fb10898a6..2928e75095897 100644 --- a/config/serverless.oblt.yml +++ b/config/serverless.oblt.yml @@ -35,6 +35,7 @@ xpack.apm.featureFlags.infraUiAvailable: false xpack.apm.featureFlags.migrationToFleetAvailable: false xpack.apm.featureFlags.sourcemapApiAvailable: false xpack.apm.featureFlags.storageExplorerAvailable: false +xpack.apm.featureFlags.fastRefreshAvailable: true # Specify in telemetry the project type telemetry.labels.serverless: observability diff --git a/config/serverless.security.yml b/config/serverless.security.yml index 5e7cd22a3500b..bad71f38f24af 100644 --- a/config/serverless.security.yml +++ b/config/serverless.security.yml @@ -6,9 +6,9 @@ xpack.apm.enabled: false xpack.observability.enabled: false xpack.uptime.enabled: false -## Enable the Serverless Security plugin -xpack.serverless.security.enabled: true -xpack.serverless.security.productTypes: +## Enable the Security Solution Serverless plugin +xpack.securitySolutionServerless.enabled: true +xpack.securitySolutionServerless.productTypes: [ { product_line: 'security', product_tier: 'complete' }, { product_line: 'endpoint', product_tier: 'complete' }, diff --git a/config/serverless.yml b/config/serverless.yml index b7f2833810d0a..0e616a97177c6 100644 --- a/config/serverless.yml +++ b/config/serverless.yml @@ -2,9 +2,17 @@ interactiveSetup.enabled: false newsfeed.enabled: false xpack.security.showNavLinks: false xpack.serverless.plugin.enabled: true +# Fleet settings xpack.fleet.internal.fleetServerStandalone: true xpack.fleet.internal.disableILMPolicies: true xpack.fleet.internal.disableProxies: true +xpack.fleet.internal.activeAgentsSoftLimit: 25000 + +# Cloud links +xpack.cloud.base_url: "https://cloud.elastic.co" +xpack.cloud.profile_url: "/user/settings" +xpack.cloud.billing_url: "/billing" +xpack.cloud.organization_url: "/account" # Enable ZDT migration algorithm migrations.algorithm: zdt @@ -13,10 +21,10 @@ migrations.algorithm: zdt # until the controller is able to spawn the migrator job/pod migrations.zdt: metaPickupSyncDelaySec: 5 - runOnRoles: ["ui"] + runOnRoles: ['ui'] # Ess plugins -xpack.ess.security.enabled: false +xpack.securitySolutionEss.enabled: false # Management team plugins xpack.upgrade_assistant.enabled: false @@ -28,6 +36,13 @@ xpack.remote_clusters.enabled: false xpack.snapshot_restore.enabled: false xpack.license_management.enabled: false +# Disable index management actions from the UI +xpack.index_management.enableIndexActions: false + +# Keep deeplinks visible so that they are shown in the sidenav +dev_tools.deeplinks.navLinkStatus: visible +management.deeplinks.navLinkStatus: visible + # Other disabled plugins #xpack.canvas.enabled: false #only disabable in dev-mode xpack.reporting.enabled: false @@ -53,9 +68,12 @@ server.versioned.versionResolution: newest # do not enforce client version check server.versioned.strictClientVersionCheck: false -# Enforce single "default" space +# Enforce single "default" space and disable feature visibility controls xpack.spaces.maxSpaces: 1 +xpack.spaces.allowFeatureVisibility: false + +# Only display console autocomplete suggestions for ES endpoints that are available in serverless +console.autocompleteDefinitions.endpointsAvailability: serverless -# Temporarily allow unauthenticated access to task manager utilization & status/stats APIs for autoscaling -status.allowAnonymous: true -xpack.task_manager.unsafe.authenticate_background_task_utilization: false +# Allow authentication via the Elasticsearch JWT realm with the `shared_secret` client authentication type. +elasticsearch.requestHeadersWhitelist: ["authorization", "es-client-authentication"] diff --git a/dev_docs/tutorials/debugging.mdx b/dev_docs/tutorials/debugging.mdx index fabd475f88d77..2f9818f571046 100644 --- a/dev_docs/tutorials/debugging.mdx +++ b/dev_docs/tutorials/debugging.mdx @@ -85,7 +85,7 @@ Backend (APM Node): In some cases, it is beneficial to enable APM on a local development environment to get an initial undesrtanding of a feature's performance during manual or automatic tests. 1. Create a secondary monitoring deployment to collect APM data. The easiest option is to use [Elastic Cloud](https://cloud.elastic.co/deployments) to create a new deployment. - 2. Open Kibana, go to `Integrations` and enable the Elastic APM integration. + 2. Open the Kibana from the monitoring deployment (_not_ your local Kibana), go to `Integrations` and enable the Elastic APM integration. 3. Scroll down and copy the server URL and secret token. You may also find them in your cloud console under APM & Fleet. 4. Create or open `config\kibana.dev.yml` on your local development environment. 5. Add the following settings: diff --git a/docs/CHANGELOG.asciidoc b/docs/CHANGELOG.asciidoc index e90fe1cbc9a1a..156a8f0254dd3 100644 --- a/docs/CHANGELOG.asciidoc +++ b/docs/CHANGELOG.asciidoc @@ -47,16 +47,43 @@ Review important information about the {kib} 8.x releases. [[release-notes-8.8.2]] == {kib} 8.8.2 -coming::[8.8.2] - Review the following information about the {kib} 8.8.2 release. +[float] +[[known-issues-8.8.2]] +=== Known issues + +// tag::known-issue-161249[] +[discrete] +.Kibana can run out of memory during an upgrade when there are many {fleet} agent policies. +[%collapsible] +==== +*Details* + +Due to a schema version update, during {fleet} setup in 8.8.x, all agent policies are being queried and deployed. +This action triggers a lot of queries to the Elastic Package Registry (EPR) to fetch integration packages. As a result, +there is an increase in Kibana's resident memory usage (RSS). + +*Impact* + +Because the default batch size of `100` for schema version upgrade of {fleet} agent policies is too high, this can +cause Kibana to run out of memory during an upgrade. For example, we have observed 1GB Kibana instances run +out of memory during an upgrade when there were 20 agent policies with 5 integrations in each. + +*Workaround* + +Two workaround options are available: + +* Increase the Kibana instance size to 2GB. So far, we are not able to reproduce the issue with 2GB instances. +* Set `xpack.fleet.setup.agentPolicySchemaUpgradeBatchSize` to `2` in the `kibana.yml` and restart the Kibana instance(s). + +In 8.9.0, we are addressing this by changing the default batch size to `2`. + +==== +// end::known-issue-161249[] + [float] [[fixes-v8.8.2]] === Bug Fixes APM:: -* Circuit breaker and performance improvements for service map {kibana-pull}159883[#159883] * Fixes the latency graph displaying all service transactions, rather than the selected one, on the transaction detail page {kibana-pull}159085[#159085] Dashboard:: @@ -109,6 +136,32 @@ Review the following information about the {kib} 8.8.1 release. [[known-issues-8.8.1]] === Known issues +// tag::known-issue-161249[] +[discrete] +.Kibana can run out of memory during an upgrade when there are many {fleet} agent policies. +[%collapsible] +==== +*Details* + +Due to a schema version update, during {fleet} setup in 8.8.x, all agent policies are being queried and deployed. +This action triggers a lot of queries to the Elastic Package Registry (EPR) to fetch integration packages. As a result, +there is an increase in Kibana's resident memory usage (RSS). + +*Impact* + +Because the default batch size of `100` for schema version upgrade of {fleet} agent policies is too high, this can +cause Kibana to run out of memory during an upgrade. For example, we have observed 1GB Kibana instances run +out of memory during an upgrade when there were 20 agent policies with 5 integrations in each. + +*Workaround* + +Two workaround options are available: + +* Increase the Kibana instance size to 2GB. So far, we are not able to reproduce the issue with 2GB instances. +* Set `xpack.fleet.setup.agentPolicySchemaUpgradeBatchSize` to `2` in the `kibana.yml` and restart the Kibana instance(s). + +In 8.9.0, we are addressing this by changing the default batch size to `2`. + +==== +// end::known-issue-161249[] + // tag::known-issue-159807[] [discrete] .Memory leak in {fleet} audit logging. @@ -201,6 +254,32 @@ Review the following information about the {kib} 8.8.0 release. [[known-issues-8.8.0]] === Known issues +// tag::known-issue-161249[] +[discrete] +.Kibana can run out of memory during an upgrade when there are many {fleet} agent policies. +[%collapsible] +==== +*Details* + +Due to a schema version update, during {fleet} setup in 8.8.x, all agent policies are being queried and deployed. +This action triggers a lot of queries to the Elastic Package Registry (EPR) to fetch integration packages. As a result, +there is an increase in Kibana's resident memory usage (RSS). + +*Impact* + +Because the default batch size of `100` for schema version upgrade of {fleet} agent policies is too high, this can +cause Kibana to run out of memory during an upgrade. For example, we have observed 1GB Kibana instances run +out of memory during an upgrade when there were 20 agent policies with 5 integrations in each. + +*Workaround* + +Two workaround options are available: + +* Increase the Kibana instance size to 2GB. So far, we are not able to reproduce the issue with 2GB instances. +* Set `xpack.fleet.setup.agentPolicySchemaUpgradeBatchSize` to `2` in the `kibana.yml` and restart the Kibana instance(s). + +In 8.9.0, we are addressing this by changing the default batch size to `2`. + +==== +// end::known-issue-161249[] + // tag::known-issue-158940[] [discrete] .Failed upgrades to 8.8.0 can cause bootlooping and data loss @@ -224,6 +303,7 @@ The 8.8.1 release includes in {kibana-pull}158940[a fix] for this problem. Custo *Details* + {fleet} introduced audit logging for various CRUD (create, read, update, and delete) operations in version 8.8.0. While audit logging is not enabled by default, we have identified an off-heap memory leak in the implementation of {fleet} audit logging that can result in poor {kib} performance, and in some cases {kib} instances being terminated by the OS kernel's oom-killer. This memory leak can occur even when {kib} audit logging is not explicitly enabled (regardless of whether `xpack.security.audit.enabled` is set in the `kibana.yml` settings file). + *Impact* + The version 8.8.2 release includes in {kibana-pull}159807[a fix] for this problem. If you are using {fleet} integrations and {kib} audit logging in version 8.8.0 or 8.8.1, you should upgrade to 8.8.2 or above to obtain the fix. @@ -320,7 +400,7 @@ The project monitor API for Synthetics in Elastic Observability has been removed *Impact* + In 8.8.0 and later, an error appears when you use the project monitor API. ==== - + [discrete] [[breaking-147985]] .Changes the privileges for alerts and cases @@ -330,7 +410,7 @@ In 8.8.0 and later, an error appears when you use the project monitor API. The privileges for attaching alerts to cases has changed. For more information, refer to {kibana-pull}147985[#147985]. *Impact* + -To attach alerts to cases, you must have `Read` access to an {observability} or Security feature that has alerts and `All` access to the **Cases** feature. For detailed information, check link:https://www.elastic.co/guide/en/kibana/current/kibana-privileges.html[{kib} privileges] and link:https://www.elastic.co/guide/en/kibana/current/setup-cases.html[Configure access to cases]. +To attach alerts to cases, you must have `Read` access to an {observability} or Security feature that has alerts and `All` access to the **Cases** feature. For detailed information, check link:https://www.elastic.co/guide/en/kibana/current/kibana-privileges.html[{kib} privileges] and link:https://www.elastic.co/guide/en/kibana/current/setup-cases.html[Configure access to cases]. ==== // end::notable-breaking-changes[] @@ -345,7 +425,7 @@ To review the breaking changes in previous versions, refer to the following: The following functionality is deprecated in 8.8.0, and will be removed in 9.0.0. Deprecated functionality does not have an immediate impact on your application, but we strongly recommend you make the necessary updates after you upgrade to 8.8.0. - + [discrete] [[deprecation-154275]] .Deprecates ephemeral Task Manager settings @@ -363,7 +443,7 @@ For more information, refer to {kibana-pull}154275[#154275]. *Impact* + To improve task execution resiliency, remove the deprecated settings from the `kibana.yml` file. For detailed information, check link:https://www.elastic.co/guide/en/kibana/current/task-manager-settings-kb.html[Task Manager settings in {kib}]. ==== - + [discrete] [[deprecation-154010]] .Deprecates monitor schedules @@ -375,7 +455,7 @@ Synthetics and Uptime monitor schedules and zip URL fields are deprecated. For m *Impact* + When you create monitors in Uptime Monitor Management and the Synthetics app, unsupported schedules are automatically transfered to the nearest supported schedule. To use zip URLs, use project monitors. ==== - + [discrete] [[deprecation-152236]] .Deprecates Agent reassign API PUT endpoint @@ -387,7 +467,7 @@ The PUT endpoint for the agent reassign API is deprecated. For more information, *Impact* + Use the POST endpoint for the agent reassign API. ==== - + [discrete] [[deprecation-151564]] .Deprecates `total` in `/agent_status` Fleet API @@ -402,7 +482,7 @@ The `/agent_status` Fleet API now returns the following statuses: * `all` — All active and inactive * `active` — All active ==== - + [discrete] [[deprecation-149506]] .Deprecates Elastic Synthetics integration @@ -412,9 +492,9 @@ The `/agent_status` Fleet API now returns the following statuses: The Elastic Synthetics integration is deprecated. For more information, refer to {kibana-pull}149506[#149506]. *Impact* + -To monitor endpoints, pages, and user journeys, go to **{observability}** -> **Synthetics (beta)**. +To monitor endpoints, pages, and user journeys, go to **{observability}** -> **Synthetics (beta)**. ==== - + [float] [[features-8.8.0]] === Features @@ -836,7 +916,7 @@ Before you upgrade to 8.7.0, review the breaking changes, then mitigate the impa `lens:useFieldExistenceSampling` has been removed from *Advanced Settings*. The setting allowed you to enable document sampling to determine the fields that are displayed in *Lens*. For more information, refer to {kibana-pull}149482[#149482]. *Impact* + -In 8.1.0 and later, {kib} uses the field caps API, by default, to determine the fields that are displayed in *Lens*. +In 8.1.0 and later, {kib} uses the field caps API, by default, to determine the fields that are displayed in *Lens*. ==== [discrete] @@ -850,7 +930,7 @@ In 8.1.0 and later, {kib} uses the field caps API, by default, to determine the *Impact* + In 7.14.0 and later, the new aggregation-based pie chart visualization is available by default. For more information, check link:https://www.elastic.co/guide/en/kibana/current/add-aggregation-based-visualization-panels.html[Aggregation-based]. ==== - + [discrete] [[breaking-147616]] .Removes the current_upgrades endpoint @@ -862,7 +942,7 @@ The `api/fleet/current_upgrades` endpoint has been removed. For more information *Impact* + When you upgrade to 8.7.0, use the `/action_status` endpoint. ==== - + [discrete] [[breaking-147199]] .Removes the preconfiguration API route @@ -1779,9 +1859,9 @@ Before you upgrade to 8.5.0, review the breaking changes, then mitigate the impa To make bulk action responses consistent, returns `actionId` instead of agent ids with `success: True` or `success: False` results. For more information, refer to {kibana-pull}141757[#141757]. *Impact* + -When you use `FleetBulkResponse`, you now receive only `actionId` responses. +When you use `FleetBulkResponse`, you now receive only `actionId` responses. ==== - + [discrete] [[breaking-139431]] .Removes filter validation for ad-hoc data views @@ -1793,7 +1873,7 @@ Filters associated with unknown data views, such as deleted data views, are no l *Impact* + Filters associated with unknown data views now display a warning message instead of being automatically disabled. ==== - + [discrete] [[breaking-138677]] .Removes the `package_policies` field from the agent policy saved object @@ -1809,7 +1889,7 @@ The agent policy saved object no longer includes the `package_policies` field. To review the breaking changes in previous versions, refer to the following: {kibana-ref-all}/8.4/release-notes-8.4.0.html#breaking-changes-8.4.0[8.4.0] | {kibana-ref-all}/8.3/release-notes-8.3.0.html#breaking-changes-8.3.0[8.3.0] | {kibana-ref-all}/8.2/release-notes-8.2.0.html#breaking-changes-8.2.0[8.2.0] | {kibana-ref-all}/8.1/release-notes-8.1.0.html#breaking-changes-8.1.0[8.1.0] | {kibana-ref-all}/8.0/release-notes-8.0.0.html#breaking-changes-8.0.0[8.0.0] | {kibana-ref-all}/8.0/release-notes-8.0.0-rc2.html#breaking-changes-8.0.0-rc2[8.0.0-rc2] | {kibana-ref-all}/8.0/release-notes-8.0.0-rc1.html#breaking-changes-8.0.0-rc1[8.0.0-rc1] | {kibana-ref-all}/8.0/release-notes-8.0.0-beta1.html#breaking-changes-8.0.0-beta1[8.0.0-beta1] | {kibana-ref-all}/8.0/release-notes-8.0.0-alpha2.html#breaking-changes-8.0.0-alpha2[8.0.0-alpha2] | {kibana-ref-all}/8.0/release-notes-8.0.0-alpha1.html#breaking-changes-8.0.0-alpha1[8.0.0-alpha1] - + [float] [[features-8.5.0]] === Features @@ -2274,21 +2354,21 @@ Before you upgrade to 8.4.0, review the breaking changes, then mitigate the impa [%collapsible] ==== *Details* + -When you configure `setxpack.fleet.agents.fleet_server.hosts` and `xpack.fleet.agents.elasticsearch.hosts` in kibana.yml, you are unable to update the fields on the Fleet UI. +When you configure `setxpack.fleet.agents.fleet_server.hosts` and `xpack.fleet.agents.elasticsearch.hosts` in kibana.yml, you are unable to update the fields on the Fleet UI. For more information, refer to {kibana-pull}135669[#135669]. *Impact* + To configure `setxpack.fleet.agents.fleet_server.hosts` and `xpack.fleet.agents.elasticsearch.hosts` on the Fleet UI, avoid configuring the settings in kibana.yml. ==== - + [discrete] [[breaking-134336]] .Removes the legacy charts library [%collapsible] ==== *Details* + -The legacy implementation of the *Timelion* visualization charts library has been removed. All *Timelion* visualizations now use the elastic-charts library, which was introduced in 7.15.0. +The legacy implementation of the *Timelion* visualization charts library has been removed. All *Timelion* visualizations now use the elastic-charts library, which was introduced in 7.15.0. For more information, refer to {kibana-pull}134336[#134336]. @@ -2312,14 +2392,14 @@ you make the necessary updates after you upgrade to 8.4.0. [%collapsible] ==== *Details* + -The ability to authenticate interactive users with ApiKey via a web browser has been deprecated, and will be removed in a future version. +The ability to authenticate interactive users with ApiKey via a web browser has been deprecated, and will be removed in a future version. For more information, refer to {kibana-pull}136422[#136422]. *Impact* + To authenticate interactive users via a web browser, use <>. Use API keys only for programmatic access to {kib} and {es}. ==== - + [float] [[features-8.4.0]] === Features @@ -2390,7 +2470,7 @@ For more information about the features introduced in 8.4.0, refer to < {rac-ui}*, multi-select the failed rules, click on **Manage rules > Disable** and then click on **Manage rules > Enable**. Disabling and re-enabling the rule will generate a new API key using the credentials of the user performing these actions and reset the rule -state. For more details about API key authorization, refer to +state. For more details about API key authorization, refer to <>. Example error message:: @@ -3711,7 +3791,7 @@ Observability:: * Ensure rum_allow_origins setting only saves valid YAML strings {kibana-pull}128704[#128704] * Standardize NOW as startedAt from executor options {kibana-pull}128020[#128020] * Fixes synthetics recorder file upload {kibana-pull}127614[#127614] -* Service maps popover detail metrics are aggregates over all transaction types {kibana-pull}125580[#125580] +* Service Maps popover detail metrics are aggregates over all transaction types {kibana-pull}125580[#125580] Platform:: * Fixes an issue where duplicate data appears in the inspector datatable in *Lens* for heatmap visualizations, and stale data persists in the inspector datatable when you remove layers {kibana-pull}126786[#126786] @@ -4226,9 +4306,9 @@ The `console.ssl` setting has been removed. For more information, refer to {kiba Before you upgrade to 8.0.0, remove `console.ssl` from kibana.yml. ==== -To review the breaking changes in previous versions, refer to the following: +To review the breaking changes in previous versions, refer to the following: -<> | <> | <> | <> | +<> | <> | <> | <> | <> [float] @@ -4291,7 +4371,7 @@ For information about the features introduced in 8.0.0, refer to <> | <> | <> | <> @@ -4354,9 +4434,9 @@ In production, you are no longer able to use the `elastic` superuser to authenti When you configure `elasticsearch.username: elastic`, {kib} fails. ==== -To review the breaking changes in previous versions, refer to the following: +To review the breaking changes in previous versions, refer to the following: -<> | <> | <> | +<> | <> | <> | <> [float] @@ -4459,7 +4539,7 @@ The endpoint is now split into two separate endpoints: } -- ==== - + [discrete] [[breaking-119945]] .Removes APM jobs from Machine Learning @@ -4490,7 +4570,7 @@ To complete the migration, re enable plugins or delete documents from the index [%collapsible] ==== *Details* + -On the Logs and Metrics UIs, references to the following API and saved object deprecated fields have been removed: +On the Logs and Metrics UIs, references to the following API and saved object deprecated fields have been removed: * `timestamp` * `tiebreaker` @@ -4504,9 +4584,9 @@ For more information, refer to {kibana-pull}116821[#116821] and {kibana-pull}115 When you upgrade to 8.0.0, you are unable to use references to the deprecated fields. ==== -To review the breaking changes in previous versions, refer to the following: +To review the breaking changes in previous versions, refer to the following: -<> | <> | +<> | <> | <> [float] @@ -4572,7 +4652,7 @@ For more information, refer to {fleet-guide}/fleet-api-docs.html[Fleet APIs]. ==== -To review the deprecations in previous versions, refer to the <>. +To review the deprecations in previous versions, refer to the <>. [float] @@ -4616,7 +4696,7 @@ Machine Learning:: * Adds support for `force` stop deployment {kibana-pull}118563[#118563] * Refactors data view loading to remove unnecessary searches {kibana-pull}116455[#116455] Observability:: -* Service maps: Adds sparklines to the detail popover {kibana-pull}120021[#120021] +* Service Maps: Adds sparklines to the detail popover {kibana-pull}120021[#120021] * Offer users upgrade to multi-metric job {kibana-pull}119980[#119980] * Display relevant anomalies from multi-metric job {kibana-pull}119709[#119709] * Adds service icon for the originating service in traces table {kibana-pull}119421[#119421] @@ -4716,14 +4796,14 @@ Review the {kib} 8.0.0-beta1 changes, then use the <> | <> [float] [[alerting-breaking-changes-8.0.0-beta1]] -==== Alerting - +==== Alerting + [discrete] [[breaking-114558]] .Removes `xpack.task_manager.index` @@ -4818,7 +4898,7 @@ Before you upgrade, make the following changes in kibana.yml: The *Dimming opacity* setting in *Advanced Settings* has been removed. For more information, refer to {kibana-pull}111704[#111704]. *Impact* + -When you upgrade to 8.0.0, you are no longer able to configure the dimming opactiy for visualizations. +When you upgrade to 8.0.0, you are no longer able to configure the dimming opactiy for visualizations. ==== [discrete] @@ -4830,7 +4910,7 @@ When you upgrade to 8.0.0, you are no longer able to configure the dimming opact In *TSVB*, custom Less stylesheets have been removed. For more information, refer to {kibana-pull}110985[#110985]. *Impact* + -Existing less stylesheets are automatically converted to CSS stylesheets. +Existing less stylesheets are automatically converted to CSS stylesheets. ==== [discrete] @@ -4882,7 +4962,7 @@ Configure the settings in https://www.elastic.co/guide/en/ecs/current/ecs-refere [float] [[machine-learning-breaking-changes-8.0.0-beta1]] ==== Machine learning - + [discrete] [[breaking-115444]] .Grants access to machine learning features when base privileges are used @@ -4913,7 +4993,7 @@ Install the on-prem version of the <>, [float] [[operations-breaking-changes-8.0.0-beta1]] -==== Operations +==== Operations [discrete] [[breaking-111535]] @@ -4929,8 +5009,8 @@ Replace the `CONFIG_PATH` environment variable with `KBN_PATH_CONF`, and replace [float] [[platform-breaking-changes-8.0.0-beta1]] -==== Platform - +==== Platform + [discrete] [[breaking-114379]] .Removes supports for csp.rules configuration @@ -5037,7 +5117,7 @@ The legacy `optimize.*` settings have been removed. If your configuration uses t For more information, refer to {kibana-pull}113296[#113296]. *Impact* + -To run the `@kbn/optimizer` separately in development, pass `--no-optimizer` to `yarn start`. For more details, refer to {kibana-pull}73154[#73154]. +To run the `@kbn/optimizer` separately in development, pass `--no-optimizer` to `yarn start`. For more details, refer to {kibana-pull}73154[#73154]. ==== [discrete] @@ -5082,7 +5162,7 @@ The `kibana.index`, `xpack.reporting.index`, and `xpack.task_manager.index` sett *Impact* + Use spaces, cross-cluster replication, or cross-cluster search. To migrate to <>, export your <> from a tenant into the default space. For more details, refer to link:https://github.com/elastic/kibana/issues/82020[#82020]. ==== - + [discrete] [[breaking-112305]] .Removes legacy logging @@ -5092,20 +5172,20 @@ Use spaces, cross-cluster replication, or cross-cluster search. To migrate to << The logging configuration and log output format has changed. For more information, refer to {kibana-pull}112305[#112305]. *Impact* + -Use the new <>. +Use the new <>. ==== [float] [[reporting-breaking-changes-8.0.0-beta1]] ==== Reporting - + [discrete] [[breaking-114216]] .Removes reporting settings [%collapsible] ==== *Details* + -The following settings have been removed: +The following settings have been removed: * `xpack.reporting.capture.concurrency` @@ -5123,7 +5203,7 @@ Before you upgrade to 8.0.0, remove the settings from kibana.yml. [float] [[rest-api-breaking-changes-8.0.0-beta1]] -==== REST API +==== REST API [discrete] [[breaking-114730]] @@ -5159,8 +5239,8 @@ Audit logs will be written to the default location in the new ECS format. To cha Deprecated functionality does not have an immediate impact on your application, but we strongly recommend you make the necessary updates after you complete the upgrade. -To review the 8.0.0 depcrecations, refer to the <>. - +To review the 8.0.0 depcrecations, refer to the <>. + [float] [[features-8.0.0-beta1]] === Features @@ -5239,7 +5319,7 @@ To review the breaking changes in the previous version, refer to <> to index your static vector data into {es}. +. To recreate the choropleth layer, use <> to index your static vector data into {es}. -. Create a choropleth layer from the indexed vector data. +. Create a choropleth layer from the indexed vector data. ==== - + [discrete] [[breaking-109798]] .Removes `kibana.defaultAppId` @@ -5281,7 +5361,7 @@ The deprecated `kibana.defaultAppId` setting in kibana.yml, which is also availa *Impact* + When you upgrade, remove `kibana.defaultAppId` from your kibana.yml file. To configure the default route for users when they enter a space, use the <> in *Advanced Settings*. ==== - + [discrete] [[breaking-109350]] .Removes `courier:batchSearches` @@ -5293,7 +5373,7 @@ The deprecated `courier:batchSearches` setting in *Advanced Settings* has been r *Impact* + When you upgrade, the `courier:batchSearches` setting will no longer be available. ==== - + [discrete] [[breaking-108111]] .Removes `xpack.task_manager.index` @@ -5305,7 +5385,7 @@ The deprecated `xpack.task_manager.index` setting in kibana.yml has been removed *Impact* + When you upgrade, remove `xpack.task_manager.index` from your kibana.yml file. ==== - + [discrete] [[breaking-108103]] .Removes dashboard-only mode @@ -5317,7 +5397,7 @@ The legacy dashboard-only mode has been removed. For more information, refer to *Impact* + To grant users access to only dashboards, create a new role, then assign only the *Dashboard* feature privilege. For more information, refer to <>. ==== - + [discrete] [[breaking-105979]] .Removes `xpack.maps.showMapVisualizationTypes` @@ -5336,8 +5416,8 @@ When you upgrade, remove `xpack.maps.showMapVisualizationTypes` from your kibana Deprecated functionality does not have an immediate impact on your application, but we strongly recommend you make the necessary updates after you complete the upgrade. -To review the 8.0.0 depcrecations, refer to the <>. - +To review the 8.0.0 depcrecations, refer to the <>. + [float] [[features-8.0.0-alpha2]] === Features @@ -5345,7 +5425,7 @@ The 8.0.0-alpha2 release adds the following new and notable feature. Security:: * Adds the interactive setup mode {kibana-pull}106881[#106881] - + [float] [[enhancement-v8.0.0-alpha2]] === Enhancements @@ -5365,7 +5445,7 @@ Review the {kib} 8.0.0-alpha1 changes, then use the <Query Parameter — The page number to return. default: 1
perPage (optional)
-
Query Parameter — The number of items to return. default: 20
sortOrder (optional)
+
Query Parameter — The number of items to return. Limited to 100 items. default: 20
sortOrder (optional)
Query Parameter — Determines the sort order. default: desc
types (optional)
@@ -951,7 +951,7 @@ Any modifications made to this file will be overwritten.
Query Parameter — The page number to return. default: 1
perPage (optional)
-
Query Parameter — The number of items to return. default: 20
sortOrder (optional)
+
Query Parameter — The number of items to return. Limited to 100 items. default: 20
sortOrder (optional)
Query Parameter — Determines the sort order. default: desc
types (optional)
@@ -1278,7 +1278,7 @@ Any modifications made to this file will be overwritten.
Query Parameter — The page number to return. default: 1
perPage (optional)
-
Query Parameter — The number of items to return. default: 20
reporters (optional)
+
Query Parameter — The number of items to return. Limited to 100 items. default: 20
reporters (optional)
Query Parameter — Filters the returned cases by the user name of the reporter. default: null
search (optional)
@@ -1471,7 +1471,7 @@ Any modifications made to this file will be overwritten.
Query Parameter — The page number to return. default: 1
perPage (optional)
-
Query Parameter — The number of items to return. default: 20
reporters (optional)
+
Query Parameter — The number of items to return. Limited to 100 items. default: 20
reporters (optional)
Query Parameter — Filters the returned cases by the user name of the reporter. default: null
search (optional)
@@ -4156,7 +4156,6 @@ Any modifications made to this file will be overwritten.
  • findCaseConnectorsDefaultSpace_200_response_inner_config -
  • findCasesDefaultSpace_200_response -
  • findCasesDefaultSpace_assignees_parameter -
    • -
  • findCasesDefaultSpace_category_parameter -
  • findCasesDefaultSpace_owner_parameter -
  • findCasesDefaultSpace_searchFields_parameter -
  • getCaseCommentDefaultSpace_200_response -
    • @@ -4580,6 +4579,7 @@ Any modifications made to this file will be overwritten.
    settings
    settings
    severity (optional)
    severity_property
    tags
    array[String] The words and phrases that help categorize cases. It can be an empty array.
    +
    category (optional)
    String Category for the case. It could be a word or a phrase to categorize the case.
    title
    String A title for the case.
    @@ -4659,12 +4659,6 @@ Any modifications made to this file will be overwritten.
    -
    -

    findCasesDefaultSpace_category_parameter - Up

    -
    -
    -
    -

    findCasesDefaultSpace_owner_parameter - Up

    @@ -5056,6 +5050,7 @@ Any modifications made to this file will be overwritten.
    severity (optional)
    severity_property
    status (optional)
    status
    tags (optional)
    array[String] The words and phrases that help categorize cases.
    +
    category (optional)
    String Category for the case. It could be a word or a phrase to categorize the case.
    title (optional)
    String A title for the case.
    version
    String The current version of the case. To determine this value, use the get case or find cases APIs.
    diff --git a/docs/api-generated/rules/rule-apis-passthru.asciidoc b/docs/api-generated/rules/rule-apis-passthru.asciidoc index e1cf66a214f31..fdcc9bc78bfd5 100644 --- a/docs/api-generated/rules/rule-apis-passthru.asciidoc +++ b/docs/api-generated/rules/rule-apis-passthru.asciidoc @@ -53,7 +53,7 @@ Any modifications made to this file will be overwritten. Up 
    post /s/{spaceId}/api/alerting/rule
    Creates a rule with a randomly generated rule identifier. (createRule)
    -
    You must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're creating. For example, you must have privileges for the Management > Stack rules feature, Analytics > Discover and Machine Learning features, Observability features, or Security features. If the rule has actions, you must also have read privileges for the Management > Actions and Connectors feature. NOTE: This API supports only token-based authentication. When you create a rule, it identifies which roles you have at that point in time. Thereafter, when the rule performs queries, it uses those security privileges. If a user with different privileges updates the rule, its behavior might change.
    +
    To create a rule, you must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're creating. For example, you must have privileges for the Management > Stack rules feature, Analytics > Discover and Machine Learning features, Observability features, or Security features. If the rule has actions, you must also have read privileges for the Management > Actions and Connectors feature. This API supports both key- and token-based authentication. To use key-based authentication, create an API key in Kibana and use it in the header of the API call. To use token-based authentication, provide a username and password; an API key that matches the current privileges of the user is created automatically. In both cases, the API key is subsequently used for authorization when the rule runs.

    Path parameters

    @@ -289,7 +289,7 @@ Any modifications made to this file will be overwritten. Up 
    post /s/{spaceId}/api/alerting/rule/{ruleId}
    Creates a rule with a specific rule identifier. (createRuleId)
    -
    You must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're creating. For example, you must have privileges for the Management > Stack rules feature, Analytics > Discover and Machine Learning features, Observability features, or Security features. If the rule has actions, you must also have read privileges for the Management > Actions and Connectors feature. NOTE: This API supports only token-based authentication. When you create a rule, it identifies which roles you have at that point in time. Thereafter, when the rule performs queries, it uses those security privileges. If a user with different privileges updates the rule, its behavior might change.
    +
    To create a rule, you must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're creating. For example, you must have privileges for the Management > Stack rules feature, Analytics > Discover and Machine Learning features, Observability features, or Security features. If the rule has actions, you must also have read privileges for the Management > Actions and Connectors feature. This API supports both key- and token-based authentication. To use key-based authentication, create an API key in Kibana and use it in the header of the API call. To use token-based authentication, provide a username and password; an API key that matches the current privileges of the user is created automatically. In both cases, the API key is subsequently used for authorization when the rule runs.

    Path parameters

    @@ -527,7 +527,7 @@ Any modifications made to this file will be overwritten. Up 
    delete /s/{spaceId}/api/alerting/rule/{ruleId}
    Deletes a rule. (deleteRule)
    -
    You must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're deleting. For example, the Management > Stack Rules feature, Analytics > Discover or Machine Learning features, Observability, or Security features. WARNING: After you delete a rule, you cannot recover it.
    +
    To delete a rule, you must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're deleting. For example, the Management > Stack Rules feature, Analytics > Discover or Machine Learning features, Observability, or Security features. WARNING: After you delete a rule, you cannot recover it. If the API key that is used by the rule was created automatically, it is deleted.

    Path parameters

    @@ -629,7 +629,7 @@ Any modifications made to this file will be overwritten. Up 
    post /s/{spaceId}/api/alerting/rule/{ruleId}/_enable
    Enables a rule. (enableRule)
    -
    This API supports token-based authentication only. You must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule. For example, the Management > Stack Rules feature, Analytics > Discover and Machine Learning features, Observability, and Security features.
    +
    To enable a rule, you must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule. For example, the Management > Stack Rules feature, Analytics > Discover and Machine Learning features, Observability, and Security features. This API supports both key- and token-based authentication. To use key-based authentication, create an API key in Kibana and use it in the header of the API call. To use token-based authentication, provide a username and password; an API key that matches the current privileges of the user is created automatically. In both cases, the API key is subsequently used for authorization when the rule runs.

    Path parameters

    @@ -2594,7 +2594,7 @@ Any modifications made to this file will be overwritten. Up 
    put /s/{spaceId}/api/alerting/rule/{ruleId}
    Updates the attributes for a rule. (updateRule)
    -
    You must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're updating. For example, you must have privileges for the Management > Stack rules feature, Analytics > Discover and Machine Learning features, Observability features, or Security features. If the rule has actions, you must also have read privileges for the Management > Actions and Connectors feature. NOTE: This API supports only token-based authentication. When you update a rule, it identifies which roles you have at that point in time. Thereafter, when the rule performs queries, it uses those security privileges. If you have different privileges than the user that created or most recently updated the rule, you might change its behavior. Though some properties are optional, when you update the rule the existing property values are overwritten with default values. Therefore, it is recommended to explicitly set all property values.
    +
    To update a rule, you must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're updating. For example, you must have privileges for the Management > Stack rules feature, Analytics > Discover and Machine Learning features, Observability features, or Security features. If the rule has actions, you must also have read privileges for the Management > Actions and Connectors feature. This API supports both key- and token-based authentication. To use key-based authentication, create an API key in Kibana and use it in the header of the API call. To use token-based authentication, provide a username and password; an API key that matches the current privileges of the user is created automatically. In both cases, the API key is subsequently used for authorization when the rule runs. NOTE: If the API key has different privileges than the key that created or most recently updated the rule, the rule behavior might change. Though some properties are optional, when you update the rule the existing property values are overwritten with default values. Therefore, it is recommended to explicitly set all property values.

    Path parameters

    diff --git a/docs/api/alerting/create_rule.asciidoc b/docs/api/alerting/create_rule.asciidoc index 590c33e895ea7..2bce4a1c49193 100644 --- a/docs/api/alerting/create_rule.asciidoc +++ b/docs/api/alerting/create_rule.asciidoc @@ -30,17 +30,6 @@ you must also have `read` privileges for the *Management* > *{connectors-feature}* feature. For more details, refer to <>. -=== {api-description-title} - -[WARNING] -==== -* This API supports only -<>. -* When you create a rule, it identifies which roles you have at that point in time. -Thereafter, when the rule performs queries, it uses those security privileges. -If a user with different privileges updates the rule, its behavior might change. -==== - [[create-rule-api-path-params]] === {api-path-parms-title} @@ -173,7 +162,7 @@ POST api/alerting/rule "group":"threshold met", "params":{ "level":"info", - "message":"alert '{{alertName}}' is active for group '{{context.group}}':\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{params.timeWindowSize}}{{params.timeWindowUnit}}\n- Timestamp: {{context.date}}" + "message":"Rule '{{rule.name}}' is active for group '{{context.group}}':\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}\n- Timestamp: {{context.date}}" } } ], @@ -231,7 +220,7 @@ The API returns the following: "id": "dceeb5d0-6b41-11eb-802b-85b0c1bc8ba2", "params": { "level": "info", - "message": "alert {{alertName}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{params.timeWindowSize}}{{params.timeWindowUnit}}\n- Timestamp: {{context.date}}" + "message": "Rule {{rule.name}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}\n- Timestamp: {{context.date}}" }, "connector_type_id": ".server-log" } diff --git a/docs/api/alerting/get_rules.asciidoc b/docs/api/alerting/get_rules.asciidoc index fd291617e08d3..60c879116948a 100644 --- a/docs/api/alerting/get_rules.asciidoc +++ b/docs/api/alerting/get_rules.asciidoc @@ -103,7 +103,7 @@ The API returns the following: "id":"1007a0c0-7a6e-11ed-89d5-abec321c0def", "params":{ "level":"info", - "message":"alert {{alertName}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{params.timeWindowSize}}{{params.timeWindowUnit}}\n- Timestamp: {{context.date}}" + "message":"Rule {{rule.name}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}\n- Timestamp: {{context.date}}" }, "connector_type_id":".server-log" }], diff --git a/docs/api/alerting/legacy/create.asciidoc b/docs/api/alerting/legacy/create.asciidoc index 8363569541356..18594b0b67f4b 100644 --- a/docs/api/alerting/legacy/create.asciidoc +++ b/docs/api/alerting/legacy/create.asciidoc @@ -127,7 +127,7 @@ $ curl -X POST api/alerts/alert -H 'kbn-xsrf: true' -H 'Content-Type: applicati "group":"threshold met", "params":{ "level":"info", - "message":"alert '{{alertName}}' is active for group '{{context.group}}':\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{params.timeWindowSize}}{{params.timeWindowUnit}}\n- Timestamp: {{context.date}}" + "message":"Rule '{{rule.name}}' is active for group '{{context.group}}':\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}\n- Timestamp: {{context.date}}" } } ], @@ -175,7 +175,7 @@ The API returns the following: "group": "threshold met", "params": { "level": "info", - "message": "alert {{alertName}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{params.timeWindowSize}}{{params.timeWindowUnit}}\n- Timestamp: {{context.date}}" + "message": "Rule {{rule.name}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}\n- Timestamp: {{context.date}}" }, "id": "dceeb5d0-6b41-11eb-802b-85b0c1bc8ba2" } diff --git a/docs/api/alerting/update_rule.asciidoc b/docs/api/alerting/update_rule.asciidoc index 0db4c2cf38195..11ca1dc35fc85 100644 --- a/docs/api/alerting/update_rule.asciidoc +++ b/docs/api/alerting/update_rule.asciidoc @@ -29,21 +29,6 @@ features, *{observability}*, or *Security* features. If the rule has *{connectors-feature}* feature. For more details, refer to <>. -=== {api-description-title} - -[WARNING] -==== -* This API supports only -<>. -* When you update a rule, it identifies which roles you have at that point in time. -Thereafter, when the rule performs queries, it uses those security privileges. -If you have different privileges than the user that created or most recently -updated the rule, you might change its behavior. -* Though some properties are optional, when you update the rule the existing -property values are overwritten with default values. Therefore, it is -recommended to explicitly set all property values. -==== - [[update-rule-api-path-params]] === {api-path-parms-title} diff --git a/docs/apm/agent-explorer.asciidoc b/docs/apm/agent-explorer.asciidoc new file mode 100644 index 0000000000000..2129853c9ee8c --- /dev/null +++ b/docs/apm/agent-explorer.asciidoc @@ -0,0 +1,18 @@ +[[agent-explorer]] +=== APM Agent explorer + +++++ +Identify deployment details for APM agents +++++ + +beta::[] + +APM agent explorer provides a centralized panel to identify APM agent deployment details, like service name, environment, instances, and agent name, version, and documentation. + +[role="screenshot"] +image::apm/images/apm-agent-explorer.png[APM agent explorer] + +Select an APM agent to expand it and view the details of each agent instance. + +[role="screenshot"] +image::apm/images/apm-agent-explorer-flyout.png[APM agent explorer flyout] diff --git a/docs/apm/apm-alerts.asciidoc b/docs/apm/apm-alerts.asciidoc index 102a31be4c4a9..cda045e8d8ccd 100644 --- a/docs/apm/apm-alerts.asciidoc +++ b/docs/apm/apm-alerts.asciidoc @@ -11,44 +11,52 @@ and trigger built-in **actions** when those conditions are met. The following **rules** are supported: -* Latency anomaly rule: -Alert when latency of a service is abnormal -* Transaction error rate threshold rule: -Alert when the service's transaction error rate is above the defined threshold -* Error count threshold rule: -Alert when the number of errors in a service exceeds a defined threshold +* **Threshold rule**: +Alert when the latency or failed transaction rate is abnormal. +Threshold rules can be as broad or as granular as you'd like, enabling you to define exactly when you want to be alerted--whether that's at the environment level, service name level, transaction type level, and/or transaction name level. +* **Anomaly rule**: +Alert when either the latency of a service is anomalous. Anomaly rules can be set at the environment level, service level, and/or transaction type level. +* **Error count rule**: +Alert when the number of errors in a service exceeds a defined threshold. Error count rules can be set at the environment level, service level, and error group level. [role="screenshot"] image::apm/images/apm-alert.png[Create an alert in the APM app] +Below, we'll walk through the creation of two APM rules. + For a complete walkthrough of the **Create rule** flyout panel, including detailed information on each configurable property, see Kibana's <>. -Below, we'll walk through the creation of two APM rules. - [float] [[apm-create-transaction-alert]] === Example: create a latency anomaly rule Latency anomaly rules trigger when the latency of a service is abnormal. +Because some parts of an application are more important than others, and have a different +tolerance for latency, we'll target a specific transaction within a service. + +Before continuing, identify the service name, transaction type, and environment that you'd like to create a latency anomaly rule for. This guide will create an alert for all services based on the following criteria: -* Environment: production +* Service: `{your_service.name}` +* Transaction: `{your_transaction.name}` +* Environment: `{your_service.environment}` * Severity level: critical -* Run every five minutes -* Send an alert to a Slack channel only when the rule status changes +* Check every five minutes +* Send an alert to a Slack channel when the rule status changes -From any page in the APM app, select **Alerts and rules** > **Latency** > **Create anomaly rule**. -Change the name of the alert, but do not edit the tags. +From any page in the APM app, select **Alerts and rules** > **Create anomaly rule**. +Change the name of the rule, but do not edit the tags. Based on the criteria above, define the following rule details: -* **Check every** - `5 minutes` -* **Notify** - "Only on status change" -* **Environment** - `all` +* **Service** - `{your_service.name}` +* **Type** - `{your_transaction.name}` +* **Environment** - `{your_service.environment}` * **Has anomaly with severity** - `critical` +* **Check every** - `5 minutes` -Next, add a connector. Multiple connectors can be selected, but in this example we're interested in Slack. +Next, add a connector type. Multiple connectors can be selected, but in this example we're interested in Slack. Select **Slack** > **Create a connector**. Enter a name for the connector, and paste your Slack webhook URL. @@ -60,30 +68,40 @@ to pass additional alert values at the time a condition is detected to an action A list of available variables can be accessed by selecting the **add variable** button image:apm/images/add-variable.png[add variable button]. -Click **Save**. The rule has been created and is now active! +Click **Save**. Your rule has been created and is now active! [float] [[apm-create-error-alert]] === Example: create an error count threshold alert The error count threshold alert triggers when the number of errors in a service exceeds a defined threshold. -This guide will create an alert for all services based on the following criteria: +Because some errors are more important than others, this guide will focus a specific error group ID. + +Before continuing, identify the service name, environment name, and error group ID that you'd like to create a latency anomaly rule for. +The easiest way to find an error group ID is to select the service that you're interested in and navigating to the **Errors** tab. -* All environments -* Error rate is above 25 for the last minute -* Check every 1 minute, and alert every time the rule is active +This guide will create an alert for an error group ID based on the following criteria: + +* Service: `{your_service.name}` +* Environment: `{your_service.environment}` +* Error Grouping Key: `{your_error.ID}` +* Error rate is above 25 errors for the last five minutes +* Group alerts by `service.name` and `service.environment` +* Check every 1 minute * Send the alert via email to the site reliability team -From any page in the APM app, select **Alerts and rules** > **Error count** > **Create threshold rule**. +From any page in the APM app, select **Alerts and rules** > **Create error count rule**. Change the name of the alert, but do not edit the tags. Based on the criteria above, define the following rule details: -* **Check every** - `1 minute` -* **Notify** - "Every time alert is active" -* **Environment** - `all` +* **Service**: `{your_service.name}` +* **Environment**: `{your_service.environment}` +* **Error Grouping Key**: `{your_error.ID}` * **Is above** - `25 errors` -* **For the last** - `1 minute` +* **For the last** - `5 minutes` +* **Group alerts by** - `service.name` `service.environment` +* **Check every** - `1 minute` Select the **Email** connector and click **Create a connector**. Fill out the required details: sender, host, port, etc., and click **save**. @@ -96,6 +114,32 @@ A list of available variables can be accessed by selecting the Click **Save**. The alert has been created and is now active! +[float] +[[apm-alert-view-active]] +=== View active alerts + +Active alerts are displayed and grouped in multiple ways in the APM app. + +[float] +[[apm-alert-view-group]] +==== View alerts by service group + +If you're using the <> feature, you can view alerts by service group. +From the service group overview page, click the red alert indicator to open the **Alerts** tab with a predefined filter that matches the filter used when creating the service group. + +[role="screenshot"] +image::apm/images/apm-service-group.png[Example view of service group in the APM app in Kibana] + +[float] +[[apm-alert-view-service]] +==== View alerts by service + +Alerts can be viewed within the context of any service. +After selecting a service, go to the **Alerts** tab to view any alerts that are active for the selected service. + +[role="screenshot"] +image::apm/images/active-alert-service.png[View active alerts by service] + [float] [[apm-alert-manage]] === Manage alerts and rules diff --git a/docs/apm/apm-app-users.asciidoc b/docs/apm/apm-app-users.asciidoc index 0df169b5e8b10..94ba6ff51bb90 100644 --- a/docs/apm/apm-app-users.asciidoc +++ b/docs/apm/apm-app-users.asciidoc @@ -243,9 +243,9 @@ See <>. ++++ [[apm-app-storage-explorer-user]] -==== Storage explorer user +==== Storage Explorer user -View the **Storage explorer** in the APM app. +View the **Storage Explorer** in the APM app. . Create a new role, named something like `storage-explorer_user`, and assign the following privileges: @@ -255,7 +255,7 @@ include::./tab-widgets/storage-explorer-user/widget.asciidoc[] -- . Assign the `storage-explorer_user` created previously, and the roles and privileges necessary to create -a <> or <> APM reader to any users that need to view **Storage explorer** in the APM app. +a <> or <> APM reader to any users that need to view **Storage Explorer** in the APM app. //// *********************************** *********************************** diff --git a/docs/apm/dependencies.asciidoc b/docs/apm/dependencies.asciidoc index b3afdc4880df5..4ac5cdef3f71c 100644 --- a/docs/apm/dependencies.asciidoc +++ b/docs/apm/dependencies.asciidoc @@ -30,3 +30,19 @@ If your usage pattern _has_ changed, the dependency view can quickly show you wh that pattern change exists in all upstream services, or just a subset of your services. You might then start digging into traces coming from impacted services to determine why that pattern change has occurred. + +[float] +[[dependencies-operations]] +==== Operations + +beta::[] + +**Dependency operations** provides a granular breakdown of the operations/queries a dependency is executing. + +[role="screenshot"] +image::apm/images/operations.png[operations view in the APM app in Kibana] + +Selecting an operation displays the operation's impact and performance trends over time, via key metrics like latency, throughput, and failed transaction rate. In addition, the <> provides a visual drill-down into an end-to-end trace sample. + +[role="screenshot"] +image::apm/images/operations-detail.png[operations detail view in the APM app in Kibana] diff --git a/docs/apm/getting-started.asciidoc b/docs/apm/getting-started.asciidoc index 22830a845e8ed..1a369202788e1 100644 --- a/docs/apm/getting-started.asciidoc +++ b/docs/apm/getting-started.asciidoc @@ -40,6 +40,8 @@ Notice something awry? Select a service or trace and dive deeper with: * <> * <> * <> +* <> +* <> TIP: Want to learn more about the Elastic APM ecosystem? See the {apm-guide-ref}/apm-overview.html[APM Overview]. @@ -63,3 +65,7 @@ include::spans.asciidoc[] include::errors.asciidoc[] include::metrics.asciidoc[] + +include::infrastructure.asciidoc[] + +include::logs.asciidoc[] \ No newline at end of file diff --git a/docs/apm/how-to-guides.asciidoc b/docs/apm/how-to-guides.asciidoc index 4f702adf01a22..1f1670a12e6fd 100644 --- a/docs/apm/how-to-guides.asciidoc +++ b/docs/apm/how-to-guides.asciidoc @@ -11,6 +11,7 @@ Learn how to perform common APM app tasks. * <> * <> * <> +* <> * <> * <> * <> @@ -30,6 +31,8 @@ include::filters.asciidoc[] include::correlations.asciidoc[] +include::agent-explorer.asciidoc[] + include::machine-learning.asciidoc[] include::lambda.asciidoc[] diff --git a/docs/apm/images/active-alert-service.png b/docs/apm/images/active-alert-service.png new file mode 100644 index 0000000000000..7d7deaf078ffb Binary files /dev/null and b/docs/apm/images/active-alert-service.png differ diff --git a/docs/apm/images/apm-agent-explorer-flyout.png b/docs/apm/images/apm-agent-explorer-flyout.png new file mode 100644 index 0000000000000..9792a93a71234 Binary files /dev/null and b/docs/apm/images/apm-agent-explorer-flyout.png differ diff --git a/docs/apm/images/apm-agent-explorer.png b/docs/apm/images/apm-agent-explorer.png new file mode 100644 index 0000000000000..c6fb7d031ed92 Binary files /dev/null and b/docs/apm/images/apm-agent-explorer.png differ diff --git a/docs/apm/images/apm-alert.png b/docs/apm/images/apm-alert.png index a845d65dd24a5..92b6f5dde9730 100644 Binary files a/docs/apm/images/apm-alert.png and b/docs/apm/images/apm-alert.png differ diff --git a/docs/apm/images/apm-query-bar.png b/docs/apm/images/apm-query-bar.png index a1fb129d3c200..457573f485f5a 100644 Binary files a/docs/apm/images/apm-query-bar.png and b/docs/apm/images/apm-query-bar.png differ diff --git a/docs/apm/images/apm-services-overview.png b/docs/apm/images/apm-services-overview.png index 97c46cb756b28..0badeea3be4b3 100644 Binary files a/docs/apm/images/apm-services-overview.png and b/docs/apm/images/apm-services-overview.png differ diff --git a/docs/apm/images/apm-traces.png b/docs/apm/images/apm-traces.png index ee16f9ed16a18..c8b8d40b01335 100644 Binary files a/docs/apm/images/apm-traces.png and b/docs/apm/images/apm-traces.png differ diff --git a/docs/apm/images/dependencies-drilldown.png b/docs/apm/images/dependencies-drilldown.png index 4c491c1ffa254..af82ee3d9305f 100644 Binary files a/docs/apm/images/dependencies-drilldown.png and b/docs/apm/images/dependencies-drilldown.png differ diff --git a/docs/apm/images/infra.png b/docs/apm/images/infra.png new file mode 100644 index 0000000000000..e139012270d5f Binary files /dev/null and b/docs/apm/images/infra.png differ diff --git a/docs/apm/images/lambda-cold-start.png b/docs/apm/images/lambda-cold-start.png deleted file mode 100644 index 54c3d36fddc64..0000000000000 Binary files a/docs/apm/images/lambda-cold-start.png and /dev/null differ diff --git a/docs/apm/images/lambda-overview.png b/docs/apm/images/lambda-overview.png new file mode 100644 index 0000000000000..9d0558949f0ce Binary files /dev/null and b/docs/apm/images/lambda-overview.png differ diff --git a/docs/apm/images/logs.png b/docs/apm/images/logs.png new file mode 100644 index 0000000000000..94d77b47495f1 Binary files /dev/null and b/docs/apm/images/logs.png differ diff --git a/docs/apm/images/operations-detail.png b/docs/apm/images/operations-detail.png new file mode 100644 index 0000000000000..64a1c6550859d Binary files /dev/null and b/docs/apm/images/operations-detail.png differ diff --git a/docs/apm/images/operations.png b/docs/apm/images/operations.png new file mode 100644 index 0000000000000..119f8bdf99ff7 Binary files /dev/null and b/docs/apm/images/operations.png differ diff --git a/docs/apm/images/storage-explorer-overview.png b/docs/apm/images/storage-explorer-overview.png index c9c02b4bbdb7a..317ad02d82e43 100644 Binary files a/docs/apm/images/storage-explorer-overview.png and b/docs/apm/images/storage-explorer-overview.png differ diff --git a/docs/apm/images/trace-explorer.png b/docs/apm/images/trace-explorer.png new file mode 100644 index 0000000000000..70c13f650e2fb Binary files /dev/null and b/docs/apm/images/trace-explorer.png differ diff --git a/docs/apm/infrastructure.asciidoc b/docs/apm/infrastructure.asciidoc new file mode 100644 index 0000000000000..f9cf45aa490c2 --- /dev/null +++ b/docs/apm/infrastructure.asciidoc @@ -0,0 +1,13 @@ +[role="xpack"] +[[infrastructure]] +=== Infrastructure + +The *Infrastructure* tab provides information about the containers, pods, and hosts, +that the selected service is linked to. + +[role="screenshot"] +image::apm/images/infra.png[Example view of the Infrastructure tab in APM app in Kibana] + +IT ops and software reliability engineers (SREs) can use this tab +to quickly find a service's underlying infrastructure resources when debugging a problem. +Knowing what infrastructure is related to a service allows you to remediate issues by restarting, killing hanging instances, changing configuration, rolling back deployments, scaling up, scaling out, etc. \ No newline at end of file diff --git a/docs/apm/lambda.asciidoc b/docs/apm/lambda.asciidoc index 2dcdf5b462b63..af3012dd19a5e 100644 --- a/docs/apm/lambda.asciidoc +++ b/docs/apm/lambda.asciidoc @@ -3,11 +3,15 @@ === Observe Lambda functions Elastic APM provides performance and error monitoring for AWS Lambda functions. -Get insight into function execution and runtime behavior, as well as visibility into how your Lambda functions relate to and depend on other services. +See how your Lambda functions relate to and depend on other services, and +get insight into function execution and runtime behavior, like lambda duration, cold start rate, cold start duration, compute usage, memory usage, and more. To set up Lambda monitoring, see the relevant {apm-guide-ref}/monitoring-aws-lambda.html[quick start guide]. +[role="screenshot"] +image::apm/images/lambda-overview.png[lambda overview] + [float] [[apm-lambda-cold-start-info]] ==== Cold starts @@ -22,9 +26,6 @@ Cold starts are an unavoidable byproduct of the serverless world, but visibility The cold start rate (i.e. proportion of requests that experience a cold start) is displayed per service and per transaction. -[role="screenshot"] -image::apm/images/lambda-cold-start.png[lambda cold start graph] - Cold start is also displayed in the trace waterfall, where you can drill-down into individual traces and see trace metadata like AWS request ID, trigger type, and trigger request ID. [role="screenshot"] diff --git a/docs/apm/logs.asciidoc b/docs/apm/logs.asciidoc new file mode 100644 index 0000000000000..04f5eff185692 --- /dev/null +++ b/docs/apm/logs.asciidoc @@ -0,0 +1,19 @@ +[role="xpack"] +[[logs]] +=== Logs + +The *Logs* tab shows contextual logs for the selected service. + +// tag::log-overview[] +Logs provide detailed information about specific events, and are crucial to successfully debugging slow or erroneous transactions. + +If you've correlated your application's logs and traces, you never have to search for relevant data; it's already available to you. Viewing log and trace data together allows you to quickly diagnose and solve problems. + +To learn how to correlate your logs with your instrumented services, +see {observability-guide}/application-logs.html[log correlation] +// end::log-overview[] + +[role="screenshot"] +image::apm/images/logs.png[Example view of the Logs tab in APM app in Kibana] + +TIP: Logs displayed on this page are filtered on `service.name` diff --git a/docs/apm/machine-learning.asciidoc b/docs/apm/machine-learning.asciidoc index 6c51290414c13..8f82cb2a00f10 100644 --- a/docs/apm/machine-learning.asciidoc +++ b/docs/apm/machine-learning.asciidoc @@ -26,7 +26,7 @@ image::apm/images/service-quick-health.png[Example view of anomaly scores on res [role="screenshot"] image::apm/images/apm-ml-integration.png[Example view of anomaly scores on response times in the APM app] -* Service maps will display a color-coded anomaly indicator based on the detected anomaly score. +* Service Maps will display a color-coded anomaly indicator based on the detected anomaly score. + [role="screenshot"] image::apm/images/apm-service-map-anomaly.png[Example view of anomaly scores on service maps in the APM app] diff --git a/docs/apm/service-maps.asciidoc b/docs/apm/service-maps.asciidoc index 5a5927a997f64..a0c9dda2188cb 100644 --- a/docs/apm/service-maps.asciidoc +++ b/docs/apm/service-maps.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [[service-maps]] -=== Service map +=== Service Map A service map is a real-time visual representation of the instrumented services in your application's architecture. It shows you how these services are connected, along with high-level metrics like average transaction duration, @@ -40,7 +40,7 @@ We currently surface two types of service maps: [[service-maps-how]] === How do service maps work? -Service maps rely on distributed traces to draw connections between services. +Service Maps rely on distributed traces to draw connections between services. As {apm-guide-ref}/apm-distributed-tracing.html[distributed tracing] is enabled out-of-the-box for supported technologies, so are service maps. However, if a service isn't instrumented, or a `traceparent` header isn't being propagated to it, @@ -105,7 +105,7 @@ Type and subtype are based on `span.type`, and `span.subtype`. [[service-maps-supported]] === Supported APM agents -Service maps are supported for the following APM agent versions: +Service Maps are supported for the following APM agent versions: [horizontal] Go agent:: ≥ v1.7.0 diff --git a/docs/apm/service-overview.asciidoc b/docs/apm/service-overview.asciidoc index 1311aa84fca18..a47ba33a7486f 100644 --- a/docs/apm/service-overview.asciidoc +++ b/docs/apm/service-overview.asciidoc @@ -139,9 +139,6 @@ or when to remove a large dependency. The cold start rate chart is currently supported for <> functions and Azure functions. -[role="screenshot"] -image::apm/images/lambda-cold-start.png[lambda cold start graph] - [discrete] [[service-instances]] === Instances diff --git a/docs/apm/services.asciidoc b/docs/apm/services.asciidoc index 7009aac04ffa8..7ce3354ecbf7e 100644 --- a/docs/apm/services.asciidoc +++ b/docs/apm/services.asciidoc @@ -10,6 +10,8 @@ To help surface potential issues, services are sorted by their health status: Health status is powered by <> and requires anomaly detection to be enabled. +In addition to health status, active alerts for each service are prominently displayed in the service inventory table. Selecting an active alert badge brings you to the <> tab where you can learn more about the active alert and take action. + [role="screenshot"] image::apm/images/apm-services-overview.png[Example view of services table the APM app in Kibana] @@ -17,11 +19,14 @@ image::apm/images/apm-services-overview.png[Example view of services table the A [[service-groups]] ==== Service groups -preview::[] +beta::[] -Group services together to build meaningful views that remove noise and simplify investigations across services. +Group services together to build meaningful views that remove noise, simplify investigations across services, +and <>. Service groups are {kib} space-specific and available for any users with appropriate access. +// This screenshot is reused in the alerts docs +// Ensure it has an active alert showing [role="screenshot"] image::apm/images/apm-service-group.png[Example view of service group in the APM app in Kibana] diff --git a/docs/apm/settings.asciidoc b/docs/apm/settings.asciidoc index 44da63143f63f..c11ab5f70f6dd 100644 --- a/docs/apm/settings.asciidoc +++ b/docs/apm/settings.asciidoc @@ -21,3 +21,14 @@ include::./../settings/apm-settings.asciidoc[tag=apm-indices-settings] === General APM settings include::./../settings/apm-settings.asciidoc[tag=general-apm-settings] + +[float] +[[apm-labs]] +=== APM Labs + +**APM Labs** allows you to easily try out new features that are technical preview. + +To enable APM labs, navigate to **APM** > **Settings** > **General settings** and toggle **Enable labs button in APM**. +Select **Save changes** and refresh the page. + +After enabling **APM Labs** select **Labs** in the toolbar to see the technical preview features available to try out. diff --git a/docs/apm/storage-explorer.asciidoc b/docs/apm/storage-explorer.asciidoc index c82c43ead2b5f..98547de494f1f 100644 --- a/docs/apm/storage-explorer.asciidoc +++ b/docs/apm/storage-explorer.asciidoc @@ -1,5 +1,5 @@ [[storage-explorer]] -=== Storage explorer +=== Storage Explorer beta::[] @@ -10,7 +10,7 @@ Or, expand the time filter to visualize data trends over time so that you can be and prepare for future storage needs. [role="screenshot"] -image::apm/images/storage-explorer-overview.png[APM Storage explorer] +image::apm/images/storage-explorer-overview.png[APM Storage Explorer] [float] ==== Index lifecycle phases @@ -50,7 +50,7 @@ the total number of documents. * Number of **transactions**, **spans**, **errors**, and **metrics** — doc count and size on disk. [role="screenshot"] -image::apm/images/storage-explorer-expanded.png[APM Storage explorer service breakdown] +image::apm/images/storage-explorer-expanded.png[APM Storage Explorer service breakdown] As you explore your service statistics, you might want to take action to reduce the number of documents and therefore storage size of a particular service. @@ -84,7 +84,7 @@ work with your developers to change how exceptions are handled in your code. [float] ==== Privileges -Storage explorer requires expanded privileges to view. +Storage Explorer requires expanded privileges to view. See <> for more information. [float] diff --git a/docs/apm/traces.asciidoc b/docs/apm/traces.asciidoc index 971d358092489..1269781e7798e 100644 --- a/docs/apm/traces.asciidoc +++ b/docs/apm/traces.asciidoc @@ -19,3 +19,18 @@ If there's a particular endpoint you're worried about, select it to view its [role="screenshot"] image::apm/images/apm-traces.png[Example view of the Traces overview in APM app in Kibana] + +[float] +[[trace-explorer]] +==== Trace explorer + +preview::[] + +**Trace explorer** is an experimental top-level search tool that allows you to query your traces using <> or {ref}/eql.html[Event Query Language (EQL)]. + +Curate your own custom queries, or use the <> to find and select edges to automatically generate queries based on your selection: + +[role="screenshot"] +image::apm/images/trace-explorer.png[Trace explorer] + +Enable **Trace explorer** in <> or in <>. diff --git a/docs/apm/transactions.asciidoc b/docs/apm/transactions.asciidoc index 307213e44fa6e..b0a1c9ee858de 100644 --- a/docs/apm/transactions.asciidoc +++ b/docs/apm/transactions.asciidoc @@ -162,12 +162,7 @@ This means you can select "Actions - View transaction in Discover" to see the ac The *Logs* tab displays logs related to the sampled trace. -Logs provide detailed information about specific events, -and are crucial to successfully debugging slow or erroneous transactions. - -If you've correlated your application's logs and traces, you never have to search for relevant data; -it's all provided on this. Viewing log and trace data together allows you to quickly diagnose -and solve problems. +include::./logs.asciidoc[tag=log-overview] [role="screenshot"] image::apm/images/apm-logs-tab.png[APM logs tab] diff --git a/docs/apm/troubleshooting.asciidoc b/docs/apm/troubleshooting.asciidoc index 339645fe50e5c..93464d23518b6 100644 --- a/docs/apm/troubleshooting.asciidoc +++ b/docs/apm/troubleshooting.asciidoc @@ -176,7 +176,7 @@ These are dynamic by default, which means they will be indexed and become search [float] [[service-map-rum-connections]] -=== Service maps: no connection between client and server +=== Service Maps: no connection between client and server If the service map is not showing an expected connection between the client and server, it's likely because you haven't configured diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index 919703efff78f..e29f0fa2ac0ed 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -538,10 +538,6 @@ security and spaces filtering. |This plugin provides Kibana user interfaces for managing the Enterprise Search solution and its products, App Search and Workplace Search. -|{kib-repo}blob/{branch}/x-pack/plugins/ess_security/README.md[essSecurity] -|This plugin contains the ESS/on-prem deployments (non-serverless) customizations for Security Solution. - - |{kib-repo}blob/{branch}/x-pack/plugins/event_log/README.md[eventLog] |The event log plugin provides a persistent history of alerting and action activities. @@ -628,6 +624,10 @@ the infrastructure monitoring use-case within Kibana. using the CURL scripts in the scripts folder. +|{kib-repo}blob/{branch}/x-pack/plugins/logs_shared/README.md[logsShared] +|Exposes the shared components and APIs to access and visualize logs. + + |{kib-repo}blob/{branch}/x-pack/plugins/logstash[logstash] |WARNING: Missing README. @@ -726,6 +726,15 @@ Kibana. |Welcome to the Kibana Security Solution plugin! This README will go over getting started with development and testing. +|{kib-repo}blob/{branch}/x-pack/plugins/security_solution_ess/README.md[securitySolutionEss] +|This plugin contains the ESS/on-prem deployments (non-serverless) specific logic for Security Solution. + + +|{kib-repo}blob/{branch}/x-pack/plugins/security_solution_serverless/README.mdx[securitySolutionServerless] +|This plugin contains configuration and code used to create a Serverless Security project. +It leverages universal configuration and other APIs in the serverless plugin to configure Kibana. + + |{kib-repo}blob/{branch}/x-pack/plugins/serverless/README.mdx[serverless] | @@ -738,10 +747,6 @@ Kibana. |This plugin contains configuration and code used to create a Serverless Search project. It leverages universal configuration and other APIs in the serverless plugin to configure Kibana. -|{kib-repo}blob/{branch}/x-pack/plugins/serverless_security/README.mdx[serverlessSecurity] -|This plugin contains configuration and code used to create a Serverless Security project. It leverages universal configuration and other APIs in the serverless plugin to configure Kibana. - - |{kib-repo}blob/{branch}/x-pack/plugins/session_view/README.md[sessionView] |Session View is meant to provide a visualization into what is going on in a particular Linux environment where the agent is running. It looks likes a terminal emulator; however, it is a tool for introspecting process activity and understanding user and service behaviour in your Linux servers and infrastructure. It is a time-ordered series of process executions displayed in a tree over time. diff --git a/docs/index-custom-title-page.html b/docs/index-custom-title-page.html deleted file mode 100644 index 5d768eab3484e..0000000000000 --- a/docs/index-custom-title-page.html +++ /dev/null @@ -1,284 +0,0 @@ - - -
    - -
    -
    -

    -

    Bring your data to life

    -

    - Kibana is a user interface that lets you visualize your Elasticsearch data and navigate the Elastic Stack. - Take this tutorial for the basics of visualizing data. -

    -

    - - - -

    -

    - What's new - Release notes - Install -

    -
    -
    - -
    -
    - -

    Get to know Kibana

    - -
    -
    -

    - - Get started -

    -
    - -
    - -
    -
    -

    - - Install and upgrade -

    -
    - -
    - -
    -
    -

    - - Discover, visualize, and share -

    -
    - -
    - - -
    -
    -

    - - Manage and secure -

    -
    - -
    - -
    -
    -

    - - Get organized -

    -
    - -
    - -
    -
    -

    - - Tools, APIs, and Dev docs -

    -
    - -
    - -

    Explore by Elastic solution

    - -
    -
    - -
    -

    - - Enterprise Search -

    -

    Create search experiences for your content, wherever it lives.

    -
    -     -
    -
    - -
    -

    - - Observability -

    -

    Learn how to monitor logs, metrics, and traces.

    -
    -     -
    -
    - -
    -

    - - Security -

    -

    Learn how to defend against threats across your environment.

    -
    -     -
    -
    - -

    View all Elastic docs

    diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 6de80b6e845de..d72b97a76af2a 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -7,6 +7,8 @@ include::{docs-root}/shared/versions/stack/{source_branch}.asciidoc[] include::{docs-root}/shared/attributes.asciidoc[] +include::landing-page.asciidoc[] + include::user/index.asciidoc[] include::accessibility.asciidoc[] diff --git a/docs/landing-page.asciidoc b/docs/landing-page.asciidoc new file mode 100644 index 0000000000000..1cb3e188d6121 --- /dev/null +++ b/docs/landing-page.asciidoc @@ -0,0 +1,300 @@ +++++ + + +
    + +
    +
    +

    +

    Bring your data to life

    +

    + Kibana is a user interface that lets you visualize your Elasticsearch data and navigate the Elastic Stack. + Take this tutorial for the basics of visualizing data. +

    +

    + + + +

    +

    + What's new + Release notes + Install +

    +
    +
    + +
    +
    + +

    Get to know Kibana

    + +
    +
    +

    + + Get started +

    +
    + +
    + +
    +
    +

    + + Install and upgrade +

    +
    + +
    + +
    +
    +

    + + Discover, visualize, and share +

    +
    + +
    + + +
    +
    +

    + + Manage and secure +

    +
    + +
    + +
    +
    +

    + + Get organized +

    +
    + +
    + +
    +
    +

    + + Tools, APIs, and Dev docs +

    +
    + +
    + +

    Explore by Elastic solution

    + +
    +
    + +
    +

    + + Enterprise Search +

    +

    Create search experiences for your content, wherever it lives.

    +
    +     +
    +
    + +
    +

    + + Observability +

    +

    Learn how to monitor logs, metrics, and traces.

    +
    +     +
    +
    + +
    +

    + + Security +

    +

    Learn how to defend against threats across your environment.

    +
    +     +
    +
    + + +++++ \ No newline at end of file diff --git a/docs/management/action-types.asciidoc b/docs/management/action-types.asciidoc index 24db744c5dd50..1e45c9c64fa14 100644 --- a/docs/management/action-types.asciidoc +++ b/docs/management/action-types.asciidoc @@ -159,6 +159,9 @@ action in the current space. For out-of-the-box and standardized connectors, refer to <>. +TIP: You can also manage connectors as resources with the https://registry.terraform.io/providers/elastic/elasticstack/latest[Elasticstack provider] for Terraform. +For more details, refer to the https://registry.terraform.io/providers/elastic/elasticstack/latest/docs/resources/kibana_action_connector[elasticstack_kibana_action_connector] resource. + [float] [[importing-and-exporting-connectors]] === Importing and exporting connectors diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index cb51a6779b604..85d6d940a8793 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -393,11 +393,48 @@ value is 10000. [[apm-enable-service-overview]]`apm:enableServiceOverview`:: When enabled, displays the *Overview* tab for services in *APM*. +[[apm-agent-explorer]]`observability:apmAgentExplorerView`:: +beta:[] Enables the Agent explorer view. + +[[apm-aws-price]]`observability:apmAWSLambdaPriceFactor`:: +Set the price per Gb-second for your AWS Lambda functions. + +[[apm-aws-request]]`observability:apmAWSLambdaRequestCostPerMillion`:: +Set the AWS Lambda cost per million requests. + +[[apm-continuous-rollups]]`observability:apmEnableContinuousRollups`:: +beta:[] When continuous rollups is enabled, the UI will select metrics with the appropriate resolution. +On larger time ranges, lower resolution metrics will be used, which will improve loading times. + +[[apm-enable-service-metrics]]`observability:apmEnableServiceMetrics`:: +beta:[] Enables the usage of service transaction metrics, which are low cardinality metrics that can be used by certain views like the service inventory for faster loading times. + +[[observability-apm-labs]]`observability:apmLabsButton`:: +Enable or disable the APM Labs button -- a quick way to enable and disable technical preview features in APM. +See <> to learn more. + +[[observability-apm-critical-path]]`observability:apmEnableCriticalPath`:: +When enabled, displays the critical path of a trace. + +[[observability-enable-progressive-loading]]`observability:apmProgressiveLoading`:: +preview:[] When enabled, uses progressive loading of some APM views. +Data may be requested with a lower sampling rate first, with lower accuracy but faster response times, +while the unsampled data loads in the background. + +[[observability-apm-max-groups]]`observability:apmServiceGroupMaxNumberOfServices`:: +Limit the number of services in a given service group. + [[observability-apm-optimized-sort]]`observability:apmServiceInventoryOptimizedSorting`:: preview:[] Sorts services without anomaly detection rules on the APM Service inventory page by service name. +[[observability-default-service-env]]`observability:apmDefaultServiceEnvironment`:: +Set the default environment for the APM app. When left empty, data from all environments will be displayed by default. + +[[observability-enable-aws-lambda-metrics]]`observability:enableAwsLambdaMetrics`:: +preview:[] Display Amazon Lambda metrics in the service metrics tab. + [[observability-apm-enable-comparison]]`observability:enableComparisonByDefault`:: -Enables the comparison feature in the APM app. +Determines whether the <> is enabled or disabled by default in the APM app. [[observability-apm-enable-infra-view]]`observability:enableInfrastructureView`:: Enables the Infrastructure view in the APM app. @@ -408,6 +445,9 @@ When enabled, allows you to inspect {es} queries in API responses. [[observability-apm-enable-service-groups]]`observability:enableServiceGroups`:: preview:[] When enabled, allows users to create Service Groups from the APM Service Inventory page. +[[observability-apm-trace-explorer-tab]]`observability:apmTraceExplorerTab`:: +preview:[] Enable the APM Trace Explorer feature, that allows you to search and inspect traces with KQL or EQL. + [float] [[kibana-reporting-settings]] ==== Reporting @@ -584,4 +624,4 @@ The URL of a custom PNG image that appears on {kib} browser tabs. [[provide-usage-data]]`telemetry:enabled`:: Enabling data usage collection (also known as Telemetry) allows us to learn what our users are most interested in, so we can improve our products and services. -Refer to our https://www.elastic.co/legal/product-privacy-statement[Privacy Statement] for more details. \ No newline at end of file +Refer to our https://www.elastic.co/legal/product-privacy-statement[Privacy Statement] for more details. diff --git a/docs/management/cases/images/cases-visualization.png b/docs/management/cases/images/cases-visualization.png index 8b2641233aa6a..4f401857027cb 100644 Binary files a/docs/management/cases/images/cases-visualization.png and b/docs/management/cases/images/cases-visualization.png differ diff --git a/docs/management/cases/images/cases.png b/docs/management/cases/images/cases.png index ca2f2ea5d9c92..ab9f01b0e3cd0 100644 Binary files a/docs/management/cases/images/cases.png and b/docs/management/cases/images/cases.png differ diff --git a/docs/management/cases/manage-cases.asciidoc b/docs/management/cases/manage-cases.asciidoc index b31146b1dfceb..a3f0a40fd6009 100644 --- a/docs/management/cases/manage-cases.asciidoc +++ b/docs/management/cases/manage-cases.asciidoc @@ -1,6 +1,11 @@ [[manage-cases]] == Open and manage cases +:frontmatter-description: Create a case then add files, visualizations, and user notifications. +:frontmatter-tags-products: [kibana] +:frontmatter-tags-content-type: [how-to] +:frontmatter-tags-user-goals: [analyze] + preview::[] [[open-case]] @@ -16,8 +21,8 @@ TIP: In the `Description` area, you can use https://www.markdownguide.org/cheat-sheet[Markdown] syntax to create formatted text. -. Optionally, add assignees and tags. You can add users only if they meet -the necessary <>. +. Optionally, add a category, assignees, and tags. +You can add users only if they meet the necessary <>. . For *External incident management system*, select a connector. For more information, refer to <>. @@ -72,8 +77,9 @@ go back to your case. . Click *Add Comment* to add the visualization to your case. -After a visualization has been added to a case, you can modify or interact with -it by clicking the *Open Visualization* option in the comment menu. +Alternatively, while viewing a <> you can open a panel's menu then click *More > Add to existing case* or *More > Add to new case*. + +After a visualization has been added to a case, you can modify or interact with it by clicking the *Open Visualization* option in the case's comment menu. [[add-case-notifications]] === Add email notifications @@ -115,7 +121,7 @@ When you subsequently add assignees to cases, they receive an email. === Manage cases In *Management > {stack-manage-app} > Cases*, you can search cases and filter -them by attributes such as assignees, severity, status, and tags. You can also +them by attributes such as assignees, categories, severity, status, and tags. You can also select multiple cases and use bulk actions to delete cases or change their attributes. @@ -126,7 +132,7 @@ To view a case, click on its name. You can then: * Add or remove assignees. * Add a connector. * Send updates to external systems (if external connections are configured). -* Edit tags. +* Edit the category and tags. * Refresh the case to retrieve the latest updates. * Change the status. * Change the severity. diff --git a/docs/management/connectors/action-types/email.asciidoc b/docs/management/connectors/action-types/email.asciidoc index 3e498f600e37c..0f652821a3661 100644 --- a/docs/management/connectors/action-types/email.asciidoc +++ b/docs/management/connectors/action-types/email.asciidoc @@ -8,11 +8,8 @@ :frontmatter-tags-content-type: [how-to] :frontmatter-tags-user-goals: [configure] -The email connector uses the SMTP protocol to send mail messages, using an -integration of https://nodemailer.com/[Nodemailer]. An exception is Microsoft -Exchange, which uses HTTP protocol for sending emails, -https://docs.microsoft.com/en-us/graph/api/user-sendmail[Send mail]. Email -message text is sent as both plain text and html text. +The email connector uses the SMTP protocol to send mail messages. +Email message text is sent as both plain text and html text. [NOTE] ==== @@ -214,11 +211,10 @@ settings. You can set configurations that apply to all your connectors or use [[configuring-email]] === Configure email accounts for well-known services -The email connector can send email using many popular SMTP email services and -the Microsoft Exchange Graph API. +The email connector uses an integration of https://nodemailer.com/[Nodemailer] to send email from many popular SMTP email services. +For Microsoft Exchange email, it uses the Microsoft Graph API. -For more information about configuring the email connector to work with -different email systems, refer to: +To configure the email connector to work with common email systems, refer to: * <> * <> @@ -337,7 +333,7 @@ at AWS. [[exchange-basic-auth]] ==== Sending email from Microsoft Exchange with Basic Authentication -deprecated:[This Microsoft Exchange configuration is deprecated in 7.16.0, and will be removed later, because Microsoft is deprecating https://docs.microsoft.com/en-us/lifecycle/announcements/exchange-online-basic-auth-deprecated [Basic Authentication]: +deprecated:[7.16.0,"This Microsoft Exchange configuration is deprecated and will be removed later because Microsoft is deprecating basic authentication."] [source,text] -------------------------------------------------- @@ -365,6 +361,8 @@ https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client [[exchange]] ==== Sending email from Microsoft Exchange with OAuth 2.0 +NOTE: The email connector uses Microsoft Graph REST API v1.0, in particular the https://docs.microsoft.com/en-us/graph/api/user-sendmail[sendMail] endpoint. It supports only the https://learn.microsoft.com/en-us/graph/deployments#microsoft-graph-and-graph-explorer-service-root-endpoints[Microsoft Graph global service] root endpoint (`https://graph.microsoft.com`). + Before you create an email connector for Microsoft Exchange, you must create and register the client integration application on the https://go.microsoft.com/fwlink/?linkid=2083908[Azure portal]: diff --git a/docs/maps/search.asciidoc b/docs/maps/search.asciidoc index 8575d9fda01ed..bfd293aa2352f 100644 --- a/docs/maps/search.asciidoc +++ b/docs/maps/search.asciidoc @@ -99,16 +99,18 @@ To filter your dashboard by your map bounds as you pan and zoom your map: A spatial filter narrows search results to documents that either intersect with, are within, or do not intersect with the specified geometry. -You can create spatial filters in two ways: - -* Click the tool icon image:maps/images/tools_icon.png[], and then draw a shape, bounding box, or distance on the map to define the spatial filter. -* Click *Filter by geometry* in a <>, and then use the feature's geometry for the spatial filter. - Spatial filters have the following properties: * *Geometry label* enables you to provide a meaningful name for your spatial filter. * *Spatial relation* determines the {ref}/query-dsl-geo-shape-query.html#geo-shape-spatial-relations[spatial relation operator] to use at search time. -* *Action* specifies whether to apply the filter to the current view or to a drilldown action. Only available when the map is a panel in a {kibana-ref}/dashboard.html[dashboard] with {kibana-ref}/drilldowns.html[drilldowns]. +* *Action* specifies whether to apply the filter to the current view or to a drilldown action. + +NOTE: {kibana-ref}/drilldowns.html[Drilldowns] are available only if the map is a panel in a {kibana-ref}/dashboard.html[dashboard], and not within the Maps application. + +You can create spatial filters in two ways: + +* Click the tool icon image:maps/images/tools_icon.png[tool icon], and then draw a shape, bounding box, or distance on the map to define the spatial filter. +* Click *Filter by geometry* in a <>, and then use the feature's geometry for the spatial filter. [role="screenshot"] image::maps/images/create_spatial_filter.png[] diff --git a/docs/settings/apm-settings.asciidoc b/docs/settings/apm-settings.asciidoc index 50d0fa2032ac3..05d8cc35f1cde 100644 --- a/docs/settings/apm-settings.asciidoc +++ b/docs/settings/apm-settings.asciidoc @@ -43,6 +43,7 @@ If you'd like to change any of the default values, copy and paste the relevant settings into your `kibana.yml` configuration file. Changing these settings may disable features of the APM App. +TIP: More settings are available in the <>. `xpack.apm.maxSuggestions` {ess-icon}:: Maximum number of suggestions fetched in autocomplete selection boxes. Defaults to `100`. diff --git a/docs/setup/access.asciidoc b/docs/setup/access.asciidoc index 2b76843b5964d..631fa22d711dd 100644 --- a/docs/setup/access.asciidoc +++ b/docs/setup/access.asciidoc @@ -61,5 +61,5 @@ curl -XGET elasticsearch_ip_or_hostname:9200/_cat/indices/.kibana,.kibana_task_m + For example: -* When {kib} is unable to connect to a healthy {es} cluster, the `master_not_discovered_exception` or `Unable to revive connection` errors appear. +* When {kib} is unable to connect to a healthy {es} cluster, errors like `master_not_discovered_exception` or `unable to revive connection` or `license is not available` errors appear. * When one or more {kib}-backing indices are unhealthy, the `index_not_green_timeout` error appears. diff --git a/docs/user/alerting/action-variables.asciidoc b/docs/user/alerting/action-variables.asciidoc index b3a2854642029..6fe275547004c 100644 --- a/docs/user/alerting/action-variables.asciidoc +++ b/docs/user/alerting/action-variables.asciidoc @@ -1,5 +1,9 @@ [[rule-action-variables]] == Rule action variables +:frontmatter-description: A summary of common variables for use in {kib} alerting rule actions. +:frontmatter-tags-products: [alerting] +:frontmatter-tags-content-type: [reference] +:frontmatter-tags-user-goals: [configure] Alerting rules can use the https://mustache.github.io/mustache.5.html[Mustache] template syntax (`{{variable name}}`) to pass values when the actions run. @@ -30,9 +34,10 @@ All rule types pass the following variables: `date`:: The date the rule scheduled the action, in ISO format. `kibanaBaseUrl`:: The configured <>. If not configured, this will be empty. -`rule.id`:: The ID of the rule. -`rule.name`:: The name of the rule. -`rule.spaceId`:: The ID of the space for the rule. +`rule.id`:: The rule identifier. +`rule.name`:: The rule name. +`rule.params`:: The rule parameters, which vary by rule type. +`rule.spaceId`:: The space identifier for the rule. `rule.tags`:: The list of tags applied to the rule. [float] @@ -116,14 +121,14 @@ For diagnostic or exploratory purposes, action variables whose values are object For situations where your rule response returns arrays of data, you can loop through the `context`: -[source] +[source,sh] -------------------------------------------------- {{#context}}{{.}}{{/context}} -------------------------------------------------- For example, looping through search result hits: -[source] +[source,sh] -------------------------------------------------- triggering data was: {{#context.hits}} - {{_source.message}} @@ -154,7 +159,7 @@ The following capabilities are available: Mustache lambdas provide additional rendering capabilities for Mustache templates. A Mustache lambda is formatted like a Mustache section. For example: -[source] +[source,sh] ---- {{#EvalMath}} round(context.value, 1) {{/EvalMath}} ---- @@ -169,7 +174,7 @@ The EvalMath lambda will evaluate the text passed to it as <` parameter is required; the `
    @@ -62,12 +66,12 @@ Array [ style="flex-shrink: 0;" >
    @@ -158,10 +162,10 @@ Array [ >
    @@ -407,7 +406,7 @@ exports[`Authentication User Table Component rendering it renders the user authe class="euiFlexItem emotion-euiFlexItem-growZero" >
    )} - {isAssistantEnabled && ( + {hasAssistantPrivilege && ( ({ diff --git a/x-pack/plugins/security_solution/public/timelines/containers/local_storage/index.test.ts b/x-pack/plugins/security_solution/public/timelines/containers/local_storage/index.test.ts index cf14653a59508..e9482e0c152e6 100644 --- a/x-pack/plugins/security_solution/public/timelines/containers/local_storage/index.test.ts +++ b/x-pack/plugins/security_solution/public/timelines/containers/local_storage/index.test.ts @@ -1261,66 +1261,17 @@ describe('SiemLocalStorage', () => { ], sort: [{ '@timestamp': { order: 'desc' } }], visibleColumns: [ - { - columnHeaderType: 'not-filtered', - id: '@timestamp', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - displayAsText: 'Rule', - id: 'kibana.alert.rule.name', - initialWidth: 180, - linkField: 'kibana.alert.rule.uuid', - }, - { - columnHeaderType: 'not-filtered', - displayAsText: 'Severity', - id: 'kibana.alert.severity', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - displayAsText: 'Risk Score', - id: 'kibana.alert.risk_score', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - displayAsText: 'Reason', - id: 'kibana.alert.reason', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - id: 'host.name', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - id: 'user.name', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - id: 'process.name', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - id: 'file.name', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - id: 'source.ip', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - id: 'destination.ip', - initialWidth: 180, - }, + '@timestamp', + 'kibana.alert.rule.name', + 'kibana.alert.severity', + 'kibana.alert.risk_score', + 'kibana.alert.reason', + 'host.name', + 'user.name', + 'process.name', + 'file.name', + 'source.ip', + 'destination.ip', ], }, }, @@ -1393,66 +1344,17 @@ describe('SiemLocalStorage', () => { { 'kibana.alert.rule.name': { order: 'desc' } }, ], visibleColumns: [ - { - columnHeaderType: 'not-filtered', - id: '@timestamp', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - displayAsText: 'Rule', - id: 'kibana.alert.rule.name', - initialWidth: 180, - linkField: 'kibana.alert.rule.uuid', - }, - { - columnHeaderType: 'not-filtered', - displayAsText: 'Severity', - id: 'kibana.alert.severity', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - displayAsText: 'Risk Score', - id: 'kibana.alert.risk_score', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - displayAsText: 'Reason', - id: 'kibana.alert.reason', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - id: 'host.name', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - id: 'user.name', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - id: 'process.name', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - id: 'file.name', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - id: 'source.ip', - initialWidth: 180, - }, - { - columnHeaderType: 'not-filtered', - id: 'destination.ip', - initialWidth: 180, - }, + '@timestamp', + 'kibana.alert.rule.name', + 'kibana.alert.severity', + 'kibana.alert.risk_score', + 'kibana.alert.reason', + 'host.name', + 'user.name', + 'process.name', + 'file.name', + 'source.ip', + 'destination.ip', ], }, }, diff --git a/x-pack/plugins/security_solution/public/timelines/containers/local_storage/index.tsx b/x-pack/plugins/security_solution/public/timelines/containers/local_storage/index.tsx index 727239ea2d894..c0bab6bfce78b 100644 --- a/x-pack/plugins/security_solution/public/timelines/containers/local_storage/index.tsx +++ b/x-pack/plugins/security_solution/public/timelines/containers/local_storage/index.tsx @@ -100,7 +100,7 @@ export const migrateAlertTableStateToTriggerActionsState = ( sort: legacyDataTableState[tableKey].sort.map((sortCandidate) => ({ [sortCandidate.columnId]: { order: sortCandidate.sortDirection }, })), - visibleColumns: legacyDataTableState[tableKey].columns, + visibleColumns: legacyDataTableState[tableKey].columns.map((c) => c.id), }, }; }); @@ -110,6 +110,7 @@ export const migrateAlertTableStateToTriggerActionsState = ( storage.set(key, stateObj[key]); }) ); + return Object.assign(legacyDataTableState, triggersActionsState); }; /** @@ -154,7 +155,7 @@ export const getDataTablesInStorageByIds = (storage: Storage, tableIds: TableIdL } } - migrateAlertTableStateToTriggerActionsState(storage, allDataTables); + allDataTables = migrateAlertTableStateToTriggerActionsState(storage, allDataTables); return tableIds.reduce((acc, tableId) => { const tableModel = allDataTables[tableId]; diff --git a/x-pack/plugins/security_solution/public/timelines/containers/notes/api.ts b/x-pack/plugins/security_solution/public/timelines/containers/notes/api.ts index 26efef0c32f6a..c9c5bd836f661 100644 --- a/x-pack/plugins/security_solution/public/timelines/containers/notes/api.ts +++ b/x-pack/plugins/security_solution/public/timelines/containers/notes/api.ts @@ -6,7 +6,7 @@ */ import { NOTE_URL } from '../../../../common/constants'; -import type { BareNote, Note } from '../../../../common/types/timeline/note/api'; +import type { BareNote, Note } from '../../../../common/api/timeline'; import { KibanaServices } from '../../../common/lib/kibana'; export const persistNote = async ({ diff --git a/x-pack/plugins/security_solution/public/timelines/containers/pinned_event/api.ts b/x-pack/plugins/security_solution/public/timelines/containers/pinned_event/api.ts index f28b2afac4837..a7cc370daa463 100644 --- a/x-pack/plugins/security_solution/public/timelines/containers/pinned_event/api.ts +++ b/x-pack/plugins/security_solution/public/timelines/containers/pinned_event/api.ts @@ -5,7 +5,7 @@ * 2.0. */ import { PINNED_EVENT_URL } from '../../../../common/constants'; -import type { PinnedEvent } from '../../../../common/types/timeline/pinned_event/api'; +import type { PinnedEvent } from '../../../../common/api/timeline'; import { KibanaServices } from '../../../common/lib/kibana'; export const persistPinnedEvent = async ({ diff --git a/x-pack/plugins/security_solution/public/timelines/pages/index.tsx b/x-pack/plugins/security_solution/public/timelines/pages/index.tsx index ac882d6da9667..384a0b86ff62c 100644 --- a/x-pack/plugins/security_solution/public/timelines/pages/index.tsx +++ b/x-pack/plugins/security_solution/public/timelines/pages/index.tsx @@ -9,7 +9,7 @@ import React from 'react'; import { Redirect } from 'react-router-dom'; import { Routes, Route } from '@kbn/shared-ux-router'; -import { TimelineType } from '../../../common/types/timeline/api'; +import { TimelineType } from '../../../common/api/timeline'; import { TimelinesPage } from './timelines_page'; diff --git a/x-pack/plugins/security_solution/public/timelines/pages/timelines_page.tsx b/x-pack/plugins/security_solution/public/timelines/pages/timelines_page.tsx index 337ae3b71fb38..6c46291f58171 100644 --- a/x-pack/plugins/security_solution/public/timelines/pages/timelines_page.tsx +++ b/x-pack/plugins/security_solution/public/timelines/pages/timelines_page.tsx @@ -11,7 +11,7 @@ import styled from 'styled-components'; import { useParams } from 'react-router-dom'; import { TimelineId } from '../../../common/types/timeline'; -import { TimelineType } from '../../../common/types/timeline/api'; +import { TimelineType } from '../../../common/api/timeline'; import { HeaderPage } from '../../common/components/header_page'; import { SecuritySolutionPageWrapper } from '../../common/components/page_wrapper'; import { useKibana } from '../../common/lib/kibana'; diff --git a/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts b/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts index eb6306f8005ef..2b9dbb45d526f 100644 --- a/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts +++ b/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts @@ -29,7 +29,7 @@ import type { ColumnHeaderOptions, SortColumnTimeline, } from '../../../../common/types/timeline'; -import type { RowRendererId } from '../../../../common/types/timeline/api'; +import type { RowRendererId } from '../../../../common/api/timeline'; import type { ResolveTimelineConfig } from '../../components/open_timeline/types'; const actionCreator = actionCreatorFactory('x-pack/security_solution/local/timeline'); diff --git a/x-pack/plugins/security_solution/public/timelines/store/timeline/defaults.ts b/x-pack/plugins/security_solution/public/timelines/store/timeline/defaults.ts index 12347b6c99189..23e8033a111f9 100644 --- a/x-pack/plugins/security_solution/public/timelines/store/timeline/defaults.ts +++ b/x-pack/plugins/security_solution/public/timelines/store/timeline/defaults.ts @@ -6,7 +6,7 @@ */ import { TimelineTabs } from '../../../../common/types/timeline'; -import { TimelineType, TimelineStatus } from '../../../../common/types/timeline/api'; +import { TimelineType, TimelineStatus } from '../../../../common/api/timeline'; import { defaultHeaders } from '../../components/timeline/body/column_headers/default_headers'; import { normalizeTimeRange } from '../../../common/utils/normalize_time_range'; diff --git a/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.test.ts b/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.test.ts index ef7ce46cb0d7b..527ea01903279 100644 --- a/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.test.ts +++ b/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.test.ts @@ -9,7 +9,7 @@ import type { Filter } from '@kbn/es-query'; import { FilterStateStore } from '@kbn/es-query'; import { Direction } from '../../../../common/search_strategy'; import { TimelineTabs } from '../../../../common/types/timeline'; -import { TimelineType, TimelineStatus } from '../../../../common/types/timeline/api'; +import { TimelineType, TimelineStatus } from '../../../../common/api/timeline'; import { convertTimelineAsInput } from './epic'; import type { TimelineModel } from './model'; diff --git a/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts b/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts index f1ad7fd527c09..1cc2b9be725c2 100644 --- a/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts +++ b/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts @@ -44,9 +44,9 @@ import type { TimelineErrorResponse, ResponseTimeline, TimelineResult, -} from '../../../../common/types/timeline/api'; +} from '../../../../common/api/timeline'; import type { ColumnHeaderOptions } from '../../../../common/types/timeline'; -import { TimelineStatus, TimelineType } from '../../../../common/types/timeline/api'; +import { TimelineStatus, TimelineType } from '../../../../common/api/timeline'; import type { inputsModel } from '../../../common/store/inputs'; import { addError } from '../../../common/store/app/actions'; diff --git a/x-pack/plugins/security_solution/public/timelines/store/timeline/epic_favorite.ts b/x-pack/plugins/security_solution/public/timelines/store/timeline/epic_favorite.ts index 0404ac595e183..6e2c623f7bea0 100644 --- a/x-pack/plugins/security_solution/public/timelines/store/timeline/epic_favorite.ts +++ b/x-pack/plugins/security_solution/public/timelines/store/timeline/epic_favorite.ts @@ -24,8 +24,8 @@ import { dispatcherTimelinePersistQueue } from './epic_dispatcher_timeline_persi import { myEpicTimelineId } from './my_epic_timeline_id'; import type { ActionTimeline, TimelineById } from './types'; import type { inputsModel } from '../../../common/store/inputs'; -import type { ResponseFavoriteTimeline } from '../../../../common/types/timeline/api'; -import { TimelineType } from '../../../../common/types/timeline/api'; +import type { ResponseFavoriteTimeline } from '../../../../common/api/timeline'; +import { TimelineType } from '../../../../common/api/timeline'; import { persistFavorite } from '../../containers/api'; export const timelineFavoriteActionsType = [updateIsFavorite.type]; diff --git a/x-pack/plugins/security_solution/public/timelines/store/timeline/epic_note.ts b/x-pack/plugins/security_solution/public/timelines/store/timeline/epic_note.ts index 5e6cc300da8ae..35ec40f2bc3d8 100644 --- a/x-pack/plugins/security_solution/public/timelines/store/timeline/epic_note.ts +++ b/x-pack/plugins/security_solution/public/timelines/store/timeline/epic_note.ts @@ -28,7 +28,7 @@ import { myEpicTimelineId } from './my_epic_timeline_id'; import { dispatcherTimelinePersistQueue } from './epic_dispatcher_timeline_persistence_queue'; import type { ActionTimeline, TimelineById } from './types'; import { persistNote } from '../../containers/notes/api'; -import type { ResponseNote } from '../../../../common/types/timeline/note/api'; +import type { ResponseNote } from '../../../../common/api/timeline'; export const timelineNoteActionsType = [addNote.type, addNoteToEvent.type]; diff --git a/x-pack/plugins/security_solution/public/timelines/store/timeline/epic_pinned_event.ts b/x-pack/plugins/security_solution/public/timelines/store/timeline/epic_pinned_event.ts index a55d32ddc68a5..e0702b22595e2 100644 --- a/x-pack/plugins/security_solution/public/timelines/store/timeline/epic_pinned_event.ts +++ b/x-pack/plugins/security_solution/public/timelines/store/timeline/epic_pinned_event.ts @@ -14,7 +14,7 @@ import { filter, mergeMap, startWith, withLatestFrom, takeUntil } from 'rxjs/ope import { addError } from '../../../common/store/app/actions'; import type { inputsModel } from '../../../common/store/inputs'; -import type { PinnedEventResponse } from '../../../../common/types/timeline/pinned_event/api'; +import type { PinnedEventResponse } from '../../../../common/api/timeline'; import { pinEvent, endTimelineSaving, diff --git a/x-pack/plugins/security_solution/public/timelines/store/timeline/helpers.ts b/x-pack/plugins/security_solution/public/timelines/store/timeline/helpers.ts index 602cd86659927..9cebc52da54fa 100644 --- a/x-pack/plugins/security_solution/public/timelines/store/timeline/helpers.ts +++ b/x-pack/plugins/security_solution/public/timelines/store/timeline/helpers.ts @@ -32,9 +32,9 @@ import type { ToggleDetailPanel, SortColumnTimeline, } from '../../../../common/types/timeline'; -import type { RowRendererId, TimelineTypeLiteral } from '../../../../common/types/timeline/api'; +import type { RowRendererId, TimelineTypeLiteral } from '../../../../common/api/timeline'; import { TimelineId } from '../../../../common/types/timeline'; -import { TimelineStatus, TimelineType } from '../../../../common/types/timeline/api'; +import { TimelineStatus, TimelineType } from '../../../../common/api/timeline'; import { normalizeTimeRange } from '../../../common/utils/normalize_time_range'; import { getTimelineManageDefaults, timelineDefaults } from './defaults'; import type { KqlMode, TimelineModel } from './model'; diff --git a/x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts b/x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts index 2f6884fac2846..0f2939309344f 100644 --- a/x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts +++ b/x-pack/plugins/security_solution/public/timelines/store/timeline/model.ts @@ -25,8 +25,8 @@ import type { RowRendererId, TimelineStatus, TimelineType, -} from '../../../../common/types/timeline/api'; -import type { PinnedEvent } from '../../../../common/types/timeline/pinned_event/api'; + PinnedEvent, +} from '../../../../common/api/timeline'; import type { ResolveTimelineConfig } from '../../components/open_timeline/types'; export type KqlMode = 'filter' | 'search'; diff --git a/x-pack/plugins/security_solution/public/timelines/store/timeline/reducer.test.ts b/x-pack/plugins/security_solution/public/timelines/store/timeline/reducer.test.ts index 58da0de140ad4..753b2cf4e0b16 100644 --- a/x-pack/plugins/security_solution/public/timelines/store/timeline/reducer.test.ts +++ b/x-pack/plugins/security_solution/public/timelines/store/timeline/reducer.test.ts @@ -8,7 +8,7 @@ import { cloneDeep } from 'lodash/fp'; import type { ColumnHeaderOptions } from '../../../../common/types/timeline'; import { TimelineTabs, TimelineId } from '../../../../common/types/timeline'; -import { TimelineType, TimelineStatus } from '../../../../common/types/timeline/api'; +import { TimelineType, TimelineStatus } from '../../../../common/api/timeline'; import type { DataProvider, diff --git a/x-pack/plugins/security_solution/public/timelines/store/timeline/reducer.ts b/x-pack/plugins/security_solution/public/timelines/store/timeline/reducer.ts index c755cad900dbe..e661fadf428d2 100644 --- a/x-pack/plugins/security_solution/public/timelines/store/timeline/reducer.ts +++ b/x-pack/plugins/security_solution/public/timelines/store/timeline/reducer.ts @@ -102,7 +102,7 @@ import { import type { TimelineState } from './types'; import { EMPTY_TIMELINE_BY_ID } from './types'; -import { TimelineType } from '../../../../common/types/timeline/api'; +import { TimelineType } from '../../../../common/api/timeline'; export const initialTimelineState: TimelineState = { timelineById: EMPTY_TIMELINE_BY_ID, diff --git a/x-pack/plugins/security_solution/public/timelines/store/timeline/types.ts b/x-pack/plugins/security_solution/public/timelines/store/timeline/types.ts index 52d4933834294..be79d70c2b27d 100644 --- a/x-pack/plugins/security_solution/public/timelines/store/timeline/types.ts +++ b/x-pack/plugins/security_solution/public/timelines/store/timeline/types.ts @@ -13,7 +13,7 @@ import type { CoreStart } from '@kbn/core/public'; import type { FilterManager } from '@kbn/data-plugin/public'; import type { TableById } from '@kbn/securitysolution-data-table'; import type { ColumnHeaderOptions, SortColumnTimeline } from '../../../../common/types'; -import type { RowRendererId } from '../../../../common/types/timeline/api'; +import type { RowRendererId } from '../../../../common/api/timeline'; import type { inputsModel } from '../../../common/store/inputs'; import type { NotesById } from '../../../common/store/app/model'; diff --git a/x-pack/plugins/security_solution/public/types.ts b/x-pack/plugins/security_solution/public/types.ts index 2687c1fcab25e..358111dd55265 100644 --- a/x-pack/plugins/security_solution/public/types.ts +++ b/x-pack/plugins/security_solution/public/types.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { BehaviorSubject, Observable } from 'rxjs'; +import type { Observable } from 'rxjs'; import type { AppLeaveHandler, CoreStart } from '@kbn/core/public'; import type { HomePublicPluginSetup } from '@kbn/home-plugin/public'; @@ -66,10 +66,12 @@ import type { ThreatIntelligence } from './threat_intelligence'; import type { SecuritySolutionTemplateWrapper } from './app/home/template_wrapper'; import type { Explore } from './explore'; import type { NavigationLink } from './common/links'; +import type { EntityAnalytics } from './entity_analytics'; import type { TelemetryClientStart } from './common/lib/telemetry'; import type { Dashboards } from './dashboards'; import type { UpsellingService } from './common/lib/upsellings'; +import type { BreadcrumbsNav } from './common/breadcrumbs/types'; export interface SetupPlugins { cloud?: CloudSetup; @@ -127,8 +129,15 @@ export interface StartPluginsDependencies extends StartPlugins { savedObjectsTaggingOss: SavedObjectTaggingOssPluginStart; } +export interface ContractStartServices { + isSidebarEnabled$: Observable; + getStartedComponent$: Observable; + upselling: UpsellingService; +} + export type StartServices = CoreStart & - StartPlugins & { + StartPlugins & + ContractStartServices & { storage: Storage; sessionStorage: Storage; apm: ApmBase; @@ -143,9 +152,6 @@ export type StartServices = CoreStart & getPluginWrapper: () => typeof SecuritySolutionTemplateWrapper; }; savedObjectsManagement: SavedObjectsManagementPluginStart; - isSidebarEnabled$: BehaviorSubject; - getStartedComponent$: BehaviorSubject; - upselling: UpsellingService; telemetry: TelemetryClientStart; }; @@ -158,6 +164,7 @@ export interface PluginStart { getNavLinks$: () => Observable; setIsSidebarEnabled: (isSidebarEnabled: boolean) => void; setGetStartedPage: (getStartedComponent: React.ComponentType) => void; + getBreadcrumbsNav$: () => Observable; } export interface AppObservableLibs { @@ -181,6 +188,7 @@ export interface SubPlugins { rules: Rules; threatIntelligence: ThreatIntelligence; timelines: Timelines; + entityAnalytics: EntityAnalytics; } // TODO: find a better way to defined these types @@ -198,4 +206,5 @@ export interface StartedSubPlugins { rules: ReturnType; threatIntelligence: ReturnType; timelines: ReturnType; + entityAnalytics: ReturnType; } diff --git a/x-pack/plugins/security_solution/scripts/endpoint/common/endpoint_host_services.ts b/x-pack/plugins/security_solution/scripts/endpoint/common/endpoint_host_services.ts index 6add9eb06a39b..8c4bdac30362e 100644 --- a/x-pack/plugins/security_solution/scripts/endpoint/common/endpoint_host_services.ts +++ b/x-pack/plugins/security_solution/scripts/endpoint/common/endpoint_host_services.ts @@ -20,6 +20,8 @@ import { waitForHostToEnroll, } from './fleet_services'; +export const VAGRANT_CWD = `${__dirname}/../endpoint_agent_runner/`; + export interface CreateAndEnrollEndpointHostOptions extends Pick { kbnClient: KbnClient; @@ -60,38 +62,48 @@ export const createAndEnrollEndpointHost = async ({ deleted: [], }); - const [vm, agentDownload, fleetServerUrl, enrollmentToken] = await Promise.all([ - createMultipassVm({ - vmName: hostname ?? `test-host-${Math.random().toString().substring(2, 6)}`, - disk, - cpus, - memory, - }), - - getAgentDownloadUrl(version, useClosestVersionMatch, log).then<{ - url: string; - cache?: DownloadedAgentInfo; - }>((url) => { - if (useCache) { - cacheCleanupPromise = cleanupDownloads(); - - return downloadAndStoreAgent(url).then((cache) => { - return { - url, - cache, - }; - }); - } - - return { url }; - }), + const vmName = hostname ?? `test-host-${Math.random().toString().substring(2, 6)}`; + + const agentDownload = await getAgentDownloadUrl(version, useClosestVersionMatch, log).then<{ + url: string; + cache?: DownloadedAgentInfo; + }>((url) => { + if (useCache) { + cacheCleanupPromise = cleanupDownloads(); + + return downloadAndStoreAgent(url).then((cache) => { + return { + url, + cache, + }; + }); + } + + return { url }; + }); + + const [vm, fleetServerUrl, enrollmentToken] = await Promise.all([ + process.env.CI + ? createVagrantVm({ + vmName, + log, + cachedAgentDownload: agentDownload.cache as DownloadedAgentInfo, + }) + : createMultipassVm({ + vmName, + disk, + cpus, + memory, + }), fetchFleetServerUrl(kbnClient), fetchAgentPolicyEnrollmentKey(kbnClient, agentPolicyId), ]); - log.verbose(await execa('multipass', ['info', vm.vmName])); + if (!process.env.CI) { + log.verbose(await execa('multipass', ['info', vm.vmName])); + } // Some validations before we proceed assert(agentDownload.url, 'Missing agent download URL'); @@ -143,6 +155,54 @@ export const destroyEndpointHost = async ( ]); }; +interface CreateVmResponse { + vmName: string; +} + +interface CreateVagrantVmOptions { + vmName: string; + cachedAgentDownload: DownloadedAgentInfo; + log: ToolingLog; +} + +/** + * Creates a new VM using `vagrant` + */ +const createVagrantVm = async ({ + vmName, + cachedAgentDownload, + log, +}: CreateVagrantVmOptions): Promise => { + try { + await execa.command(`vagrant destroy -f`, { + env: { + VAGRANT_CWD, + }, + }); + // eslint-disable-next-line no-empty + } catch (e) {} + + try { + await execa.command(`vagrant up`, { + env: { + VAGRANT_DISABLE_VBOXSYMLINKCREATE: '1', + VAGRANT_CWD, + VMNAME: vmName, + CACHED_AGENT_SOURCE: cachedAgentDownload.fullFilePath, + CACHED_AGENT_FILENAME: cachedAgentDownload.filename, + }, + stdio: ['inherit', 'inherit', 'inherit'], + }); + } catch (e) { + log.error(e); + throw e; + } + + return { + vmName, + }; +}; + interface CreateMultipassVmOptions { vmName: string; /** Number of CPUs */ @@ -153,10 +213,6 @@ interface CreateMultipassVmOptions { memory?: string; } -interface CreateMultipassVmResponse { - vmName: string; -} - /** * Creates a new VM using `multipass` */ @@ -165,7 +221,7 @@ const createMultipassVm = async ({ disk = '8G', cpus = 1, memory = '1G', -}: CreateMultipassVmOptions): Promise => { +}: CreateMultipassVmOptions): Promise => { await execa.command( `multipass launch --name ${vmName} --disk ${disk} --cpus ${cpus} --memory ${memory}` ); @@ -176,7 +232,15 @@ const createMultipassVm = async ({ }; const deleteMultipassVm = async (vmName: string): Promise => { - await execa.command(`multipass delete -p ${vmName}`); + if (process.env.CI) { + await execa.command(`vagrant destroy -f`, { + env: { + VAGRANT_CWD, + }, + }); + } else { + await execa.command(`multipass delete -p ${vmName}`); + } }; interface EnrollHostWithFleetOptions { @@ -206,35 +270,30 @@ const enrollHostWithFleet = async ({ `Installing agent on host using cached download from [${cachedAgentDownload.fullFilePath}]` ); - // mount local folder on VM - await execa.command( - `multipass mount ${cachedAgentDownload.directory} ${vmName}:~/_agent_downloads` - ); - await execa.command( - `multipass exec ${vmName} -- tar -zxf _agent_downloads/${cachedAgentDownload.filename}` - ); - await execa.command(`multipass unmount ${vmName}:~/_agent_downloads`); + if (!process.env.CI) { + // mount local folder on VM + await execa.command( + `multipass mount ${cachedAgentDownload.directory} ${vmName}:~/_agent_downloads` + ); + await execa.command( + `multipass exec ${vmName} -- tar -zxf _agent_downloads/${cachedAgentDownload.filename}` + ); + await execa.command(`multipass unmount ${vmName}:~/_agent_downloads`); + } } else { log.verbose(`downloading and installing agent from URL [${agentDownloadUrl}]`); - // download into VM - await execa.command( - `multipass exec ${vmName} -- curl -L ${agentDownloadUrl} -o ${agentDownloadedFile}` - ); - await execa.command(`multipass exec ${vmName} -- tar -zxf ${agentDownloadedFile}`); - await execa.command(`multipass exec ${vmName} -- rm -f ${agentDownloadedFile}`); + if (!process.env.CI) { + // download into VM + await execa.command( + `multipass exec ${vmName} -- curl -L ${agentDownloadUrl} -o ${agentDownloadedFile}` + ); + await execa.command(`multipass exec ${vmName} -- tar -zxf ${agentDownloadedFile}`); + await execa.command(`multipass exec ${vmName} -- rm -f ${agentDownloadedFile}`); + } } const agentInstallArguments = [ - 'exec', - - vmName, - - '--working-directory', - `/home/ubuntu/${vmDirName}`, - - '--', - 'sudo', './elastic-agent', @@ -253,10 +312,28 @@ const enrollHostWithFleet = async ({ ]; log.info(`Enrolling elastic agent with Fleet`); - log.verbose(`Command: multipass ${agentInstallArguments.join(' ')}`); + if (process.env.CI) { + log.verbose(`Command: vagrant ${agentInstallArguments.join(' ')}`); + + await execa(`vagrant`, ['ssh', '--', `cd ${vmDirName} && ${agentInstallArguments.join(' ')}`], { + env: { + VAGRANT_CWD, + }, + stdio: ['inherit', 'inherit', 'inherit'], + }); + } else { + log.verbose(`Command: multipass ${agentInstallArguments.join(' ')}`); - await execa(`multipass`, agentInstallArguments); + await execa(`multipass`, [ + 'exec', + vmName, + '--working-directory', + `/home/ubuntu/${vmDirName}`, + '--', + ...agentInstallArguments, + ]); + } log.info(`Waiting for Agent to check-in with Fleet`); const agent = await waitForHostToEnroll(kbnClient, vmName, 120000); @@ -273,9 +350,24 @@ export async function getEndpointHosts(): Promise< } export function stopEndpointHost(hostName: string) { + if (process.env.CI) { + return execa('vagrant', ['suspend'], { + env: { + VAGRANT_CWD, + VMNAME: hostName, + }, + }); + } return execa('multipass', ['stop', hostName]); } export function startEndpointHost(hostName: string) { + if (process.env.CI) { + return execa('vagrant', ['up'], { + env: { + VAGRANT_CWD, + }, + }); + } return execa('multipass', ['start', hostName]); } diff --git a/x-pack/plugins/security_solution/scripts/endpoint/common/response_actions.ts b/x-pack/plugins/security_solution/scripts/endpoint/common/response_actions.ts index f8c3aad63f4e2..8a5c77c2a61b0 100644 --- a/x-pack/plugins/security_solution/scripts/endpoint/common/response_actions.ts +++ b/x-pack/plugins/security_solution/scripts/endpoint/common/response_actions.ts @@ -209,8 +209,9 @@ export const sendEndpointActionResponse = async ( const fileMeta = await esClient.index({ index: FILE_STORAGE_METADATA_INDEX, id: getFileDownloadId(action, action.agents[0]), - body: fileMetaDoc, + op_type: 'create', refresh: 'wait_for', + body: fileMetaDoc, }); // Index the file content (just one chunk) @@ -224,12 +225,14 @@ export const sendEndpointActionResponse = async ( document: cborx.encode({ bid: fileMeta._id, last: true, + '@timestamp': new Date().toISOString(), data: Buffer.from( 'UEsDBAoACQAAAFZeRFWpAsDLHwAAABMAAAAMABwAYmFkX2ZpbGUudHh0VVQJAANTVjxjU1Y8Y3V4CwABBPUBAAAEFAAAAMOcoyEq/Q4VyG02U9O0LRbGlwP/y5SOCfRKqLz1rsBQSwcIqQLAyx8AAAATAAAAUEsBAh4DCgAJAAAAVl5EVakCwMsfAAAAEwAAAAwAGAAAAAAAAQAAAKSBAAAAAGJhZF9maWxlLnR4dFVUBQADU1Y8Y3V4CwABBPUBAAAEFAAAAFBLBQYAAAAAAQABAFIAAAB1AAAAAAA=', 'base64' ), }), refresh: 'wait_for', + op_type: 'create', }, { headers: { diff --git a/x-pack/plugins/security_solution/scripts/endpoint/common/stack_services.ts b/x-pack/plugins/security_solution/scripts/endpoint/common/stack_services.ts index 434df1b209a19..e38725e5d5e6e 100644 --- a/x-pack/plugins/security_solution/scripts/endpoint/common/stack_services.ts +++ b/x-pack/plugins/security_solution/scripts/endpoint/common/stack_services.ts @@ -44,7 +44,7 @@ export interface RuntimeServices { interface CreateRuntimeServicesOptions { kibanaUrl: string; elasticsearchUrl: string; - fleetServerUrl: string | undefined; + fleetServerUrl?: string; username: string; password: string; log?: ToolingLog; diff --git a/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/Vagrantfile b/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/Vagrantfile new file mode 100644 index 0000000000000..42080eab2984e --- /dev/null +++ b/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/Vagrantfile @@ -0,0 +1,29 @@ +hostname = ENV["VMNAME"] || 'ubuntu' +cachedAgentSource = ENV["CACHED_AGENT_SOURCE"] || '' +cachedAgentFilename = ENV["CACHED_AGENT_FILENAME"] || '' + +Vagrant.configure("2") do |config| + config.vm.hostname = hostname + config.vm.box = 'ubuntu/jammy64' + + config.vm.provider :virtualbox do |vb| + vb.memory = 4096 + vb.cpus = 2 + end + + config.vm.provider :vmware_desktop do |v, override| + override.vm.box = "starboard/ubuntu-arm64-20.04.5" + override.vm.box_version = "20221120.20.40.0" + override.vm.box_download_insecure = true + override.vm.network "private_network", type: "dhcp" + + v.ssh_info_public = true + v.gui = true + v.linked_clone = false + v.vmx["ethernet0.virtualdev"] = "vmxnet3" + end + + config.vm.provision "file", source: cachedAgentSource, destination: "~/#{cachedAgentFilename}" + config.vm.provision "shell", inline: "tar -zxf #{cachedAgentFilename} && rm -f #{cachedAgentFilename}" + config.vm.provision "shell", inline: "sudo apt-get install unzip" +end diff --git a/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/elastic_endpoint.ts b/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/elastic_endpoint.ts index 0c53f84cb9965..dcab47a3e030e 100644 --- a/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/elastic_endpoint.ts +++ b/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/elastic_endpoint.ts @@ -60,13 +60,23 @@ export const enrollEndpointHost = async (): Promise => { disk: '8G', }); - log.info(`VM created using Multipass. - VM Name: ${vmName} - Elastic Agent Version: ${version} - - Shell access: ${chalk.bold(`multipass shell ${vmName}`)} - Delete VM: ${chalk.bold(`multipass delete -p ${vmName}${await getVmCountNotice()}`)} -`); + if (process.env.CI) { + log.info(`VM created using Vagrant. + VM Name: ${vmName} + Elastic Agent Version: ${version} + + Shell access: ${chalk.bold(`vagrant ssh ${vmName}`)} + Delete VM: ${chalk.bold(`vagrant destroy ${vmName} -f`)} + `); + } else { + log.info(`VM created using Multipass. + VM Name: ${vmName} + Elastic Agent Version: ${version} + + Shell access: ${chalk.bold(`multipass shell ${vmName}`)} + Delete VM: ${chalk.bold(`multipass delete -p ${vmName}${await getVmCountNotice()}`)} + `); + } } catch (error) { log.error(dump(error)); log.indent(-4); diff --git a/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/fleet_server.ts b/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/fleet_server.ts index 49701f3c41fa7..c141ad1c3abd1 100644 --- a/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/fleet_server.ts +++ b/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/fleet_server.ts @@ -50,22 +50,11 @@ export const runFleetServerIfNeeded = async (): Promise< const { log, kibana: { isLocalhost: isKibanaOnLocalhost }, - kbnClient, } = getRuntimeServices(); log.info(`Setting up fleet server (if necessary)`); log.indent(4); - const currentFleetServerUrl = await fetchFleetServerUrl(kbnClient); - - if (currentFleetServerUrl) { - log.info( - `Fleet server is already enrolled with Fleet - URL:\n${currentFleetServerUrl}\nNothing to do.` - ); - log.indent(-4); - return; - } - try { fleetServerAgentPolicyId = await getOrCreateFleetServerAgentPolicyId(); const serviceToken = await generateFleetServiceToken(); diff --git a/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/runtime.ts b/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/runtime.ts index d267c70be8a78..c7680a42bbbbe 100644 --- a/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/runtime.ts +++ b/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/runtime.ts @@ -37,6 +37,7 @@ export const startRuntimeServices = async ({ username, password, log, + asSuperuser: otherOptions?.asSuperuser, }); runtimeServices = { diff --git a/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/types.ts b/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/types.ts index 7215fb311d77a..ac75d1f8f64e8 100644 --- a/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/types.ts +++ b/x-pack/plugins/security_solution/scripts/endpoint/endpoint_agent_runner/types.ts @@ -16,4 +16,5 @@ export interface StartRuntimeServicesOptions { version?: string; policy?: string; log?: ToolingLog; + asSuperuser?: boolean; } diff --git a/x-pack/plugins/security_solution/scripts/mappings/README.md b/x-pack/plugins/security_solution/scripts/mappings/README.md new file mode 100644 index 0000000000000..3c209b237298a --- /dev/null +++ b/x-pack/plugins/security_solution/scripts/mappings/README.md @@ -0,0 +1,36 @@ +# Huge Indices with Unmapped Fields Generator/Loader Scripts + +This script makes it easy to generate and load big amount of indices with huge amount of fields. +It is also easy to specify what portion of those fields should be unmapped across various indices. +The purpose of this scripts is to be able to test `_field_caps` APIs which we use to fetch fields, +especially with `include_unmapped` options set. + +There are two different scripts: +1. `mappings_generator.js` which generates indices +2. `mappings_loader.js` which loads all generated indices to ES + +## Examples. + +### Generate 1k indices (split into 10 buckets with 100 indices each) with 10k fields (with 20% randomly unmapped fields within each index) + +> `node mappings_generator.js --fieldsCount=10000 --indexCount=1000 --indexPrefix='.ds-huge' --unmappedRate=.2 --buckets=10 --outputDirectory='test_unmapped'` + +The result of this operation will be 10 separate bucket folders within `test_unmapped`. Each bucket folder will contain a `mappings.json` file describing 100 indices. + +Available attributes: +* `--fieldsCount` (*required*): the number of fields in generated index +* `--indexCount` (*required*): the number of indices to be generated +* `--indexPrefix` (*required*): the prefix for the generated indices +* `--unmappedRate` (*required*): the percentage of unmapped fields in each index (value ranges from 0.0 to 1.0) +* `--buckets` (*optional, default value is 1*): it is possible to split the generated indices mappings into the smaller chunks +* `--outputDirectory` (*required*): the output folder + +### Load all generated buckets generated via previous command + +> `node mappings_loader.js --mappings-dir='test_unmapped' --es-url=http://username:password@localhost:9200 --kibana-url=http://username:password@localhost:5601/app` + + +This script will go through each folder in the provided root folder (via `--mappings-dir`) and load each folder with mappings inside using `es_archiver` tool. + + +**NOTE:** The path to `es_archiver` is adjusted for the call of this script using `x-pack/plugins/security_solution/package.json`. If you call this script directly, you will need to adjust it accordingly. diff --git a/x-pack/plugins/security_solution/scripts/mappings/mappings_generator.js b/x-pack/plugins/security_solution/scripts/mappings/mappings_generator.js new file mode 100644 index 0000000000000..a97b2e707f07b --- /dev/null +++ b/x-pack/plugins/security_solution/scripts/mappings/mappings_generator.js @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +require('../../../../../src/setup_node_env'); +require('./mappings_generator_script'); diff --git a/x-pack/plugins/security_solution/scripts/mappings/mappings_generator_script.ts b/x-pack/plugins/security_solution/scripts/mappings/mappings_generator_script.ts new file mode 100644 index 0000000000000..4e06b2e08ce4e --- /dev/null +++ b/x-pack/plugins/security_solution/scripts/mappings/mappings_generator_script.ts @@ -0,0 +1,164 @@ +/* + * 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 no-console */ +import fs from 'fs'; +import path from 'path'; +import yargs from 'yargs'; +import { sampleSize } from 'lodash'; + +const generateMapping = (fieldsCount: number, numberOfMappedFieldsPerIndex: number) => { + const properties: { [key: string]: {} } = { + '@timestamp': { + type: 'date', + }, + }; + const ids = [...Array(fieldsCount - 1).keys()]; + const sampledIds = sampleSize(ids, numberOfMappedFieldsPerIndex); + for (const i of sampledIds) { + properties[`fake_field_${i}`] = { + type: 'keyword', + ignore_above: 1024, + }; + } + const mappings = { properties }; + return mappings; +}; + +const generateIndex = ( + indexId: number, + bucketId: number, + indexPrefix: string, + fieldsCount: number, + numberOfMappedFieldsPerIndex: number +) => { + const indexTemplate = { + type: 'index', + value: { + index: 'template', + mappings: {}, + settings: { + index: { + number_of_replicas: '0', + number_of_shards: '1', + }, + mapping: { + total_fields: { limit: fieldsCount }, + }, + }, + }, + }; + indexTemplate.value.index = `${indexPrefix}-${bucketId}-index-${`000000${indexId}`.slice(-6)}`; + const mappings = generateMapping(fieldsCount, numberOfMappedFieldsPerIndex); + indexTemplate.value.mappings = mappings; + return indexTemplate; +}; + +const generateIndices = ( + outputDirectory: string, + indexCount: number, + indexPrefix: string, + fieldsCount: number, + numberOfMappedFieldsPerIndex: number, + numberOfIndexBuckets: number +) => { + const absoluteOutputDir = path.resolve(outputDirectory); + + // Delete output directory if exists + console.log(`Deleting directory: ${absoluteOutputDir}`); + if (fs.existsSync(absoluteOutputDir)) { + fs.rmSync(absoluteOutputDir, { recursive: true, force: true }); + } + + // Create output directory if needed + console.log(`Creating directory: ${absoluteOutputDir}`); + fs.mkdirSync(absoluteOutputDir, { recursive: true }); + + let indicesLeft = indexCount; + const indicesPerBucket = Math.ceil(indexCount / numberOfIndexBuckets); + + const bucketIds = [...Array(numberOfIndexBuckets).keys()]; + for (const bucketId of bucketIds) { + const bucketDir = `${absoluteOutputDir}/bucket${bucketId}`; + fs.mkdirSync(bucketDir, { recursive: true }); + + const indexFilename = `${bucketDir}/index.mappings.json`; + console.log(`Generating index: ${indexFilename}`); + const stream = fs.createWriteStream(indexFilename, { flags: 'a' }); + const ids = [...Array(Math.min(indicesPerBucket, indicesLeft)).keys()]; + for (const indexId of ids) { + const index = generateIndex( + indexId, + bucketId, + indexPrefix, + fieldsCount, + numberOfMappedFieldsPerIndex + ); + stream.write(`${JSON.stringify(index)}\n\n`); + } + stream.end(); + indicesLeft -= indicesPerBucket; + } +}; + +const main = () => { + const { argv } = yargs(process.argv.slice(2)) + .option('fieldsCount', { + demandOption: true, + type: 'number', + description: 'Number of the fields in each index', + }) + .option('indexCount', { + demandOption: true, + type: 'number', + description: 'Number of indices to generate', + }) + .option('indexPrefix', { + demandOption: true, + type: 'string', + description: 'Prefix of the index name', + }) + .option('unmappedRate', { + demandOption: true, + type: 'number', + description: 'Probablity of field to be unmapped in the index', + }) + .option('buckets', { + demandOption: false, + type: 'number', + default: 1, + description: 'Number of buckets with indices (default is 1)', + }) + .option('outputDirectory', { + demandOption: true, + type: 'string', + description: 'The name of the directory to save generated mappings to', + }) + .check(({ unmappedRate }) => { + if (unmappedRate < 0.0 || unmappedRate > 1.0) { + throw new Error('--unmappedRate can only be in range [0.0, 1.0]'); + } else { + return true; + } + }) + .help(); + + const { fieldsCount, indexCount, indexPrefix, unmappedRate, buckets, outputDirectory } = argv; + const numberOfMappedFieldsPerIndex = Math.max(Math.floor(fieldsCount * (1.0 - unmappedRate)), 1); + const numberOfIndexBuckets = Math.max(1, Math.min(buckets, indexCount)); + + generateIndices( + outputDirectory, + indexCount, + indexPrefix, + fieldsCount, + numberOfMappedFieldsPerIndex, + numberOfIndexBuckets + ); +}; + +main(); diff --git a/x-pack/plugins/security_solution/scripts/mappings/mappings_loader.js b/x-pack/plugins/security_solution/scripts/mappings/mappings_loader.js new file mode 100644 index 0000000000000..8e54207074d0e --- /dev/null +++ b/x-pack/plugins/security_solution/scripts/mappings/mappings_loader.js @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +require('../../../../../src/setup_node_env'); +require('./mappings_loader_script'); diff --git a/x-pack/plugins/security_solution/scripts/mappings/mappings_loader_script.ts b/x-pack/plugins/security_solution/scripts/mappings/mappings_loader_script.ts new file mode 100644 index 0000000000000..9348bd1e17369 --- /dev/null +++ b/x-pack/plugins/security_solution/scripts/mappings/mappings_loader_script.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. + */ + +/* eslint-disable no-console */ +import fs from 'fs'; +import path from 'path'; +import yargs from 'yargs'; +import { execSync } from 'child_process'; + +const CONFIG_PATH = '../../../test/functional/config.base.js'; + +const loadAllIndices = (esUrl: string, kibanaUrl: string, mappingsDir: string) => { + const exec = (cmd: string) => execSync(cmd, { stdio: 'inherit' }); + + const absoluteMappingsDir = path.resolve(mappingsDir); + if (!fs.existsSync(absoluteMappingsDir)) { + console.warn(`Root directory "${absoluteMappingsDir}" does not exist.`); + return; + } + + fs.readdir(absoluteMappingsDir, (err, files) => { + if (err) { + throw new Error(`Could not list the directory because of error: ${JSON.stringify(err)}`); + } + + files.forEach((file) => { + // Make one pass and make the file complete + const fullPath = path.join(absoluteMappingsDir, file); + + fs.stat(fullPath, (error, stat) => { + if (error) { + console.error(`Error stating file: ${error}`); + return; + } + if (!stat.isDirectory()) { + return; + } + exec( + `node ../../../scripts/es_archiver load ${fullPath} --config "${CONFIG_PATH}" --es-url=${esUrl} --kibana-url=${kibanaUrl}` + ); + }); + }); + }); +}; + +const main = () => { + const { argv } = yargs(process.argv.slice(2)) + .option('es-url', { + demandOption: false, + type: 'string', + default: 'http://elastic:changeme@localhost:9200', + description: 'The url for Elasticsearch', + }) + .option('kibana-url', { + demandOption: false, + type: 'string', + default: 'http://elastic:changeme@localhost:5601/app', + description: 'The url for Kibana', + }) + .option('mappings-dir', { + demandOption: true, + type: 'string', + description: 'The name of the directory with all the mapping folders', + }) + .help(); + + const { 'es-url': esUrl, 'kibana-url': kibanaUrl, 'mappings-dir': mappingsDir } = argv; + loadAllIndices(esUrl, kibanaUrl, mappingsDir); +}; + +main(); diff --git a/x-pack/plugins/security_solution/scripts/run_cypress/parallel.ts b/x-pack/plugins/security_solution/scripts/run_cypress/parallel.ts index 3c14adff1ccc4..f18a36656ead8 100644 --- a/x-pack/plugins/security_solution/scripts/run_cypress/parallel.ts +++ b/x-pack/plugins/security_solution/scripts/run_cypress/parallel.ts @@ -99,6 +99,10 @@ export const cli = () => { }; const getKibanaPort = (): T | number => { + if (isOpen) { + return 5620; + } + const kibanaPort = parseInt(`56${Math.floor(Math.random() * 89) + 10}`, 10); if (kibanaPorts.includes(kibanaPort)) { return getKibanaPort(); @@ -108,6 +112,10 @@ export const cli = () => { }; const getFleetServerPort = (): T | number => { + if (isOpen) { + return 8220; + } + const fleetServerPort = parseInt(`82${Math.floor(Math.random() * 89) + 10}`, 10); if (fleetServerPorts.includes(fleetServerPort)) { return getFleetServerPort(); @@ -378,7 +386,7 @@ export const cli = () => { } await procs.stop('kibana'); - shutdownEs(); + await shutdownEs(); cleanupServerPorts({ esPort, kibanaPort, fleetServerPort }); return result; diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/file_download_handler.test.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/file_download_handler.test.ts index 1e771f9f7ed33..24245d81dde75 100644 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/file_download_handler.test.ts +++ b/x-pack/plugins/security_solution/server/endpoint/routes/actions/file_download_handler.test.ts @@ -50,7 +50,11 @@ describe('Response Actions file download API', () => { it('should register the route', () => { expect( - apiTestSetup.getRegisteredRouteHandler('get', ACTION_AGENT_FILE_DOWNLOAD_ROUTE) + apiTestSetup.getRegisteredVersionedRoute( + 'get', + ACTION_AGENT_FILE_DOWNLOAD_ROUTE, + '2023-10-31' + ) ).toBeDefined(); }); @@ -59,11 +63,9 @@ describe('Response Actions file download API', () => { (await httpHandlerContextMock.securitySolution).getEndpointAuthz as jest.Mock ).mockResolvedValue(getEndpointAuthzInitialStateMock({ canWriteFileOperations: false })); - await apiTestSetup.getRegisteredRouteHandler('get', ACTION_AGENT_FILE_DOWNLOAD_ROUTE)( - httpHandlerContextMock, - httpRequestMock, - httpResponseMock - ); + await apiTestSetup + .getRegisteredVersionedRoute('get', ACTION_AGENT_FILE_DOWNLOAD_ROUTE, '2023-10-31') + .routeHandler(httpHandlerContextMock, httpRequestMock, httpResponseMock); expect(httpResponseMock.forbidden).toHaveBeenCalledWith({ body: expect.any(EndpointAuthorizationError), diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/file_download_handler.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/file_download_handler.ts index 5a0ee82942bd5..8b510e3d8d845 100644 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/file_download_handler.ts +++ b/x-pack/plugins/security_solution/server/endpoint/routes/actions/file_download_handler.ts @@ -25,22 +25,29 @@ export const registerActionFileDownloadRoutes = ( ) => { const logger = endpointContext.logFactory.get('actionFileDownload'); - // NOTE: - // This API (as of today - 2023-06-21) can not be versioned because it is used - // to download files from the UI, where its used as part of a `` anchor, which - // has no way to define the version header. - router.get( - { + router.versioned + .get({ + access: 'public', + // NOTE: + // Because this API is used in the browser via `href` (ex. on link to download a file), + // we need to enable setting the version number via query params + enableQueryVersion: true, path: ACTION_AGENT_FILE_DOWNLOAD_ROUTE, - validate: EndpointActionFileDownloadSchema, options: { authRequired: true, tags: ['access:securitySolution'] }, - }, - withEndpointAuthz( - { all: ['canWriteFileOperations'] }, - logger, - getActionFileDownloadRouteHandler(endpointContext) - ) - ); + }) + .addVersion( + { + version: '2023-10-31', + validate: { + request: EndpointActionFileDownloadSchema, + }, + }, + withEndpointAuthz( + { all: ['canWriteFileOperations'] }, + logger, + getActionFileDownloadRouteHandler(endpointContext) + ) + ); }; export const getActionFileDownloadRouteHandler = ( diff --git a/x-pack/plugins/security_solution/server/endpoint/services/actions/mocks.ts b/x-pack/plugins/security_solution/server/endpoint/services/actions/mocks.ts index d1818b9b494e7..a4536f54b92d7 100644 --- a/x-pack/plugins/security_solution/server/endpoint/services/actions/mocks.ts +++ b/x-pack/plugins/security_solution/server/endpoint/services/actions/mocks.ts @@ -214,6 +214,7 @@ export const generateFileMetadataDocumentMock = ( transithash: { sha256: 'a0d6d6a2bb73340d4a0ed32b2a46272a19dd111427770c072918aed7a8565010', }, + '@timestamp': new Date().toISOString(), ...overrides, }; diff --git a/x-pack/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.test.ts b/x-pack/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.test.ts index 27c758ca43a8b..ebe8a34580f76 100644 --- a/x-pack/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.test.ts +++ b/x-pack/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.test.ts @@ -15,8 +15,8 @@ import { } from '../../routes/metadata/support/test_support'; import { EndpointDocGenerator } from '../../../../common/endpoint/generate_data'; import { - getESQueryHostMetadataByFleetAgentIds, buildUnitedIndexQuery, + getESQueryHostMetadataByFleetAgentIds, } from '../../routes/metadata/query_builders'; import type { HostMetadata } from '../../../../common/endpoint/types'; import type { Agent, PackagePolicy } from '@kbn/fleet-plugin/common'; @@ -137,11 +137,14 @@ describe('EndpointMetadataService', () => { package_policies: packagePolicies, }), ]; + + const newDate = new Date(); const agentPolicyIds = agentPolicies.map((policy) => policy.id); - const endpointMetadataDoc = endpointDocGenerator.generateHostMetadata(); + const endpointMetadataDoc = endpointDocGenerator.generateHostMetadata(newDate.getTime()); const mockAgent = { policy_id: agentPolicies[0].id, policy_revision: agentPolicies[0].revision, + last_checkin: newDate.toISOString(), } as unknown as Agent; const mockDoc = unitedMetadataSearchResponseMock(endpointMetadataDoc, mockAgent); esClient.search.mockResponse(mockDoc); @@ -203,6 +206,7 @@ describe('EndpointMetadataService', () => { revision: packagePolicies[0].revision, }, }, + last_checkin: newDate.toISOString(), }, ], total: 1, diff --git a/x-pack/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.ts b/x-pack/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.ts index 98f42c1a4d8ce..d6247ad1b572b 100644 --- a/x-pack/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.ts +++ b/x-pack/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.ts @@ -12,7 +12,7 @@ import type { SavedObjectsServiceStart, } from '@kbn/core/server'; -import type { SearchTotalHits, SearchResponse } from '@elastic/elasticsearch/lib/api/types'; +import type { SearchResponse, SearchTotalHits } from '@elastic/elasticsearch/lib/api/types'; import type { Agent, AgentPolicy, AgentStatus, PackagePolicy } from '@kbn/fleet-plugin/common'; import type { AgentPolicyServiceInterface, PackagePolicyClient } from '@kbn/fleet-plugin/server'; import { AgentNotFoundError } from '@kbn/fleet-plugin/server'; @@ -32,9 +32,9 @@ import { FleetEndpointPackagePolicyNotFoundError, } from './errors'; import { + buildUnitedIndexQuery, getESQueryHostMetadataByFleetAgentIds, getESQueryHostMetadataByID, - buildUnitedIndexQuery, getESQueryHostMetadataByIDs, } from '../../routes/metadata/query_builders'; import { @@ -176,7 +176,7 @@ export class EndpointMetadataService { } } - // If the agent is not longer active, then that means that the Agent/Endpoint have been un-enrolled from the host + // If the agent is no longer active, then that means that the Agent/Endpoint have been un-enrolled from the host if (fleetAgent && !fleetAgent.active) { throw new EndpointHostUnEnrolledError( `Endpoint with id ${endpointId} (Fleet agent id ${fleetAgentId}) is unenrolled` @@ -251,7 +251,7 @@ export class EndpointMetadataService { } } - // The fleetAgentPolicy might have the endpoint policy in the `package_policies`, lets check that first + // The fleetAgentPolicy might have the endpoint policy in the `package_policies`, let's check that first if ( !endpointPackagePolicy && fleetAgentPolicy && @@ -262,7 +262,7 @@ export class EndpointMetadataService { ); } - // if we still don't have an endpoint package policy, try retrieving it from fleet + // if we still don't have an endpoint package policy, try retrieving it from `fleet` if (!endpointPackagePolicy) { try { endpointPackagePolicy = await this.getFleetEndpointPackagePolicy( @@ -294,6 +294,8 @@ export class EndpointMetadataService { id: endpointPackagePolicy?.id ?? '', }, }, + last_checkin: + _fleetAgent?.last_checkin || new Date(endpointMetadata['@timestamp']).toISOString(), }; } @@ -363,6 +365,8 @@ export class EndpointMetadataService { * * @param esClient * @param queryOptions + * @param soClient + * @param fleetServices * * @throws */ diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/fleet_integrations/api/get_installed_integrations/installed_integration_set.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/fleet_integrations/api/get_installed_integrations/installed_integration_set.ts index 92483f2335dee..ec3cf038389a3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/fleet_integrations/api/get_installed_integrations/installed_integration_set.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/fleet_integrations/api/get_installed_integrations/installed_integration_set.ts @@ -14,7 +14,7 @@ import type { InstalledPackage, InstalledPackageArray, InstalledPackageBasicInfo, -} from '../../../../../../common/detection_engine/fleet_integrations'; +} from '../../../../../../common/api/detection_engine/fleet_integrations'; export interface IInstalledIntegrationSet { addPackage(fleetPackage: PackageListItem): void; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/fleet_integrations/api/get_installed_integrations/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/fleet_integrations/api/get_installed_integrations/route.ts index 559abe391f5a1..e4e4e2f4a6f78 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/fleet_integrations/api/get_installed_integrations/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/fleet_integrations/api/get_installed_integrations/route.ts @@ -10,8 +10,8 @@ import { transformError } from '@kbn/securitysolution-es-utils'; import { buildSiemResponse } from '../../../routes/utils'; import type { SecuritySolutionPluginRouter } from '../../../../../types'; -import type { GetInstalledIntegrationsResponse } from '../../../../../../common/detection_engine/fleet_integrations'; -import { GET_INSTALLED_INTEGRATIONS_URL } from '../../../../../../common/detection_engine/fleet_integrations'; +import type { GetInstalledIntegrationsResponse } from '../../../../../../common/api/detection_engine/fleet_integrations'; +import { GET_INSTALLED_INTEGRATIONS_URL } from '../../../../../../common/api/detection_engine/fleet_integrations'; import { createInstalledIntegrationSet } from './installed_integration_set'; /** diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/migrations/create_migration.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/migrations/create_migration.ts index 992bad6432cb4..da49cda43507a 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/migrations/create_migration.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/migrations/create_migration.ts @@ -6,7 +6,7 @@ */ import type { ElasticsearchClient } from '@kbn/core/server'; -import type { SignalsReindexOptions } from '../../../../common/detection_engine/schemas/request/create_signals_migration_schema'; +import type { SignalsReindexOptions } from '../../../../common/api/detection_engine/signals_migration'; import { createMigrationIndex } from './create_migration_index'; export interface CreatedMigration { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/migrations/migration_service.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/migrations/migration_service.ts index e3d30bfb17c6c..e0c82f70549fd 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/migrations/migration_service.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/migrations/migration_service.ts @@ -6,7 +6,7 @@ */ import type { ElasticsearchClient, SavedObjectsClientContract } from '@kbn/core/server'; -import type { SignalsReindexOptions } from '../../../../common/detection_engine/schemas/request/create_signals_migration_schema'; +import type { SignalsReindexOptions } from '../../../../common/api/detection_engine/signals_migration'; import type { SignalsMigrationSO } from './saved_objects_schema'; import { createMigrationSavedObject } from './create_migration_saved_object'; import { createMigration } from './create_migration'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/generate_assets/generate_assets_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/generate_assets/generate_assets_route.ts index 1157fe9d3b9ef..3bbf983c5c0f9 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/generate_assets/generate_assets_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/generate_assets/generate_assets_route.ts @@ -10,7 +10,7 @@ import moment from 'moment'; import { transformError } from '@kbn/securitysolution-es-utils'; import { PositiveIntegerGreaterThanZero } from '@kbn/securitysolution-io-ts-types'; -import { GENERATE_ASSETS_URL } from '../../../../../../common/detection_engine/prebuilt_rules'; +import { GENERATE_ASSETS_URL } from '../../../../../../common/api/detection_engine/prebuilt_rules'; import type { SecuritySolutionPluginRouter } from '../../../../../types'; import { buildRouteValidation } from '../../../../../utils/build_validation/route_validation'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/get_prebuilt_rules_and_timelines_status/get_prebuilt_rules_and_timelines_status_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/get_prebuilt_rules_and_timelines_status/get_prebuilt_rules_and_timelines_status_route.ts index 40b3078fe06eb..290db5ad7d5b2 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/get_prebuilt_rules_and_timelines_status/get_prebuilt_rules_and_timelines_status_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/get_prebuilt_rules_and_timelines_status/get_prebuilt_rules_and_timelines_status_route.ts @@ -14,7 +14,7 @@ import type { SecuritySolutionPluginRouter } from '../../../../../types'; import { PREBUILT_RULES_STATUS_URL, GetPrebuiltRulesAndTimelinesStatusResponse, -} from '../../../../../../common/detection_engine/prebuilt_rules'; +} from '../../../../../../common/api/detection_engine/prebuilt_rules'; import { getExistingPrepackagedRules } from '../../../rule_management/logic/search/get_existing_prepackaged_rules'; import { findRules } from '../../../rule_management/logic/search/find_rules'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/get_prebuilt_rules_status/get_prebuilt_rules_status_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/get_prebuilt_rules_status/get_prebuilt_rules_status_route.ts index 92180b723703f..159591e273a37 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/get_prebuilt_rules_status/get_prebuilt_rules_status_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/get_prebuilt_rules_status/get_prebuilt_rules_status_route.ts @@ -6,8 +6,8 @@ */ import { transformError } from '@kbn/securitysolution-es-utils'; -import { GET_PREBUILT_RULES_STATUS_URL } from '../../../../../../common/detection_engine/prebuilt_rules'; -import type { GetPrebuiltRulesStatusResponseBody } from '../../../../../../common/detection_engine/prebuilt_rules/api/get_prebuilt_rules_status/response_schema'; +import { GET_PREBUILT_RULES_STATUS_URL } from '../../../../../../common/api/detection_engine/prebuilt_rules'; +import type { GetPrebuiltRulesStatusResponseBody } from '../../../../../../common/api/detection_engine/prebuilt_rules'; import type { SecuritySolutionPluginRouter } from '../../../../../types'; import { buildSiemResponse } from '../../../routes/utils'; import { createPrebuiltRuleAssetsClient } from '../../logic/rule_assets/prebuilt_rule_assets_client'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/install_prebuilt_rules_and_timelines/install_prebuilt_rules_and_timelines_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/install_prebuilt_rules_and_timelines/install_prebuilt_rules_and_timelines_route.ts index 48191679396dc..711565e5e793d 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/install_prebuilt_rules_and_timelines/install_prebuilt_rules_and_timelines_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/install_prebuilt_rules_and_timelines/install_prebuilt_rules_and_timelines_route.ts @@ -13,7 +13,7 @@ import moment from 'moment'; import { InstallPrebuiltRulesAndTimelinesResponse, PREBUILT_RULES_URL, -} from '../../../../../../common/detection_engine/prebuilt_rules'; +} from '../../../../../../common/api/detection_engine/prebuilt_rules'; import type { SecuritySolutionApiRequestHandlerContext, SecuritySolutionPluginRouter, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/perform_rule_installation/perform_rule_installation_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/perform_rule_installation/perform_rule_installation_route.ts index ba7ca335402e7..b87db8619a99c 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/perform_rule_installation/perform_rule_installation_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/perform_rule_installation/perform_rule_installation_route.ts @@ -6,13 +6,15 @@ */ import { transformError } from '@kbn/securitysolution-es-utils'; -import { PERFORM_RULE_INSTALLATION_URL } from '../../../../../../common/detection_engine/prebuilt_rules'; -import { PerformRuleInstallationRequestBody } from '../../../../../../common/detection_engine/prebuilt_rules/api/perform_rule_installation/perform_rule_installation_request_schema'; +import { + PERFORM_RULE_INSTALLATION_URL, + PerformRuleInstallationRequestBody, + SkipRuleInstallReason, +} from '../../../../../../common/api/detection_engine/prebuilt_rules'; import type { PerformRuleInstallationResponseBody, SkippedRuleInstall, -} from '../../../../../../common/detection_engine/prebuilt_rules/api/perform_rule_installation/perform_rule_installation_response_schema'; -import { SkipRuleInstallReason } from '../../../../../../common/detection_engine/prebuilt_rules/api/perform_rule_installation/perform_rule_installation_response_schema'; +} from '../../../../../../common/api/detection_engine/prebuilt_rules'; import type { SecuritySolutionPluginRouter } from '../../../../../types'; import { buildRouteValidation } from '../../../../../utils/build_validation/route_validation'; import type { PromisePoolError } from '../../../../../utils/promise_pool'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/perform_rule_upgrade/perform_rule_upgrade_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/perform_rule_upgrade/perform_rule_upgrade_route.ts index 47f90cf5fb427..d722d58244d06 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/perform_rule_upgrade/perform_rule_upgrade_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/perform_rule_upgrade/perform_rule_upgrade_route.ts @@ -6,16 +6,16 @@ */ import { transformError } from '@kbn/securitysolution-es-utils'; -import { PERFORM_RULE_UPGRADE_URL } from '../../../../../../common/detection_engine/prebuilt_rules'; import { + PERFORM_RULE_UPGRADE_URL, + SkipRuleUpgradeReason, PerformRuleUpgradeRequestBody, PickVersionValues, -} from '../../../../../../common/detection_engine/prebuilt_rules/api/perform_rule_upgrade/perform_rule_upgrade_request_schema'; +} from '../../../../../../common/api/detection_engine/prebuilt_rules'; import type { PerformRuleUpgradeResponseBody, SkippedRuleUpgrade, -} from '../../../../../../common/detection_engine/prebuilt_rules/api/perform_rule_upgrade/perform_rule_upgrade_response_schema'; -import { SkipRuleUpgradeReason } from '../../../../../../common/detection_engine/prebuilt_rules/api/perform_rule_upgrade/perform_rule_upgrade_response_schema'; +} from '../../../../../../common/api/detection_engine/prebuilt_rules'; import { assertUnreachable } from '../../../../../../common/utility_types'; import type { SecuritySolutionPluginRouter } from '../../../../../types'; import { buildRouteValidation } from '../../../../../utils/build_validation/route_validation'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/review_rule_installation/review_rule_installation_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/review_rule_installation/review_rule_installation_route.ts index b76f5c6f00391..701724389d200 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/review_rule_installation/review_rule_installation_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/review_rule_installation/review_rule_installation_route.ts @@ -6,12 +6,12 @@ */ import { transformError } from '@kbn/securitysolution-es-utils'; -import { REVIEW_RULE_INSTALLATION_URL } from '../../../../../../common/detection_engine/prebuilt_rules'; +import { REVIEW_RULE_INSTALLATION_URL } from '../../../../../../common/api/detection_engine/prebuilt_rules'; import type { ReviewRuleInstallationResponseBody, RuleInstallationInfoForReview, RuleInstallationStatsForReview, -} from '../../../../../../common/detection_engine/prebuilt_rules/api/review_rule_installation/response_schema'; +} from '../../../../../../common/api/detection_engine/prebuilt_rules'; import type { SecuritySolutionPluginRouter } from '../../../../../types'; import { buildSiemResponse } from '../../../routes/utils'; import { convertRuleToDiffable } from '../../logic/diff/normalization/convert_rule_to_diffable'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/review_rule_upgrade/review_rule_upgrade_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/review_rule_upgrade/review_rule_upgrade_route.ts index 65d912cb1ac46..f5e332ad86aad 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/review_rule_upgrade/review_rule_upgrade_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/review_rule_upgrade/review_rule_upgrade_route.ts @@ -7,13 +7,13 @@ import { transformError } from '@kbn/securitysolution-es-utils'; import { pickBy } from 'lodash'; -import { REVIEW_RULE_UPGRADE_URL } from '../../../../../../common/detection_engine/prebuilt_rules'; +import { REVIEW_RULE_UPGRADE_URL } from '../../../../../../common/api/detection_engine/prebuilt_rules'; import type { ReviewRuleUpgradeResponseBody, RuleUpgradeInfoForReview, RuleUpgradeStatsForReview, -} from '../../../../../../common/detection_engine/prebuilt_rules/api/review_rule_upgrade/response_schema'; -import type { ThreeWayDiff } from '../../../../../../common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff'; + ThreeWayDiff, +} from '../../../../../../common/api/detection_engine/prebuilt_rules'; import { invariant } from '../../../../../../common/utils/invariant'; import type { SecuritySolutionPluginRouter } from '../../../../../types'; import { buildSiemResponse } from '../../../routes/utils'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/aggregate_prebuilt_rule_errors.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/aggregate_prebuilt_rule_errors.ts index 802b0c302141d..d76f145723132 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/aggregate_prebuilt_rule_errors.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/aggregate_prebuilt_rule_errors.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { AggregatedPrebuiltRuleError } from '../../../../../common/detection_engine/prebuilt_rules/model/prebuilt_rules/aggregated_prebuilt_rules_error'; +import type { AggregatedPrebuiltRuleError } from '../../../../../common/api/detection_engine/prebuilt_rules'; import { getErrorMessage, getErrorStatusCode } from '../../../../utils/error_helpers'; import type { PromisePoolError } from '../../../../utils/promise_pool'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculate_rule_diff.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculate_rule_diff.ts index fb0551c280aff..337a510c3b4b2 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculate_rule_diff.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculate_rule_diff.ts @@ -5,11 +5,13 @@ * 2.0. */ -import type { DiffableRule } from '../../../../../../common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_rule'; -import type { FullRuleDiff } from '../../../../../../common/detection_engine/prebuilt_rules/model/diff/rule_diff/rule_diff'; -import type { ThreeWayDiff } from '../../../../../../common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff'; -import { MissingVersion } from '../../../../../../common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff'; -import type { RuleResponse } from '../../../../../../common/detection_engine/rule_schema'; +import type { + DiffableRule, + FullRuleDiff, + ThreeWayDiff, +} from '../../../../../../common/api/detection_engine/prebuilt_rules'; +import { MissingVersion } from '../../../../../../common/api/detection_engine/prebuilt_rules'; +import type { RuleResponse } from '../../../../../../common/api/detection_engine/model/rule_schema'; import { invariant } from '../../../../../../common/utils/invariant'; import type { PrebuiltRuleAsset } from '../../model/rule_assets/prebuilt_rule_asset'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculation/algorithms/simple_diff_algorithm.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculation/algorithms/simple_diff_algorithm.ts index 90a55ee3d6eff..f598e9da451c6 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculation/algorithms/simple_diff_algorithm.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculation/algorithms/simple_diff_algorithm.ts @@ -9,13 +9,13 @@ import { assertUnreachable } from '../../../../../../../../common/utility_types' import type { ThreeVersionsOf, ThreeWayDiff, -} from '../../../../../../../../common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff'; +} from '../../../../../../../../common/api/detection_engine/prebuilt_rules'; import { determineDiffOutcome, determineIfValueCanUpdate, ThreeWayDiffOutcome, -} from '../../../../../../../../common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff_outcome'; -import { ThreeWayMergeOutcome } from '../../../../../../../../common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_merge_outcome'; + ThreeWayMergeOutcome, +} from '../../../../../../../../common/api/detection_engine/prebuilt_rules'; export const simpleDiffAlgorithm = ( versions: ThreeVersionsOf diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculation/calculate_rule_fields_diff.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculation/calculate_rule_fields_diff.ts index abd084c1789e4..dd46ae93a5af7 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculation/calculate_rule_fields_diff.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculation/calculate_rule_fields_diff.ts @@ -9,6 +9,8 @@ import { assertUnreachable } from '../../../../../../../common/utility_types'; import { invariant } from '../../../../../../../common/utils/invariant'; import type { + AllFieldsDiff, + DiffableAllFields, DiffableCommonFields, DiffableCustomQueryFields, DiffableEqlFields, @@ -18,8 +20,6 @@ import type { DiffableSavedQueryFields, DiffableThreatMatchFields, DiffableThresholdFields, -} from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_rule'; -import type { CommonFieldsDiff, CustomQueryFieldsDiff, EqlFieldsDiff, @@ -29,11 +29,11 @@ import type { SavedQueryFieldsDiff, ThreatMatchFieldsDiff, ThresholdFieldsDiff, -} from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/rule_diff/rule_diff'; +} from '../../../../../../../common/api/detection_engine/prebuilt_rules'; -import type { FieldsDiffAlgorithmsFor } from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/rule_diff/fields_diff'; -import type { ThreeVersionsOf } from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff'; -import { MissingVersion } from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff'; +import type { FieldsDiffAlgorithmsFor } from '../../../../../../../common/api/detection_engine/prebuilt_rules/model/diff/rule_diff/fields_diff'; +import type { ThreeVersionsOf } from '../../../../../../../common/api/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff'; +import { MissingVersion } from '../../../../../../../common/api/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff'; import { calculateFieldsDiffFor } from './diff_calculation_helpers'; import { simpleDiffAlgorithm } from './algorithms/simple_diff_algorithm'; @@ -53,6 +53,24 @@ export const calculateRuleFieldsDiff = ( const { base_version, current_version, target_version } = ruleVersions; const hasBaseVersion = base_version !== MissingVersion; + const isRuleTypeDifferentInTargetVersion = current_version.type !== target_version.type; + const isRuleTypeDifferentInBaseVersion = hasBaseVersion + ? current_version.type !== base_version.type + : false; + + if (isRuleTypeDifferentInTargetVersion || isRuleTypeDifferentInBaseVersion) { + // If rule type has been changed by Elastic in the target version (can happen) + // or by user in the current version (should never happen), we can't calculate the diff + // only for fields of a single rule type, and need to calculate it for all fields + // of all the rule types we have. + // TODO: Try to get rid of "as" casting + return calculateAllFieldsDiff({ + base_version: base_version as DiffableAllFields | MissingVersion, + current_version: current_version as DiffableAllFields, + target_version: target_version as DiffableAllFields, + }) as RuleFieldsDiff; + } + switch (current_version.type) { case 'query': { if (hasBaseVersion) { @@ -175,7 +193,7 @@ const calculateCustomQueryFieldsDiff = ( const customQueryFieldsDiffAlgorithms: FieldsDiffAlgorithmsFor = { type: simpleDiffAlgorithm, - data_query: simpleDiffAlgorithm, + kql_query: simpleDiffAlgorithm, data_source: simpleDiffAlgorithm, alert_suppression: simpleDiffAlgorithm, }; @@ -188,7 +206,7 @@ const calculateSavedQueryFieldsDiff = ( const savedQueryFieldsDiffAlgorithms: FieldsDiffAlgorithmsFor = { type: simpleDiffAlgorithm, - data_query: simpleDiffAlgorithm, + kql_query: simpleDiffAlgorithm, data_source: simpleDiffAlgorithm, alert_suppression: simpleDiffAlgorithm, }; @@ -201,7 +219,7 @@ const calculateEqlFieldsDiff = ( const eqlFieldsDiffAlgorithms: FieldsDiffAlgorithmsFor = { type: simpleDiffAlgorithm, - data_query: simpleDiffAlgorithm, + eql_query: simpleDiffAlgorithm, data_source: simpleDiffAlgorithm, event_category_override: simpleDiffAlgorithm, timestamp_field: simpleDiffAlgorithm, @@ -216,7 +234,7 @@ const calculateThreatMatchFieldsDiff = ( const threatMatchFieldsDiffAlgorithms: FieldsDiffAlgorithmsFor = { type: simpleDiffAlgorithm, - data_query: simpleDiffAlgorithm, + kql_query: simpleDiffAlgorithm, data_source: simpleDiffAlgorithm, threat_query: simpleDiffAlgorithm, threat_index: simpleDiffAlgorithm, @@ -234,7 +252,7 @@ const calculateThresholdFieldsDiff = ( const thresholdFieldsDiffAlgorithms: FieldsDiffAlgorithmsFor = { type: simpleDiffAlgorithm, - data_query: simpleDiffAlgorithm, + kql_query: simpleDiffAlgorithm, data_source: simpleDiffAlgorithm, threshold: simpleDiffAlgorithm, }; @@ -260,8 +278,26 @@ const calculateNewTermsFieldsDiff = ( const newTermsFieldsDiffAlgorithms: FieldsDiffAlgorithmsFor = { type: simpleDiffAlgorithm, - data_query: simpleDiffAlgorithm, + kql_query: simpleDiffAlgorithm, data_source: simpleDiffAlgorithm, new_terms_fields: simpleDiffAlgorithm, history_window_start: simpleDiffAlgorithm, }; + +const calculateAllFieldsDiff = ( + ruleVersions: ThreeVersionsOf +): AllFieldsDiff => { + return calculateFieldsDiffFor(ruleVersions, allFieldsDiffAlgorithms); +}; + +const allFieldsDiffAlgorithms: FieldsDiffAlgorithmsFor = { + ...commonFieldsDiffAlgorithms, + ...customQueryFieldsDiffAlgorithms, + ...savedQueryFieldsDiffAlgorithms, + ...eqlFieldsDiffAlgorithms, + ...threatMatchFieldsDiffAlgorithms, + ...thresholdFieldsDiffAlgorithms, + ...machineLearningFieldsDiffAlgorithms, + ...newTermsFieldsDiffAlgorithms, + type: simpleDiffAlgorithm, +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculation/diff_calculation_helpers.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculation/diff_calculation_helpers.ts index d36c33cf5d890..eba89041260ce 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculation/diff_calculation_helpers.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/calculation/diff_calculation_helpers.ts @@ -9,9 +9,9 @@ import { mapValues } from 'lodash'; import type { FieldsDiff, FieldsDiffAlgorithmsFor, -} from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/rule_diff/fields_diff'; -import type { ThreeVersionsOf } from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff'; -import { MissingVersion } from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff'; + ThreeVersionsOf, +} from '../../../../../../../common/api/detection_engine/prebuilt_rules'; +import { MissingVersion } from '../../../../../../../common/api/detection_engine/prebuilt_rules'; export const calculateFieldsDiffFor = ( ruleVersions: ThreeVersionsOf, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/convert_rule_to_diffable.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/convert_rule_to_diffable.ts index f917b7154a163..7cc2b5bc43679 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/convert_rule_to_diffable.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/convert_rule_to_diffable.ts @@ -23,7 +23,7 @@ import type { ThreatMatchRuleCreateProps, ThresholdRule, ThresholdRuleCreateProps, -} from '../../../../../../../common/detection_engine/rule_schema'; +} from '../../../../../../../common/api/detection_engine/model/rule_schema'; import type { PrebuiltRuleAsset } from '../../../model/rule_assets/prebuilt_rule_asset'; import type { DiffableCommonFields, @@ -35,7 +35,7 @@ import type { DiffableSavedQueryFields, DiffableThreatMatchFields, DiffableThresholdFields, -} from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_rule'; +} from '../../../../../../../common/api/detection_engine/prebuilt_rules'; import { extractBuildingBlockObject } from './extract_building_block_object'; import { extractInlineKqlQuery, @@ -146,7 +146,7 @@ const extractDiffableCustomQueryFields = ( ): DiffableCustomQueryFields => { return { type: rule.type, - data_query: extractRuleKqlQuery(rule.query, rule.language, rule.filters, rule.saved_id), + kql_query: extractRuleKqlQuery(rule.query, rule.language, rule.filters, rule.saved_id), data_source: extractRuleDataSource(rule.index, rule.data_view_id), alert_suppression: rule.alert_suppression, }; @@ -157,7 +157,7 @@ const extractDiffableSavedQueryFieldsFromRuleObject = ( ): DiffableSavedQueryFields => { return { type: rule.type, - data_query: extractRuleKqlQuery(rule.query, rule.language, rule.filters, rule.saved_id), + kql_query: extractRuleKqlQuery(rule.query, rule.language, rule.filters, rule.saved_id), data_source: extractRuleDataSource(rule.index, rule.data_view_id), alert_suppression: rule.alert_suppression, }; @@ -168,7 +168,7 @@ const extractDiffableEqlFieldsFromRuleObject = ( ): DiffableEqlFields => { return { type: rule.type, - data_query: extractRuleEqlQuery(rule.query, rule.language, rule.filters), + eql_query: extractRuleEqlQuery(rule.query, rule.language, rule.filters), data_source: extractRuleDataSource(rule.index, rule.data_view_id), event_category_override: rule.event_category_override, timestamp_field: rule.timestamp_field, @@ -181,7 +181,7 @@ const extractDiffableThreatMatchFieldsFromRuleObject = ( ): DiffableThreatMatchFields => { return { type: rule.type, - data_query: extractRuleKqlQuery(rule.query, rule.language, rule.filters, rule.saved_id), + kql_query: extractRuleKqlQuery(rule.query, rule.language, rule.filters, rule.saved_id), data_source: extractRuleDataSource(rule.index, rule.data_view_id), threat_query: extractInlineKqlQuery( rule.threat_query, @@ -201,7 +201,7 @@ const extractDiffableThresholdFieldsFromRuleObject = ( ): DiffableThresholdFields => { return { type: rule.type, - data_query: extractRuleKqlQuery(rule.query, rule.language, rule.filters, rule.saved_id), + kql_query: extractRuleKqlQuery(rule.query, rule.language, rule.filters, rule.saved_id), data_source: extractRuleDataSource(rule.index, rule.data_view_id), threshold: rule.threshold, }; @@ -222,7 +222,7 @@ const extractDiffableNewTermsFieldsFromRuleObject = ( ): DiffableNewTermsFields => { return { type: rule.type, - data_query: extractInlineKqlQuery(rule.query, rule.language, rule.filters), + kql_query: extractInlineKqlQuery(rule.query, rule.language, rule.filters), data_source: extractRuleDataSource(rule.index, rule.data_view_id), new_terms_fields: rule.new_terms_fields, history_window_start: rule.history_window_start, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_building_block_object.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_building_block_object.ts index fda8efafea6b5..4f986464b12f7 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_building_block_object.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_building_block_object.ts @@ -5,8 +5,8 @@ * 2.0. */ -import type { RuleResponse } from '../../../../../../../common/detection_engine/rule_schema'; -import type { BuildingBlockObject } from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types'; +import type { RuleResponse } from '../../../../../../../common/api/detection_engine/model/rule_schema'; +import type { BuildingBlockObject } from '../../../../../../../common/api/detection_engine/prebuilt_rules'; import type { PrebuiltRuleAsset } from '../../../model/rule_assets/prebuilt_rule_asset'; export const extractBuildingBlockObject = ( diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_data_query.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_data_query.ts index 3672dddca4e64..4e34617aaf8b7 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_data_query.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_data_query.ts @@ -10,13 +10,13 @@ import type { KqlQueryLanguage, RuleFilterArray, RuleQuery, -} from '../../../../../../../common/detection_engine/rule_schema'; +} from '../../../../../../../common/api/detection_engine/model/rule_schema'; import type { InlineKqlQuery, RuleEqlQuery, RuleKqlQuery, -} from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types'; -import { KqlQueryType } from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types'; +} from '../../../../../../../common/api/detection_engine/prebuilt_rules'; +import { KqlQueryType } from '../../../../../../../common/api/detection_engine/prebuilt_rules'; export const extractRuleKqlQuery = ( query: RuleQuery | undefined, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_data_source.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_data_source.ts index 3391407e856dc..5ab1562869d26 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_data_source.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_data_source.ts @@ -8,9 +8,9 @@ import type { DataViewId, IndexPatternArray, -} from '../../../../../../../common/detection_engine/rule_schema'; -import type { RuleDataSource } from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types'; -import { DataSourceType } from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types'; +} from '../../../../../../../common/api/detection_engine/model/rule_schema'; +import type { RuleDataSource } from '../../../../../../../common/api/detection_engine/prebuilt_rules'; +import { DataSourceType } from '../../../../../../../common/api/detection_engine/prebuilt_rules'; export const extractRuleDataSource = ( indexPatterns: IndexPatternArray | undefined, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_name_override_object.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_name_override_object.ts index e1e95c12cc9c0..ab7e7fd3c4716 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_name_override_object.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_name_override_object.ts @@ -5,8 +5,8 @@ * 2.0. */ -import type { RuleResponse } from '../../../../../../../common/detection_engine/rule_schema'; -import type { RuleNameOverrideObject } from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types'; +import type { RuleResponse } from '../../../../../../../common/api/detection_engine/model/rule_schema'; +import type { RuleNameOverrideObject } from '../../../../../../../common/api/detection_engine/prebuilt_rules'; import type { PrebuiltRuleAsset } from '../../../model/rule_assets/prebuilt_rule_asset'; export const extractRuleNameOverrideObject = ( diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_schedule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_schedule.ts index 21d81d218680c..28880523c774c 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_schedule.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_rule_schedule.ts @@ -9,8 +9,8 @@ import moment from 'moment'; import dateMath from '@elastic/datemath'; import { parseDuration } from '@kbn/alerting-plugin/common'; -import type { RuleResponse } from '../../../../../../../common/detection_engine/rule_schema'; -import type { RuleSchedule } from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types'; +import type { RuleResponse } from '../../../../../../../common/api/detection_engine/model/rule_schema'; +import type { RuleSchedule } from '../../../../../../../common/api/detection_engine/prebuilt_rules'; import type { PrebuiltRuleAsset } from '../../../model/rule_assets/prebuilt_rule_asset'; export const extractRuleSchedule = (rule: RuleResponse | PrebuiltRuleAsset): RuleSchedule => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_timeline_template_reference.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_timeline_template_reference.ts index f213f8a5a2189..03244e5bb0adf 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_timeline_template_reference.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_timeline_template_reference.ts @@ -5,8 +5,8 @@ * 2.0. */ -import type { RuleResponse } from '../../../../../../../common/detection_engine/rule_schema'; -import type { TimelineTemplateReference } from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types'; +import type { RuleResponse } from '../../../../../../../common/api/detection_engine/model/rule_schema'; +import type { TimelineTemplateReference } from '../../../../../../../common/api/detection_engine/prebuilt_rules'; import type { PrebuiltRuleAsset } from '../../../model/rule_assets/prebuilt_rule_asset'; export const extractTimelineTemplateReference = ( diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_timestamp_override_object.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_timestamp_override_object.ts index b311557b7d260..5b67e4c46bfaf 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_timestamp_override_object.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/diff/normalization/extract_timestamp_override_object.ts @@ -5,8 +5,8 @@ * 2.0. */ -import type { RuleResponse } from '../../../../../../../common/detection_engine/rule_schema'; -import type { TimestampOverrideObject } from '../../../../../../../common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types'; +import type { RuleResponse } from '../../../../../../../common/api/detection_engine/model/rule_schema'; +import type { TimestampOverrideObject } from '../../../../../../../common/api/detection_engine/prebuilt_rules'; import type { PrebuiltRuleAsset } from '../../../model/rule_assets/prebuilt_rule_asset'; export const extractTimestampOverrideObject = ( diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/perform_timelines_installation.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/perform_timelines_installation.ts index fb61f86972dbb..101883e8ccd9b 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/perform_timelines_installation.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/perform_timelines_installation.ts @@ -6,7 +6,7 @@ */ import { validate } from '@kbn/securitysolution-io-ts-utils'; -import { importTimelineResultSchema } from '../../../../../common/types/timeline/api'; +import { importTimelineResultSchema } from '../../../../../common/api/timeline'; import type { SecuritySolutionApiRequestHandlerContext } from '../../../../types'; import { installPrepackagedTimelines } from '../../../timeline/routes/prepackaged_timelines/install_prepackaged_timelines'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_objects/prebuilt_rule_objects_client.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_objects/prebuilt_rule_objects_client.ts index c22995f2d12f1..7ad4df3cddabd 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_objects/prebuilt_rule_objects_client.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_objects/prebuilt_rule_objects_client.ts @@ -9,7 +9,7 @@ import type { RulesClient } from '@kbn/alerting-plugin/server'; import type { RuleResponse, RuleSignatureId, -} from '../../../../../../common/detection_engine/rule_schema'; +} from '../../../../../../common/api/detection_engine/model/rule_schema'; import { withSecuritySpan } from '../../../../../utils/with_security_span'; import { findRules } from '../../../rule_management/logic/search/find_rules'; import { getExistingPrepackagedRules } from '../../../rule_management/logic/search/get_existing_prepackaged_rules'; 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 3b21254b3d0dd..a06b5dc17825f 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 @@ -71,6 +71,7 @@ const upgradeRule = async ( return createRules({ rulesClient, + immutable: true, params: { ...rule, // Force the prepackaged rule to use the enabled state from the existing rule, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_versions/zip_rule_versions.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_versions/zip_rule_versions.ts index dbfe798c2405b..b004d98c9dc0b 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_versions/zip_rule_versions.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/logic/rule_versions/zip_rule_versions.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { RuleResponse } from '../../../../../../common/detection_engine/rule_schema'; +import type { RuleResponse } from '../../../../../../common/api/detection_engine/model/rule_schema'; import type { PrebuiltRuleAsset } from '../../model/rule_assets/prebuilt_rule_asset'; import type { RuleVersions } from '../diff/calculate_rule_diff'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/model/rule_assets/prebuilt_rule_asset.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/model/rule_assets/prebuilt_rule_asset.ts index d1e6029678073..40666a39af4b9 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/model/rule_assets/prebuilt_rule_asset.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/model/rule_assets/prebuilt_rule_asset.ts @@ -14,7 +14,7 @@ import { RuleVersion, BaseCreateProps, TypeSpecificCreateProps, -} from '../../../../../../common/detection_engine/rule_schema'; +} from '../../../../../../common/api/detection_engine/model/rule_schema'; /** * Asset containing source content of a prebuilt Security detection rule. diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/model/rule_versions/get_version_buckets.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/model/rule_versions/get_version_buckets.ts index 754d0ec4330e2..0c541c0ae00ff 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/model/rule_versions/get_version_buckets.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/model/rule_versions/get_version_buckets.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { RuleResponse } from '../../../../../../common/detection_engine/rule_schema'; +import type { RuleResponse } from '../../../../../../common/api/detection_engine/model/rule_schema'; import type { RuleVersions } from '../../logic/diff/calculate_rule_diff'; import type { PrebuiltRuleAsset } from '../rule_assets/prebuilt_rule_asset'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/model/rule_versions/rule_version_specifier.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/model/rule_versions/rule_version_specifier.ts index d54d6239cba03..890bc025e29e0 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/model/rule_versions/rule_version_specifier.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/model/rule_versions/rule_version_specifier.ts @@ -8,7 +8,7 @@ import type { RuleSignatureId, RuleVersion, -} from '../../../../../../common/detection_engine/rule_schema'; +} from '../../../../../../common/api/detection_engine/model/rule_schema'; export interface RuleVersionSpecifier { rule_id: RuleSignatureId; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts index c53017acf0a53..78d8eecc109f3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts @@ -24,22 +24,26 @@ import { DETECTION_ENGINE_RULES_BULK_CREATE, DETECTION_ENGINE_RULES_URL_FIND, } from '../../../../../common/constants'; -import { RULE_MANAGEMENT_FILTERS_URL } from '../../../../../common/detection_engine/rule_management/api/urls'; +import { RULE_MANAGEMENT_FILTERS_URL } from '../../../../../common/api/detection_engine/rule_management/urls'; import { PREBUILT_RULES_STATUS_URL, PREBUILT_RULES_URL, -} from '../../../../../common/detection_engine/prebuilt_rules'; +} from '../../../../../common/api/detection_engine/prebuilt_rules'; import { getPerformBulkActionSchemaMock, getPerformBulkActionEditSchemaMock, -} from '../../../../../common/detection_engine/rule_management/mocks'; +} from '../../../../../common/api/detection_engine/rule_management/mocks'; -import { getCreateRulesSchemaMock } from '../../../../../common/detection_engine/rule_schema/mocks'; -import type { QuerySignalsSchemaDecoded } from '../../../../../common/detection_engine/schemas/request/query_signals_index_schema'; -import type { SetSignalsStatusSchemaDecoded } from '../../../../../common/detection_engine/schemas/request/set_signal_status_schema'; -import { getFinalizeSignalsMigrationSchemaMock } from '../../../../../common/detection_engine/schemas/request/finalize_signals_migration_schema.mock'; -import { getSignalsMigrationStatusSchemaMock } from '../../../../../common/detection_engine/schemas/request/get_signals_migration_status_schema.mock'; +import { getCreateRulesSchemaMock } from '../../../../../common/api/detection_engine/model/rule_schema/mocks'; +import type { + QuerySignalsSchemaDecoded, + SetSignalsStatusSchemaDecoded, +} from '../../../../../common/api/detection_engine/signals'; +import { + getFinalizeSignalsMigrationSchemaMock, + getSignalsMigrationStatusSchemaMock, +} from '../../../../../common/api/detection_engine/signals_migration/mocks'; // eslint-disable-next-line no-restricted-imports import type { LegacyRuleNotificationAlertType } from '../../rule_actions_legacy'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/utils.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/utils.ts index 4d30d9add5d5e..7c6d7926f2fa9 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/utils.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/utils.ts @@ -9,7 +9,7 @@ import { Readable } from 'stream'; import { getListArrayMock } from '../../../../../common/detection_engine/schemas/types/lists.mock'; import { getThreatMock } from '../../../../../common/detection_engine/schemas/types/threat.mock'; -import type { RuleResponse } from '../../../../../common/detection_engine/rule_schema'; +import type { RuleResponse } from '../../../../../common/api/detection_engine/model/rule_schema'; import type { HapiReadableStream } from '../../../../types'; /** diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.test.ts index 6b7d28bc63e10..e48cd6ff2dab1 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.test.ts @@ -7,9 +7,9 @@ import { requestMock, serverMock } from '../__mocks__'; import type { SetupPlugins } from '../../../../plugin'; -import type { SignalsReindexOptions } from '../../../../../common/detection_engine/schemas/request/create_signals_migration_schema'; +import type { SignalsReindexOptions } from '../../../../../common/api/detection_engine/signals_migration'; import { DETECTION_ENGINE_SIGNALS_MIGRATION_URL } from '../../../../../common/constants'; -import { getCreateSignalsMigrationSchemaMock } from '../../../../../common/detection_engine/schemas/request/create_signals_migration_schema.mock'; +import { getCreateSignalsMigrationSchemaMock } from '../../../../../common/api/detection_engine/signals_migration/create_signals_migration/create_signals_migration_route.mock'; import { getIndexVersionsByIndex } from '../../migrations/get_index_versions_by_index'; import { getSignalVersionsByIndex } from '../../migrations/get_signal_versions_by_index'; import { createMigration } from '../../migrations/create_migration'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts index 5166aafc1c4a7..25360a12d34b5 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts @@ -9,7 +9,7 @@ import { transformError, BadRequestError, getIndexAliases } from '@kbn/securitys import type { SecuritySolutionPluginRouter } from '../../../../types'; import type { SetupPlugins } from '../../../../plugin'; import { DETECTION_ENGINE_SIGNALS_MIGRATION_URL } from '../../../../../common/constants'; -import { createSignalsMigrationSchema } from '../../../../../common/detection_engine/schemas/request/create_signals_migration_schema'; +import { createSignalsMigrationSchema } from '../../../../../common/api/detection_engine/signals_migration'; import { buildRouteValidation } from '../../../../utils/build_validation/route_validation'; import { buildSiemResponse } from '../utils'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts index f25364820a0f4..da49f0a8ace3a 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts @@ -9,7 +9,7 @@ import { transformError } from '@kbn/securitysolution-es-utils'; import type { SecuritySolutionPluginRouter } from '../../../../types'; import type { SetupPlugins } from '../../../../plugin'; import { DETECTION_ENGINE_SIGNALS_MIGRATION_URL } from '../../../../../common/constants'; -import { deleteSignalsMigrationSchema } from '../../../../../common/detection_engine/schemas/request/delete_signals_migration_schema'; +import { deleteSignalsMigrationSchema } from '../../../../../common/api/detection_engine/signals_migration'; import { buildRouteValidation } from '../../../../utils/build_validation/route_validation'; import { buildSiemResponse } from '../utils'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts index 539dd6af4c9e5..0cdcef4e987d6 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts @@ -10,7 +10,7 @@ import type { RuleDataPluginService } from '@kbn/rule-registry-plugin/server'; import type { SecuritySolutionPluginRouter } from '../../../../types'; import type { SetupPlugins } from '../../../../plugin'; import { DETECTION_ENGINE_SIGNALS_FINALIZE_MIGRATION_URL } from '../../../../../common/constants'; -import { finalizeSignalsMigrationSchema } from '../../../../../common/detection_engine/schemas/request/finalize_signals_migration_schema'; +import { finalizeSignalsMigrationSchema } from '../../../../../common/api/detection_engine/signals_migration'; import { buildRouteValidation } from '../../../../utils/build_validation/route_validation'; import { isMigrationFailed, isMigrationPending } from '../../migrations/helpers'; import { signalsMigrationService } from '../../migrations/migration_service'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/get_signals_migration_status_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/get_signals_migration_status_route.ts index f23bf4ae4185e..7ceecf83268cf 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/get_signals_migration_status_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/get_signals_migration_status_route.ts @@ -8,7 +8,7 @@ import { transformError, getIndexAliases } from '@kbn/securitysolution-es-utils'; import type { SecuritySolutionPluginRouter } from '../../../../types'; import { DETECTION_ENGINE_SIGNALS_MIGRATION_STATUS_URL } from '../../../../../common/constants'; -import { getSignalsMigrationStatusSchema } from '../../../../../common/detection_engine/schemas/request/get_signals_migration_status_schema'; +import { getSignalsMigrationStatusSchema } from '../../../../../common/api/detection_engine/signals_migration'; import { buildRouteValidation } from '../../../../utils/build_validation/route_validation'; import { getIndexVersionsByIndex } from '../../migrations/get_index_versions_by_index'; import { getMigrationSavedObjectsByIndex } from '../../migrations/get_migration_saved_objects_by_index'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/helpers.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/helpers.ts index ffa28ad832620..a557586a008fd 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/helpers.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/helpers.ts @@ -5,14 +5,18 @@ * 2.0. */ -import type { AlertTags } from '../../../../../common/detection_engine/schemas/common'; +import type { AlertTags } from '../../../../../common/api/detection_engine'; import * as i18n from './translations'; -export const validateAlertTagsArrays = (tags: AlertTags) => { +export const validateAlertTagsArrays = (tags: AlertTags, ids: string[]) => { + const validationErrors = []; + if (ids.length === 0) { + validationErrors.push(i18n.NO_IDS_VALIDATION_ERROR); + } const { tags_to_add: tagsToAdd, tags_to_remove: tagsToRemove } = tags; const duplicates = tagsToAdd.filter((tag) => tagsToRemove.includes(tag)); if (duplicates.length) { - return [i18n.ALERT_TAGS_VALIDATION_ERROR(JSON.stringify(duplicates))]; + validationErrors.push(i18n.ALERT_TAGS_VALIDATION_ERROR(JSON.stringify(duplicates))); } - return []; + return validationErrors; }; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals.test.ts index 50c6cc8878723..b4a493d7f1312 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals.test.ts @@ -84,6 +84,53 @@ describe('set signal status', () => { status_code: 500, }); }); + + test('calls "esClient.updateByQuery" with queryId when query is defined', async () => { + await server.inject( + getSetSignalStatusByQueryRequest(), + requestContextMock.convertContext(context) + ); + expect(context.core.elasticsearch.client.asCurrentUser.updateByQuery).toHaveBeenCalledWith( + expect.objectContaining({ + body: expect.objectContaining({ + query: expect.objectContaining({ + bool: { filter: typicalSetStatusSignalByQueryPayload().query }, + }), + }), + }) + ); + }); + + test('calls "esClient.bulk" with signalIds when ids are defined', async () => { + await server.inject( + getSetSignalStatusByIdsRequest(), + requestContextMock.convertContext(context) + ); + expect(context.core.elasticsearch.client.asCurrentUser.bulk).toHaveBeenCalledWith( + expect.objectContaining({ + body: expect.arrayContaining([ + { + update: { + _id: 'somefakeid1', + _index: '.alerts-security.alerts-default', + }, + }, + { + script: expect.anything(), + }, + { + update: { + _id: 'somefakeid2', + _index: '.alerts-security.alerts-default', + }, + }, + { + script: expect.anything(), + }, + ]), + }) + ); + }); }); describe('request validation', () => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts index 9681d22d91198..5ceeddad22514 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts @@ -8,10 +8,12 @@ import { get } from 'lodash'; import { transformError } from '@kbn/securitysolution-es-utils'; import { ALERT_WORKFLOW_STATUS } from '@kbn/rule-data-utils'; -import type { Logger } from '@kbn/core/server'; -import { setSignalStatusValidateTypeDependents } from '../../../../../common/detection_engine/schemas/request/set_signal_status_type_dependents'; -import type { SetSignalsStatusSchemaDecoded } from '../../../../../common/detection_engine/schemas/request/set_signal_status_schema'; -import { setSignalsStatusSchema } from '../../../../../common/detection_engine/schemas/request/set_signal_status_schema'; +import type { ElasticsearchClient, Logger } from '@kbn/core/server'; +import { + setSignalStatusValidateTypeDependents, + setSignalsStatusSchema, +} from '../../../../../common/api/detection_engine/signals'; +import type { SetSignalsStatusSchemaDecoded } from '../../../../../common/api/detection_engine/signals'; import type { SecuritySolutionPluginRouter } from '../../../../types'; import { DEFAULT_ALERTS_INDEX, @@ -87,40 +89,20 @@ export const setSignalsStatusRoute = ( } } - let queryObject; - if (signalIds) { - queryObject = { ids: { values: signalIds } }; - } - if (query) { - queryObject = { - bool: { - filter: query, - }, - }; - } try { - const body = await esClient.updateByQuery({ - index: `${DEFAULT_ALERTS_INDEX}-${spaceId}`, - conflicts: conflicts ?? 'abort', - // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html#_refreshing_shards_2 - // Note: Before we tried to use "refresh: wait_for" but I do not think that was available and instead it defaulted to "refresh: true" - // but the tests do not pass with "refresh: false". If at some point a "refresh: wait_for" is implemented, we should use that instead. - refresh: true, - body: { - script: { - source: `if (ctx._source['${ALERT_WORKFLOW_STATUS}'] != null) { - ctx._source['${ALERT_WORKFLOW_STATUS}'] = '${status}' - } - if (ctx._source.signal != null && ctx._source.signal.status != null) { - ctx._source.signal.status = '${status}' - }`, - lang: 'painless', - }, - query: queryObject, - }, - ignore_unavailable: true, - }); - return response.ok({ body }); + if (signalIds) { + const body = await updateSignalsStatusByIds(status, signalIds, spaceId, esClient); + return response.ok({ body }); + } else { + const body = await updateSignalsStatusByQuery( + status, + query, + { conflicts: conflicts ?? 'abort' }, + spaceId, + esClient + ); + return response.ok({ body }); + } } catch (err) { // error while getting or updating signal with id: id in signal index .siem-signals const error = transformError(err); @@ -132,3 +114,62 @@ export const setSignalsStatusRoute = ( } ); }; + +const updateSignalsStatusByIds = async ( + status: SetSignalsStatusSchemaDecoded['status'], + signalsId: string[], + spaceId: string, + esClient: ElasticsearchClient +) => + esClient.bulk({ + index: `${DEFAULT_ALERTS_INDEX}-${spaceId}`, + refresh: 'wait_for', + body: signalsId.flatMap((signalId) => [ + { + update: { _id: signalId, _index: `${DEFAULT_ALERTS_INDEX}-${spaceId}` }, + }, + { + script: getUpdateSignalStatusScript(status), + }, + ]), + }); + +/** + * Please avoid using `updateSignalsStatusByQuery` when possible, use `updateSignalsStatusByIds` instead. + * + * This method calls `updateByQuery` with `refresh: true` which is expensive on serverless. + */ +const updateSignalsStatusByQuery = async ( + status: SetSignalsStatusSchemaDecoded['status'], + query: object | undefined, + options: { conflicts: 'abort' | 'proceed' }, + spaceId: string, + esClient: ElasticsearchClient +) => + esClient.updateByQuery({ + index: `${DEFAULT_ALERTS_INDEX}-${spaceId}`, + conflicts: options.conflicts, + // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html#_refreshing_shards_2 + // Note: Before we tried to use "refresh: wait_for" but I do not think that was available and instead it defaulted to "refresh: true" + // but the tests do not pass with "refresh: false". If at some point a "refresh: wait_for" is implemented, we should use that instead. + refresh: true, + body: { + script: getUpdateSignalStatusScript(status), + query: { + bool: { + filter: query, + }, + }, + }, + ignore_unavailable: true, + }); + +const getUpdateSignalStatusScript = (status: SetSignalsStatusSchemaDecoded['status']) => ({ + source: `if (ctx._source['${ALERT_WORKFLOW_STATUS}'] != null) { + ctx._source['${ALERT_WORKFLOW_STATUS}'] = '${status}' + } + if (ctx._source.signal != null && ctx._source.signal.status != null) { + ctx._source.signal.status = '${status}' + }`, + lang: 'painless', +}); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/query_signals_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/query_signals_route.ts index 94a8ec8b3b870..922a032ffc78f 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/query_signals_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/query_signals_route.ts @@ -13,8 +13,8 @@ import { DETECTION_ENGINE_QUERY_SIGNALS_URL } from '../../../../../common/consta import { buildSiemResponse } from '../utils'; import { buildRouteValidation } from '../../../../utils/build_validation/route_validation'; -import type { QuerySignalsSchemaDecoded } from '../../../../../common/detection_engine/schemas/request/query_signals_index_schema'; -import { querySignalsSchema } from '../../../../../common/detection_engine/schemas/request/query_signals_index_schema'; +import type { QuerySignalsSchemaDecoded } from '../../../../../common/api/detection_engine/signals'; +import { querySignalsSchema } from '../../../../../common/api/detection_engine/signals'; export const querySignalsRoute = ( router: SecuritySolutionPluginRouter, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/set_alert_tags_route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/set_alert_tags_route.test.ts index b6476cd80e36d..445d81526e85b 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/set_alert_tags_route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/set_alert_tags_route.test.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { getSetAlertTagsRequestMock } from '../../../../../common/detection_engine/schemas/request/set_alert_tags_schema.mock'; +import { getSetAlertTagsRequestMock } from '../../../../../common/api/detection_engine/alert_tags/mocks'; import { DETECTION_ENGINE_ALERT_TAGS_URL } from '../../../../../common/constants'; import { requestContextMock, serverMock, requestMock } from '../__mocks__'; import { getSuccessfulSignalUpdateResponse } from '../__mocks__/request_responses'; @@ -27,12 +27,14 @@ describe('setAlertTagsRoute', () => { request = requestMock.create({ method: 'post', path: DETECTION_ENGINE_ALERT_TAGS_URL, - body: getSetAlertTagsRequestMock(['tag-1'], ['tag-2']), + body: getSetAlertTagsRequestMock(['tag-1'], ['tag-2'], ['test-id']), }); - context.core.elasticsearch.client.asCurrentUser.updateByQuery.mockResponse( - getSuccessfulSignalUpdateResponse() - ); + context.core.elasticsearch.client.asCurrentUser.bulk.mockResponse({ + errors: false, + took: 0, + items: [{ update: { result: 'updated', status: 200, _index: 'test-index' } }], + }); const response = await server.inject(request, requestContextMock.convertContext(context)); @@ -45,7 +47,7 @@ describe('setAlertTagsRoute', () => { request = requestMock.create({ method: 'post', path: DETECTION_ENGINE_ALERT_TAGS_URL, - body: getSetAlertTagsRequestMock(['tag-1'], ['tag-1']), + body: getSetAlertTagsRequestMock(['tag-1'], ['tag-1'], ['test-id']), }); context.core.elasticsearch.client.asCurrentUser.updateByQuery.mockResponse( @@ -65,20 +67,43 @@ describe('setAlertTagsRoute', () => { status_code: 400, }); }); - }); - describe('500s', () => { - test('returns 500 if ', async () => { + test('returns 400 if no alert ids are provided', async () => { request = requestMock.create({ method: 'post', path: DETECTION_ENGINE_ALERT_TAGS_URL, body: getSetAlertTagsRequestMock(['tag-1'], ['tag-2']), }); + context.core.elasticsearch.client.asCurrentUser.updateByQuery.mockResponse( + getSuccessfulSignalUpdateResponse() + ); + + const response = await server.inject(request, requestContextMock.convertContext(context)); + context.core.elasticsearch.client.asCurrentUser.updateByQuery.mockRejectedValue( new Error('Test error') ); + expect(response.body).toEqual({ + message: [`No alert ids were provided`], + status_code: 400, + }); + }); + }); + + describe('500s', () => { + test('returns 500 if asCurrentUser throws error', async () => { + request = requestMock.create({ + method: 'post', + path: DETECTION_ENGINE_ALERT_TAGS_URL, + body: getSetAlertTagsRequestMock(['tag-1'], ['tag-2'], ['test-id']), + }); + + context.core.elasticsearch.client.asCurrentUser.bulk.mockRejectedValue( + new Error('Test error') + ); + const response = await server.inject(request, requestContextMock.convertContext(context)); expect(response.body).toEqual({ diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/set_alert_tags_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/set_alert_tags_route.ts index 00e85bf29f598..02fe1ff73f710 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/set_alert_tags_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/set_alert_tags_route.ts @@ -7,8 +7,8 @@ import { transformError } from '@kbn/securitysolution-es-utils'; import { uniq } from 'lodash/fp'; -import type { SetAlertTagsSchemaDecoded } from '../../../../../common/detection_engine/schemas/request/set_alert_tags_schema'; -import { setAlertTagsSchema } from '../../../../../common/detection_engine/schemas/request/set_alert_tags_schema'; +import type { SetAlertTagsRequestBodyDecoded } from '../../../../../common/api/detection_engine/alert_tags'; +import { setAlertTagsRequestBody } from '../../../../../common/api/detection_engine/alert_tags'; import type { SecuritySolutionPluginRouter } from '../../../../types'; import { DEFAULT_ALERTS_INDEX, @@ -23,8 +23,8 @@ export const setAlertTagsRoute = (router: SecuritySolutionPluginRouter) => { { path: DETECTION_ENGINE_ALERT_TAGS_URL, validate: { - body: buildRouteValidation( - setAlertTagsSchema + body: buildRouteValidation( + setAlertTagsRequestBody ), }, options: { @@ -32,13 +32,13 @@ export const setAlertTagsRoute = (router: SecuritySolutionPluginRouter) => { }, }, async (context, request, response) => { - const { tags, query } = request.body; + const { tags, ids } = request.body; const core = await context.core; const securitySolution = await context.securitySolution; const esClient = core.elasticsearch.client.asCurrentUser; const siemClient = securitySolution?.getAppClient(); const siemResponse = buildSiemResponse(response); - const validationErrors = validateAlertTagsArrays(tags); + const validationErrors = validateAlertTagsArrays(tags, ids); const spaceId = securitySolution?.getSpaceId() ?? 'default'; if (validationErrors.length) { @@ -49,45 +49,50 @@ export const setAlertTagsRoute = (router: SecuritySolutionPluginRouter) => { return siemResponse.error({ statusCode: 404 }); } - let queryObject; - if (query) { - queryObject = { - bool: { - filter: query, - }, - }; - } const tagsToAdd = uniq(tags.tags_to_add); const tagsToRemove = uniq(tags.tags_to_remove); - try { - const body = await esClient.updateByQuery({ - index: `${DEFAULT_ALERTS_INDEX}-${spaceId}`, - refresh: false, - body: { - script: { - params: { tagsToAdd, tagsToRemove }, - source: `List newTagsArray = []; - if (ctx._source["kibana.alert.workflow_tags"] != null) { - for (tag in ctx._source["kibana.alert.workflow_tags"]) { - if (!params.tagsToRemove.contains(tag)) { - newTagsArray.add(tag); - } - } - for (tag in params.tagsToAdd) { - if (!newTagsArray.contains(tag)) { - newTagsArray.add(tag) - } - } - ctx._source["kibana.alert.workflow_tags"] = newTagsArray; - } else { - ctx._source["kibana.alert.workflow_tags"] = params.tagsToAdd; - } - `, - lang: 'painless', + + const painlessScript = { + params: { tagsToAdd, tagsToRemove }, + source: `List newTagsArray = []; + if (ctx._source["kibana.alert.workflow_tags"] != null) { + for (tag in ctx._source["kibana.alert.workflow_tags"]) { + if (!params.tagsToRemove.contains(tag)) { + newTagsArray.add(tag); + } + } + for (tag in params.tagsToAdd) { + if (!newTagsArray.contains(tag)) { + newTagsArray.add(tag) + } + } + ctx._source["kibana.alert.workflow_tags"] = newTagsArray; + } else { + ctx._source["kibana.alert.workflow_tags"] = params.tagsToAdd; + } + `, + lang: 'painless', + }; + + const bulkUpdateRequest = []; + for (const id of ids) { + bulkUpdateRequest.push( + { + update: { + _index: `${DEFAULT_ALERTS_INDEX}-${spaceId}`, + _id: id, }, - query: queryObject, }, - ignore_unavailable: true, + { + script: painlessScript, + } + ); + } + + try { + const body = await esClient.bulk({ + refresh: 'wait_for', + body: bulkUpdateRequest, }); return response.ok({ body }); } catch (err) { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/translations.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/translations.ts index 74c662caa1cb5..715537fee47ab 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/translations.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/translations.ts @@ -13,3 +13,10 @@ export const ALERT_TAGS_VALIDATION_ERROR = (duplicates: string) => defaultMessage: 'Duplicate tags { duplicates } were found in the tags_to_add and tags_to_remove parameters.', }); + +export const NO_IDS_VALIDATION_ERROR = i18n.translate( + 'xpack.securitySolution.api.alertTags.noAlertIds', + { + defaultMessage: 'No alert ids were provided', + } +); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/notifications/schedule_notification_actions.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/notifications/schedule_notification_actions.test.ts index a3f6b39cfa26c..b4c1a794929c5 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/notifications/schedule_notification_actions.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/notifications/schedule_notification_actions.test.ts @@ -7,7 +7,7 @@ import type { RuleExecutorServicesMock } from '@kbn/alerting-plugin/server/mocks'; import { alertsMock } from '@kbn/alerting-plugin/server/mocks'; -import type { DetectionAlert } from '../../../../../../common/detection_engine/schemas/alerts'; +import type { DetectionAlert } from '../../../../../../common/api/detection_engine/model/alerts'; import { ALERT_THRESHOLD_RESULT_COUNT } from '../../../../../../common/field_maps/field_names'; import { sampleThresholdAlert } from '../../../rule_types/__mocks__/threshold'; import type { NotificationRuleTypeParams } from './schedule_notification_actions'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/notifications/schedule_notification_actions.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/notifications/schedule_notification_actions.ts index b54f74bd7ca20..51d4328f19061 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/notifications/schedule_notification_actions.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/notifications/schedule_notification_actions.ts @@ -15,7 +15,7 @@ import { expandDottedObject } from '../../../../../../common/utils/expand_dotted import type { RuleParams } from '../../../rule_schema'; import aadFieldConversion from '../../../routes/index/signal_aad_mapping.json'; import { isDetectionAlert } from '../../../rule_types/utils/utils'; -import type { DetectionAlert } from '../../../../../../common/detection_engine/schemas/alerts'; +import type { DetectionAlert } from '../../../../../../common/api/detection_engine/model/alerts'; export type NotificationRuleTypeParams = RuleParams & { id: string; 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 f2cf69d66fb5a..e962b48485020 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 @@ -31,12 +31,12 @@ import type { RulesClient } from '@kbn/alerting-plugin/server'; import type { CreateRuleExceptionsRequestBodyDecoded, CreateRuleExceptionsRequestParamsDecoded, -} from '../../../../../../common/detection_engine/rule_exceptions'; +} from '../../../../../../common/api/detection_engine/rule_exceptions'; import { CREATE_RULE_EXCEPTIONS_URL, CreateRuleExceptionsRequestBody, CreateRuleExceptionsRequestParams, -} from '../../../../../../common/detection_engine/rule_exceptions'; +} from '../../../../../../common/api/detection_engine/rule_exceptions'; import { readRules } from '../../../rule_management/logic/crud/read_rules'; import { patchRules } from '../../../rule_management/logic/crud/patch_rules'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions/api/find_exception_references/route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions/api/find_exception_references/route.test.ts index e16f23a70cedd..d48d2cc2227f3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions/api/find_exception_references/route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions/api/find_exception_references/route.test.ts @@ -7,7 +7,7 @@ import { getExceptionListSchemaMock } from '@kbn/lists-plugin/common/schemas/response/exception_list_schema.mock'; -import { DETECTION_ENGINE_RULES_EXCEPTIONS_REFERENCE_URL } from '../../../../../../common/detection_engine/rule_exceptions'; +import { DETECTION_ENGINE_RULES_EXCEPTIONS_REFERENCE_URL } from '../../../../../../common/api/detection_engine/rule_exceptions'; import { getEmptyFindResult, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions/api/find_exception_references/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions/api/find_exception_references/route.ts index 3771778e79f9d..05e8a58d3e972 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions/api/find_exception_references/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_exceptions/api/find_exception_references/route.ts @@ -16,12 +16,12 @@ import type { SecuritySolutionPluginRouter } from '../../../../../types'; import type { FindExceptionReferencesOnRuleSchemaDecoded, RuleReferencesSchema, -} from '../../../../../../common/detection_engine/rule_exceptions'; +} from '../../../../../../common/api/detection_engine/rule_exceptions'; import { DETECTION_ENGINE_RULES_EXCEPTIONS_REFERENCE_URL, findExceptionReferencesOnRuleSchema, rulesReferencedByExceptionListsSchema, -} from '../../../../../../common/detection_engine/rule_exceptions'; +} from '../../../../../../common/api/detection_engine/rule_exceptions'; import { enrichFilterWithRuleTypeMapping } from '../../../rule_management/logic/search/enrich_filter_with_rule_type_mappings'; import type { RuleParams } from '../../../rule_schema'; 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 ea49f53eacdd3..428010033c5b2 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 @@ -23,7 +23,7 @@ import { performBulkActionRoute } from './route'; import { getPerformBulkActionEditSchemaMock, getPerformBulkActionSchemaMock, -} from '../../../../../../../common/detection_engine/rule_management/mocks'; +} from '../../../../../../../common/api/detection_engine/rule_management/mocks'; import { loggingSystemMock } from '@kbn/core/server/mocks'; import { readRules } from '../../../logic/crud/read_rules'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_actions/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_actions/route.ts index 974ea9cc7ecc5..674b61cebd6a0 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_actions/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_actions/route.ts @@ -24,14 +24,14 @@ import { BulkActionType, PerformBulkActionRequestBody, PerformBulkActionRequestQuery, -} from '../../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; +} from '../../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; import type { NormalizedRuleError, RuleDetailsInError, BulkEditActionResponse, BulkEditActionResults, BulkEditActionSummary, -} from '../../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/response_schema'; +} from '../../../../../../../common/api/detection_engine'; import type { SetupPlugins } from '../../../../../../plugin'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import { buildRouteValidation } from '../../../../../../utils/build_validation/route_validation'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/get_duplicates.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/get_duplicates.test.ts index bc15b93639cdb..b3a9519ad5566 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/get_duplicates.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/get_duplicates.test.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { BulkCreateRulesRequestBody } from '../../../../../../../common/detection_engine/rule_management'; +import type { BulkCreateRulesRequestBody } from '../../../../../../../common/api/detection_engine/rule_management'; import { getDuplicates } from './get_duplicates'; describe('getDuplicates', () => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/get_duplicates.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/get_duplicates.ts index 3d537bbd25c46..3b8f336e05905 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/get_duplicates.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/get_duplicates.ts @@ -6,7 +6,7 @@ */ import { countBy } from 'lodash/fp'; -import type { BulkCreateRulesRequestBody } from '../../../../../../../common/detection_engine/rule_management'; +import type { BulkCreateRulesRequestBody } from '../../../../../../../common/api/detection_engine/rule_management'; export const getDuplicates = ( ruleDefinitions: BulkCreateRulesRequestBody, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/route.test.ts index 1dcb5e885d72b..eeef7846b519a 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/route.test.ts @@ -19,7 +19,7 @@ import { } from '../../../../routes/__mocks__/request_responses'; import { requestContextMock, serverMock, requestMock } from '../../../../routes/__mocks__'; import { bulkCreateRulesRoute } from './route'; -import { getCreateRulesSchemaMock } from '../../../../../../../common/detection_engine/rule_schema/mocks'; +import { getCreateRulesSchemaMock } from '../../../../../../../common/api/detection_engine/model/rule_schema/mocks'; import { elasticsearchClientMock } from '@kbn/core-elasticsearch-client-server-mocks'; import { getQueryRuleParams } from '../../../../rule_schema/mocks'; import { loggingSystemMock } from '@kbn/core/server/mocks'; 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 958a1e01ce2f5..6374edfe09a23 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 @@ -13,7 +13,7 @@ import { BulkCreateRulesRequestBody, validateCreateRuleProps, BulkCrudRulesResponse, -} from '../../../../../../../common/detection_engine/rule_management'; +} from '../../../../../../../common/api/detection_engine/rule_management'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import type { SetupPlugins } from '../../../../../../plugin'; 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 f1842e0bb76d4..955cfbd13dd73 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 @@ -13,7 +13,7 @@ import { BulkDeleteRulesRequestBody, validateQueryRuleByIds, BulkCrudRulesResponse, -} from '../../../../../../../common/detection_engine/rule_management'; +} from '../../../../../../../common/api/detection_engine/rule_management'; import { buildRouteValidation } from '../../../../../../utils/build_validation/route_validation'; import type { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_patch_rules/route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_patch_rules/route.test.ts index 802763872cbd3..4fdc0d0dedda2 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_patch_rules/route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_patch_rules/route.test.ts @@ -20,7 +20,7 @@ import { } from '../../../../routes/__mocks__/request_responses'; import { serverMock, requestContextMock, requestMock } from '../../../../routes/__mocks__'; import { bulkPatchRulesRoute } from './route'; -import { getCreateRulesSchemaMock } from '../../../../../../../common/detection_engine/rule_schema/mocks'; +import { getCreateRulesSchemaMock } from '../../../../../../../common/api/detection_engine/model/rule_schema/mocks'; import { getMlRuleParams, getQueryRuleParams } from '../../../../rule_schema/mocks'; import { loggingSystemMock } from '@kbn/core/server/mocks'; 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 39507d050987c..730349078bb65 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 @@ -12,7 +12,7 @@ import { DETECTION_ENGINE_RULES_BULK_UPDATE } from '../../../../../../../common/ import { BulkPatchRulesRequestBody, BulkCrudRulesResponse, -} from '../../../../../../../common/detection_engine/rule_management'; +} from '../../../../../../../common/api/detection_engine/rule_management'; import { buildRouteValidationNonExact } from '../../../../../../utils/build_validation/route_validation'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_update_rules/route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_update_rules/route.test.ts index 54fd9671078da..ba9a61d2126e4 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_update_rules/route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/bulk_update_rules/route.test.ts @@ -18,7 +18,7 @@ import { import { serverMock, requestContextMock, requestMock } from '../../../../routes/__mocks__'; import { bulkUpdateRulesRoute } from './route'; import type { BulkError } from '../../../../routes/utils'; -import { getCreateRulesSchemaMock } from '../../../../../../../common/detection_engine/rule_schema/mocks'; +import { getCreateRulesSchemaMock } from '../../../../../../../common/api/detection_engine/model/rule_schema/mocks'; import { getQueryRuleParams } from '../../../../rule_schema/mocks'; import { loggingSystemMock } from '@kbn/core/server/mocks'; 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 9a8ce4a2cd595..bae2757854760 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 @@ -12,7 +12,7 @@ import { BulkUpdateRulesRequestBody, validateUpdateRuleProps, BulkCrudRulesResponse, -} from '../../../../../../../common/detection_engine/rule_management'; +} from '../../../../../../../common/api/detection_engine/rule_management'; import { buildRouteValidation } from '../../../../../../utils/build_validation/route_validation'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/coverage_overview/handle_coverage_overview_request.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/coverage_overview/handle_coverage_overview_request.ts index 101f4c190bb3e..256441fe0da49 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/coverage_overview/handle_coverage_overview_request.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/coverage_overview/handle_coverage_overview_request.ts @@ -8,12 +8,14 @@ import type { SanitizedRule } from '@kbn/alerting-plugin/common'; import type { RulesClient } from '@kbn/alerting-plugin/server'; import { convertRulesFilterToKQL } from '../../../../../../../common/utils/kql'; -import type { CoverageOverviewRequestBody } from '../../../../../../../common/detection_engine/rule_management/api/rules/coverage_overview/request_schema'; +import type { + CoverageOverviewRequestBody, + CoverageOverviewResponse, +} from '../../../../../../../common/api/detection_engine'; import { CoverageOverviewRuleSource, CoverageOverviewRuleActivity, -} from '../../../../../../../common/detection_engine/rule_management/api/rules/coverage_overview/request_schema'; -import type { CoverageOverviewResponse } from '../../../../../../../common/detection_engine/rule_management/api/rules/coverage_overview/response_schema'; +} from '../../../../../../../common/api/detection_engine'; import type { RuleParams } from '../../../../rule_schema'; type CoverageOverviewRuleParams = Pick; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/coverage_overview/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/coverage_overview/route.ts index 989d1a762cdc2..71394c93be301 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/coverage_overview/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/coverage_overview/route.ts @@ -6,9 +6,11 @@ */ import { transformError } from '@kbn/securitysolution-es-utils'; -import { CoverageOverviewRequestBody } from '../../../../../../../common/detection_engine/rule_management/api/rules/coverage_overview/request_schema'; +import { + CoverageOverviewRequestBody, + RULE_MANAGEMENT_COVERAGE_OVERVIEW_URL, +} from '../../../../../../../common/api/detection_engine'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; -import { RULE_MANAGEMENT_COVERAGE_OVERVIEW_URL } from '../../../../../../../common/detection_engine/rule_management/api/urls'; import { buildSiemResponse } from '../../../../routes/utils'; import { buildRouteValidation } from '../../../../../../utils/build_validation/route_validation'; import { handleCoverageOverviewRequest } from './handle_coverage_overview_request'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/create_rule/route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/create_rule/route.test.ts index 0fc066e8b7614..18efcc5c94c2e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/create_rule/route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/create_rule/route.test.ts @@ -18,7 +18,7 @@ import { mlServicesMock } from '../../../../../machine_learning/mocks'; import { buildMlAuthz } from '../../../../../machine_learning/authz'; import { requestContextMock, serverMock, requestMock } from '../../../../routes/__mocks__'; import { createRuleRoute } from './route'; -import { getCreateRulesSchemaMock } from '../../../../../../../common/detection_engine/rule_schema/mocks'; +import { getCreateRulesSchemaMock } from '../../../../../../../common/api/detection_engine/model/rule_schema/mocks'; import { elasticsearchClientMock } from '@kbn/core-elasticsearch-client-server-mocks'; import { getQueryRuleParams } from '../../../../rule_schema/mocks'; 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 11c6769349256..8e6dd96f15f3e 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 @@ -8,8 +8,8 @@ import { transformError } from '@kbn/securitysolution-es-utils'; import { DETECTION_ENGINE_RULES_URL } from '../../../../../../../common/constants'; -import { validateCreateRuleProps } from '../../../../../../../common/detection_engine/rule_management'; -import { RuleCreateProps } from '../../../../../../../common/detection_engine/rule_schema'; +import { validateCreateRuleProps } from '../../../../../../../common/api/detection_engine/rule_management'; +import { RuleCreateProps } from '../../../../../../../common/api/detection_engine/model/rule_schema'; import { buildRouteValidation } from '../../../../../../utils/build_validation/route_validation'; import type { SetupPlugins } from '../../../../../../plugin'; 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 4c8a61d91543c..b46e85f38a83a 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 @@ -11,7 +11,7 @@ import { DETECTION_ENGINE_RULES_URL } from '../../../../../../../common/constant import { QueryRuleByIds, validateQueryRuleByIds, -} from '../../../../../../../common/detection_engine/rule_management'; +} from '../../../../../../../common/api/detection_engine/rule_management'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import { buildRouteValidation } from '../../../../../../utils/build_validation/route_validation'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/export_rules/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/export_rules/route.ts index f02187da055d1..28f65bcfcaa7c 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/export_rules/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/export_rules/route.ts @@ -9,11 +9,11 @@ import { transformError } from '@kbn/securitysolution-es-utils'; import type { Logger } from '@kbn/core/server'; import { DETECTION_ENGINE_RULES_URL } from '../../../../../../../common/constants'; -import type { ExportRulesRequestQueryDecoded } from '../../../../../../../common/detection_engine/rule_management'; +import type { ExportRulesRequestQueryDecoded } from '../../../../../../../common/api/detection_engine/rule_management'; import { ExportRulesRequestBody, ExportRulesRequestQuery, -} from '../../../../../../../common/detection_engine/rule_management'; +} from '../../../../../../../common/api/detection_engine/rule_management'; import { buildRouteValidation } from '../../../../../../utils/build_validation/route_validation'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/filters/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/filters/route.ts index d7d974aa8d9ef..54e84b989ab55 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/filters/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/filters/route.ts @@ -8,8 +8,10 @@ import { transformError } from '@kbn/securitysolution-es-utils'; import { validate } from '@kbn/securitysolution-io-ts-utils'; import type { RulesClient } from '@kbn/alerting-plugin/server'; -import { RuleManagementFiltersResponse } from '../../../../../../../common/detection_engine/rule_management/api/rules/filters/response_schema'; -import { RULE_MANAGEMENT_FILTERS_URL } from '../../../../../../../common/detection_engine/rule_management/api/urls'; +import { + GetRuleManagementFiltersResponse, + RULE_MANAGEMENT_FILTERS_URL, +} from '../../../../../../../common/api/detection_engine/rule_management'; import { buildSiemResponse } from '../../../../routes/utils'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import { findRules } from '../../../logic/search/find_rules'; @@ -65,7 +67,7 @@ export const getRuleManagementFilters = (router: SecuritySolutionPluginRouter) = try { const [{ prebuilt: prebuiltRulesCount, custom: customRulesCount }, tags] = await Promise.all([fetchRulesCount(rulesClient), readTags({ rulesClient })]); - const responseBody: RuleManagementFiltersResponse = { + const responseBody: GetRuleManagementFiltersResponse = { rules_summary: { custom_count: customRulesCount, prebuilt_installed_count: prebuiltRulesCount, @@ -76,7 +78,7 @@ export const getRuleManagementFilters = (router: SecuritySolutionPluginRouter) = }; const [validatedBody, validationError] = validate( responseBody, - RuleManagementFiltersResponse + GetRuleManagementFiltersResponse ); if (validationError != null) { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/find_rules/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/find_rules/route.ts index 59b1842f4ee62..fd0a5b2b25a95 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/find_rules/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/find_rules/route.ts @@ -5,15 +5,18 @@ * 2.0. */ -import type { Logger } from '@kbn/core/server'; +import type { IKibanaResponse, Logger } from '@kbn/core/server'; import { transformError } from '@kbn/securitysolution-es-utils'; import { DETECTION_ENGINE_RULES_URL_FIND } from '../../../../../../../common/constants'; -import type { FindRulesRequestQueryDecoded } from '../../../../../../../common/detection_engine/rule_management'; +import type { + FindRulesRequestQueryDecoded, + FindRulesResponse, +} from '../../../../../../../common/api/detection_engine/rule_management'; import { FindRulesRequestQuery, validateFindRulesRequestQuery, -} from '../../../../../../../common/detection_engine/rule_management'; +} from '../../../../../../../common/api/detection_engine/rule_management'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import { findRules } from '../../../logic/search/find_rules'; @@ -34,7 +37,7 @@ export const findRulesRoute = (router: SecuritySolutionPluginRouter, logger: Log tags: ['access:securitySolution'], }, }, - async (context, request, response) => { + async (context, request, response): Promise> => { const siemResponse = buildSiemResponse(response); const validationErrors = validateFindRulesRequestQuery(request.query); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/import_rules/route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/import_rules/route.test.ts index bb1bb7d55244a..fda5fbe5b2800 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/import_rules/route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/import_rules/route.test.ts @@ -11,7 +11,7 @@ import { getImportRulesWithIdSchemaMock, ruleIdsToNdJsonString, rulesToNdJsonString, -} from '../../../../../../../common/detection_engine/rule_management/mocks'; +} from '../../../../../../../common/api/detection_engine/rule_management/mocks'; import { buildMlAuthz } from '../../../../../machine_learning/authz'; import { mlServicesMock } from '../../../../../machine_learning/mocks'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/import_rules/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/import_rules/route.ts index 1ff192a9c1ca7..a1608a9fa9eb7 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/import_rules/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/import_rules/route.ts @@ -12,11 +12,13 @@ import { createPromiseFromStreams } from '@kbn/utils'; import { transformError } from '@kbn/securitysolution-es-utils'; import { validate } from '@kbn/securitysolution-io-ts-utils'; -import type { ImportQuerySchemaDecoded } from '@kbn/securitysolution-io-ts-types'; -import { importQuerySchema } from '@kbn/securitysolution-io-ts-types'; import { DETECTION_ENGINE_RULES_URL } from '../../../../../../../common/constants'; -import { ImportRulesResponse } from '../../../../../../../common/detection_engine/rule_management'; +import type { ImportRulesRequestQueryDecoded } from '../../../../../../../common/api/detection_engine/rule_management'; +import { + ImportRulesRequestQuery, + ImportRulesResponse, +} from '../../../../../../../common/api/detection_engine/rule_management'; import type { HapiReadableStream, SecuritySolutionPluginRouter } from '../../../../../../types'; import type { ConfigType } from '../../../../../../config'; @@ -48,8 +50,8 @@ export const importRulesRoute = ( { path: `${DETECTION_ENGINE_RULES_URL}/_import`, validate: { - query: buildRouteValidation( - importQuerySchema + query: buildRouteValidation( + ImportRulesRequestQuery ), body: schema.any(), // validation on file object is accomplished later in the handler. }, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/patch_rule/route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/patch_rule/route.test.ts index f2786446056d5..e50fd79f8cf8a 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/patch_rule/route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/patch_rule/route.test.ts @@ -6,7 +6,7 @@ */ import { DETECTION_ENGINE_RULES_URL } from '../../../../../../../common/constants'; -import { getPatchRulesSchemaMock } from '../../../../../../../common/detection_engine/rule_management/mocks'; +import { getPatchRulesSchemaMock } from '../../../../../../../common/api/detection_engine/rule_management/mocks'; import { buildMlAuthz } from '../../../../../machine_learning/authz'; import { mlServicesMock } from '../../../../../machine_learning/mocks'; 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 caf9ea5ce5e17..4631d57608d9a 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 @@ -11,7 +11,7 @@ import { DETECTION_ENGINE_RULES_URL } from '../../../../../../../common/constant import { PatchRuleRequestBody, validatePatchRuleRequestBody, -} from '../../../../../../../common/detection_engine/rule_management'; +} from '../../../../../../../common/api/detection_engine/rule_management'; import { buildRouteValidationNonExact } from '../../../../../../utils/build_validation/route_validation'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; 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 da7e4be16e3c4..db97fb7b0404e 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 @@ -10,9 +10,9 @@ import { transformError } from '@kbn/securitysolution-es-utils'; import { DETECTION_ENGINE_RULES_URL } from '../../../../../../../common/constants'; import { - QueryRuleByIds, + ReadRuleRequestQuery, validateQueryRuleByIds, -} from '../../../../../../../common/detection_engine/rule_management'; +} from '../../../../../../../common/api/detection_engine/rule_management'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import { buildRouteValidation } from '../../../../../../utils/build_validation/route_validation'; @@ -26,7 +26,7 @@ export const readRuleRoute = (router: SecuritySolutionPluginRouter, logger: Logg { path: DETECTION_ENGINE_RULES_URL, validate: { - query: buildRouteValidation(QueryRuleByIds), + query: buildRouteValidation(ReadRuleRequestQuery), }, options: { tags: ['access:securitySolution'], diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/update_rule/route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/update_rule/route.test.ts index 310ec98218f17..6266764018974 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/update_rule/route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/rules/update_rule/route.test.ts @@ -21,9 +21,9 @@ import { updateRuleRoute } from './route'; import { getCreateRulesSchemaMock, getUpdateRulesSchemaMock, -} from '../../../../../../../common/detection_engine/rule_schema/mocks'; +} from '../../../../../../../common/api/detection_engine/model/rule_schema/mocks'; import { getQueryRuleParams } from '../../../../rule_schema/mocks'; -import { RESPONSE_ACTION_TYPES } from '../../../../../../../common/detection_engine/rule_response_actions/schemas'; +import { RESPONSE_ACTION_TYPES } from '../../../../../../../common/api/detection_engine/model/rule_response_actions'; jest.mock('../../../../../machine_learning/authz'); 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 41a2945e249b7..a24d5079a8f3d 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 @@ -8,8 +8,8 @@ import { transformError } from '@kbn/securitysolution-es-utils'; import { DETECTION_ENGINE_RULES_URL } from '../../../../../../../common/constants'; -import { validateUpdateRuleProps } from '../../../../../../../common/detection_engine/rule_management'; -import { RuleUpdateProps } from '../../../../../../../common/detection_engine/rule_schema'; +import { validateUpdateRuleProps } from '../../../../../../../common/api/detection_engine/rule_management'; +import { RuleUpdateProps } from '../../../../../../../common/api/detection_engine/model/rule_schema'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import type { SetupPlugins } from '../../../../../../plugin'; import { buildMlAuthz } from '../../../../../machine_learning/authz'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/tags/read_tags/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/tags/read_tags/route.ts index c7cca7e443bd3..3733f07fb9d8c 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/tags/read_tags/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/api/tags/read_tags/route.ts @@ -6,6 +6,7 @@ */ import { transformError } from '@kbn/securitysolution-es-utils'; +import type { IKibanaResponse } from '@kbn/core/server'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import { DETECTION_ENGINE_TAGS_URL } from '../../../../../../../common/constants'; import { buildSiemResponse } from '../../../../routes/utils'; @@ -21,7 +22,7 @@ export const readTagsRoute = (router: SecuritySolutionPluginRouter) => { tags: ['access:securitySolution'], }, }, - async (context, request, response) => { + async (context, request, response): Promise> => { const siemResponse = buildSiemResponse(response); const rulesClient = (await context.alerting)?.getRulesClient(); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/action_to_rules_client_operation.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/action_to_rules_client_operation.test.ts index e48f0b4cbd3c4..e598715e8f9ec 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/action_to_rules_client_operation.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/action_to_rules_client_operation.test.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { BulkActionEditType } from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; +import { BulkActionEditType } from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; import { bulkEditActionToRulesClientOperation } from './action_to_rules_client_operation'; describe('bulkEditActionToRulesClientOperation', () => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/action_to_rules_client_operation.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/action_to_rules_client_operation.ts index b463567838a38..dfd4ee64c0787 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/action_to_rules_client_operation.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/action_to_rules_client_operation.ts @@ -8,8 +8,8 @@ import type { BulkEditOperation } from '@kbn/alerting-plugin/server'; import { transformNormalizedRuleToAlertAction } from '../../../../../../common/detection_engine/transform_actions'; -import type { BulkActionEditForRuleAttributes } from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; -import { BulkActionEditType } from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; +import type { BulkActionEditForRuleAttributes } from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; +import { BulkActionEditType } from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; import { assertUnreachable } from '../../../../../../common/utility_types'; import { transformToActionFrequency } from '../../normalization/rule_actions'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/bulk_edit_rules.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/bulk_edit_rules.ts index 09d4eb691427d..76034819b508d 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/bulk_edit_rules.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/bulk_edit_rules.ts @@ -7,7 +7,7 @@ import type { RulesClient } from '@kbn/alerting-plugin/server'; -import type { BulkActionEditPayload } from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; +import type { BulkActionEditPayload } from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; import type { MlAuthz } from '../../../../machine_learning/authz'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/rule_params_modifier.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/rule_params_modifier.test.ts index 6d65665713ade..0e95035aaf412 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/rule_params_modifier.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/rule_params_modifier.test.ts @@ -6,7 +6,7 @@ */ import { addItemsToArray, deleteItemsFromArray, ruleParamsModifier } from './rule_params_modifier'; -import { BulkActionEditType } from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; +import { BulkActionEditType } from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; import type { RuleAlertType } from '../../../rule_schema'; describe('addItemsToArray', () => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/rule_params_modifier.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/rule_params_modifier.ts index e92b6e6ab0163..3bfa483564914 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/rule_params_modifier.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/rule_params_modifier.ts @@ -12,8 +12,8 @@ import type { RuleAlertType } from '../../../rule_schema'; import type { BulkActionEditForRuleParams, BulkActionEditPayloadIndexPatterns, -} from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; -import { BulkActionEditType } from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; +} from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; +import { BulkActionEditType } from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; import { invariant } from '../../../../../../common/utils/invariant'; export const addItemsToArray = (arr: T[], items: T[]): T[] => diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/split_bulk_edit_actions.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/split_bulk_edit_actions.test.ts index 33f1e0e4ad15e..5bde6c29e6082 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/split_bulk_edit_actions.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/split_bulk_edit_actions.test.ts @@ -5,8 +5,8 @@ * 2.0. */ -import type { BulkActionEditPayload } from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; -import { BulkActionEditType } from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; +import type { BulkActionEditPayload } from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; +import { BulkActionEditType } from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; import { splitBulkEditActions } from './split_bulk_edit_actions'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/split_bulk_edit_actions.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/split_bulk_edit_actions.ts index b6441d46c5ebd..2896acbea0e85 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/split_bulk_edit_actions.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/split_bulk_edit_actions.ts @@ -5,12 +5,12 @@ * 2.0. */ -import { BulkActionEditType } from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; +import { BulkActionEditType } from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; import type { BulkActionEditPayload, BulkActionEditForRuleAttributes, BulkActionEditForRuleParams, -} from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; +} from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; /** * Split bulk edit actions in 2 chunks: actions applied to params and diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/utils.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/utils.ts index 993750cfc0964..214fc16b40a49 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/utils.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/utils.ts @@ -4,7 +4,7 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ -import { BulkActionEditType } from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; +import { BulkActionEditType } from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; /** * helper utility that defines whether bulk edit action is related to index patterns, i.e. one of: diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/validations.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/validations.ts index ce9b084679a5b..65dfbae87b79e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/validations.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/bulk_actions/validations.ts @@ -9,8 +9,8 @@ import type { Type as RuleType } from '@kbn/securitysolution-io-ts-alerting-type import { invariant } from '../../../../../../common/utils/invariant'; import { isMlRule } from '../../../../../../common/machine_learning/helpers'; import { BulkActionsDryRunErrCode } from '../../../../../../common/constants'; -import type { BulkActionEditPayload } from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; -import { BulkActionEditType } from '../../../../../../common/detection_engine/rule_management/api/rules/bulk_actions/request_schema'; +import type { BulkActionEditPayload } from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; +import { BulkActionEditType } from '../../../../../../common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; import type { RuleAlertType } from '../../../rule_schema'; import { isIndexPatternsBulkEditAction } from './utils'; import { throwDryRunError } from './dry_run'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/create_rules.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/create_rules.test.ts index 8b59effd9c910..59b7d9996b5b4 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/create_rules.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/create_rules.test.ts @@ -11,7 +11,7 @@ import { DEFAULT_INDICATOR_SOURCE_PATH } from '../../../../../../common/constant import { getCreateMachineLearningRulesSchemaMock, getCreateThreatMatchRulesSchemaMock, -} from '../../../../../../common/detection_engine/rule_schema/mocks'; +} from '../../../../../../common/api/detection_engine/model/rule_schema/mocks'; describe('createRules', () => { it('calls the rulesClient with legacy ML params', async () => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/create_rules.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/create_rules.ts index 5b9f3efa1ad52..0c39d0f39411f 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/create_rules.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/create_rules.ts @@ -8,7 +8,7 @@ import type { SanitizedRule } from '@kbn/alerting-plugin/common'; import type { RulesClient } from '@kbn/alerting-plugin/server'; -import type { RuleCreateProps } from '../../../../../../common/detection_engine/rule_schema'; +import type { RuleCreateProps } from '../../../../../../common/api/detection_engine/model/rule_schema'; import { convertCreateAPIToInternalSchema } from '../../normalization/rule_converters'; import type { RuleParams } from '../../../rule_schema'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/delete_rules.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/delete_rules.ts index e650c89fd96eb..23e09d8e35c62 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/delete_rules.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/delete_rules.ts @@ -6,7 +6,7 @@ */ import type { RulesClient } from '@kbn/alerting-plugin/server'; -import type { RuleObjectId } from '../../../../../../common/detection_engine/rule_schema'; +import type { RuleObjectId } from '../../../../../../common/api/detection_engine/model/rule_schema'; export interface DeleteRuleOptions { ruleId: RuleObjectId; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/patch_rules.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/patch_rules.test.ts index 6e4d573a880e0..3191d25a40e02 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/patch_rules.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/patch_rules.test.ts @@ -13,7 +13,7 @@ import { getMlRuleParams, getQueryRuleParams } from '../../../rule_schema/mocks' import { getCreateMachineLearningRulesSchemaMock, getCreateRulesSchemaMock, -} from '../../../../../../common/detection_engine/rule_schema/mocks'; +} from '../../../../../../common/api/detection_engine/model/rule_schema/mocks'; describe('patchRules', () => { it('should call rulesClient.disable if the rule was enabled and enabled is false', async () => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/patch_rules.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/patch_rules.ts index 643750ea78b6d..ede7b86bd737e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/patch_rules.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/patch_rules.ts @@ -7,7 +7,7 @@ import type { PartialRule, RulesClient } from '@kbn/alerting-plugin/server'; -import type { PatchRuleRequestBody } from '../../../../../../common/detection_engine/rule_management'; +import type { PatchRuleRequestBody } from '../../../../../../common/api/detection_engine/rule_management'; import type { RuleAlertType, RuleParams } from '../../../rule_schema'; import { convertPatchAPIToInternalSchema } from '../../normalization/rule_converters'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/read_rules.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/read_rules.test.ts index fa6ccba511833..356b826b27198 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/read_rules.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/read_rules.test.ts @@ -28,7 +28,6 @@ export class TestError extends Error { describe('read_rules', () => { beforeEach(() => { jest.resetAllMocks(); - jest.restoreAllMocks(); jest.clearAllMocks(); }); describe('readRules', () => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/read_rules.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/read_rules.ts index 76969b31aab66..e01bcd4b7e2ec 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/read_rules.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/read_rules.ts @@ -11,7 +11,7 @@ import type { RulesClient } from '@kbn/alerting-plugin/server'; import type { RuleObjectId, RuleSignatureId, -} from '../../../../../../common/detection_engine/rule_schema'; +} from '../../../../../../common/api/detection_engine/model/rule_schema'; import { withSecuritySpan } from '../../../../../utils/with_security_span'; import type { RuleParams } from '../../../rule_schema'; import { isAlertType } from '../../../rule_schema'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/update_rules.mock.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/update_rules.mock.ts index 3e3da2e6f5530..c30fdb107b83e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/update_rules.mock.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/update_rules.mock.ts @@ -9,7 +9,7 @@ import { rulesClientMock } from '@kbn/alerting-plugin/server/mocks'; import { getUpdateMachineLearningSchemaMock, getUpdateRulesSchemaMock, -} from '../../../../../../common/detection_engine/rule_schema/mocks'; +} from '../../../../../../common/api/detection_engine/model/rule_schema/mocks'; import { getRuleMock } from '../../../routes/__mocks__/request_responses'; import { getQueryRuleParams } from '../../../rule_schema/mocks'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/update_rules.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/update_rules.ts index 070a81692f3d5..66a4531d1c2e3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/update_rules.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/update_rules.ts @@ -8,7 +8,7 @@ /* eslint-disable complexity */ import type { PartialRule, RulesClient } from '@kbn/alerting-plugin/server'; import { DEFAULT_MAX_SIGNALS } from '../../../../../../common/constants'; -import type { RuleUpdateProps } from '../../../../../../common/detection_engine/rule_schema'; +import type { RuleUpdateProps } from '../../../../../../common/api/detection_engine/model/rule_schema'; import { transformRuleToAlertAction } from '../../../../../../common/detection_engine/transform_actions'; import type { InternalRuleUpdate, RuleParams, RuleAlertType } from '../../../rule_schema'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/exceptions/validate_rules_with_duplicated_default_exceptions_list.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/exceptions/validate_rules_with_duplicated_default_exceptions_list.ts index b80c68bc507de..060a21f12c429 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/exceptions/validate_rules_with_duplicated_default_exceptions_list.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/exceptions/validate_rules_with_duplicated_default_exceptions_list.ts @@ -11,7 +11,7 @@ import type { BulkCreateRulesRequestBody, BulkPatchRulesRequestBody, BulkUpdateRulesRequestBody, -} from '../../../../../../common/detection_engine/rule_management'; +} from '../../../../../../common/api/detection_engine/rule_management'; import { CustomHttpRequestError } from '../../../../../utils/custom_http_request_error'; /** * Check if rule has duplicated default exceptions lits diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_all.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_all.test.ts index 55f797e73ebc3..60e4d56278337 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_all.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_all.test.ts @@ -18,7 +18,7 @@ import { getThreatMock } from '../../../../../../common/detection_engine/schemas import { getOutputDetailsSampleWithExceptions, getSampleDetailsAsNdjson, -} from '../../../../../../common/detection_engine/rule_management/mocks'; +} from '../../../../../../common/api/detection_engine/rule_management/mocks'; import { getQueryRuleParams } from '../../../rule_schema/mocks'; import { getExceptionListClientMock } from '@kbn/lists-plugin/server/services/exception_lists/exception_list_client.mock'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_by_object_ids.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_by_object_ids.test.ts index 79aa4bfd3d88e..cf1c9db355bdd 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_by_object_ids.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_by_object_ids.test.ts @@ -19,7 +19,7 @@ import { getThreatMock } from '../../../../../../common/detection_engine/schemas import { getSampleDetailsAsNdjson, getOutputDetailsSampleWithExceptions, -} from '../../../../../../common/detection_engine/rule_management/mocks'; +} from '../../../../../../common/api/detection_engine/rule_management/mocks'; import { getQueryRuleParams } from '../../../rule_schema/mocks'; import { getExceptionListClientMock } from '@kbn/lists-plugin/server/services/exception_lists/exception_list_client.mock'; import { savedObjectsExporterMock } from '@kbn/core-saved-objects-import-export-server-mocks'; @@ -60,7 +60,6 @@ describe('get_export_by_object_ids', () => { const actionsClient = actionsClientMock.create(); beforeEach(() => { jest.resetAllMocks(); - jest.restoreAllMocks(); jest.clearAllMocks(); clients.savedObjectsClient.find.mockResolvedValue(getEmptySavedObjectsResponse()); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_by_object_ids.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_by_object_ids.ts index 492fe15b8c228..90feafaf036fa 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_by_object_ids.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_by_object_ids.ts @@ -23,7 +23,7 @@ import { getRuleExceptionsForExport } from './get_export_rule_exceptions'; import { getRuleActionConnectorsForExport } from './get_export_rule_action_connectors'; import { internalRuleToAPIResponse } from '../../normalization/rule_converters'; -import type { RuleResponse } from '../../../../../../common/detection_engine/rule_schema'; +import type { RuleResponse } from '../../../../../../common/api/detection_engine/model/rule_schema'; interface ExportSuccessRule { statusCode: 200; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_details_ndjson.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_details_ndjson.test.ts index b380fc804233b..97d423158c7d3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_details_ndjson.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_details_ndjson.test.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { getRulesSchemaMock } from '../../../../../../common/detection_engine/rule_schema/mocks'; +import { getRulesSchemaMock } from '../../../../../../common/api/detection_engine/model/rule_schema/mocks'; import { getExportDetailsNdjson } from './get_export_details_ndjson'; describe('getExportDetailsNdjson', () => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_details_ndjson.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_details_ndjson.ts index 9efbe665812c9..1341a0c853be0 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_details_ndjson.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_details_ndjson.ts @@ -6,8 +6,8 @@ */ import type { ExportExceptionDetails } from '@kbn/securitysolution-io-ts-list-types'; -import type { ExportRulesDetails } from '../../../../../../common/detection_engine/rule_management'; -import type { RuleResponse } from '../../../../../../common/detection_engine/rule_schema'; +import type { ExportRulesDetails } from '../../../../../../common/api/detection_engine/rule_management'; +import type { RuleResponse } from '../../../../../../common/api/detection_engine/model/rule_schema'; import type { DefaultActionConnectorDetails } from './get_export_rule_action_connectors'; export const getExportDetailsNdjson = ( diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_rule_action_connectors.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_rule_action_connectors.ts index 0bc87aadb8e62..f65d2a5b8c985 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_rule_action_connectors.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/export/get_export_rule_action_connectors.ts @@ -14,7 +14,7 @@ import type { SavedObject, } from '@kbn/core-saved-objects-server'; import { createConcatStream, createMapStream, createPromiseFromStreams } from '@kbn/utils'; -import type { RuleResponse } from '../../../../../../common/detection_engine/rule_schema'; +import type { RuleResponse } from '../../../../../../common/api/detection_engine/model/rule_schema'; export interface DefaultActionConnectorDetails { exported_action_connector_count: number; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/import_rule_action_connectors.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/import_rule_action_connectors.test.ts index 19b4597f408df..f6e0e34904c5a 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/import_rule_action_connectors.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/import_rule_action_connectors.test.ts @@ -8,7 +8,7 @@ import { actionsClientMock } from '@kbn/actions-plugin/server/actions_client.moc import { getImportRulesSchemaMock, webHookConnector, -} from '../../../../../../../common/detection_engine/rule_management/model/import/rule_to_import.mock'; +} from '../../../../../../../common/api/detection_engine/rule_management/import_rules/rule_to_import.mock'; import { importRuleActionConnectors } from './import_rule_action_connectors'; import { coreMock } from '@kbn/core/server/mocks'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/import_rule_action_connectors.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/import_rule_action_connectors.ts index dda1a28192eef..dfbacdcfd8ce2 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/import_rule_action_connectors.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/import_rule_action_connectors.ts @@ -9,8 +9,8 @@ import { Readable } from 'stream'; import type { SavedObjectsImportResponse } from '@kbn/core-saved-objects-common'; import type { SavedObject } from '@kbn/core-saved-objects-server'; -import type { RuleToImport } from '../../../../../../../common/detection_engine/rule_management'; -import type { WarningSchema } from '../../../../../../../common/detection_engine/schemas/response'; +import type { RuleToImport } from '../../../../../../../common/api/detection_engine/rule_management'; +import type { WarningSchema } from '../../../../../../../common/api/detection_engine'; import { checkIfActionsHaveMissingConnectors, filterExistingActionConnectors, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/types.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/types.ts index 3d9471016a859..a935dc37c5238 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/types.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/types.ts @@ -7,8 +7,8 @@ import type { ISavedObjectsImporter, SavedObject } from '@kbn/core-saved-objects-server'; import type { ActionsClient } from '@kbn/actions-plugin/server'; import type { SavedObjectsImportFailure } from '@kbn/core-saved-objects-common'; -import type { RuleToImport } from '../../../../../../../common/detection_engine/rule_management'; -import type { WarningSchema } from '../../../../../../../common/detection_engine/schemas/response'; +import type { RuleToImport } from '../../../../../../../common/api/detection_engine/rule_management'; +import type { WarningSchema } from '../../../../../../../common/api/detection_engine'; import type { BulkError } from '../../../../routes/utils'; export interface ImportRuleActionConnectorsResult { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/utils/index.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/utils/index.ts index 4ab122f6da94e..1a72afb695db5 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/utils/index.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/action_connectors/utils/index.ts @@ -13,7 +13,7 @@ import type { SavedObject } from '@kbn/core-saved-objects-server'; import type { ActionsClient } from '@kbn/actions-plugin/server'; import type { BulkError } from '../../../../../routes/utils'; import { createBulkErrorObject } from '../../../../../routes/utils'; -import type { RuleToImport } from '../../../../../../../../common/detection_engine/rule_management'; +import type { RuleToImport } from '../../../../../../../../common/api/detection_engine/rule_management'; import type { ActionRules, ConflictError, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/check_rule_exception_references.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/check_rule_exception_references.test.ts index fdee52eac1a24..2b7996c5094ab 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/check_rule_exception_references.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/check_rule_exception_references.test.ts @@ -6,7 +6,7 @@ */ import { getExceptionListSchemaMock } from '@kbn/lists-plugin/common/schemas/response/exception_list_schema.mock'; -import { getImportRulesSchemaMock } from '../../../../../../common/detection_engine/rule_management/mocks'; +import { getImportRulesSchemaMock } from '../../../../../../common/api/detection_engine/rule_management/mocks'; import { checkRuleExceptionReferences } from './check_rule_exception_references'; describe('checkRuleExceptionReferences', () => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/check_rule_exception_references.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/check_rule_exception_references.ts index 23494c3fc23dd..efa6026d875bf 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/check_rule_exception_references.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/check_rule_exception_references.ts @@ -6,7 +6,7 @@ */ import type { ListArray, ExceptionListSchema } from '@kbn/securitysolution-io-ts-list-types'; -import type { RuleToImport } from '../../../../../../common/detection_engine/rule_management'; +import type { RuleToImport } from '../../../../../../common/api/detection_engine/rule_management'; import type { BulkError } from '../../../routes/utils'; import { createBulkErrorObject } from '../../../routes/utils'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/create_rules_stream_from_ndjson.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/create_rules_stream_from_ndjson.test.ts index 47a4a4832b034..594047d237bc7 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/create_rules_stream_from_ndjson.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/create_rules_stream_from_ndjson.test.ts @@ -10,11 +10,11 @@ import { createPromiseFromStreams } from '@kbn/utils'; import { createRulesAndExceptionsStreamFromNdJson } from './create_rules_stream_from_ndjson'; import { BadRequestError } from '@kbn/securitysolution-es-utils'; -import type { RuleToImport } from '../../../../../../common/detection_engine/rule_management'; +import type { RuleToImport } from '../../../../../../common/api/detection_engine/rule_management'; import { getOutputDetailsSample, getSampleDetailsAsNdjson, -} from '../../../../../../common/detection_engine/rule_management/mocks'; +} from '../../../../../../common/api/detection_engine/rule_management/mocks'; import type { RuleExceptionsPromiseFromStreams } from './import_rules_utils'; export const getOutputSample = (): Partial => ({ diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/create_rules_stream_from_ndjson.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/create_rules_stream_from_ndjson.ts index 4414b6063c473..dcb22706c3c59 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/create_rules_stream_from_ndjson.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/create_rules_stream_from_ndjson.ts @@ -28,7 +28,7 @@ import type { SavedObject } from '@kbn/core-saved-objects-server'; import { RuleToImport, validateRuleToImport, -} from '../../../../../../common/detection_engine/rule_management'; +} from '../../../../../../common/api/detection_engine/rule_management'; import { parseNdjsonStrings, createRulesLimitStream, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/gather_referenced_exceptions.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/gather_referenced_exceptions.test.ts index 5f903386ab012..df136fe6cfc8d 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/gather_referenced_exceptions.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/gather_referenced_exceptions.test.ts @@ -9,7 +9,7 @@ import type { SavedObjectsClientContract } from '@kbn/core/server'; import { savedObjectsClientMock } from '@kbn/core/server/mocks'; import { findExceptionList } from '@kbn/lists-plugin/server/services/exception_lists/find_exception_list'; import { getExceptionListSchemaMock } from '@kbn/lists-plugin/common/schemas/response/exception_list_schema.mock'; -import { getImportRulesSchemaMock } from '../../../../../../common/detection_engine/rule_management/mocks'; +import { getImportRulesSchemaMock } from '../../../../../../common/api/detection_engine/rule_management/mocks'; import { getReferencedExceptionLists, parseReferencedExceptionsLists, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/gather_referenced_exceptions.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/gather_referenced_exceptions.ts index 6653e8ad54a6e..2ae8c56e73c74 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/gather_referenced_exceptions.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/gather_referenced_exceptions.ts @@ -8,7 +8,7 @@ import type { ExceptionListSchema, ListArray } from '@kbn/securitysolution-io-ts import type { SavedObjectsClientContract } from '@kbn/core/server'; import type { ExceptionListQueryInfo } from '@kbn/lists-plugin/server/services/exception_lists/utils/import/find_all_exception_list_types'; import { getAllListTypes } from '@kbn/lists-plugin/server/services/exception_lists/utils/import/find_all_exception_list_types'; -import type { RuleToImport } from '../../../../../../common/detection_engine/rule_management'; +import type { RuleToImport } from '../../../../../../common/api/detection_engine/rule_management'; /** * splitting out the parsing of the lists from the fetching diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/import_rules_utils.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/import_rules_utils.test.ts index 2de1816e4541f..96bc58ee6d441 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/import_rules_utils.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/import/import_rules_utils.test.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { getImportRulesSchemaMock } from '../../../../../../common/detection_engine/rule_management/mocks'; +import { getImportRulesSchemaMock } from '../../../../../../common/api/detection_engine/rule_management/mocks'; import { getQueryRuleParams } from '../../../rule_schema/mocks'; import { requestContextMock } from '../../../routes/__mocks__'; 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 d38b48bf9181f..a2618f4af7e22 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 @@ -15,7 +15,7 @@ import type { import type { RulesClient } from '@kbn/alerting-plugin/server'; import type { ExceptionListClient } from '@kbn/lists-plugin/server'; -import type { RuleToImport } from '../../../../../../common/detection_engine/rule_management'; +import type { RuleToImport } from '../../../../../../common/api/detection_engine/rule_management'; import type { ImportRuleResponse } from '../../../routes/utils'; import { createBulkErrorObject } from '../../../routes/utils'; import { createRules } from '../crud/create_rules'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/search/find_rules.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/search/find_rules.ts index d72e3e6900be3..f47a2e497a5d1 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/search/find_rules.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/search/find_rules.ts @@ -6,7 +6,7 @@ */ import type { FindResult, RulesClient } from '@kbn/alerting-plugin/server'; -import type { FindRulesSortFieldOrUndefined } from '../../../../../../common/detection_engine/rule_management'; +import type { FindRulesSortFieldOrUndefined } from '../../../../../../common/api/detection_engine/rule_management'; import type { FieldsOrUndefined, @@ -14,7 +14,7 @@ import type { PerPageOrUndefined, QueryFilterOrUndefined, SortOrderOrUndefined, -} from '../../../../../../common/detection_engine/schemas/common'; +} from '../../../../../../common/api/detection_engine'; import type { RuleParams } from '../../../rule_schema'; import { enrichFilterWithRuleTypeMapping } from './enrich_filter_with_rule_type_mappings'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/search/transform_sort_field.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/search/transform_sort_field.ts index dc94afa07ddb0..53573879d07df 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/search/transform_sort_field.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/search/transform_sort_field.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { FindRulesSortFieldOrUndefined } from '../../../../../../common/detection_engine/rule_management'; +import type { FindRulesSortFieldOrUndefined } from '../../../../../../common/api/detection_engine/rule_management'; import { assertUnreachable } from '../../../../../../common/utility_types'; /** diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/normalization/rule_converters.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/normalization/rule_converters.ts index 66d873c2c0935..300d58ecc2e11 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/normalization/rule_converters.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/normalization/rule_converters.ts @@ -18,7 +18,7 @@ import { SERVER_APP_ID, } from '../../../../../common/constants'; -import type { PatchRuleRequestBody } from '../../../../../common/detection_engine/rule_management'; +import type { PatchRuleRequestBody } from '../../../../../common/api/detection_engine/rule_management'; import type { RelatedIntegrationArray, RequiredFieldArray, @@ -27,7 +27,7 @@ import type { RuleResponse, TypeSpecificCreateProps, TypeSpecificResponse, -} from '../../../../../common/detection_engine/rule_schema'; +} from '../../../../../common/api/detection_engine/model/rule_schema'; import { EqlPatchParams, MachineLearningPatchParams, @@ -36,7 +36,7 @@ import { SavedQueryPatchParams, ThreatMatchPatchParams, ThresholdPatchParams, -} from '../../../../../common/detection_engine/rule_schema'; +} from '../../../../../common/api/detection_engine/model/rule_schema'; import { transformAlertToRuleAction, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/utils.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/utils.test.ts index 89699de1316ad..328dd8d0ea24f 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/utils.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/utils.test.ts @@ -11,8 +11,8 @@ import { createPromiseFromStreams } from '@kbn/utils'; import type { RuleAction, ThreatMapping } from '@kbn/securitysolution-io-ts-alerting-types'; import type { PartialRule } from '@kbn/alerting-plugin/server'; -import type { RuleToImport } from '../../../../../common/detection_engine/rule_management'; -import { getCreateRulesSchemaMock } from '../../../../../common/detection_engine/rule_schema/mocks'; +import type { RuleToImport } from '../../../../../common/api/detection_engine/rule_management'; +import { getCreateRulesSchemaMock } from '../../../../../common/api/detection_engine/model/rule_schema/mocks'; import { requestContextMock } from '../../routes/__mocks__'; import { getOutputRuleAlertForRest } from '../../routes/__mocks__/utils'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/utils.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/utils.ts index 0e8d52e4ce84e..c443a66880454 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/utils.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/utils.ts @@ -14,12 +14,15 @@ import type { RuleAction } from '@kbn/securitysolution-io-ts-alerting-types'; import type { PartialRule, FindResult } from '@kbn/alerting-plugin/server'; import type { ActionsClient, FindActionResult } from '@kbn/actions-plugin/server'; -import type { RuleToImport } from '../../../../../common/detection_engine/rule_management'; +import type { + FindRulesResponse, + RuleToImport, +} from '../../../../../common/api/detection_engine/rule_management'; import type { AlertSuppression, RuleResponse, AlertSuppressionCamel, -} from '../../../../../common/detection_engine/rule_schema'; +} from '../../../../../common/api/detection_engine/model/rule_schema'; import type { RuleAlertType, RuleParams } from '../../rule_schema'; import { isAlertType } from '../../rule_schema'; @@ -110,14 +113,7 @@ export const transformRuleToExportableFormat = ( return exportedRule; }; -export const transformFindAlerts = ( - ruleFindResults: FindResult -): { - page: number; - perPage: number; - total: number; - data: Array>; -} | null => { +export const transformFindAlerts = (ruleFindResults: FindResult): FindRulesResponse => { return { page: ruleFindResults.page, perPage: ruleFindResults.perPage, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/validate.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/validate.test.ts index 373842fe31860..ce60bf34d2ed8 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/validate.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/validate.test.ts @@ -11,7 +11,7 @@ import { getRuleMock } from '../../routes/__mocks__/request_responses'; import { getListArrayMock } from '../../../../../common/detection_engine/schemas/types/lists.mock'; import { getThreatMock } from '../../../../../common/detection_engine/schemas/types/threat.mock'; import { getQueryRuleParams } from '../../rule_schema/mocks'; -import type { RuleResponse } from '../../../../../common/detection_engine/rule_schema'; +import type { RuleResponse } from '../../../../../common/api/detection_engine/model/rule_schema'; export const ruleOutput = (): RuleResponse => ({ actions: [], diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/validate.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/validate.ts index 4544a735c960f..611a5943dee1f 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/validate.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/utils/validate.ts @@ -21,8 +21,8 @@ import type { QueryRule, RuleCreateProps, RuleUpdateProps, -} from '../../../../../common/detection_engine/rule_schema'; -import { RuleResponse } from '../../../../../common/detection_engine/rule_schema'; +} from '../../../../../common/api/detection_engine/model/rule_schema'; +import { RuleResponse } from '../../../../../common/api/detection_engine/model/rule_schema'; import type { RuleParams, RuleAlertType, UnifiedQueryRuleParams } from '../../rule_schema'; import { isAlertType } from '../../rule_schema'; import type { BulkError } from '../../routes/utils'; @@ -32,7 +32,7 @@ import { internalRuleToAPIResponse } from '../normalization/rule_converters'; import type { ResponseAction, RuleResponseAction, -} from '../../../../../common/detection_engine/rule_response_actions/schemas'; +} from '../../../../../common/api/detection_engine/model/rule_response_actions'; export const transformValidate = ( rule: PartialRule diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/README.md b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/README.md index f8b13affd4082..571604a6fb854 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/README.md +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/README.md @@ -1,3 +1,3 @@ # Detection Engine health API -See [README](../../../../../../common/detection_engine/rule_monitoring/api/detection_engine_health/README.md) in the common folder. +See [README](../../../../../../common/api/detection_engine/rule_monitoring/detection_engine_health/README.md) in the common folder. diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health/get_cluster_health_request.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health/get_cluster_health_request.ts index 162febd917ac7..9ad2b2b5e10a3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health/get_cluster_health_request.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health/get_cluster_health_request.ts @@ -9,7 +9,7 @@ import moment from 'moment'; import type { GetClusterHealthRequest, GetClusterHealthRequestBody, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { validateHealthInterval } from '../health_interval'; export const validateGetClusterHealthRequest = ( diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health/get_cluster_health_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health/get_cluster_health_route.ts index 175813b020bca..fe25e7d93c870 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health/get_cluster_health_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health/get_cluster_health_route.ts @@ -14,11 +14,11 @@ import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import type { GetClusterHealthRequest, GetClusterHealthResponse, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { GET_CLUSTER_HEALTH_URL, GetClusterHealthRequestBody, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import type { IDetectionEngineHealthClient } from '../../../logic/detection_engine_health'; import { calculateHealthTimings } from '../health_timings'; import { validateGetClusterHealthRequest } from './get_cluster_health_request'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_rule_health/get_rule_health_request.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_rule_health/get_rule_health_request.ts index 8a5f0a1dd7f78..ed5e6e2e20a6e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_rule_health/get_rule_health_request.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_rule_health/get_rule_health_request.ts @@ -9,7 +9,7 @@ import moment from 'moment'; import type { GetRuleHealthRequest, GetRuleHealthRequestBody, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { validateHealthInterval } from '../health_interval'; export const validateGetRuleHealthRequest = ( diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_rule_health/get_rule_health_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_rule_health/get_rule_health_route.ts index 71ed3f63c7162..30dbf65e63f3c 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_rule_health/get_rule_health_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_rule_health/get_rule_health_route.ts @@ -7,11 +7,11 @@ import { transformError } from '@kbn/securitysolution-es-utils'; -import type { GetRuleHealthResponse } from '../../../../../../../common/detection_engine/rule_monitoring'; +import type { GetRuleHealthResponse } from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { GetRuleHealthRequestBody, GET_RULE_HEALTH_URL, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import { buildRouteValidation } from '../../../../../../utils/build_validation/route_validation'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health/get_space_health_request.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health/get_space_health_request.ts index d74069c07c8a1..f95d7a1fe2439 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health/get_space_health_request.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health/get_space_health_request.ts @@ -9,7 +9,7 @@ import moment from 'moment'; import type { GetSpaceHealthRequest, GetSpaceHealthRequestBody, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { validateHealthInterval } from '../health_interval'; export const validateGetSpaceHealthRequest = ( diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health/get_space_health_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health/get_space_health_route.ts index 3171c99a65085..9d59ed97ba60f 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health/get_space_health_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health/get_space_health_route.ts @@ -14,11 +14,11 @@ import type { SecuritySolutionPluginRouter } from '../../../../../../types'; import type { GetSpaceHealthRequest, GetSpaceHealthResponse, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { GET_SPACE_HEALTH_URL, GetSpaceHealthRequestBody, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import type { IDetectionEngineHealthClient } from '../../../logic/detection_engine_health'; import { calculateHealthTimings } from '../health_timings'; import { validateGetSpaceHealthRequest } from './get_space_health_request'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/health_interval.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/health_interval.ts index b6eb276c4f849..560c21f4fa063 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/health_interval.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/health_interval.ts @@ -10,11 +10,11 @@ import moment from 'moment'; import type { HealthInterval, HealthIntervalParameters, -} from '../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../common/api/detection_engine/rule_monitoring'; import { HealthIntervalGranularity, HealthIntervalType, -} from '../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../common/api/detection_engine/rule_monitoring'; import { assertUnreachable } from '../../../../../../common/utility_types'; const DEFAULT_INTERVAL_PARAMETERS: HealthIntervalParameters = { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/health_timings.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/health_timings.ts index edbfa1ce8f834..903c72a36afd3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/health_timings.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/health_timings.ts @@ -7,7 +7,7 @@ import moment from 'moment'; import type { IsoDateString } from '@kbn/securitysolution-io-ts-types'; -import type { HealthTimings } from '../../../../../../common/detection_engine/rule_monitoring'; +import type { HealthTimings } from '../../../../../../common/api/detection_engine/rule_monitoring'; export const calculateHealthTimings = (requestReceivedAt: IsoDateString): HealthTimings => { const requestedAt = moment(requestReceivedAt); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/setup/setup_health_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/setup/setup_health_route.ts index 4d4face86b825..40d3d9d88192e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/setup/setup_health_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/detection_engine_health/setup/setup_health_route.ts @@ -9,7 +9,7 @@ import { transformError } from '@kbn/securitysolution-es-utils'; import { buildSiemResponse } from '../../../../routes/utils'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; -import { SETUP_HEALTH_URL } from '../../../../../../../common/detection_engine/rule_monitoring'; +import { SETUP_HEALTH_URL } from '../../../../../../../common/api/detection_engine/rule_monitoring'; /** * Similar to the "setup" command of beats, this endpoint installs resources diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.test.ts index 1f5d01387fce9..c01f09f1b0534 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.test.ts @@ -11,8 +11,8 @@ import { GET_RULE_EXECUTION_EVENTS_URL, LogLevel, RuleExecutionEventType, -} from '../../../../../../../common/detection_engine/rule_monitoring'; -import { getRuleExecutionEventsResponseMock } from '../../../../../../../common/detection_engine/rule_monitoring/mocks'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; +import { getRuleExecutionEventsResponseMock } from '../../../../../../../common/api/detection_engine/rule_monitoring/mocks'; import type { GetExecutionEventsArgs } from '../../../logic/rule_execution_log'; import { getRuleExecutionEventsRoute } from './get_rule_execution_events_route'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.ts index 9c7fb1f130af5..b0170d2a8a763 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.ts @@ -10,12 +10,12 @@ import { buildRouteValidation } from '../../../../../../utils/build_validation/r import { buildSiemResponse } from '../../../../routes/utils'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; -import type { GetRuleExecutionEventsResponse } from '../../../../../../../common/detection_engine/rule_monitoring'; +import type { GetRuleExecutionEventsResponse } from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { GET_RULE_EXECUTION_EVENTS_URL, GetRuleExecutionEventsRequestParams, GetRuleExecutionEventsRequestQuery, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; /** * Returns execution events of a given rule (e.g. status changes) from Event Log. diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.test.ts index 5eec91d39e6df..af4afd399479e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.test.ts @@ -7,8 +7,8 @@ import { serverMock, requestContextMock, requestMock } from '../../../../routes/__mocks__'; -import { GET_RULE_EXECUTION_RESULTS_URL } from '../../../../../../../common/detection_engine/rule_monitoring'; -import { getRuleExecutionResultsResponseMock } from '../../../../../../../common/detection_engine/rule_monitoring/mocks'; +import { GET_RULE_EXECUTION_RESULTS_URL } from '../../../../../../../common/api/detection_engine/rule_monitoring'; +import { getRuleExecutionResultsResponseMock } from '../../../../../../../common/api/detection_engine/rule_monitoring/mocks'; import { getRuleExecutionResultsRoute } from './get_rule_execution_results_route'; describe('getRuleExecutionResultsRoute', () => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.ts index 5eaec11a3a709..98ab544835bb5 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.ts @@ -10,12 +10,12 @@ import { buildRouteValidation } from '../../../../../../utils/build_validation/r import { buildSiemResponse } from '../../../../routes/utils'; import type { SecuritySolutionPluginRouter } from '../../../../../../types'; -import type { GetRuleExecutionResultsResponse } from '../../../../../../../common/detection_engine/rule_monitoring'; +import type { GetRuleExecutionResultsResponse } from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { GET_RULE_EXECUTION_RESULTS_URL, GetRuleExecutionResultsRequestParams, GetRuleExecutionResultsRequestQuery, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; /** * Returns execution results of a given rule (aggregated by execution UUID) from Event Log. diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/README.md b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/README.md index 8f19a0759c7eb..c7e9c7ba9d687 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/README.md +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/README.md @@ -1,6 +1,6 @@ # Detection Engine health logic -See [README](../../../../../../common/detection_engine/rule_monitoring/api/detection_engine_health/README.md) in the common folder for info about the Detection Engine health API. +See [README](../../../../../../common/api/detection_engine/rule_monitoring/detection_engine_health/README.md) in the common folder for info about the Detection Engine health API. This logic provides the following functionality via the `IDetectionEngineHealthClient` interface: @@ -34,15 +34,15 @@ Only a few adjustments would need to be done after that manually in the source f - the dashboard's id has to be updated to `security-detection-rule-monitoring-` - you have to make sure the references to tags are specified correctly: - ```json - { - "id": "fleet-managed-", - "name": "tag-ref-fleet-managed", - "type": "tag" - }, - { - "id": "security-solution-", - "name": "tag-ref-security-solution", - "type": "tag" - } - ``` + ```json + { + "id": "fleet-managed-", + "name": "tag-ref-fleet-managed", + "type": "tag" + }, + { + "id": "security-solution-", + "name": "tag-ref-security-solution", + "type": "tag" + } + ``` diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/__mocks__/index.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/__mocks__/index.ts index 306bd5f624439..7e69c129f4de0 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/__mocks__/index.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/__mocks__/index.ts @@ -9,7 +9,7 @@ import { clusterHealthSnapshotMock, ruleHealthSnapshotMock, spaceHealthSnapshotMock, -} from '../../../../../../../common/detection_engine/rule_monitoring/mocks'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring/mocks'; import type { IDetectionEngineHealthClient } from '../detection_engine_health_client_interface'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/detection_engine_health_client.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/detection_engine_health_client.ts index 8adfbf1ad21e8..af7066dfa780c 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/detection_engine_health_client.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/detection_engine_health_client.ts @@ -16,7 +16,7 @@ import type { RuleHealthSnapshot, SpaceHealthParameters, SpaceHealthSnapshot, -} from '../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../common/api/detection_engine/rule_monitoring'; import type { IEventLogHealthClient } from './event_log/event_log_health_client'; import type { IRuleObjectsHealthClient } from './rule_objects/rule_objects_health_client'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/detection_engine_health_client_interface.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/detection_engine_health_client_interface.ts index e55768c1a352f..6635682675488 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/detection_engine_health_client_interface.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/detection_engine_health_client_interface.ts @@ -12,7 +12,7 @@ import type { RuleHealthSnapshot, SpaceHealthParameters, SpaceHealthSnapshot, -} from '../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../common/api/detection_engine/rule_monitoring'; /** * Calculates health of the Detection Engine overall and detection rules individually. diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/event_log/aggregations/health_stats_for_rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/event_log/aggregations/health_stats_for_rule.ts index b02d6f3aad981..7704bdd3f2441 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/event_log/aggregations/health_stats_for_rule.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/event_log/aggregations/health_stats_for_rule.ts @@ -13,7 +13,7 @@ import type { RuleHealthSnapshot, RuleHealthStatsOverInterval, StatsHistory, -} from '../../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../../common/api/detection_engine/rule_monitoring'; import type { RawData } from '../../../utils/normalization'; import * as f from '../../../event_log/event_log_fields'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/event_log/aggregations/rule_execution_stats.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/event_log/aggregations/rule_execution_stats.ts index 16e3ccf5bc25d..fe5da1322fc45 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/event_log/aggregations/rule_execution_stats.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/event_log/aggregations/rule_execution_stats.ts @@ -15,12 +15,12 @@ import type { NumberOfLoggedMessages, RuleExecutionStats, TopMessages, -} from '../../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../../common/api/detection_engine/rule_monitoring'; import { RuleExecutionEventType, RuleExecutionStatus, LogLevel, -} from '../../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../../common/api/detection_engine/rule_monitoring'; import { DEFAULT_PERCENTILES } from '../../../utils/es_aggregations'; import type { RawData } from '../../../utils/normalization'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/event_log/event_log_health_client.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/event_log/event_log_health_client.ts index 763ce36a47099..f4a164629a618 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/event_log/event_log_health_client.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/event_log/event_log_health_client.ts @@ -14,7 +14,7 @@ import type { RuleHealthSnapshot, SpaceHealthParameters, SpaceHealthSnapshot, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import * as f from '../../event_log/event_log_fields'; import { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/aggregations/health_stats_for_space.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/aggregations/health_stats_for_space.ts index 9f3dc9eab9da3..aba4e6153ad34 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/aggregations/health_stats_for_space.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/aggregations/health_stats_for_space.ts @@ -6,7 +6,7 @@ */ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; -import type { SpaceHealthStatsAtTheMoment } from '../../../../../../../../common/detection_engine/rule_monitoring'; +import type { SpaceHealthStatsAtTheMoment } from '../../../../../../../../common/api/detection_engine/rule_monitoring'; import { getRuleStatsAggregation, normalizeRuleStatsAggregation } from './rule_stats'; export const getSpaceHealthAggregation = (): Record< diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/aggregations/rule_stats.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/aggregations/rule_stats.ts index 569cd92f177c9..35b75fdbd4e7e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/aggregations/rule_stats.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/aggregations/rule_stats.ts @@ -9,7 +9,7 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import type { RuleStats, TotalEnabledDisabled, -} from '../../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../../common/api/detection_engine/rule_monitoring'; import type { RawData } from '../../../utils/normalization'; export const getRuleStatsAggregation = (): Record< 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 c33455827251e..a2082b548660e 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 @@ -10,7 +10,7 @@ import type { RulesClient } from '@kbn/alerting-plugin/server'; import type { RuleObjectId, RuleResponse, -} from '../../../../../../../common/detection_engine/rule_schema'; +} from '../../../../../../../common/api/detection_engine/model/rule_schema'; import { readRules } from '../../../../rule_management/logic/crud/read_rules'; import { transform } from '../../../../rule_management/utils/utils'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/rule_objects_health_client.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/rule_objects_health_client.ts index 624bd86333552..0ba0ccdeaf529 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/rule_objects_health_client.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/rule_objects/rule_objects_health_client.ts @@ -13,7 +13,7 @@ import type { RuleHealthSnapshot, SpaceHealthParameters, SpaceHealthSnapshot, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { getSpaceHealthAggregation, normalizeSpaceHealthAggregationResult, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/event_log/register_event_log_provider.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/event_log/register_event_log_provider.ts index cec9aee84347e..61a321c427205 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/event_log/register_event_log_provider.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/event_log/register_event_log_provider.ts @@ -6,7 +6,7 @@ */ import type { IEventLogService } from '@kbn/event-log-plugin/server'; -import { RuleExecutionEventType } from '../../../../../../common/detection_engine/rule_monitoring'; +import { RuleExecutionEventType } from '../../../../../../common/api/detection_engine/rule_monitoring'; import { RULE_EXECUTION_LOG_PROVIDER } from './event_log_constants'; export const registerEventLogProvider = (eventLogService: IEventLogService) => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/__mocks__/index.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/__mocks__/index.ts index c68eab1baec36..309b970e053f0 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/__mocks__/index.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/__mocks__/index.ts @@ -8,7 +8,7 @@ import { getRuleExecutionEventsResponseMock, getRuleExecutionResultsResponseMock, -} from '../../../../../../../common/detection_engine/rule_monitoring/mocks'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring/mocks'; import type { IRuleExecutionLogForRoutes } from '../client_for_routes/client_interface'; import type { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_executors/client.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_executors/client.ts index 6c1f407eef08e..2d14f62156db8 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_executors/client.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_executors/client.ts @@ -16,14 +16,14 @@ import type { import type { RuleExecutionMetrics, RuleExecutionSettings, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { LogLevel, logLevelFromExecutionStatus, LogLevelSetting, logLevelToNumber, RuleExecutionStatus, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { assertUnreachable } from '../../../../../../../common/utility_types'; import { withSecuritySpan } from '../../../../../../utils/with_security_span'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_executors/client_interface.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_executors/client_interface.ts index 54cad1f72be07..e1d0998a21225 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_executors/client_interface.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_executors/client_interface.ts @@ -6,7 +6,7 @@ */ import type { Duration } from 'moment'; -import type { RuleExecutionStatus } from '../../../../../../../common/detection_engine/rule_monitoring'; +import type { RuleExecutionStatus } from '../../../../../../../common/api/detection_engine/rule_monitoring'; /** * Used from rule executors to log various information about the rule execution: diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_executors/correlation_ids.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_executors/correlation_ids.ts index c74d762e150b8..1c3f9860f1fc0 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_executors/correlation_ids.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_executors/correlation_ids.ts @@ -6,7 +6,7 @@ */ import type { ExtMeta } from '../../utils/console_logging'; -import type { RuleExecutionStatus } from '../../../../../../../common/detection_engine/rule_monitoring'; +import type { RuleExecutionStatus } from '../../../../../../../common/api/detection_engine/rule_monitoring'; import type { RuleExecutionContext } from './client_interface'; export interface ICorrelationIds { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_routes/client.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_routes/client.ts index 78792722155fa..4c895459c5794 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_routes/client.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_routes/client.ts @@ -10,7 +10,7 @@ import type { Logger } from '@kbn/core/server'; import type { GetRuleExecutionEventsResponse, GetRuleExecutionResultsResponse, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { withSecuritySpan } from '../../../../../../utils/with_security_span'; import type { IEventLogReader } from '../event_log/event_log_reader'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_routes/client_interface.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_routes/client_interface.ts index 20e73f46e11bd..436ddd91bd595 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_routes/client_interface.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/client_for_routes/client_interface.ts @@ -12,9 +12,9 @@ import type { RuleExecutionEventType, RuleExecutionStatus, SortFieldOfRuleExecutionResult, -} from '../../../../../../../common/detection_engine/rule_monitoring'; -import type { RuleObjectId } from '../../../../../../../common/detection_engine/rule_schema'; -import type { SortOrder } from '../../../../../../../common/detection_engine/schemas/common'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; +import type { RuleObjectId } from '../../../../../../../common/api/detection_engine/model/rule_schema'; +import type { SortOrder } from '../../../../../../../common/api/detection_engine'; /** * Used from route handlers to fetch and manage various information about the rule execution: diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/create_rule_execution_summary.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/create_rule_execution_summary.ts index 3818ca1403e63..7dbac0ded96e5 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/create_rule_execution_summary.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/create_rule_execution_summary.ts @@ -7,12 +7,12 @@ import type { ResolvedSanitizedRule, SanitizedRule } from '@kbn/alerting-plugin/common'; -import type { RuleExecutionSummary } from '../../../../../../common/detection_engine/rule_monitoring'; +import type { RuleExecutionSummary } from '../../../../../../common/api/detection_engine/rule_monitoring'; import { ruleLastRunOutcomeToExecutionStatus, ruleExecutionStatusToNumber, RuleExecutionStatus, -} from '../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../common/api/detection_engine/rule_monitoring'; import type { RuleParams } from '../../../rule_schema'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/aggregations/execution_results/index.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/aggregations/execution_results/index.test.ts index f72630fba68fe..234eac9d594e6 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/aggregations/execution_results/index.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/aggregations/execution_results/index.test.ts @@ -13,7 +13,7 @@ */ import { MAX_EXECUTION_EVENTS_DISPLAYED } from '@kbn/securitysolution-rules'; -import { RuleExecutionStatus } from '../../../../../../../../../common/detection_engine/rule_monitoring'; +import { RuleExecutionStatus } from '../../../../../../../../../common/api/detection_engine/rule_monitoring'; import { formatExecutionEventResponse, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/aggregations/execution_results/index.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/aggregations/execution_results/index.ts index c215478ff85d4..d2077208e718e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/aggregations/execution_results/index.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/aggregations/execution_results/index.ts @@ -14,8 +14,8 @@ import type { AggregateEventsBySavedObjectResult } from '@kbn/event-log-plugin/s import type { RuleExecutionResult, GetRuleExecutionResultsResponse, -} from '../../../../../../../../../common/detection_engine/rule_monitoring'; -import { RuleExecutionStatus } from '../../../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../../../common/api/detection_engine/rule_monitoring'; +import { RuleExecutionStatus } from '../../../../../../../../../common/api/detection_engine/rule_monitoring'; import type { ExecutionEventAggregationOptions, ExecutionUuidAggResult, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/event_log_reader.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/event_log_reader.ts index edebe65f28023..03871248ff5be 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/event_log_reader.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/event_log_reader.ts @@ -13,13 +13,13 @@ import type { GetRuleExecutionEventsResponse, GetRuleExecutionResultsResponse, RuleExecutionEvent, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { LogLevel, logLevelFromString, RuleExecutionEventType, ruleExecutionEventTypeFromString, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { assertUnreachable } from '../../../../../../../common/utility_types'; import { invariant } from '../../../../../../../common/utils/invariant'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/event_log_writer.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/event_log_writer.ts index e9fffaca8e916..dfd01f5ad80af 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/event_log_writer.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/event_log/event_log_writer.ts @@ -11,14 +11,14 @@ import { SAVED_OBJECT_REL_PRIMARY } from '@kbn/event-log-plugin/server'; import type { RuleExecutionMetrics, RuleExecutionStatus, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { LogLevel, logLevelFromExecutionStatus, logLevelToNumber, RuleExecutionEventType, ruleExecutionStatusToNumber, -} from '../../../../../../../common/detection_engine/rule_monitoring'; +} from '../../../../../../../common/api/detection_engine/rule_monitoring'; import { RULE_SAVED_OBJECT_TYPE, RULE_EXECUTION_LOG_PROVIDER, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/execution_settings/fetch_rule_execution_settings.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/execution_settings/fetch_rule_execution_settings.ts index a73dba17b6b9f..387e1ef34fd2f 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/execution_settings/fetch_rule_execution_settings.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/rule_execution_log/execution_settings/fetch_rule_execution_settings.ts @@ -14,8 +14,8 @@ import { EXTENDED_RULE_EXECUTION_LOGGING_ENABLED_SETTING, EXTENDED_RULE_EXECUTION_LOGGING_MIN_LEVEL_SETTING, } from '../../../../../../../common/constants'; -import type { RuleExecutionSettings } from '../../../../../../../common/detection_engine/rule_monitoring'; -import { LogLevelSetting } from '../../../../../../../common/detection_engine/rule_monitoring'; +import type { RuleExecutionSettings } from '../../../../../../../common/api/detection_engine/rule_monitoring'; +import { LogLevelSetting } from '../../../../../../../common/api/detection_engine/rule_monitoring'; export const fetchRuleExecutionSettings = async ( config: ConfigType, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/utils/console_logging.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/utils/console_logging.ts index aeb63125e64f0..ae99f790576de 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/utils/console_logging.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/utils/console_logging.ts @@ -6,7 +6,7 @@ */ import type { LogMeta } from '@kbn/core/server'; -import type { RuleExecutionStatus } from '../../../../../../common/detection_engine/rule_monitoring'; +import type { RuleExecutionStatus } from '../../../../../../common/api/detection_engine/rule_monitoring'; /** * Extended metadata that rule execution logger can attach to every console log record. diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts index e1107e7ae135b..b7fdea9661809 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts @@ -8,7 +8,7 @@ import moment from 'moment'; import { v4 as uuidv4 } from 'uuid'; import { transformError } from '@kbn/securitysolution-es-utils'; import { QUERY_RULE_TYPE_ID, SAVED_QUERY_RULE_TYPE_ID } from '@kbn/securitysolution-rules'; -import type { Logger, StartServicesAccessor } from '@kbn/core/server'; +import type { Logger, StartServicesAccessor, IKibanaResponse } from '@kbn/core/server'; import type { IRuleDataClient } from '@kbn/rule-registry-plugin/server'; import type { AlertInstanceContext, @@ -23,10 +23,13 @@ import { DEFAULT_PREVIEW_INDEX, DETECTION_ENGINE_RULES_PREVIEW, } from '../../../../../../common/constants'; -import { validateCreateRuleProps } from '../../../../../../common/detection_engine/rule_management'; -import { RuleExecutionStatus } from '../../../../../../common/detection_engine/rule_monitoring'; -import type { RulePreviewLogs } from '../../../../../../common/detection_engine/rule_schema'; -import { previewRulesSchema } from '../../../../../../common/detection_engine/rule_schema'; +import { validateCreateRuleProps } from '../../../../../../common/api/detection_engine/rule_management'; +import { RuleExecutionStatus } from '../../../../../../common/api/detection_engine/rule_monitoring'; +import type { + PreviewResponse, + RulePreviewLogs, +} from '../../../../../../common/api/detection_engine/model/rule_schema'; +import { previewRulesSchema } from '../../../../../../common/api/detection_engine/model/rule_schema'; import type { StartPlugins, SetupPlugins } from '../../../../../plugin'; import { buildSiemResponse } from '../../../routes/utils'; @@ -85,7 +88,7 @@ export const previewRulesRoute = async ( tags: ['access:securitySolution', routeLimitedConcurrencyTag(MAX_ROUTE_CONCURRENCY)], }, }, - async (context, request, response) => { + async (context, request, response): Promise> => { const siemResponse = buildSiemResponse(response); const validationErrors = validateCreateRuleProps(request.body); const coreContext = await context.core; @@ -102,7 +105,11 @@ export const previewRulesRoute = async ( let invocationCount = request.body.invocationCount; if (invocationCount < 1) { return response.ok({ - body: { logs: [{ errors: ['Invalid invocation count'], warnings: [], duration: 0 }] }, + body: { + logs: [{ errors: ['Invalid invocation count'], warnings: [], duration: 0 }], + previewId: undefined, + isAborted: undefined, + }, }); } @@ -153,6 +160,8 @@ export const previewRulesRoute = async ( duration: 0, }, ], + previewId: undefined, + isAborted: undefined, }, }); } diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/endpoint_response_action.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/endpoint_response_action.ts index 41063bc436e00..f6c3161921934 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/endpoint_response_action.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/endpoint_response_action.ts @@ -9,7 +9,7 @@ import { each, map, uniq } from 'lodash'; import { ALERT_RULE_NAME, ALERT_RULE_UUID } from '@kbn/rule-data-utils'; import type { ResponseActionAlerts } from './types'; import type { EndpointAppContextService } from '../../../endpoint/endpoint_app_context_services'; -import type { RuleResponseEndpointAction } from '../../../../common/detection_engine/rule_response_actions/schemas'; +import type { RuleResponseEndpointAction } from '../../../../common/api/detection_engine/model/rule_response_actions'; export const endpointResponseAction = ( responseAction: RuleResponseEndpointAction, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/osquery_response_action.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/osquery_response_action.ts index 7a18ab7571a21..c8dfa113af6a4 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/osquery_response_action.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/osquery_response_action.ts @@ -9,7 +9,7 @@ import { each, map, some, uniq } from 'lodash'; import { containsDynamicQuery } from '@kbn/osquery-plugin/common/utils/replace_params_query'; import type { ResponseActionAlerts } from './types'; import type { SetupPlugins } from '../../../plugin_contract'; -import type { RuleResponseOsqueryAction } from '../../../../common/detection_engine/rule_response_actions/schemas'; +import type { RuleResponseOsqueryAction } from '../../../../common/api/detection_engine/model/rule_response_actions'; export const osqueryResponseAction = ( responseAction: RuleResponseOsqueryAction, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.test.ts index 0c59d720c4af2..fcec7e98c06c2 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.test.ts @@ -6,8 +6,8 @@ */ import { getScheduleNotificationResponseActionsService } from './schedule_notification_response_actions'; -import type { RuleResponseAction } from '../../../../common/detection_engine/rule_response_actions/schemas'; -import { RESPONSE_ACTION_TYPES } from '../../../../common/detection_engine/rule_response_actions/schemas'; +import type { RuleResponseAction } from '../../../../common/api/detection_engine/model/rule_response_actions'; +import { RESPONSE_ACTION_TYPES } from '../../../../common/api/detection_engine/model/rule_response_actions'; describe('ScheduleNotificationResponseActions', () => { const signalOne = { agent: { id: 'agent-id-1' }, _id: 'alert-id-1', user: { id: 'S-1-5-20' } }; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.ts index 06e5f9d120918..25efe01d15f05 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.ts @@ -8,7 +8,7 @@ import { each } from 'lodash'; import type { EndpointAppContextService } from '../../../endpoint/endpoint_app_context_services'; import type { SetupPlugins } from '../../../plugin_contract'; -import { RESPONSE_ACTION_TYPES } from '../../../../common/detection_engine/rule_response_actions/schemas'; +import { RESPONSE_ACTION_TYPES } from '../../../../common/api/detection_engine/model/rule_response_actions'; import { osqueryResponseAction } from './osquery_response_action'; import { endpointResponseAction } from './endpoint_response_action'; import type { ScheduleNotificationActions } from '../rule_types/types'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_schema/model/rule_schemas.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_schema/model/rule_schemas.ts index 0fbddc2a2236c..c851ed9288ea6 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_schema/model/rule_schemas.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_schema/model/rule_schemas.ts @@ -76,14 +76,14 @@ import { TimestampField, TimestampOverride, TimestampOverrideFallbackDisabled, -} from '../../../../../common/detection_engine/rule_schema'; +} from '../../../../../common/api/detection_engine/model/rule_schema'; import { savedIdOrUndefined, saved_id, anomaly_threshold, -} from '../../../../../common/detection_engine/schemas/common'; +} from '../../../../../common/api/detection_engine'; import { SERVER_APP_ID } from '../../../../../common/constants'; -import { ResponseActionRuleParamsOrUndefined } from '../../../../../common/detection_engine/rule_response_actions/schemas'; +import { ResponseActionRuleParamsOrUndefined } from '../../../../../common/api/detection_engine/model/rule_response_actions'; const nonEqlLanguages = t.keyof({ kuery: null, lucene: null }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/threshold.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/threshold.ts index 399a80f4b9101..c16fced1112cd 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/threshold.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/threshold.ts @@ -27,7 +27,7 @@ import { flattenWithPrefix } from '@kbn/securitysolution-rules'; import type { TypeOfFieldMap } from '@kbn/rule-registry-plugin/common/field_map'; import { SERVER_APP_ID } from '../../../../../common/constants'; -import { ANCHOR_DATE } from '../../../../../common/detection_engine/rule_schema/mocks'; +import { ANCHOR_DATE } from '../../../../../common/api/detection_engine/model/rule_schema/mocks'; import { getListArrayMock } from '../../../../../common/detection_engine/schemas/types/lists.mock'; import type { RulesFieldMap } from '../../../../../common/field_maps'; import { 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 3b398f9ddf0d9..f542431295c6b 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 @@ -33,7 +33,7 @@ import { getNotificationResultsLink } from '../rule_actions_legacy'; import { formatAlertForNotificationActions } from '../rule_actions_legacy/logic/notifications/schedule_notification_actions'; import { createResultObject } from './utils'; import { bulkCreateFactory, wrapHitsFactory, wrapSequencesFactory } from './factories'; -import { RuleExecutionStatus } from '../../../../common/detection_engine/rule_monitoring'; +import { RuleExecutionStatus } from '../../../../common/api/detection_engine/rule_monitoring'; import { truncateList } from '../rule_monitoring'; import aadFieldConversion from '../routes/index/signal_aad_mapping.json'; import { extractReferences, injectReferences } from './saved_object_references'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/build_alert_group_from_sequence.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/build_alert_group_from_sequence.ts index 92c8e4d749a7d..8db01c11d4de5 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/build_alert_group_from_sequence.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/build_alert_group_from_sequence.ts @@ -28,7 +28,7 @@ import type { EqlBuildingBlockFieldsLatest, EqlShellFieldsLatest, WrappedFieldsLatest, -} from '../../../../../common/detection_engine/schemas/alerts'; +} from '../../../../../common/api/detection_engine/model/alerts'; /** * Takes N raw documents from ES that form a sequence and builds them into N+1 signals ready to be indexed - diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/build_eql_search_request.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/build_eql_search_request.ts index 317cb57402b8b..5110e7fc10c85 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/build_eql_search_request.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/build_eql_search_request.ts @@ -11,7 +11,7 @@ import { isEmpty } from 'lodash/fp'; import type { RuleFilterArray, TimestampOverride, -} from '../../../../../common/detection_engine/rule_schema'; +} from '../../../../../common/api/detection_engine/model/rule_schema'; import { buildTimeRangeFilter } from '../utils/build_events_query'; import { getQueryFilter } from '../utils/get_query_filter'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/eql.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/eql.ts index a55be51eca3a7..475a7f6dcdafe 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/eql.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/eql.ts @@ -38,7 +38,7 @@ import { withSecuritySpan } from '../../../../utils/with_security_span'; import type { BaseFieldsLatest, WrappedFieldsLatest, -} from '../../../../../common/detection_engine/schemas/alerts'; +} from '../../../../../common/api/detection_engine/model/alerts'; import type { IRuleExecutionLogForExecutors } from '../../rule_monitoring'; export const eqlExecutor = async ({ diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/wrap_sequences_factory.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/wrap_sequences_factory.ts index 6c608da5cb5cb..e21f09438e8b8 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/wrap_sequences_factory.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/eql/wrap_sequences_factory.ts @@ -13,7 +13,7 @@ import type { IRuleExecutionLogForExecutors } from '../../rule_monitoring'; import type { BaseFieldsLatest, WrappedFieldsLatest, -} from '../../../../../common/detection_engine/schemas/alerts'; +} from '../../../../../common/api/detection_engine/model/alerts'; export const wrapSequencesFactory = ({ diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/bulk_create_factory.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/bulk_create_factory.ts index 4e16c8378c03c..69c6d5263d3f3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/bulk_create_factory.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/bulk_create_factory.ts @@ -16,7 +16,7 @@ import type { RefreshTypes } from '../../types'; import type { BaseFieldsLatest, WrappedFieldsLatest, -} from '../../../../../common/detection_engine/schemas/alerts'; +} from '../../../../../common/api/detection_engine/model/alerts'; export interface GenericBulkCreateResponse { success: boolean; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_alert.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_alert.ts index 5604c0f9a9a11..2309833a947f0 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_alert.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_alert.ts @@ -85,7 +85,7 @@ import { transformAlertToRuleAction } from '../../../../../../common/detection_e import type { AncestorLatest, BaseFieldsLatest, -} from '../../../../../../common/detection_engine/schemas/alerts'; +} from '../../../../../../common/api/detection_engine/model/alerts'; export const generateAlertId = (alert: BaseFieldsLatest) => { return createHash('sha256') diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_bulk_body.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_bulk_body.ts index 1963837d64bc7..50df9b714c3ca 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_bulk_body.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_bulk_body.ts @@ -20,7 +20,7 @@ import type { IRuleExecutionLogForExecutors } from '../../../rule_monitoring'; import { buildRuleNameFromMapping } from '../../utils/mappings/build_rule_name_from_mapping'; import { buildSeverityFromMapping } from '../../utils/mappings/build_severity_from_mapping'; import { buildRiskScoreFromMapping } from '../../utils/mappings/build_risk_score_from_mapping'; -import type { BaseFieldsLatest } from '../../../../../../common/detection_engine/schemas/alerts'; +import type { BaseFieldsLatest } from '../../../../../../common/api/detection_engine/model/alerts'; import { stripNonEcsFields } from './strip_non_ecs_fields'; const isSourceDoc = ( diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/generate_building_block_ids.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/generate_building_block_ids.ts index 0493424151d84..d4b71e6030373 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/generate_building_block_ids.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/generate_building_block_ids.ts @@ -7,7 +7,7 @@ import { ALERT_RULE_UUID } from '@kbn/rule-data-utils'; import { createHash } from 'crypto'; -import type { BaseFieldsLatest } from '../../../../../../common/detection_engine/schemas/alerts'; +import type { BaseFieldsLatest } from '../../../../../../common/api/detection_engine/model/alerts'; import { ALERT_ANCESTORS } from '../../../../../../common/field_maps/field_names'; /** diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/wrap_hits_factory.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/wrap_hits_factory.ts index a5b56303c603d..4e7c72f7dbf50 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/wrap_hits_factory.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/wrap_hits_factory.ts @@ -15,7 +15,7 @@ import type { BuildReasonMessage } from '../utils/reason_formatters'; import type { BaseFieldsLatest, WrappedFieldsLatest, -} from '../../../../../common/detection_engine/schemas/alerts'; +} from '../../../../../common/api/detection_engine/model/alerts'; import type { IRuleExecutionLogForExecutors } from '../../rule_monitoring'; export const wrapHitsFactory = diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/ml/bulk_create_ml_signals.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/ml/bulk_create_ml_signals.ts index 25ff5cca03f2e..11343645f8ff4 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/ml/bulk_create_ml_signals.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/ml/bulk_create_ml_signals.ts @@ -18,7 +18,7 @@ import type { Anomaly } from '../../../machine_learning'; import type { BulkCreate, WrapHits } from '../types'; import type { CompleteRule, MachineLearningRuleParams } from '../../rule_schema'; import { buildReasonMessageForMlAlert } from '../utils/reason_formatters'; -import type { BaseFieldsLatest } from '../../../../../common/detection_engine/schemas/alerts'; +import type { BaseFieldsLatest } from '../../../../../common/api/detection_engine/model/alerts'; import type { IRuleExecutionLogForExecutors } from '../../rule_monitoring'; import { createEnrichEventsFunction } from '../utils/enrichments'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/new_terms/wrap_new_terms_alerts.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/new_terms/wrap_new_terms_alerts.ts index 2a373edf7de6e..5028c15c2c8d1 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/new_terms/wrap_new_terms_alerts.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/new_terms/wrap_new_terms_alerts.ts @@ -11,7 +11,7 @@ import type { BaseFieldsLatest, NewTermsFieldsLatest, WrappedFieldsLatest, -} from '../../../../../common/detection_engine/schemas/alerts'; +} from '../../../../../common/api/detection_engine/model/alerts'; import { ALERT_NEW_TERMS } from '../../../../../common/field_maps/field_names'; import type { ConfigType } from '../../../../config'; import type { CompleteRule, RuleParams } from '../../rule_schema'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/alert_suppression/bulk_create_with_suppression.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/alert_suppression/bulk_create_with_suppression.ts index 88af364c732a4..110f9848c6d83 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/alert_suppression/bulk_create_with_suppression.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/alert_suppression/bulk_create_with_suppression.ts @@ -18,7 +18,7 @@ import { makeFloatString } from '../../utils/utils'; import type { BaseFieldsLatest, WrappedFieldsLatest, -} from '../../../../../../common/detection_engine/schemas/alerts'; +} from '../../../../../../common/api/detection_engine/model/alerts'; import type { RuleServices } from '../../types'; import { createEnrichEventsFunction } from '../../utils/enrichments'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/alert_suppression/group_and_bulk_create.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/alert_suppression/group_and_bulk_create.ts index b0120fa8466a8..54bc3d0e5cc47 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/alert_suppression/group_and_bulk_create.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/alert_suppression/group_and_bulk_create.ts @@ -29,7 +29,7 @@ import type { BuildReasonMessage } from '../../utils/reason_formatters'; import { AlertSuppressionMissingFieldsStrategy, DEFAULT_SUPPRESSION_MISSING_FIELDS_STRATEGY, -} from '../../../../../../common/detection_engine/rule_schema'; +} from '../../../../../../common/api/detection_engine/model/rule_schema'; import { bulkCreateUnsuppressedAlerts } from './bulk_create_unsuppressed_alerts'; import type { ITelemetryEventsSender } from '../../../../telemetry/sender'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/alert_suppression/wrap_suppressed_alerts.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/alert_suppression/wrap_suppressed_alerts.ts index f3a294e77c16d..e7bfe3f7eaacd 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/alert_suppression/wrap_suppressed_alerts.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/alert_suppression/wrap_suppressed_alerts.ts @@ -18,7 +18,7 @@ import type { SuppressionFieldsLatest } from '@kbn/rule-registry-plugin/common/s import type { BaseFieldsLatest, WrappedFieldsLatest, -} from '../../../../../../common/detection_engine/schemas/alerts'; +} from '../../../../../../common/api/detection_engine/model/alerts'; import type { ConfigType } from '../../../../../config'; import type { CompleteRule, RuleParams } from '../../../rule_schema'; import type { IRuleExecutionLogForExecutors } from '../../../rule_monitoring'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/build_threshold_aggregation.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/build_threshold_aggregation.ts index 1bc2b18860722..a37dd07b5adc3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/build_threshold_aggregation.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/build_threshold_aggregation.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { ThresholdNormalized } from '../../../../../common/detection_engine/rule_schema'; +import type { ThresholdNormalized } from '../../../../../common/api/detection_engine/model/rule_schema'; import { shouldFilterByCardinality } from './utils'; export const buildThresholdMultiBucketAggregation = ({ diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/bulk_create_threshold_signals.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/bulk_create_threshold_signals.test.ts index 1e709b9b47017..950474ffe6866 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/bulk_create_threshold_signals.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/bulk_create_threshold_signals.test.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { ThresholdNormalized } from '../../../../../common/detection_engine/rule_schema'; +import type { ThresholdNormalized } from '../../../../../common/api/detection_engine/model/rule_schema'; import { calculateThresholdSignalUuid } from './utils'; import { getTransformedHits } from './bulk_create_threshold_signals'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/bulk_create_threshold_signals.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/bulk_create_threshold_signals.ts index 1bef127097e60..318ac5bf562b0 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/bulk_create_threshold_signals.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/bulk_create_threshold_signals.ts @@ -12,14 +12,14 @@ import type { AlertInstanceState, RuleExecutorServices, } from '@kbn/alerting-plugin/server'; -import type { ThresholdNormalized } from '../../../../../common/detection_engine/rule_schema'; +import type { ThresholdNormalized } from '../../../../../common/api/detection_engine/model/rule_schema'; import type { GenericBulkCreateResponse } from '../factories/bulk_create_factory'; import { calculateThresholdSignalUuid } from './utils'; import { buildReasonMessageForThresholdAlert } from '../utils/reason_formatters'; import type { ThresholdSignalHistory, ThresholdBucket } from './types'; import type { BulkCreate, WrapHits } from '../types'; import type { CompleteRule, ThresholdRuleParams } from '../../rule_schema'; -import type { BaseFieldsLatest } from '../../../../../common/detection_engine/schemas/alerts'; +import type { BaseFieldsLatest } from '../../../../../common/api/detection_engine/model/alerts'; import { createEnrichEventsFunction } from '../utils/enrichments'; import type { IRuleExecutionLogForExecutors } from '../../rule_monitoring'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/find_threshold_signals.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/find_threshold_signals.ts index e9d7b8901f9a6..214633b8e67db 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/find_threshold_signals.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/find_threshold_signals.ts @@ -17,7 +17,7 @@ import type { ESBoolQuery } from '../../../../../common/typed_json'; import type { ThresholdNormalized, TimestampOverride, -} from '../../../../../common/detection_engine/rule_schema'; +} from '../../../../../common/api/detection_engine/model/rule_schema'; import { singleSearchAfter } from '../utils/single_search_after'; import { buildThresholdMultiBucketAggregation, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/utils.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/utils.ts index 1c4f85e250a1f..6d2273391abe6 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/utils.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/utils.ts @@ -10,7 +10,7 @@ import { v5 as uuidv5 } from 'uuid'; import type { ThresholdNormalized, ThresholdWithCardinality, -} from '../../../../../common/detection_engine/rule_schema'; +} from '../../../../../common/api/detection_engine/model/rule_schema'; export const shouldFilterByCardinality = ( threshold: ThresholdNormalized diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/types.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/types.ts index 6da7119b7f8b9..61ab9a29ee51e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/types.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/types.ts @@ -34,7 +34,7 @@ import type { TypeOfFieldMap } from '@kbn/rule-registry-plugin/common/field_map' import type { Filter, DataViewFieldBase } from '@kbn/es-query'; import type { LicensingPluginSetup } from '@kbn/licensing-plugin/server'; -import type { RuleResponseAction } from '../../../../common/detection_engine/rule_response_actions/schemas'; +import type { RuleResponseAction } from '../../../../common/api/detection_engine/model/rule_response_actions'; import type { ConfigType } from '../../../config'; import type { SetupPlugins } from '../../../plugin'; import type { CompleteRule, RuleParams } from '../rule_schema'; @@ -43,7 +43,7 @@ import type { ITelemetryEventsSender } from '../../telemetry/sender'; import type { IRuleExecutionLogForExecutors, IRuleMonitoringService } from '../rule_monitoring'; import type { RefreshTypes } from '../types'; -import type { Status } from '../../../../common/detection_engine/schemas/common/schemas'; +import type { Status } from '../../../../common/api/detection_engine'; import type { BaseHit, RuleAlertAction, @@ -56,8 +56,8 @@ import type { BaseFieldsLatest, DetectionAlert, WrappedFieldsLatest, -} from '../../../../common/detection_engine/schemas/alerts'; -import type { RuleResponse } from '../../../../common/detection_engine/rule_schema'; +} from '../../../../common/api/detection_engine/model/alerts'; +import type { RuleResponse } from '../../../../common/api/detection_engine/model/rule_schema'; import type { EnrichEvents } from './utils/enrichments/types'; import type { ThresholdResult } from './threshold/types'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/build_events_query.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/build_events_query.ts index 3f0cac4d7089b..c8998a83e11da 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/build_events_query.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/build_events_query.ts @@ -7,7 +7,7 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { isEmpty } from 'lodash'; import type { OverrideBodyQuery } from '../types'; -import type { TimestampOverride } from '../../../../../common/detection_engine/rule_schema'; +import type { TimestampOverride } from '../../../../../common/api/detection_engine/model/rule_schema'; interface BuildEventsSearchQuery { aggregations?: Record; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/enrichments/__mocks__/alerts.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/enrichments/__mocks__/alerts.ts index c1d80cc3975ec..9ffdc8eafd7f9 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/enrichments/__mocks__/alerts.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/enrichments/__mocks__/alerts.ts @@ -48,7 +48,7 @@ import { } from '@kbn/rule-data-utils'; import type { EventsForEnrichment } from '../types'; -import type { BaseFieldsLatest } from '../../../../../../../common/detection_engine/schemas/alerts'; +import type { BaseFieldsLatest } from '../../../../../../../common/api/detection_engine/model/alerts'; import { ALERT_ANCESTORS, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/enrichments/types.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/enrichments/types.ts index 1fe7fa9ecfb20..8d1cf78b23525 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/enrichments/types.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/enrichments/types.ts @@ -11,7 +11,7 @@ import type { Filter } from '@kbn/es-query'; import type { BaseFieldsLatest, WrappedFieldsLatest, -} from '../../../../../../common/detection_engine/schemas/alerts'; +} from '../../../../../../common/api/detection_engine/model/alerts'; import type { RuleServices } from '../../types'; import type { IRuleExecutionLogForExecutors } from '../../../rule_monitoring'; 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 a667f359309ac..abecfbf3968d4 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 @@ -21,8 +21,8 @@ import { assertUnreachable } from '../../../../../common/utility_types'; import type { IndexPatternArray, RuleQuery, -} from '../../../../../common/detection_engine/rule_schema'; -import type { SavedIdOrUndefined } from '../../../../../common/detection_engine/schemas/common/schemas'; +} from '../../../../../common/api/detection_engine/model/rule_schema'; +import type { SavedIdOrUndefined } from '../../../../../common/api/detection_engine'; import type { PartialFilter } from '../../types'; import { withSecuritySpan } from '../../../../utils/with_security_span'; import type { ESBoolQuery } from '../../../../../common/typed_json'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_query_filter.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_query_filter.ts index 096e3c9706bd6..11dd368e165df 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_query_filter.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_query_filter.ts @@ -12,7 +12,7 @@ import type { ESBoolQuery } from '../../../../../common/typed_json'; import type { IndexPatternArray, RuleQuery, -} from '../../../../../common/detection_engine/rule_schema'; +} from '../../../../../common/api/detection_engine/model/rule_schema'; export const getQueryFilter = ({ query, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/mappings/build_risk_score_from_mapping.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/mappings/build_risk_score_from_mapping.ts index 95a7034b5310b..a6540c67170f1 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/mappings/build_risk_score_from_mapping.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/mappings/build_risk_score_from_mapping.ts @@ -8,7 +8,7 @@ import { get } from 'lodash/fp'; import type { RiskScore, RiskScoreMapping } from '@kbn/securitysolution-io-ts-alerting-types'; -import type { RuleMetadata } from '../../../../../../common/detection_engine/rule_schema'; +import type { RuleMetadata } from '../../../../../../common/api/detection_engine/model/rule_schema'; import type { SignalSource } from '../../types'; export interface BuildRiskScoreFromMappingProps { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/mappings/build_rule_name_from_mapping.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/mappings/build_rule_name_from_mapping.ts index 7bc9c987a4d10..d11e81d835ebb 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/mappings/build_rule_name_from_mapping.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/mappings/build_rule_name_from_mapping.ts @@ -12,7 +12,7 @@ import type { RuleMetadata, RuleName, RuleNameOverride, -} from '../../../../../../common/detection_engine/rule_schema'; +} from '../../../../../../common/api/detection_engine/model/rule_schema'; import type { SignalSource } from '../../types'; interface BuildRuleNameFromMappingProps { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/mappings/build_severity_from_mapping.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/mappings/build_severity_from_mapping.ts index 2a25d00e85f22..cad5cd607ef4a 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/mappings/build_severity_from_mapping.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/mappings/build_severity_from_mapping.ts @@ -13,7 +13,7 @@ import type { SeverityMappingItem, } from '@kbn/securitysolution-io-ts-alerting-types'; -import type { RuleMetadata } from '../../../../../../common/detection_engine/rule_schema'; +import type { RuleMetadata } from '../../../../../../common/api/detection_engine/model/rule_schema'; import type { SearchTypes } from '../../../../../../common/detection_engine/types'; import type { SignalSource } from '../../types'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/single_search_after.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/single_search_after.ts index b667791bfd28a..ba91454b3aa02 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/single_search_after.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/single_search_after.ts @@ -14,7 +14,7 @@ import type { import type { SignalSearchResponse, SignalSource, OverrideBodyQuery } from '../types'; import { buildEventsSearchQuery } from './build_events_query'; import { createErrorsFromShard, makeFloatString } from './utils'; -import type { TimestampOverride } from '../../../../../common/detection_engine/rule_schema'; +import type { TimestampOverride } from '../../../../../common/api/detection_engine/model/rule_schema'; import { withSecuritySpan } from '../../../../utils/with_security_span'; import type { IRuleExecutionLogForExecutors } from '../../rule_monitoring'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/utils.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/utils.test.ts index e39573562d277..d507977de11c8 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/utils.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/utils.test.ts @@ -14,7 +14,7 @@ import type { RuleExecutorServicesMock } from '@kbn/alerting-plugin/server/mocks import { alertsMock } from '@kbn/alerting-plugin/server/mocks'; import { listMock } from '@kbn/lists-plugin/server/mocks'; import type { ExceptionListClient } from '@kbn/lists-plugin/server'; -import { RuleExecutionStatus } from '../../../../../common/detection_engine/rule_monitoring'; +import { RuleExecutionStatus } from '../../../../../common/api/detection_engine/rule_monitoring'; import { getListArrayMock } from '../../../../../common/detection_engine/schemas/types/lists.mock'; import { getExceptionListItemSchemaMock } from '@kbn/lists-plugin/common/schemas/response/exception_list_item_schema.mock'; @@ -64,7 +64,7 @@ import { import type { ShardError } from '../../../types'; import { ruleExecutionLogMock } from '../../rule_monitoring/mocks'; import type { GenericBulkCreateResponse } from '../factories'; -import type { BaseFieldsLatest } from '../../../../../common/detection_engine/schemas/alerts'; +import type { BaseFieldsLatest } from '../../../../../common/api/detection_engine/model/alerts'; describe('utils', () => { const anchor = '2020-01-01T06:06:06.666Z'; @@ -83,7 +83,6 @@ describe('utils', () => { clock.restore(); jest.clearAllMocks(); jest.resetAllMocks(); - jest.restoreAllMocks(); }); describe('generateId', () => { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/utils.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/utils.ts index 7f3298b32139f..17d3e0a4876f3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/utils.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/utils.ts @@ -30,9 +30,9 @@ import type { } from '@kbn/alerting-plugin/server'; import { parseDuration } from '@kbn/alerting-plugin/server'; import type { ExceptionListClient, ListClient, ListPluginSetup } from '@kbn/lists-plugin/server'; -import type { TimestampOverride } from '../../../../../common/detection_engine/rule_schema'; -import type { Privilege } from '../../../../../common/detection_engine/schemas/common'; -import { RuleExecutionStatus } from '../../../../../common/detection_engine/rule_monitoring'; +import type { TimestampOverride } from '../../../../../common/api/detection_engine/model/rule_schema'; +import type { Privilege } from '../../../../../common/api/detection_engine'; +import { RuleExecutionStatus } from '../../../../../common/api/detection_engine/rule_monitoring'; import type { BulkResponseErrorAggregation, SignalHit, @@ -61,7 +61,7 @@ import { withSecuritySpan } from '../../../../utils/with_security_span'; import type { BaseFieldsLatest, DetectionAlert, -} from '../../../../../common/detection_engine/schemas/alerts'; +} from '../../../../../common/api/detection_engine/model/alerts'; import { ENABLE_CCS_READ_WARNING_SETTING } from '../../../../../common/constants'; import type { GenericBulkCreateResponse } from '../factories'; diff --git a/x-pack/plugins/security_solution/server/lib/exceptions/api/manage_exceptions/route.ts b/x-pack/plugins/security_solution/server/lib/exceptions/api/manage_exceptions/route.ts index a30745da834ea..8661cf87e2fb6 100644 --- a/x-pack/plugins/security_solution/server/lib/exceptions/api/manage_exceptions/route.ts +++ b/x-pack/plugins/security_solution/server/lib/exceptions/api/manage_exceptions/route.ts @@ -6,6 +6,8 @@ */ import * as t from 'io-ts'; import { v4 as uuidv4 } from 'uuid'; +import type { ExceptionListSchema } from '@kbn/securitysolution-io-ts-list-types'; +import type { IKibanaResponse } from '@kbn/core/server'; import { SHARED_EXCEPTION_LIST_URL } from '../../../../../common/constants'; import type { SecuritySolutionPluginRouter } from '../../../../types'; @@ -41,7 +43,7 @@ export const createSharedExceptionListRoute = (router: SecuritySolutionPluginRou tags: ['access:securitySolution'], }, }, - async (context, request, response) => { + async (context, request, response): Promise> => { const siemResponse = buildSiemResponse(response); const { description, name } = request.body; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/__mocks__/import_timelines.ts b/x-pack/plugins/security_solution/server/lib/timeline/__mocks__/import_timelines.ts index df44d510a7613..eea6d60c739d3 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/__mocks__/import_timelines.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/__mocks__/import_timelines.ts @@ -7,7 +7,7 @@ import { omit } from 'lodash/fp'; import { TimelineId } from '../../../../common/types/timeline'; -import { TimelineType, TimelineStatus } from '../../../../common/types/timeline/api'; +import { TimelineType, TimelineStatus } from '../../../../common/api/timeline'; export const mockDuplicateIdErrors = []; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/__mocks__/request_responses.ts b/x-pack/plugins/security_solution/server/lib/timeline/__mocks__/request_responses.ts index 1a02c4e649722..1fdc16d4aeec3 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/__mocks__/request_responses.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/__mocks__/request_responses.ts @@ -15,16 +15,15 @@ import { TIMELINE_URL, TIMELINE_PREPACKAGED_URL, } from '../../../../common/constants'; -import type { SavedTimeline } from '../../../../common/types/timeline/api'; -import { TimelineType, TimelineStatus } from '../../../../common/types/timeline/api'; - -import { requestMock } from '../../detection_engine/routes/__mocks__'; - import type { + SavedTimeline, patchTimelineSchema, createTimelineSchema, GetTimelineQuery, -} from '../schemas/timelines'; +} from '../../../../common/api/timeline'; +import { TimelineType, TimelineStatus } from '../../../../common/api/timeline'; + +import { requestMock } from '../../detection_engine/routes/__mocks__'; import { getReadables } from '../utils/common'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/__mocks__/resolve_timeline.ts b/x-pack/plugins/security_solution/server/lib/timeline/__mocks__/resolve_timeline.ts index a776826117b7b..b3f2d8adbaba9 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/__mocks__/resolve_timeline.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/__mocks__/resolve_timeline.ts @@ -5,8 +5,8 @@ * 2.0. */ -import type { ResolvedTimelineWithOutcomeSavedObject } from '../../../../common/types/timeline/api'; -import { TimelineStatus, TimelineType } from '../../../../common/types/timeline/api'; +import type { ResolvedTimelineWithOutcomeSavedObject } from '../../../../common/api/timeline'; +import { TimelineStatus, TimelineType } from '../../../../common/api/timeline'; export const mockResolvedSavedObject = { saved_object: { diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/clean_draft_timelines/index.test.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/clean_draft_timelines/index.test.ts index d4b1668d07de4..177f8bc530471 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/clean_draft_timelines/index.test.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/clean_draft_timelines/index.test.ts @@ -6,7 +6,7 @@ */ import type { SecurityPluginSetup } from '@kbn/security-plugin/server'; -import { TimelineType } from '../../../../../../common/types/timeline/api'; +import { TimelineType } from '../../../../../../common/api/timeline'; import { serverMock, @@ -35,7 +35,6 @@ describe('clean draft timelines', () => { beforeEach(() => { jest.resetModules(); jest.resetAllMocks(); - jest.restoreAllMocks(); jest.clearAllMocks(); server = serverMock.create(); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/clean_draft_timelines/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/clean_draft_timelines/index.ts index 936d906b9f6a5..55934342a8cfc 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/clean_draft_timelines/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/clean_draft_timelines/index.ts @@ -22,8 +22,7 @@ import { persistTimeline, } from '../../../saved_object/timelines'; import { draftTimelineDefaults } from '../../../utils/default_timeline'; -import { cleanDraftTimelineSchema } from '../../../schemas/draft_timelines'; -import { TimelineType } from '../../../../../../common/types/timeline/api'; +import { cleanDraftTimelineSchema, TimelineType } from '../../../../../../common/api/timeline'; export const cleanDraftTimelinesRoute = ( router: SecuritySolutionPluginRouter, diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/get_draft_timelines/index.test.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/get_draft_timelines/index.test.ts index 03d4dd51a91dc..fd38d5c4a865d 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/get_draft_timelines/index.test.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/get_draft_timelines/index.test.ts @@ -6,7 +6,7 @@ */ import type { SecurityPluginSetup } from '@kbn/security-plugin/server'; -import { TimelineType } from '../../../../../../common/types/timeline/api'; +import { TimelineType } from '../../../../../../common/api/timeline'; import { serverMock, @@ -34,7 +34,6 @@ describe('get draft timelines', () => { beforeEach(() => { jest.resetModules(); jest.resetAllMocks(); - jest.restoreAllMocks(); jest.clearAllMocks(); server = serverMock.create(); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/get_draft_timelines/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/get_draft_timelines/index.ts index 697de40ca6113..f58b2dc6d6d5f 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/get_draft_timelines/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/draft_timelines/get_draft_timelines/index.ts @@ -16,7 +16,7 @@ import type { SetupPlugins } from '../../../../../plugin'; import { buildRouteValidationWithExcess } from '../../../../../utils/build_validation/route_validation'; import { getDraftTimeline, persistTimeline } from '../../../saved_object/timelines'; import { draftTimelineDefaults } from '../../../utils/default_timeline'; -import { getDraftTimelineSchema } from '../../../schemas/draft_timelines'; +import { getDraftTimelineSchema } from '../../../../../../common/api/timeline'; export const getDraftTimelinesRoute = ( router: SecuritySolutionPluginRouter, diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/notes/delete_note.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/notes/delete_note.ts index bb12c2de04058..6ae4872cc236a 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/notes/delete_note.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/notes/delete_note.ts @@ -17,7 +17,7 @@ import type { ConfigType } from '../../../..'; import { buildSiemResponse } from '../../../detection_engine/routes/utils'; import { buildFrameworkRequest } from '../../utils/common'; -import { deleteNoteSchema } from '../../schemas/notes'; +import { deleteNoteSchema } from '../../../../../common/api/timeline'; import { deleteNote } from '../../saved_object/notes'; export const deleteNoteRoute = ( diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/notes/persist_note.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/notes/persist_note.ts index d72d3a4822d6d..36da9a034cfc3 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/notes/persist_note.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/notes/persist_note.ts @@ -17,7 +17,7 @@ import type { ConfigType } from '../../../..'; import { buildSiemResponse } from '../../../detection_engine/routes/utils'; import { buildFrameworkRequest } from '../../utils/common'; -import { persistNoteSchema } from '../../schemas/notes'; +import { persistNoteSchema } from '../../../../../common/api/timeline'; import { persistNote } from '../../saved_object/notes'; export const persistNoteRoute = ( diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/pinned_events/persist_pinned_event.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/pinned_events/persist_pinned_event.ts index 300b5f3ce36f3..8e68010867d8d 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/pinned_events/persist_pinned_event.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/pinned_events/persist_pinned_event.ts @@ -17,7 +17,7 @@ import type { ConfigType } from '../../../..'; import { buildSiemResponse } from '../../../detection_engine/routes/utils'; import { buildFrameworkRequest } from '../../utils/common'; -import { persistPinnedEventSchema } from '../../schemas/pinned_events'; +import { persistPinnedEventSchema } from '../../../../../common/api/timeline'; import { persistPinnedEventOnTimeline } from '../../saved_object/pinned_events'; export const persistPinnedEventRoute = ( diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/prepackaged_timelines/install_prepackaged_timelines/helpers.test.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/prepackaged_timelines/install_prepackaged_timelines/helpers.test.ts index ab9dd73241810..763833a0ab4e8 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/prepackaged_timelines/install_prepackaged_timelines/helpers.test.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/prepackaged_timelines/install_prepackaged_timelines/helpers.test.ts @@ -22,7 +22,7 @@ import { import * as helpers from './helpers'; import { importTimelines } from '../../timelines/import_timelines/helpers'; import { buildFrameworkRequest } from '../../../utils/common'; -import type { ImportTimelineResultSchema } from '../../../../../../common/types/timeline/api'; +import type { ImportTimelineResultSchema } from '../../../../../../common/api/timeline'; jest.mock('../../timelines/import_timelines/helpers'); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/prepackaged_timelines/install_prepackaged_timelines/helpers.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/prepackaged_timelines/install_prepackaged_timelines/helpers.ts index 78db1d90b01ed..dee31d479e2da 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/prepackaged_timelines/install_prepackaged_timelines/helpers.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/prepackaged_timelines/install_prepackaged_timelines/helpers.ts @@ -8,7 +8,7 @@ import path, { join, resolve } from 'path'; import { Readable } from 'stream'; -import type { ImportTimelineResultSchema } from '../../../../../../common/types/timeline/api'; +import type { ImportTimelineResultSchema } from '../../../../../../common/api/timeline'; import type { FrameworkRequest } from '../../../../framework'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/helpers.test.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/helpers.test.ts index d061efb6b9f37..d444983e7b00a 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/helpers.test.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/helpers.test.ts @@ -9,8 +9,7 @@ import * as module from './helpers'; import { savePinnedEvents } from '../../../saved_object/pinned_events'; import { getNote } from '../../../saved_object/notes'; import type { FrameworkRequest } from '../../../../framework'; -import type { SavedTimeline } from '../../../../../../common/types/timeline/api'; -import type { Note } from '../../../../../../common/types/timeline/note/api'; +import type { SavedTimeline, Note } from '../../../../../../common/api/timeline'; import { mockTemplate, mockTimeline } from '../../../__mocks__/create_timelines'; import { buildFrameworkRequest } from '../../../utils/common'; import type { SecurityPluginSetup } from '@kbn/security-plugin/server'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/helpers.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/helpers.ts index 5addc9c7a1b54..1428f09d39560 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/helpers.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/helpers.ts @@ -10,9 +10,8 @@ import { isEmpty } from 'lodash/fp'; import moment from 'moment'; import { timeline as timelineLib, pinnedEvent as pinnedEventLib } from '../../../saved_object'; import type { FrameworkRequest } from '../../../../framework'; -import type { ResponseTimeline, SavedTimeline } from '../../../../../../common/types/timeline/api'; +import type { ResponseTimeline, SavedTimeline, Note } from '../../../../../../common/api/timeline'; import { persistNotes } from '../../../saved_object/notes/persist_notes'; -import type { Note } from '../../../../../../common/types/timeline/note/api'; interface CreateTimelineProps { frameworkRequest: FrameworkRequest; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/index.test.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/index.test.ts index 568a066397b7d..a510f24a35637 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/index.test.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/index.test.ts @@ -45,7 +45,6 @@ describe('create timelines', () => { beforeEach(() => { jest.resetModules(); jest.resetAllMocks(); - jest.restoreAllMocks(); jest.clearAllMocks(); server = serverMock.create(); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/index.ts index b5407191b22f7..2fe44d49bb84b 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/create_timelines/index.ts @@ -6,6 +6,7 @@ */ import { transformError } from '@kbn/securitysolution-es-utils'; +import type { IKibanaResponse } from '@kbn/core/server'; import type { SecuritySolutionPluginRouter } from '../../../../../types'; import { TIMELINE_URL } from '../../../../../../common/constants'; @@ -16,7 +17,7 @@ import { buildRouteValidationWithExcess } from '../../../../../utils/build_valid import { buildSiemResponse } from '../../../../detection_engine/routes/utils'; -import { createTimelineSchema } from '../../../schemas/timelines'; +import { createTimelineSchema } from '../../../../../../common/api/timeline'; import { buildFrameworkRequest, CompareTimelinesStatus, @@ -24,6 +25,7 @@ import { } from '../../../utils/common'; import { DEFAULT_ERROR } from '../../../utils/failure_cases'; import { createTimelines } from './helpers'; +import type { CreateTimelinesResponse } from '../../../../../../common/api/timeline'; export * from './helpers'; @@ -42,7 +44,7 @@ export const createTimelinesRoute = ( tags: ['access:securitySolution'], }, }, - async (context, request, response) => { + async (context, request, response): Promise> => { const siemResponse = buildSiemResponse(response); try { diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/delete_timelines/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/delete_timelines/index.ts index e8d2725689ccd..12243c6777cae 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/delete_timelines/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/delete_timelines/index.ts @@ -8,7 +8,7 @@ import { transformError } from '@kbn/securitysolution-es-utils'; import { buildRouteValidationWithExcess } from '../../../../../utils/build_validation/route_validation'; import type { ConfigType } from '../../../../..'; -import { deleteTimelinesSchema } from '../../../schemas/timelines/delete_timelines_schema'; +import { deleteTimelinesSchema } from '../../../../../../common/api/timeline'; import type { SecuritySolutionPluginRouter } from '../../../../../types'; import type { SetupPlugins } from '../../../../../plugin'; import { TIMELINE_URL } from '../../../../../../common/constants'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/export_timelines/helpers.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/export_timelines/helpers.ts index e29f9504922c8..4974e6bd0edda 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/export_timelines/helpers.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/export_timelines/helpers.ts @@ -12,9 +12,9 @@ import type { ExportedTimelines, ExportedNotes, ExportTimelineNotFoundError, -} from '../../../../../../common/types/timeline/api'; -import type { Note } from '../../../../../../common/types/timeline/note/api'; -import type { PinnedEvent } from '../../../../../../common/types/timeline/pinned_event/api'; + Note, + PinnedEvent, +} from '../../../../../../common/api/timeline'; import type { FrameworkRequest } from '../../../../framework'; import * as noteLib from '../../../saved_object/notes'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/export_timelines/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/export_timelines/index.ts index 38e34f75db8f5..6c33f81b0c858 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/export_timelines/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/export_timelines/index.ts @@ -14,7 +14,7 @@ import { buildSiemResponse } from '../../../../detection_engine/routes/utils'; import { exportTimelinesQuerySchema, exportTimelinesRequestBodySchema, -} from '../../../schemas/timelines'; +} from '../../../../../../common/api/timeline'; import { buildRouteValidationWithExcess } from '../../../../../utils/build_validation/route_validation'; import { buildFrameworkRequest } from '../../../utils/common'; import type { SetupPlugins } from '../../../../../plugin'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/get_timeline/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/get_timeline/index.ts index 644174148166a..54a44c3e5b4de 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/get_timeline/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/get_timeline/index.ts @@ -17,12 +17,12 @@ import { buildRouteValidationWithExcess } from '../../../../../utils/build_valid import { buildSiemResponse } from '../../../../detection_engine/routes/utils'; import { buildFrameworkRequest } from '../../../utils/common'; -import { getTimelineQuerySchema } from '../../../schemas/timelines'; +import { getTimelineQuerySchema } from '../../../../../../common/api/timeline'; import { getTimelineTemplateOrNull, getTimelineOrNull } from '../../../saved_object/timelines'; import type { TimelineSavedObject, ResolvedTimelineWithOutcomeSavedObject, -} from '../../../../../../common/types/timeline/api'; +} from '../../../../../../common/api/timeline'; export const getTimelineRoute = ( router: SecuritySolutionPluginRouter, diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/get_timelines/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/get_timelines/index.ts index 45f574a703889..1abd8270f3374 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/get_timelines/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/get_timelines/index.ts @@ -21,7 +21,7 @@ import { buildSiemResponse } from '../../../../detection_engine/routes/utils'; import { CustomHttpRequestError } from '../../../../../utils/custom_http_request_error'; import { buildFrameworkRequest, escapeHatch, throwErrors } from '../../../utils/common'; import { getAllTimeline } from '../../../saved_object/timelines'; -import { getTimelinesQuerySchema } from '../../../schemas/timelines'; +import { getTimelinesQuerySchema } from '../../../../../../common/api/timeline'; export const getTimelinesRoute = ( router: SecuritySolutionPluginRouter, diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/create_timelines_stream_from_ndjson.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/create_timelines_stream_from_ndjson.ts index cd520f194cfd9..65f3510c75f8c 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/create_timelines_stream_from_ndjson.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/create_timelines_stream_from_ndjson.ts @@ -19,7 +19,7 @@ import { } from '../../../../../utils/read_stream/create_stream_from_ndjson'; import type { ImportTimelineResponse } from './types'; -import { ImportTimelinesSchemaRt } from '../../../schemas/timelines/import_timelines_schema'; +import { ImportTimelinesSchemaRt } from '../../../../../../common/api/timeline'; import { throwErrors } from '../../../utils/common'; type ErrorFactory = (message: string) => Error; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/helpers.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/helpers.ts index 0a0e91ed6d624..0858df47ac360 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/helpers.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/helpers.ts @@ -11,11 +11,8 @@ import { v4 as uuidv4 } from 'uuid'; import { createPromiseFromStreams } from '@kbn/utils'; import { validate } from '@kbn/securitysolution-io-ts-utils'; -import type { ImportTimelineResultSchema } from '../../../../../../common/types/timeline/api'; -import { - importTimelineResultSchema, - TimelineStatus, -} from '../../../../../../common/types/timeline/api'; +import type { ImportTimelineResultSchema } from '../../../../../../common/api/timeline'; +import { importTimelineResultSchema, TimelineStatus } from '../../../../../../common/api/timeline'; import type { BulkError } from '../../../../detection_engine/routes/utils'; import { createBulkErrorObject } from '../../../../detection_engine/routes/utils'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/index.test.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/index.test.ts index 4e2cd7a6322e6..9f66040d8704b 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/index.test.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/index.test.ts @@ -13,7 +13,7 @@ import { createMockConfig, } from '../../../../detection_engine/routes/__mocks__'; import { TIMELINE_EXPORT_URL } from '../../../../../../common/constants'; -import { TimelineStatus, TimelineType } from '../../../../../../common/types/timeline/api'; +import { TimelineStatus, TimelineType } from '../../../../../../common/api/timeline'; import type { SecurityPluginSetup } from '@kbn/security-plugin/server'; import { @@ -53,7 +53,6 @@ describe('import timelines', () => { beforeEach(() => { jest.resetModules(); jest.resetAllMocks(); - jest.restoreAllMocks(); jest.clearAllMocks(); server = serverMock.create(); @@ -514,7 +513,6 @@ describe('import timeline templates', () => { beforeEach(() => { jest.resetModules(); jest.resetAllMocks(); - jest.restoreAllMocks(); jest.clearAllMocks(); server = serverMock.create(); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/index.ts index 2b30565a9d4a7..11755868b7336 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/index.ts @@ -19,7 +19,7 @@ import { buildRouteValidationWithExcess } from '../../../../../utils/build_valid import { buildSiemResponse } from '../../../../detection_engine/routes/utils'; import { importTimelines } from './helpers'; -import { ImportTimelinesPayloadSchemaRt } from '../../../schemas/timelines/import_timelines_schema'; +import { ImportTimelinesPayloadSchemaRt } from '../../../../../../common/api/timeline'; import { buildFrameworkRequest } from '../../../utils/common'; export { importTimelines } from './helpers'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/types.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/types.ts index fe8c7e8a1e81c..42978ac197c7d 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/types.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/import_timelines/types.ts @@ -6,9 +6,8 @@ */ import type { BulkError } from '../../../../detection_engine/routes/utils'; -import type { SavedTimeline } from '../../../../../../common/types/timeline/api'; +import type { SavedTimeline, Note } from '../../../../../../common/api/timeline'; import type { TimelineStatusActions } from '../../../utils/common'; -import type { Note } from '../../../../../../common/types/timeline/note/api'; export type ImportedTimeline = SavedTimeline & { savedObjectId: string | null; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/patch_timelines/index.test.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/patch_timelines/index.test.ts index 8a168250669f7..bb2ba80526d00 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/patch_timelines/index.test.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/patch_timelines/index.test.ts @@ -42,7 +42,6 @@ describe('update timelines', () => { beforeEach(() => { jest.resetModules(); jest.resetAllMocks(); - jest.restoreAllMocks(); jest.clearAllMocks(); server = serverMock.create(); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/patch_timelines/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/patch_timelines/index.ts index 5413e036237ea..a213a67b1f835 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/patch_timelines/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/patch_timelines/index.ts @@ -6,6 +6,7 @@ */ import { transformError } from '@kbn/securitysolution-es-utils'; +import type { IKibanaResponse } from '@kbn/core/server'; import type { SecuritySolutionPluginRouter } from '../../../../../types'; import { TIMELINE_URL } from '../../../../../../common/constants'; @@ -16,10 +17,11 @@ import type { ConfigType } from '../../../../..'; import { buildSiemResponse } from '../../../../detection_engine/routes/utils'; -import { patchTimelineSchema } from '../../../schemas/timelines/patch_timelines_schema'; +import { patchTimelineSchema } from '../../../../../../common/api/timeline'; import { buildFrameworkRequest, TimelineStatusActions } from '../../../utils/common'; import { createTimelines } from '../create_timelines'; import { CompareTimelinesStatus } from '../../../utils/compare_timelines_status'; +import type { PatchTimelinesResponse } from '../../../../../../common/api/timeline'; export const patchTimelinesRoute = ( router: SecuritySolutionPluginRouter, @@ -36,7 +38,7 @@ export const patchTimelinesRoute = ( tags: ['access:securitySolution'], }, }, - async (context, request, response) => { + async (context, request, response): Promise> => { const siemResponse = buildSiemResponse(response); try { diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/persist_favorite/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/persist_favorite/index.ts index 970959beb8f5b..70dc5ee2449b5 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/persist_favorite/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/persist_favorite/index.ts @@ -18,8 +18,7 @@ import { buildSiemResponse } from '../../../../detection_engine/routes/utils'; import { buildFrameworkRequest } from '../../../utils/common'; import { persistFavorite } from '../../../saved_object/timelines'; -import { TimelineType } from '../../../../../../common/types/timeline/api'; -import { persistFavoriteSchema } from '../../../schemas/timelines/persist_favorite_schema'; +import { TimelineType, persistFavoriteSchema } from '../../../../../../common/api/timeline'; export const persistFavoriteRoute = ( router: SecuritySolutionPluginRouter, diff --git a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/resolve_timeline/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/resolve_timeline/index.ts index 77132f892e39d..75ba2f4ec62cb 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/resolve_timeline/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/routes/timelines/resolve_timeline/index.ts @@ -17,12 +17,12 @@ import { buildRouteValidationWithExcess } from '../../../../../utils/build_valid import { buildSiemResponse } from '../../../../detection_engine/routes/utils'; import { buildFrameworkRequest } from '../../../utils/common'; -import { getTimelineQuerySchema } from '../../../schemas/timelines'; +import { getTimelineQuerySchema } from '../../../../../../common/api/timeline'; import { getTimelineTemplateOrNull, resolveTimelineOrNull } from '../../../saved_object/timelines'; import type { SavedTimeline, ResolvedTimelineWithOutcomeSavedObject, -} from '../../../../../../common/types/timeline/api'; +} from '../../../../../../common/api/timeline'; export const resolveTimelineRoute = ( router: SecuritySolutionPluginRouter, diff --git a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/get_overridable_note.ts b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/get_overridable_note.ts index fcfc3a09e90a1..359482c77dc57 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/get_overridable_note.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/get_overridable_note.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { Note } from '../../../../../common/types/timeline/note/api'; +import type { Note } from '../../../../../common/api/timeline'; import type { FrameworkRequest } from '../../../framework'; import { getNote } from './saved_object'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/persist_notes.ts b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/persist_notes.ts index 6bbb908a6a537..a12aaeb010234 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/persist_notes.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/persist_notes.ts @@ -8,7 +8,7 @@ import type { FrameworkRequest } from '../../../framework'; import { persistNote } from './saved_object'; import { getOverridableNote } from './get_overridable_note'; -import type { Note } from '../../../../../common/types/timeline/note/api'; +import type { Note } from '../../../../../common/api/timeline'; export const persistNotes = async ( frameworkRequest: FrameworkRequest, diff --git a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/saved_object.test.ts b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/saved_object.test.ts index 6b10dfc55dcf6..527c46598e922 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/saved_object.test.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/saved_object.test.ts @@ -6,7 +6,7 @@ */ import type { AuthenticatedUser } from '@kbn/security-plugin/common/model'; -import type { Note } from '../../../../../common/types/timeline/note/api'; +import type { Note } from '../../../../../common/api/timeline'; import { pickSavedNote } from './saved_object'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/saved_object.ts b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/saved_object.ts index a8e367e15b5b5..7169938e335dd 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/saved_object.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/notes/saved_object.ts @@ -22,7 +22,7 @@ import type { BareNote, BareNoteWithoutExternalRefs, ResponseNote, -} from '../../../../../common/types/timeline/note/api'; +} from '../../../../../common/api/timeline'; import { SavedObjectNoteRuntimeType } from '../../../../../common/types/timeline/note/saved_object'; import type { SavedObjectNoteWithoutExternalRefs } from '../../../../../common/types/timeline/note/saved_object'; import type { FrameworkRequest } from '../../../framework'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/pinned_events/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/pinned_events/index.ts index 313ba69a89a11..6dad7e61f0b2e 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/pinned_events/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/pinned_events/index.ts @@ -19,7 +19,7 @@ import type { PinnedEvent, PinnedEventResponse, BarePinnedEventWithoutExternalRefs, -} from '../../../../../common/types/timeline/pinned_event/api'; +} from '../../../../../common/api/timeline'; import { SavedObjectPinnedEventRuntimeType } from '../../../../../common/types/timeline/pinned_event/saved_object'; import type { SavedObjectPinnedEventWithoutExternalRefs } from '../../../../../common/types/timeline/pinned_event/saved_object'; import type { FrameworkRequest } from '../../../framework'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/convert_saved_object_to_savedtimeline.ts b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/convert_saved_object_to_savedtimeline.ts index 6be3c2cff7825..f93d8a5fef73c 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/convert_saved_object_to_savedtimeline.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/convert_saved_object_to_savedtimeline.ts @@ -16,8 +16,8 @@ import { SavedObjectTimelineType, SavedObjectTimelineStatus, } from '../../../../../common/types/timeline/saved_object'; -import type { TimelineSavedObject } from '../../../../../common/types/timeline/api'; -import { TimelineType, TimelineStatus } from '../../../../../common/types/timeline/api'; +import type { TimelineSavedObject } from '../../../../../common/api/timeline'; +import { TimelineType, TimelineStatus } from '../../../../../common/api/timeline'; // TODO: Added to support legacy TimelineType.draft, can be removed in 7.10 const TimelineSavedObjectWithDraftRuntime = intersection([ diff --git a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.test.ts b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.test.ts index fba7c6df2a2a4..67ff652176161 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.test.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.test.ts @@ -19,12 +19,12 @@ import { import { convertSavedObjectToSavedTimeline } from './convert_saved_object_to_savedtimeline'; import { getNotesByTimelineId } from '../notes/saved_object'; import { getAllPinnedEventsByTimelineId } from '../pinned_events'; -import { TimelineType } from '../../../../../common/types/timeline/api'; +import { TimelineType } from '../../../../../common/api/timeline'; import type { AllTimelinesResponse, ResolvedTimelineWithOutcomeSavedObject, SavedTimeline, -} from '../../../../../common/types/timeline/api'; +} from '../../../../../common/api/timeline'; import { mockResolvedSavedObject, mockResolvedTimeline, diff --git a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.ts index 84bb914e290e0..e966a2d9f9f32 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/index.ts @@ -15,9 +15,9 @@ import { import type { AuthenticatedUser } from '@kbn/security-plugin/server'; import { UNAUTHENTICATED_USER } from '../../../../../common/constants'; -import type { Note } from '../../../../../common/types/timeline/note/api'; -import type { PinnedEvent } from '../../../../../common/types/timeline/pinned_event/api'; import type { + Note, + PinnedEvent, AllTimelinesResponse, ExportTimelineNotFoundError, PageInfoTimeline, @@ -32,8 +32,8 @@ import type { TimelineSavedObject, SavedTimeline, TimelineWithoutExternalRefs, -} from '../../../../../common/types/timeline/api'; -import { TimelineStatus, TimelineType } from '../../../../../common/types/timeline/api'; +} from '../../../../../common/api/timeline'; +import { TimelineStatus, TimelineType } from '../../../../../common/api/timeline'; import type { SavedObjectTimelineWithoutExternalRefs } from '../../../../../common/types/timeline/saved_object'; import type { FrameworkRequest } from '../../../framework'; import * as note from '../notes/saved_object'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/pick_saved_timeline.test.ts b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/pick_saved_timeline.test.ts index f47dd4be8d487..98bc33fee3759 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/pick_saved_timeline.test.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/pick_saved_timeline.test.ts @@ -7,9 +7,8 @@ import type { AuthenticatedUser } from '@kbn/security-plugin/common/model'; -import type { SavedTimeline } from '../../../../../common/types/timeline/api'; -import { TimelineStatus, TimelineType } from '../../../../../common/types/timeline/api'; -import type { Note } from '../../../../../common/types/timeline/note/api'; +import type { SavedTimeline, Note } from '../../../../../common/api/timeline'; +import { TimelineStatus, TimelineType } from '../../../../../common/api/timeline'; import { pickSavedTimeline } from './pick_saved_timeline'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/pick_saved_timeline.ts b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/pick_saved_timeline.ts index 93c5aadc26334..bc0c9075887bd 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/pick_saved_timeline.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/saved_object/timelines/pick_saved_timeline.ts @@ -9,8 +9,8 @@ import { isEmpty } from 'lodash/fp'; import type { AuthenticatedUser } from '@kbn/security-plugin/common/model'; import { getUserDisplayName } from '@kbn/user-profile-components'; import { UNAUTHENTICATED_USER } from '../../../../../common/constants'; -import type { SavedTimelineWithSavedObjectId } from '../../../../../common/types/timeline/api'; -import { TimelineType, TimelineStatus } from '../../../../../common/types/timeline/api'; +import type { SavedTimelineWithSavedObjectId } from '../../../../../common/api/timeline'; +import { TimelineType, TimelineStatus } from '../../../../../common/api/timeline'; export const pickSavedTimeline = ( timelineId: string | null, diff --git a/x-pack/plugins/security_solution/server/lib/timeline/saved_object_mappings/timelines.ts b/x-pack/plugins/security_solution/server/lib/timeline/saved_object_mappings/timelines.ts index 4f7df977662f4..d133e9b114f8b 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/saved_object_mappings/timelines.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/saved_object_mappings/timelines.ts @@ -213,6 +213,9 @@ export const timelineSavedObjectMappings: SavedObjectsType['mappings'] = { value: { type: 'text', }, + relation: { + type: 'keyword', + }, }, }, exists: { diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/clean_draft_timelines_schema.ts b/x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/clean_draft_timelines_schema.ts deleted file mode 100644 index 7dd0de2258a6b..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/clean_draft_timelines_schema.ts +++ /dev/null @@ -1,14 +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 * as rt from 'io-ts'; - -import { TimelineTypeLiteralRt } from '../../../../../common/types/timeline/api'; - -export const cleanDraftTimelineSchema = rt.type({ - timelineType: TimelineTypeLiteralRt, -}); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/get_draft_timelines_schema.ts b/x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/get_draft_timelines_schema.ts deleted file mode 100644 index d995bcedbfb2b..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/get_draft_timelines_schema.ts +++ /dev/null @@ -1,14 +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 * as rt from 'io-ts'; - -import { TimelineTypeLiteralRt } from '../../../../../common/types/timeline/api'; - -export const getDraftTimelineSchema = rt.type({ - timelineType: TimelineTypeLiteralRt, -}); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/index.ts deleted file mode 100644 index d98958dee4510..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/index.ts +++ /dev/null @@ -1,9 +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 { cleanDraftTimelineSchema } from './clean_draft_timelines_schema'; -export { getDraftTimelineSchema } from './get_draft_timelines_schema'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/notes/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/schemas/notes/index.ts deleted file mode 100644 index 9aa18b93ef60a..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/notes/index.ts +++ /dev/null @@ -1,28 +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 * as runtimeTypes from 'io-ts'; -import { unionWithNullType } from '../../../../../common/utility_types'; -import { BareNoteSchema } from '../../../../../common/types/timeline/note/api'; - -export const eventNotes = unionWithNullType(runtimeTypes.array(BareNoteSchema)); -export const globalNotes = unionWithNullType(runtimeTypes.array(BareNoteSchema)); - -export const persistNoteSchema = runtimeTypes.intersection([ - runtimeTypes.type({ - note: BareNoteSchema, - }), - runtimeTypes.partial({ - overrideOwner: unionWithNullType(runtimeTypes.boolean), - noteId: unionWithNullType(runtimeTypes.string), - version: unionWithNullType(runtimeTypes.string), - }), -]); - -export const deleteNoteSchema = runtimeTypes.partial({ - noteId: unionWithNullType(runtimeTypes.string), -}); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/pinned_events/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/schemas/pinned_events/index.ts deleted file mode 100644 index e0bd1f95f5953..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/pinned_events/index.ts +++ /dev/null @@ -1,20 +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 * as runtimeTypes from 'io-ts'; -import { unionWithNullType } from '../../../../../common/utility_types'; - -export const pinnedEventIds = unionWithNullType(runtimeTypes.array(runtimeTypes.string)); -export const persistPinnedEventSchema = runtimeTypes.intersection([ - runtimeTypes.type({ - eventId: runtimeTypes.string, - }), - runtimeTypes.partial({ - pinnedEventId: unionWithNullType(runtimeTypes.string), - timelineId: unionWithNullType(runtimeTypes.string), - }), -]); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/create_timelines_schema.ts b/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/create_timelines_schema.ts deleted file mode 100644 index 800fba1477c41..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/create_timelines_schema.ts +++ /dev/null @@ -1,29 +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 * as rt from 'io-ts'; - -import { - SavedTimelineRuntimeType, - TimelineStatusLiteralRt, - TimelineTypeLiteralRt, -} from '../../../../../common/types/timeline/api'; -import { unionWithNullType } from '../../../../../common/utility_types'; - -export const createTimelineSchema = rt.intersection([ - rt.type({ - timeline: SavedTimelineRuntimeType, - }), - rt.partial({ - status: unionWithNullType(TimelineStatusLiteralRt), - timelineId: unionWithNullType(rt.string), - templateTimelineId: unionWithNullType(rt.string), - templateTimelineVersion: unionWithNullType(rt.number), - timelineType: unionWithNullType(TimelineTypeLiteralRt), - version: unionWithNullType(rt.string), - }), -]); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/export_timelines_schema.ts b/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/export_timelines_schema.ts deleted file mode 100644 index 778e692b2c0ed..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/export_timelines_schema.ts +++ /dev/null @@ -1,17 +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 * as rt from 'io-ts'; -import { unionWithNullType } from '../../../../../common/utility_types'; - -export const exportTimelinesQuerySchema = rt.type({ - file_name: rt.string, -}); - -export const exportTimelinesRequestBodySchema = rt.partial({ - ids: unionWithNullType(rt.array(rt.string)), -}); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/get_timelines_schema.ts b/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/get_timelines_schema.ts deleted file mode 100644 index 3fedcab33d83d..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/get_timelines_schema.ts +++ /dev/null @@ -1,28 +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 * as rt from 'io-ts'; -import { - direction, - sortFieldTimeline, - TimelineStatusLiteralRt, - TimelineTypeLiteralRt, -} from '../../../../../common/types/timeline/api'; -import { unionWithNullType } from '../../../../../common/utility_types'; - -const BoolFromString = rt.union([rt.literal('true'), rt.literal('false')]); - -export const getTimelinesQuerySchema = rt.partial({ - only_user_favorite: unionWithNullType(BoolFromString), - page_index: unionWithNullType(rt.string), - page_size: unionWithNullType(rt.string), - search: unionWithNullType(rt.string), - sort_field: sortFieldTimeline, - sort_order: direction, - status: unionWithNullType(TimelineStatusLiteralRt), - timeline_type: unionWithNullType(TimelineTypeLiteralRt), -}); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/import_timelines_schema.ts b/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/import_timelines_schema.ts deleted file mode 100644 index 3858f3886084f..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/import_timelines_schema.ts +++ /dev/null @@ -1,58 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import * as rt from 'io-ts'; - -import { SavedTimelineRuntimeType } from '../../../../../common/types/timeline/api'; -import { unionWithNullType } from '../../../../../common/utility_types'; - -import { eventNotes, globalNotes } from '../notes'; -import { pinnedEventIds } from '../pinned_events'; - -export const ImportTimelinesSchemaRt = rt.intersection([ - SavedTimelineRuntimeType, - rt.type({ - savedObjectId: unionWithNullType(rt.string), - version: unionWithNullType(rt.string), - }), - rt.type({ - globalNotes, - eventNotes, - pinnedEventIds, - }), -]); - -export type ImportTimelinesSchema = rt.TypeOf; - -const ReadableRt = rt.partial({ - _maxListeners: rt.unknown, - _readableState: rt.unknown, - _read: rt.unknown, - readable: rt.boolean, - _events: rt.unknown, - _eventsCount: rt.number, - _data: rt.unknown, - _position: rt.number, - _encoding: rt.string, -}); - -const booleanInString = rt.union([rt.literal('true'), rt.literal('false')]); - -export const ImportTimelinesPayloadSchemaRt = rt.intersection([ - rt.type({ - file: rt.intersection([ - ReadableRt, - rt.type({ - hapi: rt.type({ - filename: rt.string, - headers: rt.unknown, - }), - }), - ]), - }), - rt.partial({ isImmutable: booleanInString }), -]); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/index.ts b/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/index.ts deleted file mode 100644 index a88d6a6741517..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/index.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ -export * from './create_timelines_schema'; -export * from './export_timelines_schema'; -export * from './get_timeline_schema'; -export * from './get_timelines_schema'; -export * from './patch_timelines_schema'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/patch_timelines_schema.ts b/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/patch_timelines_schema.ts deleted file mode 100644 index c5061730c3c54..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/patch_timelines_schema.ts +++ /dev/null @@ -1,17 +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 * as rt from 'io-ts'; - -import { SavedTimelineRuntimeType } from '../../../../../common/types/timeline/api'; -import { unionWithNullType } from '../../../../../common/utility_types'; - -export const patchTimelineSchema = rt.type({ - timeline: SavedTimelineRuntimeType, - timelineId: unionWithNullType(rt.string), - version: unionWithNullType(rt.string), -}); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/utils/check_timelines_status.ts b/x-pack/plugins/security_solution/server/lib/timeline/utils/check_timelines_status.ts index 67ba857db3e29..d1b9ecec79ecb 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/utils/check_timelines_status.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/utils/check_timelines_status.ts @@ -7,11 +7,12 @@ import path, { join, resolve } from 'path'; import * as rt from 'io-ts'; -import type { TimelineSavedObject } from '../../../../common/types/timeline/api'; -import { TimelineSavedToReturnObjectRuntimeType } from '../../../../common/types/timeline/api'; +import type { TimelineSavedObject, ImportTimelinesSchema } from '../../../../common/api/timeline'; +import { + TimelineSavedToReturnObjectRuntimeType, + ImportTimelinesSchemaRt, +} from '../../../../common/api/timeline'; -import type { ImportTimelinesSchema } from '../schemas/timelines/import_timelines_schema'; -import { ImportTimelinesSchemaRt } from '../schemas/timelines/import_timelines_schema'; import { unionWithNullType } from '../../../../common/utility_types'; import type { FrameworkRequest } from '../../framework'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/utils/compare_timelines_status.test.ts b/x-pack/plugins/security_solution/server/lib/timeline/utils/compare_timelines_status.test.ts index dde7440345b15..2cff9c903c734 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/utils/compare_timelines_status.test.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/utils/compare_timelines_status.test.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { TimelineType, TimelineStatus } from '../../../../common/types/timeline/api'; +import { TimelineType, TimelineStatus } from '../../../../common/api/timeline'; import type { FrameworkRequest } from '../../framework'; import { diff --git a/x-pack/plugins/security_solution/server/lib/timeline/utils/compare_timelines_status.ts b/x-pack/plugins/security_solution/server/lib/timeline/utils/compare_timelines_status.ts index 5bf981862e836..ff5f75d232f8c 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/utils/compare_timelines_status.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/utils/compare_timelines_status.ts @@ -9,8 +9,8 @@ import { isEmpty, isInteger } from 'lodash/fp'; import type { TimelineTypeLiteralWithNull, TimelineTypeLiteral, -} from '../../../../common/types/timeline/api'; -import { TimelineType, TimelineStatus } from '../../../../common/types/timeline/api'; +} from '../../../../common/api/timeline'; +import { TimelineType, TimelineStatus } from '../../../../common/api/timeline'; import type { FrameworkRequest } from '../../framework'; import type { TimelineStatusAction } from './common'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/utils/default_timeline.ts b/x-pack/plugins/security_solution/server/lib/timeline/utils/default_timeline.ts index 26819ab457523..3624458c9e7fd 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/utils/default_timeline.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/utils/default_timeline.ts @@ -6,8 +6,8 @@ */ import { defaultHeaders } from './default_timeline_headers'; -import type { SavedTimeline } from '../../../../common/types/timeline/api'; -import { TimelineType, TimelineStatus } from '../../../../common/types/timeline/api'; +import type { SavedTimeline } from '../../../../common/api/timeline'; +import { TimelineType, TimelineStatus } from '../../../../common/api/timeline'; import { Direction } from '../../../../common/search_strategy'; export const draftTimelineDefaults: SavedTimeline = { diff --git a/x-pack/plugins/security_solution/server/lib/timeline/utils/default_timeline_headers.ts b/x-pack/plugins/security_solution/server/lib/timeline/utils/default_timeline_headers.ts index b3122c5c3a05b..b481c392e113b 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/utils/default_timeline_headers.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/utils/default_timeline_headers.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { SavedTimeline } from '../../../../common/types/timeline/api'; +import type { SavedTimeline } from '../../../../common/api/timeline'; export const defaultColumnHeaderType = 'not-filtered'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/utils/failure_cases.test.ts b/x-pack/plugins/security_solution/server/lib/timeline/utils/failure_cases.test.ts index 7e19deb5553d8..29538caef2972 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/utils/failure_cases.test.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/utils/failure_cases.test.ts @@ -25,8 +25,8 @@ import { NOT_ALLOW_UPDATE_STATUS_ERROR_MESSAGE, TEMPLATE_TIMELINE_VERSION_CONFLICT_MESSAGE, } from './failure_cases'; -import type { TimelineSavedObject } from '../../../../common/types/timeline/api'; -import { TimelineStatus, TimelineType } from '../../../../common/types/timeline/api'; +import type { TimelineSavedObject } from '../../../../common/api/timeline'; +import { TimelineStatus, TimelineType } from '../../../../common/api/timeline'; import { mockGetTimelineValue, mockGetTemplateTimelineValue } from '../__mocks__/import_timelines'; describe('failure cases', () => { diff --git a/x-pack/plugins/security_solution/server/lib/timeline/utils/failure_cases.ts b/x-pack/plugins/security_solution/server/lib/timeline/utils/failure_cases.ts index e5dd7095559bc..1062e2b65eade 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/utils/failure_cases.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/utils/failure_cases.ts @@ -6,11 +6,8 @@ */ import { isEmpty } from 'lodash/fp'; -import type { - TimelineTypeLiteral, - TimelineSavedObject, -} from '../../../../common/types/timeline/api'; -import { TimelineStatus } from '../../../../common/types/timeline/api'; +import type { TimelineTypeLiteral, TimelineSavedObject } from '../../../../common/api/timeline'; +import { TimelineStatus } from '../../../../common/api/timeline'; export const UPDATE_TIMELINE_ERROR_MESSAGE = 'You cannot create new timelines with PATCH. Use POST instead.'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/utils/timeline_object.ts b/x-pack/plugins/security_solution/server/lib/timeline/utils/timeline_object.ts index 37560838311ea..d7e8e240fea1d 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/utils/timeline_object.ts +++ b/x-pack/plugins/security_solution/server/lib/timeline/utils/timeline_object.ts @@ -5,11 +5,8 @@ * 2.0. */ -import type { - TimelineSavedObject, - TimelineTypeLiteral, -} from '../../../../common/types/timeline/api'; -import { TimelineType, TimelineStatus } from '../../../../common/types/timeline/api'; +import type { TimelineSavedObject, TimelineTypeLiteral } from '../../../../common/api/timeline'; +import { TimelineType, TimelineStatus } from '../../../../common/api/timeline'; import type { FrameworkRequest } from '../../framework'; import { getTimelineOrNull, getTimelineTemplateOrNull } from '../saved_object/timelines'; diff --git a/x-pack/plugins/security_solution/server/ui_settings.ts b/x-pack/plugins/security_solution/server/ui_settings.ts index 0ee1d4e9e676e..f5ff542a7833f 100644 --- a/x-pack/plugins/security_solution/server/ui_settings.ts +++ b/x-pack/plugins/security_solution/server/ui_settings.ts @@ -38,7 +38,7 @@ import { DEFAULT_ALERT_TAGS_VALUE, } from '../common/constants'; import type { ExperimentalFeatures } from '../common/experimental_features'; -import { LogLevelSetting } from '../common/detection_engine/rule_monitoring'; +import { LogLevelSetting } from '../common/api/detection_engine/rule_monitoring'; type SettingsConfig = Record>; diff --git a/x-pack/plugins/security_solution/server/utils/read_stream/create_stream_from_ndjson.ts b/x-pack/plugins/security_solution/server/utils/read_stream/create_stream_from_ndjson.ts index e04ecd40ef04a..f9f1066019714 100644 --- a/x-pack/plugins/security_solution/server/utils/read_stream/create_stream_from_ndjson.ts +++ b/x-pack/plugins/security_solution/server/utils/read_stream/create_stream_from_ndjson.ts @@ -9,7 +9,7 @@ import { Transform } from 'stream'; import { has, isString } from 'lodash/fp'; import { createMapStream, createFilterStream } from '@kbn/utils'; -import type { RuleToImport } from '../../../common/detection_engine/rule_management'; +import type { RuleToImport } from '../../../common/api/detection_engine/rule_management'; export interface RulesObjectsExportResultDetails { /** number of successfully exported objects */ diff --git a/x-pack/plugins/security_solution/tsconfig.json b/x-pack/plugins/security_solution/tsconfig.json index bb7c6ce5ea4b6..01987641931a7 100644 --- a/x-pack/plugins/security_solution/tsconfig.json +++ b/x-pack/plugins/security_solution/tsconfig.json @@ -83,7 +83,6 @@ "@kbn/guided-onboarding-plugin", "@kbn/i18n-react", "@kbn/kibana-react-plugin", - "@kbn/core-chrome-browser", "@kbn/ecs-data-quality-dashboard", "@kbn/elastic-assistant", "@kbn/data-views-plugin", @@ -155,13 +154,13 @@ "@kbn/core-analytics-server", "@kbn/analytics-client", "@kbn/security-solution-side-nav", - "@kbn/core-lifecycle-browser", "@kbn/ecs", "@kbn/url-state", "@kbn/ml-anomaly-utils", "@kbn/discover-plugin", "@kbn/field-formats-plugin", "@kbn/dev-proc-runner", - "@kbn/cloud-chat-plugin" + "@kbn/cloud-chat-plugin", + "@kbn/alerts-ui-shared" ] } diff --git a/x-pack/plugins/ess_security/.gitignore b/x-pack/plugins/security_solution_ess/.gitignore similarity index 100% rename from x-pack/plugins/ess_security/.gitignore rename to x-pack/plugins/security_solution_ess/.gitignore diff --git a/x-pack/plugins/security_solution_ess/README.md b/x-pack/plugins/security_solution_ess/README.md new file mode 100755 index 0000000000000..de7339892f750 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/README.md @@ -0,0 +1,3 @@ +# securitySolutionEss + +This plugin contains the ESS/on-prem deployments (non-serverless) specific logic for Security Solution. \ No newline at end of file diff --git a/x-pack/plugins/security_solution_ess/common/index.ts b/x-pack/plugins/security_solution_ess/common/index.ts new file mode 100644 index 0000000000000..b3541827fd117 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/common/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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export const PLUGIN_ID = 'securitySolutionEss'; +export const PLUGIN_NAME = 'securitySolutionEss'; diff --git a/x-pack/plugins/security_solution_ess/jest.config.dev.js b/x-pack/plugins/security_solution_ess/jest.config.dev.js new file mode 100644 index 0000000000000..6ac2f96f95f04 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/jest.config.dev.js @@ -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. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../', + projects: ['/x-pack/plugins/security_solution_ess/public/jest.config.js'], +}; diff --git a/x-pack/plugins/security_solution_ess/kibana.jsonc b/x-pack/plugins/security_solution_ess/kibana.jsonc new file mode 100644 index 0000000000000..cf1edb3f571c5 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/kibana.jsonc @@ -0,0 +1,19 @@ +{ + "type": "plugin", + "id": "@kbn/security-solution-ess", + "owner": "@elastic/security-solution", + "description": "ESS customizations for Security Solution.", + "plugin": { + "id": "securitySolutionEss", + "server": true, + "browser": true, + "configPath": ["xpack", "securitySolutionEss"], + "requiredPlugins": [ + "securitySolution" + ], + "optionalPlugins": [ + "cloudExperiments", + ], + "requiredBundles": [ "kibanaReact"] + } +} diff --git a/x-pack/plugins/security_solution_ess/package.json b/x-pack/plugins/security_solution_ess/package.json new file mode 100644 index 0000000000000..e7ab99edd6a2a --- /dev/null +++ b/x-pack/plugins/security_solution_ess/package.json @@ -0,0 +1,11 @@ +{ + "name": "@kbn/security-solution-ess", + "version": "1.0.0", + "license": "Elastic License 2.0", + "private": true, + "scripts": { + "build": "yarn plugin-helpers build", + "plugin-helpers": "node ../../../scripts/plugin_helpers", + "kbn": "node ../../../scripts/kbn" + } +} diff --git a/x-pack/plugins/security_solution_ess/public/breadcrumbs/breadcrumbs.test.ts b/x-pack/plugins/security_solution_ess/public/breadcrumbs/breadcrumbs.test.ts new file mode 100644 index 0000000000000..3b4c340488572 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/public/breadcrumbs/breadcrumbs.test.ts @@ -0,0 +1,33 @@ +/* + * 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 { ChromeBreadcrumb } from '@kbn/core/public'; +import { emptyLastBreadcrumbUrl } from './breadcrumbs'; + +describe('emptyLastBreadcrumbUrl', () => { + it('should empty the URL and onClick function of the last breadcrumb', () => { + const breadcrumbs: ChromeBreadcrumb[] = [ + { text: 'Home', href: '/home', onClick: () => {} }, + { text: 'Breadcrumb 1', href: '/bc1', onClick: () => {} }, + { text: 'Last Breadcrumbs', href: '/last_bc', onClick: () => {} }, + ]; + + const expectedBreadcrumbs = [ + { text: 'Home', href: '/home', onClick: breadcrumbs[0].onClick }, + { text: 'Breadcrumb 1', href: '/bc1', onClick: breadcrumbs[1].onClick }, + { text: 'Last Breadcrumbs', href: '', onClick: undefined }, + ]; + + expect(emptyLastBreadcrumbUrl(breadcrumbs)).toEqual(expectedBreadcrumbs); + }); + + it('should return the original breadcrumbs if the input is empty', () => { + const emptyBreadcrumbs: ChromeBreadcrumb[] = []; + + expect(emptyLastBreadcrumbUrl(emptyBreadcrumbs)).toEqual(emptyBreadcrumbs); + }); +}); diff --git a/x-pack/plugins/security_solution_ess/public/breadcrumbs/breadcrumbs.ts b/x-pack/plugins/security_solution_ess/public/breadcrumbs/breadcrumbs.ts new file mode 100644 index 0000000000000..ca76dc304ab99 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/public/breadcrumbs/breadcrumbs.ts @@ -0,0 +1,27 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { ChromeBreadcrumb } from '@kbn/core/public'; +import type { Services } from '../common/services'; + +export const subscribeBreadcrumbs = (services: Services) => { + const { chrome, securitySolution } = services; + securitySolution.getBreadcrumbsNav$().subscribe((breadcrumbsNav) => { + const breadcrumbs = [...breadcrumbsNav.leading, ...breadcrumbsNav.trailing]; + if (breadcrumbs.length > 0) { + chrome.setBreadcrumbs(emptyLastBreadcrumbUrl(breadcrumbs)); + } + }); +}; + +export const emptyLastBreadcrumbUrl = (breadcrumbs: ChromeBreadcrumb[]) => { + const lastBreadcrumb = breadcrumbs[breadcrumbs.length - 1]; + if (lastBreadcrumb) { + return [...breadcrumbs.slice(0, -1), { ...lastBreadcrumb, href: '', onClick: undefined }]; + } + return breadcrumbs; +}; diff --git a/x-pack/plugins/security_solution_ess/public/breadcrumbs/index.ts b/x-pack/plugins/security_solution_ess/public/breadcrumbs/index.ts new file mode 100644 index 0000000000000..e1ed7fcff0986 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/public/breadcrumbs/index.ts @@ -0,0 +1,7 @@ +/* + * 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 { subscribeBreadcrumbs } from './breadcrumbs'; diff --git a/x-pack/plugins/security_solution_ess/public/common/__mocks__/services.mock.ts b/x-pack/plugins/security_solution_ess/public/common/__mocks__/services.mock.ts new file mode 100644 index 0000000000000..9e9909b45894b --- /dev/null +++ b/x-pack/plugins/security_solution_ess/public/common/__mocks__/services.mock.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 { coreMock } from '@kbn/core/public/mocks'; +import { securitySolutionMock } from '@kbn/security-solution-plugin/public/mocks'; +import type { Services } from '../services'; + +export const mockServices: Services = { + ...coreMock.createStart(), + securitySolution: securitySolutionMock.createStart(), +}; diff --git a/x-pack/plugins/security_solution_ess/public/common/__mocks__/services.tsx b/x-pack/plugins/security_solution_ess/public/common/__mocks__/services.tsx new file mode 100644 index 0000000000000..710a9b378adad --- /dev/null +++ b/x-pack/plugins/security_solution_ess/public/common/__mocks__/services.tsx @@ -0,0 +1,10 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { mockServices } from './services.mock'; + +export const useKibana = jest.fn(() => ({ services: mockServices })); diff --git a/x-pack/plugins/ess_security/public/common/hooks/__mocks__/use_variation.ts b/x-pack/plugins/security_solution_ess/public/common/hooks/__mocks__/use_variation.ts similarity index 100% rename from x-pack/plugins/ess_security/public/common/hooks/__mocks__/use_variation.ts rename to x-pack/plugins/security_solution_ess/public/common/hooks/__mocks__/use_variation.ts diff --git a/x-pack/plugins/ess_security/public/common/hooks/use_variation.test.ts b/x-pack/plugins/security_solution_ess/public/common/hooks/use_variation.test.ts similarity index 100% rename from x-pack/plugins/ess_security/public/common/hooks/use_variation.test.ts rename to x-pack/plugins/security_solution_ess/public/common/hooks/use_variation.test.ts diff --git a/x-pack/plugins/ess_security/public/common/hooks/use_variation.ts b/x-pack/plugins/security_solution_ess/public/common/hooks/use_variation.ts similarity index 100% rename from x-pack/plugins/ess_security/public/common/hooks/use_variation.ts rename to x-pack/plugins/security_solution_ess/public/common/hooks/use_variation.ts diff --git a/x-pack/plugins/security_solution_ess/public/common/services.tsx b/x-pack/plugins/security_solution_ess/public/common/services.tsx new file mode 100644 index 0000000000000..d00fd10350a7d --- /dev/null +++ b/x-pack/plugins/security_solution_ess/public/common/services.tsx @@ -0,0 +1,31 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { CoreStart } from '@kbn/core/public'; +import React from 'react'; +import { + KibanaContextProvider, + useKibana as useKibanaReact, +} from '@kbn/kibana-react-plugin/public'; +import type { SecuritySolutionEssPluginStartDeps } from '../types'; + +export type Services = CoreStart & SecuritySolutionEssPluginStartDeps; + +export const KibanaServicesProvider: React.FC<{ + services: Services; +}> = ({ services, children }) => { + return {children}; +}; + +export const useKibana = () => useKibanaReact(); + +export const createServices = ( + core: CoreStart, + pluginsStart: SecuritySolutionEssPluginStartDeps +): Services => { + return { ...core, ...pluginsStart }; +}; diff --git a/x-pack/plugins/ess_security/public/get_started/images/cloud1.svg b/x-pack/plugins/security_solution_ess/public/get_started/images/cloud1.svg similarity index 100% rename from x-pack/plugins/ess_security/public/get_started/images/cloud1.svg rename to x-pack/plugins/security_solution_ess/public/get_started/images/cloud1.svg diff --git a/x-pack/plugins/ess_security/public/get_started/images/endpoint1.svg b/x-pack/plugins/security_solution_ess/public/get_started/images/endpoint1.svg similarity index 100% rename from x-pack/plugins/ess_security/public/get_started/images/endpoint1.svg rename to x-pack/plugins/security_solution_ess/public/get_started/images/endpoint1.svg diff --git a/x-pack/plugins/ess_security/public/get_started/images/siem1.svg b/x-pack/plugins/security_solution_ess/public/get_started/images/siem1.svg similarity index 100% rename from x-pack/plugins/ess_security/public/get_started/images/siem1.svg rename to x-pack/plugins/security_solution_ess/public/get_started/images/siem1.svg diff --git a/x-pack/plugins/security_solution_ess/public/get_started/index.tsx b/x-pack/plugins/security_solution_ess/public/get_started/index.tsx new file mode 100644 index 0000000000000..f85d20afe0c07 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/public/get_started/index.tsx @@ -0,0 +1,19 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import React from 'react'; + +import { KibanaServicesProvider, type Services } from '../common/services'; +import { GetStarted } from './lazy'; + +export const getSecurityGetStartedComponent = (services: Services): React.ComponentType => + function GetStartedComponent() { + return ( + + + + ); + }; diff --git a/x-pack/plugins/ess_security/public/get_started/landing_cards.test.tsx b/x-pack/plugins/security_solution_ess/public/get_started/landing_cards.test.tsx similarity index 98% rename from x-pack/plugins/ess_security/public/get_started/landing_cards.test.tsx rename to x-pack/plugins/security_solution_ess/public/get_started/landing_cards.test.tsx index 05ef9d5cf23f4..153d279a6a06e 100644 --- a/x-pack/plugins/ess_security/public/get_started/landing_cards.test.tsx +++ b/x-pack/plugins/security_solution_ess/public/get_started/landing_cards.test.tsx @@ -12,7 +12,7 @@ import { ADD_DATA_PATH } from '@kbn/security-solution-plugin/common'; import { useVariation } from '../common/hooks/use_variation'; jest.mock('../common/hooks/use_variation'); -jest.mock('../services'); +jest.mock('../common/services'); describe('LandingCards component', () => { beforeEach(() => { diff --git a/x-pack/plugins/ess_security/public/get_started/landing_cards.tsx b/x-pack/plugins/security_solution_ess/public/get_started/landing_cards.tsx similarity index 98% rename from x-pack/plugins/ess_security/public/get_started/landing_cards.tsx rename to x-pack/plugins/security_solution_ess/public/get_started/landing_cards.tsx index eacf3c380a293..91e3c2c5f1fc8 100644 --- a/x-pack/plugins/ess_security/public/get_started/landing_cards.tsx +++ b/x-pack/plugins/security_solution_ess/public/get_started/landing_cards.tsx @@ -12,8 +12,8 @@ import { EuiFlexGroup, EuiFlexItem, EuiPageHeader, - EuiThemeComputed, useEuiTheme, + type EuiThemeComputed, } from '@elastic/eui'; import { css } from '@emotion/react'; import { ADD_DATA_PATH } from '@kbn/security-solution-plugin/common'; @@ -22,7 +22,7 @@ import * as i18n from './translations'; import endpointSvg from './images/endpoint1.svg'; import cloudSvg from './images/cloud1.svg'; import siemSvg from './images/siem1.svg'; -import { useKibana } from '../services'; +import { useKibana } from '../common/services'; const imgUrls = { cloud: cloudSvg, diff --git a/x-pack/plugins/ess_security/public/get_started/lazy.tsx b/x-pack/plugins/security_solution_ess/public/get_started/lazy.tsx similarity index 100% rename from x-pack/plugins/ess_security/public/get_started/lazy.tsx rename to x-pack/plugins/security_solution_ess/public/get_started/lazy.tsx diff --git a/x-pack/plugins/ess_security/public/get_started/translations.tsx b/x-pack/plugins/security_solution_ess/public/get_started/translations.tsx similarity index 100% rename from x-pack/plugins/ess_security/public/get_started/translations.tsx rename to x-pack/plugins/security_solution_ess/public/get_started/translations.tsx diff --git a/x-pack/plugins/security_solution_ess/public/index.ts b/x-pack/plugins/security_solution_ess/public/index.ts new file mode 100644 index 0000000000000..3a26496d3692d --- /dev/null +++ b/x-pack/plugins/security_solution_ess/public/index.ts @@ -0,0 +1,17 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { PluginInitializerContext } from '@kbn/core/public'; +import { SecuritySolutionEssPlugin } from './plugin'; + +// This exports static code and TypeScript types, +// as well as, Kibana Platform `plugin()` initializer. +export function plugin(_initializerContext: PluginInitializerContext) { + return new SecuritySolutionEssPlugin(); +} + +export type { SecuritySolutionEssPluginSetup, SecuritySolutionEssPluginStart } from './types'; diff --git a/x-pack/plugins/security_solution_ess/public/jest.config.js b/x-pack/plugins/security_solution_ess/public/jest.config.js new file mode 100644 index 0000000000000..fac3d4ceba420 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/public/jest.config.js @@ -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. + */ +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + /** all nested directories have their own Jest config file */ + testMatch: ['/x-pack/plugins/security_solution_ess/public/**/*.test.{js,mjs,ts,tsx}'], + roots: ['/x-pack/plugins/security_solution_ess/public'], + coverageDirectory: + '/target/kibana-coverage/jest/x-pack/plugins/security_solution_ess/public', + coverageReporters: ['text', 'html'], + collectCoverageFrom: [ + '/x-pack/plugins/security_solution_ess/public/**/*.{ts,tsx}', + '!/x-pack/plugins/security_solution_ess/public/*.test.{ts,tsx}', + '!/x-pack/plugins/security_solution_ess/public/{__test__,__snapshots__,__examples__,*mock*,tests,test_helpers,integration_tests,types}/**/*', + '!/x-pack/plugins/security_solution_ess/public/*mock*.{ts,tsx}', + '!/x-pack/plugins/security_solution_ess/public/*.test.{ts,tsx}', + '!/x-pack/plugins/security_solution_ess/public/*.d.ts', + '!/x-pack/plugins/security_solution_ess/public/*.config.ts', + '!/x-pack/plugins/security_solution_ess/public/index.{js,ts,tsx}', + ], +}; diff --git a/x-pack/plugins/security_solution_ess/public/plugin.ts b/x-pack/plugins/security_solution_ess/public/plugin.ts new file mode 100644 index 0000000000000..7224a46f682e4 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/public/plugin.ts @@ -0,0 +1,49 @@ +/* + * 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 } from '@kbn/core/public'; +import { subscribeBreadcrumbs } from './breadcrumbs'; +import { createServices } from './common/services'; +import { getSecurityGetStartedComponent } from './get_started'; +import type { + SecuritySolutionEssPluginSetup, + SecuritySolutionEssPluginStart, + SecuritySolutionEssPluginSetupDeps, + SecuritySolutionEssPluginStartDeps, +} from './types'; + +export class SecuritySolutionEssPlugin + implements + Plugin< + SecuritySolutionEssPluginSetup, + SecuritySolutionEssPluginStart, + SecuritySolutionEssPluginSetupDeps, + SecuritySolutionEssPluginStartDeps + > +{ + public setup( + _core: CoreSetup, + _setupDeps: SecuritySolutionEssPluginSetupDeps + ): SecuritySolutionEssPluginSetup { + return {}; + } + + public start( + core: CoreStart, + startDeps: SecuritySolutionEssPluginStartDeps + ): SecuritySolutionEssPluginStart { + const { securitySolution } = startDeps; + const services = createServices(core, startDeps); + + securitySolution.setGetStartedPage(getSecurityGetStartedComponent(services)); + subscribeBreadcrumbs(services); + + return {}; + } + + public stop() {} +} diff --git a/x-pack/plugins/security_solution_ess/public/types.ts b/x-pack/plugins/security_solution_ess/public/types.ts new file mode 100644 index 0000000000000..2bdeeffebf723 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/public/types.ts @@ -0,0 +1,27 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { + PluginSetup as SecuritySolutionPluginSetup, + PluginStart as SecuritySolutionPluginStart, +} from '@kbn/security-solution-plugin/public'; +import type { CloudExperimentsPluginStart } from '@kbn/cloud-experiments-plugin/common'; + +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface SecuritySolutionEssPluginSetup {} + +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface SecuritySolutionEssPluginStart {} + +export interface SecuritySolutionEssPluginSetupDeps { + securitySolution: SecuritySolutionPluginSetup; +} + +export interface SecuritySolutionEssPluginStartDeps { + securitySolution: SecuritySolutionPluginStart; + cloudExperiments?: CloudExperimentsPluginStart; +} diff --git a/x-pack/plugins/security_solution_ess/server/config.ts b/x-pack/plugins/security_solution_ess/server/config.ts new file mode 100644 index 0000000000000..48e96989859f5 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/server/config.ts @@ -0,0 +1,18 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { schema, type TypeOf } from '@kbn/config-schema'; +import type { PluginConfigDescriptor } from '@kbn/core/server'; + +export const configSchema = schema.object({ + enabled: schema.boolean({ defaultValue: true }), +}); +export type EssSecurityConfig = TypeOf; + +export const config: PluginConfigDescriptor = { + schema: configSchema, +}; diff --git a/x-pack/plugins/ess_security/server/constants.ts b/x-pack/plugins/security_solution_ess/server/constants.ts similarity index 100% rename from x-pack/plugins/ess_security/server/constants.ts rename to x-pack/plugins/security_solution_ess/server/constants.ts diff --git a/x-pack/plugins/security_solution_ess/server/index.ts b/x-pack/plugins/security_solution_ess/server/index.ts new file mode 100644 index 0000000000000..ebb28fda2cf0a --- /dev/null +++ b/x-pack/plugins/security_solution_ess/server/index.ts @@ -0,0 +1,19 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { PluginInitializerContext } from '@kbn/core/server'; + +import { SecuritySolutionEssPlugin } from './plugin'; +export { config } from './config'; + +// This exports static code and TypeScript types, +// as well as, Kibana Platform `plugin()` initializer. +export function plugin(_initializerContext: PluginInitializerContext) { + return new SecuritySolutionEssPlugin(); +} + +export type { SecuritySolutionEssPluginSetup, SecuritySolutionEssPluginStart } from './types'; diff --git a/x-pack/plugins/security_solution_ess/server/plugin.ts b/x-pack/plugins/security_solution_ess/server/plugin.ts new file mode 100644 index 0000000000000..0083fe1314cfd --- /dev/null +++ b/x-pack/plugins/security_solution_ess/server/plugin.ts @@ -0,0 +1,37 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { Plugin, CoreSetup } from '@kbn/core/server'; +import { DEFAULT_APP_FEATURES } from './constants'; + +import type { + SecuritySolutionEssPluginSetup, + SecuritySolutionEssPluginStart, + SecuritySolutionEssPluginSetupDeps, + SecuritySolutionEssPluginStartDeps, +} from './types'; + +export class SecuritySolutionEssPlugin + implements + Plugin< + SecuritySolutionEssPluginSetup, + SecuritySolutionEssPluginStart, + SecuritySolutionEssPluginSetupDeps, + SecuritySolutionEssPluginStartDeps + > +{ + public setup(_coreSetup: CoreSetup, pluginsSetup: SecuritySolutionEssPluginSetupDeps) { + pluginsSetup.securitySolution.setAppFeatures(DEFAULT_APP_FEATURES); + return {}; + } + + public start() { + return {}; + } + + public stop() {} +} diff --git a/x-pack/plugins/security_solution_ess/server/types.ts b/x-pack/plugins/security_solution_ess/server/types.ts new file mode 100644 index 0000000000000..37dd38d76ed77 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/server/types.ts @@ -0,0 +1,24 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { + PluginSetup as SecuritySolutionPluginSetup, + PluginStart as SecuritySolutionPluginStart, +} from '@kbn/security-solution-plugin/server'; + +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface SecuritySolutionEssPluginSetup {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface SecuritySolutionEssPluginStart {} + +export interface SecuritySolutionEssPluginSetupDeps { + securitySolution: SecuritySolutionPluginSetup; +} + +export interface SecuritySolutionEssPluginStartDeps { + securitySolution: SecuritySolutionPluginStart; +} diff --git a/x-pack/plugins/security_solution_ess/tsconfig.json b/x-pack/plugins/security_solution_ess/tsconfig.json new file mode 100644 index 0000000000000..c37fc77790254 --- /dev/null +++ b/x-pack/plugins/security_solution_ess/tsconfig.json @@ -0,0 +1,23 @@ +{ + "extends": "../../../tsconfig.base.json", + "compilerOptions": { + "outDir": "target/types" + }, + "include": [ + "index.ts", + "common/**/*.ts", + "public/**/*.ts", + "public/**/*.tsx", + "server/**/*.ts", + "../../../typings/**/*" + ], + "exclude": ["target/**/*"], + "kbn_references": [ + "@kbn/core", + "@kbn/config-schema", + "@kbn/security-solution-plugin", + "@kbn/i18n", + "@kbn/cloud-experiments-plugin", + "@kbn/kibana-react-plugin", + ] +} diff --git a/x-pack/plugins/serverless_security/.gitignore b/x-pack/plugins/security_solution_serverless/.gitignore similarity index 100% rename from x-pack/plugins/serverless_security/.gitignore rename to x-pack/plugins/security_solution_serverless/.gitignore diff --git a/x-pack/plugins/security_solution_serverless/README.mdx b/x-pack/plugins/security_solution_serverless/README.mdx new file mode 100755 index 0000000000000..a9e20bf8147a4 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/README.mdx @@ -0,0 +1,4 @@ +# Serverless Security project plugin + +This plugin contains configuration and code used to create a Serverless Security project. +It leverages universal configuration and other APIs in the [`serverless`](../serverless/README.mdx) plugin to configure Kibana. \ No newline at end of file diff --git a/x-pack/plugins/security_solution_serverless/common/config.ts b/x-pack/plugins/security_solution_serverless/common/config.ts new file mode 100644 index 0000000000000..cc661da4af1a9 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/common/config.ts @@ -0,0 +1,34 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { schema, type TypeOf } from '@kbn/config-schema'; +import { ProductLine, ProductTier } from './product'; + +export const productLine = schema.oneOf([ + schema.literal(ProductLine.security), + schema.literal(ProductLine.endpoint), + schema.literal(ProductLine.cloud), +]); + +export type SecurityProductLine = TypeOf; + +export const productTier = schema.oneOf([ + schema.literal(ProductTier.essentials), + schema.literal(ProductTier.complete), +]); +export type SecurityProductTier = TypeOf; + +export const productType = schema.object({ + product_line: productLine, + product_tier: productTier, +}); +export type SecurityProductType = TypeOf; + +export const productTypes = schema.arrayOf(productType, { + defaultValue: [], +}); +export type SecurityProductTypes = TypeOf; diff --git a/x-pack/plugins/security_solution_serverless/common/index.ts b/x-pack/plugins/security_solution_serverless/common/index.ts new file mode 100644 index 0000000000000..e6a263165b00e --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/common/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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export const PLUGIN_ID = 'securitySolutionServerless'; +export const PLUGIN_NAME = 'securitySolutionServerless'; diff --git a/x-pack/plugins/security_solution_serverless/common/jest.config.js b/x-pack/plugins/security_solution_serverless/common/jest.config.js new file mode 100644 index 0000000000000..01ea1139d6e44 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/common/jest.config.js @@ -0,0 +1,28 @@ +/* + * 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/security_solution_serverless/common'], + testMatch: [ + '/x-pack/plugins/security_solution_serverless/common/**/*.test.{js,mjs,ts,tsx}', + ], + coverageDirectory: + '/target/kibana-coverage/jest/x-pack/plugins/security_solution_serverless/common', + coverageReporters: ['text', 'html'], + collectCoverageFrom: [ + '/x-pack/plugins/security_solution_serverless/common/**/*.{ts,tsx}', + '!/x-pack/plugins/security_solution_serverless/common/*.test.{ts,tsx}', + '!/x-pack/plugins/security_solution_serverless/common/{__test__,__snapshots__,__examples__,*mock*,tests,test_helpers,integration_tests,types}/**/*', + '!/x-pack/plugins/security_solution_serverless/common/*mock*.{ts,tsx}', + '!/x-pack/plugins/security_solution_serverless/common/*.test.{ts,tsx}', + '!/x-pack/plugins/security_solution_serverless/common/*.d.ts', + '!/x-pack/plugins/security_solution_serverless/common/*.config.ts', + '!/x-pack/plugins/security_solution_serverless/common/index.{js,ts,tsx}', + ], +}; diff --git a/x-pack/plugins/serverless_security/common/pli/pli_config.ts b/x-pack/plugins/security_solution_serverless/common/pli/pli_config.ts similarity index 100% rename from x-pack/plugins/serverless_security/common/pli/pli_config.ts rename to x-pack/plugins/security_solution_serverless/common/pli/pli_config.ts diff --git a/x-pack/plugins/serverless_security/common/pli/pli_features.test.ts b/x-pack/plugins/security_solution_serverless/common/pli/pli_features.test.ts similarity index 80% rename from x-pack/plugins/serverless_security/common/pli/pli_features.test.ts rename to x-pack/plugins/security_solution_serverless/common/pli/pli_features.test.ts index 0d46bcc421ec0..3358ee69a4250 100644 --- a/x-pack/plugins/serverless_security/common/pli/pli_features.test.ts +++ b/x-pack/plugins/security_solution_serverless/common/pli/pli_features.test.ts @@ -6,6 +6,7 @@ */ import { getProductAppFeatures } from './pli_features'; import * as pliConfig from './pli_config'; +import { ProductLine, ProductTier } from '../product'; describe('getProductAppFeatures', () => { it('should return the essentials PLIs features', () => { @@ -18,7 +19,7 @@ describe('getProductAppFeatures', () => { }; const appFeatureKeys = getProductAppFeatures([ - { product_line: 'security', product_tier: 'essentials' }, + { product_line: ProductLine.security, product_tier: ProductTier.essentials }, ]); expect(appFeatureKeys).toEqual(['foo']); @@ -34,7 +35,7 @@ describe('getProductAppFeatures', () => { }; const appFeatureKeys = getProductAppFeatures([ - { product_line: 'security', product_tier: 'complete' }, + { product_line: ProductLine.security, product_tier: ProductTier.complete }, ]); expect(appFeatureKeys).toEqual(['foo', 'baz']); @@ -58,9 +59,9 @@ describe('getProductAppFeatures', () => { }; const appFeatureKeys = getProductAppFeatures([ - { product_line: 'security', product_tier: 'essentials' }, - { product_line: 'endpoint', product_tier: 'complete' }, - { product_line: 'cloud', product_tier: 'essentials' }, + { product_line: ProductLine.security, product_tier: ProductTier.essentials }, + { product_line: ProductLine.endpoint, product_tier: ProductTier.complete }, + { product_line: ProductLine.cloud, product_tier: ProductTier.essentials }, ]); expect(appFeatureKeys).toEqual(['foo', 'bar', 'repeated', 'qux', 'quux', 'corge', 'garply']); diff --git a/x-pack/plugins/serverless_security/common/pli/pli_features.ts b/x-pack/plugins/security_solution_serverless/common/pli/pli_features.ts similarity index 100% rename from x-pack/plugins/serverless_security/common/pli/pli_features.ts rename to x-pack/plugins/security_solution_serverless/common/pli/pli_features.ts diff --git a/x-pack/plugins/security_solution_serverless/common/product.ts b/x-pack/plugins/security_solution_serverless/common/product.ts new file mode 100644 index 0000000000000..d5095eea31637 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/common/product.ts @@ -0,0 +1,17 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export enum ProductLine { + security = 'security', + endpoint = 'endpoint', + cloud = 'cloud', +} + +export enum ProductTier { + essentials = 'essentials', + complete = 'complete', +} diff --git a/x-pack/plugins/security_solution_serverless/jest.config.dev.js b/x-pack/plugins/security_solution_serverless/jest.config.dev.js new file mode 100644 index 0000000000000..2591fcc775ab0 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/jest.config.dev.js @@ -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. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../', + projects: ['/x-pack/plugins/security_solution_serverless/public/jest.config.js'], +}; diff --git a/x-pack/plugins/security_solution_serverless/kibana.jsonc b/x-pack/plugins/security_solution_serverless/kibana.jsonc new file mode 100644 index 0000000000000..fc146de9b0ab8 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/kibana.jsonc @@ -0,0 +1,28 @@ +{ + "type": "plugin", + "id": "@kbn/security-solution-serverless", + "owner": "@elastic/security-solution", + "description": "Serverless customizations for security.", + "plugin": { + "id": "securitySolutionServerless", + "server": true, + "browser": true, + "configPath": [ + "xpack", + "securitySolutionServerless", + ], + "requiredPlugins": [ + "kibanaReact", + "management", + "ml", + "security", + "securitySolution", + "serverless", + "taskManager" + ], + "optionalPlugins": [ + "securitySolutionEss" + ], + "requiredBundles": ["kibanaUtils"] + } +} diff --git a/x-pack/plugins/security_solution_serverless/package.json b/x-pack/plugins/security_solution_serverless/package.json new file mode 100644 index 0000000000000..745afbe7d97c6 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/package.json @@ -0,0 +1,11 @@ +{ + "name": "@kbn/security-solution-serverless", + "version": "1.0.0", + "license": "Elastic License 2.0", + "private": true, + "scripts": { + "build": "yarn plugin-helpers build", + "plugin-helpers": "node ../../../scripts/plugin_helpers", + "kbn": "node ../../../scripts/kbn" + } +} \ No newline at end of file diff --git a/x-pack/plugins/security_solution_serverless/public/common/__mocks__/services.mock.tsx b/x-pack/plugins/security_solution_serverless/public/common/__mocks__/services.mock.tsx new file mode 100644 index 0000000000000..e4b1c777191ef --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/common/__mocks__/services.mock.tsx @@ -0,0 +1,36 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import React from 'react'; +import { I18nProvider } from '@kbn/i18n-react'; +import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; +import { coreMock } from '@kbn/core/public/mocks'; +import { serverlessMock } from '@kbn/serverless/public/mocks'; +import { securityMock } from '@kbn/security-plugin/public/mocks'; +import { securitySolutionMock } from '@kbn/security-solution-plugin/public/mocks'; +import { BehaviorSubject } from 'rxjs'; +import { managementPluginMock } from '@kbn/management-plugin/public/mocks'; +import type { ProjectNavigationLink } from '../../navigation/links'; +import type { Services } from '../services'; + +export const mockProjectNavLinks = jest.fn((): ProjectNavigationLink[] => []); + +export const mockServices: Services = { + ...coreMock.createStart(), + serverless: serverlessMock.createStart(), + security: securityMock.createStart(), + securitySolution: securitySolutionMock.createStart(), + getProjectNavLinks$: jest.fn(() => new BehaviorSubject(mockProjectNavLinks())), + management: managementPluginMock.createStartContract(), +}; + +export const ServicesWrapper = React.memo(function ServicesWrapper({ children }) { + return ( + + {children} + + ); +}); diff --git a/x-pack/plugins/security_solution_serverless/public/common/__mocks__/services.tsx b/x-pack/plugins/security_solution_serverless/public/common/__mocks__/services.tsx new file mode 100644 index 0000000000000..5c6d2f1117c64 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/common/__mocks__/services.tsx @@ -0,0 +1,19 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { I18nProvider } from '@kbn/i18n-react'; +import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; +import { mockServices } from './services.mock'; + +export const KibanaServicesProvider: React.FC = ({ children }) => ( + + {children} + +); + +export const useKibana = jest.fn(() => ({ services: mockServices })); diff --git a/x-pack/plugins/serverless_security/public/hooks/__mocks__/use_link_props.ts b/x-pack/plugins/security_solution_serverless/public/common/hooks/__mocks__/use_link_props.ts similarity index 100% rename from x-pack/plugins/serverless_security/public/hooks/__mocks__/use_link_props.ts rename to x-pack/plugins/security_solution_serverless/public/common/hooks/__mocks__/use_link_props.ts diff --git a/x-pack/plugins/serverless_security/public/hooks/use_link_props.test.tsx b/x-pack/plugins/security_solution_serverless/public/common/hooks/use_link_props.test.tsx similarity index 82% rename from x-pack/plugins/serverless_security/public/hooks/use_link_props.test.tsx rename to x-pack/plugins/security_solution_serverless/public/common/hooks/use_link_props.test.tsx index b04f19be75b8f..5b4d215e331ea 100644 --- a/x-pack/plugins/serverless_security/public/hooks/use_link_props.test.tsx +++ b/x-pack/plugins/security_solution_serverless/public/common/hooks/use_link_props.test.tsx @@ -5,16 +5,19 @@ * 2.0. */ -import { MouseEvent } from 'react'; +import type { MouseEvent } from 'react'; import { renderHook } from '@testing-library/react-hooks'; import { APP_UI_ID, SecurityPageName } from '@kbn/security-solution-plugin/common'; -import { KibanaServicesProvider, servicesMocks } from '../services.mock'; +import { mockServices } from '../__mocks__/services.mock'; import { useGetLinkProps, useLinkProps } from './use_link_props'; -const { getUrlForApp: mockGetUrlForApp, navigateToUrl: mockNavigateToUrl } = - servicesMocks.application; +jest.mock('../services'); const href = '/app/security/test'; + +const { getUrlForApp, navigateToUrl } = mockServices.application; +const mockNavigateToUrl = navigateToUrl as jest.MockedFunction; +const mockGetUrlForApp = getUrlForApp as jest.MockedFunction; mockGetUrlForApp.mockReturnValue(href); describe('useLinkProps', () => { @@ -23,7 +26,7 @@ describe('useLinkProps', () => { }); it('should return link props', async () => { - const { result } = renderHook(useLinkProps, { wrapper: KibanaServicesProvider }); + const { result } = renderHook(useLinkProps); const linkProps = result.current; @@ -37,7 +40,7 @@ describe('useLinkProps', () => { it('should call navigate when clicked normally', async () => { const ev = { preventDefault: jest.fn() } as unknown as MouseEvent; - const { result } = renderHook(useLinkProps, { wrapper: KibanaServicesProvider }); + const { result } = renderHook(useLinkProps); const { onClick } = result.current; onClick(ev); @@ -48,7 +51,7 @@ describe('useLinkProps', () => { it('should not call navigate when clicked with modifiers', async () => { const ev = { preventDefault: jest.fn(), ctrlKey: true } as unknown as MouseEvent; - const { result } = renderHook(useLinkProps, { wrapper: KibanaServicesProvider }); + const { result } = renderHook(useLinkProps); const { onClick } = result.current; onClick(ev); @@ -58,7 +61,6 @@ describe('useLinkProps', () => { it('should return link props passing deepLink', async () => { const { result } = renderHook(useLinkProps, { - wrapper: KibanaServicesProvider, initialProps: { deepLinkId: SecurityPageName.alerts }, }); @@ -74,7 +76,6 @@ describe('useLinkProps', () => { it('should return link props passing deepLink and path', async () => { const { result } = renderHook(useLinkProps, { - wrapper: KibanaServicesProvider, initialProps: { deepLinkId: SecurityPageName.alerts, path: '/test' }, }); @@ -95,7 +96,7 @@ describe('useGetLinkProps', () => { }); it('should return link props', async () => { - const { result } = renderHook(useGetLinkProps, { wrapper: KibanaServicesProvider }); + const { result } = renderHook(useGetLinkProps); const linkProps = result.current({}); @@ -109,7 +110,7 @@ describe('useGetLinkProps', () => { it('should call navigate when clicked normally', async () => { const ev = { preventDefault: jest.fn() } as unknown as MouseEvent; - const { result } = renderHook(useGetLinkProps, { wrapper: KibanaServicesProvider }); + const { result } = renderHook(useGetLinkProps); const { onClick } = result.current({}); onClick(ev); @@ -120,7 +121,7 @@ describe('useGetLinkProps', () => { it('should not call navigate when clicked with modifiers', async () => { const ev = { preventDefault: jest.fn(), ctrlKey: true } as unknown as MouseEvent; - const { result } = renderHook(useGetLinkProps, { wrapper: KibanaServicesProvider }); + const { result } = renderHook(useGetLinkProps); const { onClick } = result.current({}); onClick(ev); @@ -129,7 +130,7 @@ describe('useGetLinkProps', () => { }); it('should return link props passing deepLink', async () => { - const { result } = renderHook(useGetLinkProps, { wrapper: KibanaServicesProvider }); + const { result } = renderHook(useGetLinkProps); const linkProps = result.current({ deepLinkId: SecurityPageName.alerts }); @@ -142,7 +143,7 @@ describe('useGetLinkProps', () => { }); it('should return link props passing deepLink and path', async () => { - const { result } = renderHook(useGetLinkProps, { wrapper: KibanaServicesProvider }); + const { result } = renderHook(useGetLinkProps); const linkProps = result.current({ deepLinkId: SecurityPageName.alerts, path: '/test' }); diff --git a/x-pack/plugins/serverless_security/public/hooks/use_link_props.ts b/x-pack/plugins/security_solution_serverless/public/common/hooks/use_link_props.ts similarity index 100% rename from x-pack/plugins/serverless_security/public/hooks/use_link_props.ts rename to x-pack/plugins/security_solution_serverless/public/common/hooks/use_link_props.ts diff --git a/x-pack/plugins/security_solution_serverless/public/common/hooks/use_nav_links.ts b/x-pack/plugins/security_solution_serverless/public/common/hooks/use_nav_links.ts new file mode 100644 index 0000000000000..625e836223822 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/common/hooks/use_nav_links.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. + */ + +import { useMemo } from 'react'; +import useObservable from 'react-use/lib/useObservable'; +import { useKibana } from '../services'; + +export const useNavLinks = () => { + const { getProjectNavLinks$ } = useKibana().services; + const projectNavLinks$ = useMemo(() => getProjectNavLinks$(), [getProjectNavLinks$]); + return useObservable(projectNavLinks$, []); +}; diff --git a/x-pack/plugins/serverless_security/public/lib/__mocks__/storage.ts b/x-pack/plugins/security_solution_serverless/public/common/lib/__mocks__/storage.ts similarity index 100% rename from x-pack/plugins/serverless_security/public/lib/__mocks__/storage.ts rename to x-pack/plugins/security_solution_serverless/public/common/lib/__mocks__/storage.ts diff --git a/x-pack/plugins/serverless_security/public/lib/storage.ts b/x-pack/plugins/security_solution_serverless/public/common/lib/storage.ts similarity index 100% rename from x-pack/plugins/serverless_security/public/lib/storage.ts rename to x-pack/plugins/security_solution_serverless/public/common/lib/storage.ts diff --git a/x-pack/plugins/security_solution_serverless/public/common/services.tsx b/x-pack/plugins/security_solution_serverless/public/common/services.tsx new file mode 100644 index 0000000000000..799b2e5913c0a --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/common/services.tsx @@ -0,0 +1,38 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { CoreStart } from '@kbn/core/public'; +import React from 'react'; +import { + KibanaContextProvider, + useKibana as useKibanaReact, +} from '@kbn/kibana-react-plugin/public'; + +import type { SecuritySolutionServerlessPluginStartDeps } from '../types'; +import { getProjectNavLinks$, type ProjectNavLinks } from '../navigation/links'; + +interface InternalServices { + getProjectNavLinks$: () => ProjectNavLinks; +} +export type Services = CoreStart & SecuritySolutionServerlessPluginStartDeps & InternalServices; + +export const KibanaServicesProvider: React.FC<{ + services: Services; +}> = ({ services, children }) => { + return {children}; +}; + +export const useKibana = () => useKibanaReact(); + +export const createServices = ( + core: CoreStart, + pluginsStart: SecuritySolutionServerlessPluginStartDeps +): Services => { + const { securitySolution } = pluginsStart; + const projectNavLinks$ = getProjectNavLinks$(securitySolution.getNavLinks$()); + return { ...core, ...pluginsStart, getProjectNavLinks$: () => projectNavLinks$ }; +}; diff --git a/x-pack/plugins/serverless_security/public/components/get_started/__mocks__/card_step.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/__mocks__/card_step.tsx similarity index 100% rename from x-pack/plugins/serverless_security/public/components/get_started/__mocks__/card_step.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/__mocks__/card_step.tsx diff --git a/x-pack/plugins/serverless_security/public/components/get_started/__mocks__/product_switch.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/__mocks__/product_switch.tsx similarity index 100% rename from x-pack/plugins/serverless_security/public/components/get_started/__mocks__/product_switch.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/__mocks__/product_switch.tsx diff --git a/x-pack/plugins/serverless_security/public/lib/get_started/__mocks__/storage.ts b/x-pack/plugins/security_solution_serverless/public/get_started/__mocks__/storage.ts similarity index 100% rename from x-pack/plugins/serverless_security/public/lib/get_started/__mocks__/storage.ts rename to x-pack/plugins/security_solution_serverless/public/get_started/__mocks__/storage.ts diff --git a/x-pack/plugins/serverless_security/public/components/get_started/__mocks__/toggle_panel.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/__mocks__/toggle_panel.tsx similarity index 100% rename from x-pack/plugins/serverless_security/public/components/get_started/__mocks__/toggle_panel.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/__mocks__/toggle_panel.tsx diff --git a/x-pack/plugins/serverless_security/public/components/get_started/__mocks__/welcome_panel.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/__mocks__/welcome_panel.tsx similarity index 100% rename from x-pack/plugins/serverless_security/public/components/get_started/__mocks__/welcome_panel.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/__mocks__/welcome_panel.tsx diff --git a/x-pack/plugins/serverless_security/public/components/get_started/card_item.test.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/card_item.test.tsx similarity index 92% rename from x-pack/plugins/serverless_security/public/components/get_started/card_item.test.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/card_item.test.tsx index aacd3f520d9cf..c132eb72bb359 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/card_item.test.tsx +++ b/x-pack/plugins/security_solution_serverless/public/get_started/card_item.test.tsx @@ -7,8 +7,9 @@ import React from 'react'; import { render } from '@testing-library/react'; import { CardItem } from './card_item'; -import { CardId, GetSetUpCardId, IntroductionSteps, SectionId, StepId } from './types'; -import { EuiThemeComputed } from '@elastic/eui'; +import type { CardId, StepId } from './types'; +import { GetSetUpCardId, IntroductionSteps, SectionId } from './types'; +import type { EuiThemeComputed } from '@elastic/eui'; jest.mock('./card_step'); describe('CardItemComponent', () => { diff --git a/x-pack/plugins/serverless_security/public/components/get_started/card_item.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/card_item.tsx similarity index 90% rename from x-pack/plugins/serverless_security/public/components/get_started/card_item.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/card_item.tsx index 4abb71354b641..2dbd6da34d992 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/card_item.tsx +++ b/x-pack/plugins/security_solution_serverless/public/get_started/card_item.tsx @@ -5,18 +5,11 @@ * 2.0. */ -import { - EuiFlexGroup, - EuiFlexItem, - EuiIcon, - EuiPanel, - EuiText, - EuiThemeComputed, - EuiTitle, -} from '@elastic/eui'; +import { EuiFlexGroup, EuiFlexItem, EuiIcon, EuiPanel, EuiText, EuiTitle } from '@elastic/eui'; +import type { EuiThemeComputed } from '@elastic/eui'; import React, { useCallback, useState } from 'react'; import { css } from '@emotion/react'; -import { CardId, SectionId, StepId } from './types'; +import type { CardId, SectionId, StepId } from './types'; import * as i18n from './translations'; import { CardStep } from './card_step'; import { getSections } from './sections'; @@ -102,7 +95,10 @@ const CardItemComponent: React.FC<{ {i18n.STEPS_LEFT(stepsLeft)} )} {timeInMins != null && timeInMins > 0 && ( - • {i18n.STEP_TIME_MIN(timeInMins)} + + {' • '} + {i18n.STEP_TIME_MIN(timeInMins)} + )} diff --git a/x-pack/plugins/serverless_security/public/components/get_started/card_step.test.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/card_step.test.tsx similarity index 94% rename from x-pack/plugins/serverless_security/public/components/get_started/card_step.test.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/card_step.test.tsx index d5fe2433a9fab..9e72370f179e8 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/card_step.test.tsx +++ b/x-pack/plugins/security_solution_serverless/public/get_started/card_step.test.tsx @@ -7,7 +7,8 @@ import React from 'react'; import { render, fireEvent } from '@testing-library/react'; import { CardStep } from './card_step'; -import { GetSetUpCardId, IntroductionSteps, SectionId, StepId } from './types'; +import type { StepId } from './types'; +import { GetSetUpCardId, IntroductionSteps, SectionId } from './types'; describe('CardStepComponent', () => { const step = { @@ -18,7 +19,7 @@ describe('CardStepComponent', () => { { id: 'badge2', name: 'Badge 2' }, ], description: ['Description line 1', 'Description line 2'], - splitPanel:
    Split Panel
    , + splitPanel:
    {'Split Panel'}
    , }; const onStepClicked = jest.fn(); diff --git a/x-pack/plugins/serverless_security/public/components/get_started/card_step.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/card_step.tsx similarity index 97% rename from x-pack/plugins/serverless_security/public/components/get_started/card_step.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/card_step.tsx index 67d683edaac5e..137895b9bb078 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/card_step.tsx +++ b/x-pack/plugins/security_solution_serverless/public/get_started/card_step.tsx @@ -18,7 +18,7 @@ import { import { css } from '@emotion/react'; import React, { useCallback, useState } from 'react'; -import { CardId, SectionId, Step, StepId } from './types'; +import type { CardId, SectionId, Step, StepId } from './types'; import step from './images/step.svg'; const CardStepComponent: React.FC<{ diff --git a/x-pack/plugins/security_solution_serverless/public/get_started/get_started.test.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/get_started.test.tsx new file mode 100644 index 0000000000000..51896789c6b31 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/get_started/get_started.test.tsx @@ -0,0 +1,62 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import React from 'react'; +import { render } from '@testing-library/react'; +import { GetStartedComponent } from './get_started'; +import type { SecurityProductTypes } from '../../common/config'; + +jest.mock('./toggle_panel'); +jest.mock('./welcome_panel'); +jest.mock('@elastic/eui', () => { + const original = jest.requireActual('@elastic/eui'); + return { + ...original, + useEuiTheme: jest.fn().mockReturnValue({ + euiTheme: { base: 16, size: { xs: '4px' } }, + }), + }; +}); + +const productTypes = [ + { product_line: 'security', product_tier: 'essentials' }, + { product_line: 'endpoint', product_tier: 'complete' }, + { product_line: 'cloud', product_tier: 'complete' }, +] as SecurityProductTypes; + +describe('GetStartedComponent', () => { + it('should render page title, subtitle, and description', () => { + const { getByText } = render(); + + const pageTitle = getByText('Welcome'); + const subtitle = getByText(`Let's get started`); + const description = getByText( + `Set up your Elastic Security workspace. Use the toggles below to curate a list of tasks that best fits your environment` + ); + + expect(pageTitle).toBeInTheDocument(); + expect(subtitle).toBeInTheDocument(); + expect(description).toBeInTheDocument(); + }); + + it('should render Product Switch', () => { + const { getByTestId } = render(); + + const productSwitch = getByTestId('product-switch'); + + expect(productSwitch).toBeInTheDocument(); + }); + + it('should render WelcomePanel and TogglePanel', () => { + const { getByTestId } = render(); + + const welcomePanel = getByTestId('welcome-panel'); + const togglePanel = getByTestId('toggle-panel'); + + expect(welcomePanel).toBeInTheDocument(); + expect(togglePanel).toBeInTheDocument(); + }); +}); diff --git a/x-pack/plugins/security_solution_serverless/public/get_started/get_started.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/get_started.tsx new file mode 100644 index 0000000000000..55550495e6e13 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/get_started/get_started.tsx @@ -0,0 +1,120 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { EuiTitle, useEuiTheme, useEuiShadow } from '@elastic/eui'; +import React from 'react'; +import { KibanaPageTemplate } from '@kbn/shared-ux-page-kibana-template'; +import { css } from '@emotion/react'; + +import { WelcomePanel } from './welcome_panel'; +import { TogglePanel } from './toggle_panel'; +import { + GET_STARTED_PAGE_DESCRIPTION, + GET_STARTED_PAGE_SUBTITLE, + GET_STARTED_PAGE_TITLE, +} from './translations'; +import type { SecurityProductTypes } from '../../common/config'; +import { ProductSwitch } from './product_switch'; +import { useTogglePanel } from './use_toggle_panel'; + +const CONTENT_WIDTH = 1150; + +export interface GetStartedProps { + productTypes: SecurityProductTypes; +} + +export const GetStartedComponent: React.FC = ({ productTypes }) => { + const { euiTheme } = useEuiTheme(); + const shadow = useEuiShadow('s'); + const { + onProductSwitchChanged, + onStepClicked, + state: { activeProducts, activeCards, finishedSteps }, + } = useTogglePanel({ productTypes }); + return ( + + + {GET_STARTED_PAGE_TITLE} + + } + description={ + <> + {GET_STARTED_PAGE_SUBTITLE} + {GET_STARTED_PAGE_DESCRIPTION} + + } + > + + + + + + + + + + ); +}; + +GetStartedComponent.displayName = 'GetStartedComponent'; +export const GetStarted = React.memo(GetStartedComponent); + +// eslint-disable-next-line import/no-default-export +export default GetStarted; diff --git a/x-pack/plugins/security_solution_serverless/public/get_started/helpers.test.ts b/x-pack/plugins/security_solution_serverless/public/get_started/helpers.test.ts new file mode 100644 index 0000000000000..050d42fbec573 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/get_started/helpers.test.ts @@ -0,0 +1,299 @@ +/* + * 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 { + getCardTimeInMinutes, + getCardStepsLeft, + isCardActive, + setupCards, + updateCard, +} from './helpers'; +import type { ActiveCards, Card, CardId, Section, StepId } from './types'; +import { + GetMoreFromElasticSecurityCardId, + GetSetUpCardId, + IntroductionSteps, + SectionId, +} from './types'; +import * as sectionsConfigs from './sections'; +import { ProductLine } from '../../common/product'; +const mockSections = jest.spyOn(sectionsConfigs, 'getSections'); +describe('getCardTimeInMinutes', () => { + it('should calculate the total time in minutes for a card correctly', () => { + const card = { + steps: [ + { id: 'step1', timeInMinutes: 30 }, + { id: 'step2', timeInMinutes: 45 }, + { id: 'step3', timeInMinutes: 15 }, + ], + } as unknown as Card; + const stepsDone = new Set(['step1', 'step3']) as unknown as Set; + + const timeInMinutes = getCardTimeInMinutes(card, stepsDone); + + expect(timeInMinutes).toEqual(45); + }); + + it('should return 0 if the card is null or has no steps', () => { + const card = {} as Card; + const stepsDone = new Set(['step1']) as unknown as Set; + + const timeInMinutes = getCardTimeInMinutes(card, stepsDone); + + expect(timeInMinutes).toEqual(0); + }); +}); + +describe('getCardStepsLeft', () => { + it('should calculate the number of steps left for a card correctly', () => { + const card = { steps: ['step1', 'step2', 'step3'] } as unknown as Card; + const stepsDone = new Set(['step1', 'step3']) as unknown as Set; + + const stepsLeft = getCardStepsLeft(card, stepsDone); + + expect(stepsLeft).toEqual(1); + }); + + it('should return the total number of steps if the card is null or has no steps', () => { + const card = {} as Card; + const stepsDone = new Set() as unknown as Set; + + const stepsLeft = getCardStepsLeft(card, stepsDone); + + expect(stepsLeft).toEqual(0); + }); +}); + +describe('isCardActive', () => { + it('should return true if the card is active based on the active products', () => { + const card = { productLineRequired: [ProductLine.security, ProductLine.cloud] } as Card; + const activeProducts = new Set([ProductLine.security]); + + const isActive = isCardActive(card, activeProducts); + + expect(isActive).toBe(true); + }); + + it('should return true if the card has no product type requirement', () => { + const card = {} as Card; + const activeProducts = new Set([ProductLine.security]); + + const isActive = isCardActive(card, activeProducts); + + expect(isActive).toBe(true); + }); + + it('should return false if the card is not active based on the active products', () => { + const card = { productLineRequired: [ProductLine.security, ProductLine.cloud] } as Card; + const activeProducts = new Set([ProductLine.endpoint]); + + const isActive = isCardActive(card, activeProducts); + + expect(isActive).toBe(false); + }); +}); + +describe('setupCards', () => { + const analyticProductActiveCards = { + [SectionId.getSetUp]: { + [GetSetUpCardId.introduction]: { + id: GetSetUpCardId.introduction, + timeInMins: 3, + stepsLeft: 1, + }, + [GetSetUpCardId.bringInYourData]: { + id: GetSetUpCardId.bringInYourData, + timeInMins: 0, + stepsLeft: 0, + }, + [GetSetUpCardId.activateAndCreateRules]: { + id: GetSetUpCardId.activateAndCreateRules, + timeInMins: 0, + stepsLeft: 0, + }, + }, + [SectionId.getMoreFromElasticSecurity]: { + [GetMoreFromElasticSecurityCardId.masterTheInvestigationsWorkflow]: { + id: GetMoreFromElasticSecurityCardId.masterTheInvestigationsWorkflow, + stepsLeft: 0, + timeInMins: 0, + }, + [GetMoreFromElasticSecurityCardId.respondToThreats]: { + id: GetMoreFromElasticSecurityCardId.respondToThreats, + stepsLeft: 0, + timeInMins: 0, + }, + [GetMoreFromElasticSecurityCardId.optimizeYourWorkSpace]: { + id: GetMoreFromElasticSecurityCardId.optimizeYourWorkSpace, + stepsLeft: 0, + timeInMins: 0, + }, + }, + }; + it('should set up active cards based on active products', () => { + const finishedSteps = {} as unknown as Record>; + const activeProducts = new Set([ProductLine.cloud]); + + const activeCards = setupCards(finishedSteps, activeProducts); + + expect(activeCards).toEqual({ + ...analyticProductActiveCards, + [SectionId.getSetUp]: { + ...analyticProductActiveCards[SectionId.getSetUp], + [GetSetUpCardId.protectYourEnvironmentInRealtime]: { + id: GetSetUpCardId.protectYourEnvironmentInRealtime, + timeInMins: 0, + stepsLeft: 0, + }, + }, + }); + }); + + it('should skip inactive cards based on finished steps and active products', () => { + const finishedSteps = {} as Record>; + const activeProducts = new Set([ProductLine.security]); + + const activeCards = setupCards(finishedSteps, activeProducts); + + expect(activeCards).toEqual(analyticProductActiveCards); + }); + + it('should return null if there are no active products', () => { + const finishedSteps = { + [GetSetUpCardId.introduction]: new Set([IntroductionSteps.watchOverviewVideo]), + } as unknown as Record>; + + const activeProducts: Set = new Set(); + + const activeCards = setupCards(finishedSteps, activeProducts); + + expect(activeCards).toBeNull(); + }); + + it('should handle null or empty cards in sections', () => { + mockSections.mockImplementation(() => [ + { + id: SectionId.getSetUp, + } as unknown as Section, + ]); + + const finishedSteps = { + [GetSetUpCardId.introduction]: new Set([IntroductionSteps.watchOverviewVideo]), + } as unknown as Record>; + const activeProducts = new Set([ProductLine.security]); + + const activeCards = setupCards(finishedSteps, activeProducts); + + expect(activeCards).toEqual({}); + + mockSections.mockRestore(); + }); +}); + +describe('updateCard', () => { + const finishedSteps = { + [GetSetUpCardId.introduction]: new Set([IntroductionSteps.watchOverviewVideo]), + } as unknown as Record>; + const activeProducts = new Set([ProductLine.security, ProductLine.cloud]); + + const activeCards = { + [SectionId.getSetUp]: { + [GetSetUpCardId.introduction]: { + id: GetSetUpCardId.introduction, + timeInMins: 3, + stepsLeft: 1, + }, + [GetSetUpCardId.bringInYourData]: { + id: GetSetUpCardId.bringInYourData, + timeInMins: 0, + stepsLeft: 0, + }, + [GetSetUpCardId.activateAndCreateRules]: { + id: GetSetUpCardId.activateAndCreateRules, + timeInMins: 0, + stepsLeft: 0, + }, + [GetSetUpCardId.protectYourEnvironmentInRealtime]: { + id: GetSetUpCardId.protectYourEnvironmentInRealtime, + timeInMins: 0, + stepsLeft: 0, + }, + }, + [SectionId.getMoreFromElasticSecurity]: { + [GetMoreFromElasticSecurityCardId.masterTheInvestigationsWorkflow]: { + id: GetMoreFromElasticSecurityCardId.masterTheInvestigationsWorkflow, + stepsLeft: 0, + timeInMins: 0, + }, + [GetMoreFromElasticSecurityCardId.respondToThreats]: { + id: GetMoreFromElasticSecurityCardId.respondToThreats, + stepsLeft: 0, + timeInMins: 0, + }, + [GetMoreFromElasticSecurityCardId.optimizeYourWorkSpace]: { + id: GetMoreFromElasticSecurityCardId.optimizeYourWorkSpace, + stepsLeft: 0, + timeInMins: 0, + }, + }, + } as ActiveCards; + + it('should update the active card based on finished steps and active products', () => { + const sectionId = SectionId.getSetUp; + const cardId = GetSetUpCardId.introduction; + + const updatedCards = updateCard({ + finishedSteps, + activeProducts, + activeCards, + sectionId, + cardId, + }); + + expect(updatedCards).toEqual({ + ...activeCards, + [SectionId.getSetUp]: { + ...activeCards[SectionId.getSetUp], + [GetSetUpCardId.introduction]: { + id: GetSetUpCardId.introduction, + timeInMins: 0, + stepsLeft: 0, + }, + }, + }); + }); + + it('should return null if the card is inactive based on active products', () => { + const sectionId = SectionId.getSetUp; + const cardId = GetSetUpCardId.protectYourEnvironmentInRealtime; + + const updatedCards = updateCard({ + finishedSteps, + activeProducts, + activeCards: null, + sectionId, + cardId, + }); + + expect(updatedCards).toBeNull(); + }); + + it('should return null if the card or activeCards is not found', () => { + const sectionId = SectionId.getSetUp; + const cardId = 'test' as CardId; + + const updatedCards = updateCard({ + finishedSteps, + activeProducts, + activeCards, + sectionId, + cardId, + }); + + expect(updatedCards).toEqual(activeCards); + }); +}); diff --git a/x-pack/plugins/security_solution_serverless/public/get_started/helpers.ts b/x-pack/plugins/security_solution_serverless/public/get_started/helpers.ts new file mode 100644 index 0000000000000..202e00dc1a40a --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/get_started/helpers.ts @@ -0,0 +1,93 @@ +/* + * 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 { ProductLine } from '../../common/product'; +import { getSections } from './sections'; +import type { ActiveCard, ActiveCards, Card, CardId, SectionId, StepId } from './types'; + +export const getCardTimeInMinutes = (card: Card, stepsDone: Set) => + card.steps?.reduce( + (totalMin, { timeInMinutes, id: stepId }) => + totalMin + (stepsDone.has(stepId) ? 0 : timeInMinutes ?? 0), + 0 + ) ?? 0; + +export const getCardStepsLeft = (card: Card, stepsDone: Set) => + (card.steps?.length ?? 0) - (stepsDone.size ?? 0); + +export const isCardActive = (card: Card, activeProducts: Set) => + !card.productLineRequired || + card.productLineRequired?.some((condition) => activeProducts.has(condition)); + +export const setupCards = ( + finishedSteps: Record>, + activeProducts: Set +) => + activeProducts.size > 0 + ? getSections().reduce((acc, section) => { + const cardsInSections = section.cards?.reduce((accCards, card) => { + if (isCardActive(card, activeProducts)) { + const stepsDone: Set = finishedSteps[card.id] ?? new Set(); + const timeInMins = getCardTimeInMinutes(card, stepsDone); + const stepsLeft = getCardStepsLeft(card, stepsDone); + + accCards[card.id] = { + id: card.id, + timeInMins, + stepsLeft, + }; + } + return accCards; + }, {} as Record); + if (cardsInSections) { + acc[section.id] = cardsInSections; + } + return acc; + }, {} as ActiveCards) + : null; + +export const updateCard = ({ + finishedSteps, + activeProducts, + activeCards, + sectionId, + cardId, +}: { + finishedSteps: Record>; + activeProducts: Set; + activeCards: ActiveCards | null; + sectionId: SectionId; + cardId: CardId; +}): ActiveCards | null => { + const sections = getSections(); + const section = sections.find(({ id }) => id === sectionId); + const cards = section?.cards; + const card = cards?.find(({ id }) => id === cardId); + + if (!card || !activeCards) { + return activeCards; + } + + if (isCardActive(card, activeProducts)) { + const stepsDone = finishedSteps[cardId] ?? new Set(); + const timeInMins = getCardTimeInMinutes(card, stepsDone); + const stepsLeft = getCardStepsLeft(card, stepsDone); + + return { + ...activeCards, + [sectionId]: { + ...activeCards[sectionId], + [cardId]: { + id: cardId, + timeInMins, + stepsLeft, + }, + }, + }; + } + return activeCards; +}; diff --git a/x-pack/plugins/serverless_security/public/components/get_started/images/invite.svg b/x-pack/plugins/security_solution_serverless/public/get_started/images/invite.svg similarity index 100% rename from x-pack/plugins/serverless_security/public/components/get_started/images/invite.svg rename to x-pack/plugins/security_solution_serverless/public/get_started/images/invite.svg diff --git a/x-pack/plugins/serverless_security/public/components/get_started/images/progress.svg b/x-pack/plugins/security_solution_serverless/public/get_started/images/progress.svg similarity index 100% rename from x-pack/plugins/serverless_security/public/components/get_started/images/progress.svg rename to x-pack/plugins/security_solution_serverless/public/get_started/images/progress.svg diff --git a/x-pack/plugins/serverless_security/public/components/get_started/images/protect.svg b/x-pack/plugins/security_solution_serverless/public/get_started/images/protect.svg similarity index 100% rename from x-pack/plugins/serverless_security/public/components/get_started/images/protect.svg rename to x-pack/plugins/security_solution_serverless/public/get_started/images/protect.svg diff --git a/x-pack/plugins/serverless_security/public/components/get_started/images/respond.svg b/x-pack/plugins/security_solution_serverless/public/get_started/images/respond.svg similarity index 100% rename from x-pack/plugins/serverless_security/public/components/get_started/images/respond.svg rename to x-pack/plugins/security_solution_serverless/public/get_started/images/respond.svg diff --git a/x-pack/plugins/serverless_security/public/components/get_started/images/step.svg b/x-pack/plugins/security_solution_serverless/public/get_started/images/step.svg similarity index 100% rename from x-pack/plugins/serverless_security/public/components/get_started/images/step.svg rename to x-pack/plugins/security_solution_serverless/public/get_started/images/step.svg diff --git a/x-pack/plugins/security_solution_serverless/public/get_started/index.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/index.tsx new file mode 100644 index 0000000000000..c457d47a3da30 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/get_started/index.tsx @@ -0,0 +1,24 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; + +import { KibanaServicesProvider, type Services } from '../common/services'; +import { GetStarted } from './lazy'; +import type { SecurityProductTypes } from '../../common/config'; + +export const getSecurityGetStartedComponent = ( + services: Services, + productTypes: SecurityProductTypes +): React.ComponentType => + function GetStartedComponent() { + return ( + + + + ); + }; diff --git a/x-pack/plugins/serverless_security/public/components/get_started/lazy.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/lazy.tsx similarity index 77% rename from x-pack/plugins/serverless_security/public/components/get_started/lazy.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/lazy.tsx index f968ad5d2ab22..99f89ada0055d 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/lazy.tsx +++ b/x-pack/plugins/security_solution_serverless/public/get_started/lazy.tsx @@ -6,13 +6,14 @@ */ import React, { lazy, Suspense } from 'react'; import { EuiLoadingLogo } from '@elastic/eui'; +import type { GetStartedProps } from './get_started'; const GetStartedLazy = lazy(() => import('./get_started')); const centerLogoStyle = { display: 'flex', margin: 'auto' }; -export const GetStarted = () => ( +export const GetStarted = ({ productTypes }: GetStartedProps) => ( }> - + ); diff --git a/x-pack/plugins/serverless_security/public/components/get_started/product_switch.test.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/product_switch.test.tsx similarity index 88% rename from x-pack/plugins/serverless_security/public/components/get_started/product_switch.test.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/product_switch.test.tsx index 49c0087f59830..5c54c87ccdd21 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/product_switch.test.tsx +++ b/x-pack/plugins/security_solution_serverless/public/get_started/product_switch.test.tsx @@ -8,8 +8,8 @@ import React from 'react'; import { render, fireEvent } from '@testing-library/react'; import { ProductSwitch } from './product_switch'; -import { EuiThemeComputed } from '@elastic/eui'; -import { ProductId } from './types'; +import type { EuiThemeComputed } from '@elastic/eui'; +import { ProductLine } from '../../common/product'; describe('ProductSwitch', () => { const onProductSwitchChangedMock = jest.fn(); @@ -49,12 +49,12 @@ describe('ProductSwitch', () => { fireEvent.click(analyticsSwitch); expect(onProductSwitchChangedMock).toHaveBeenCalledWith( - expect.objectContaining({ id: 'analytics' }) + expect.objectContaining({ id: 'security' }) ); }); it('should have checked switches for activeProducts', () => { - const activeProducts = new Set([ProductId.analytics, ProductId.endpoint]); + const activeProducts = new Set([ProductLine.security, ProductLine.endpoint]); const { getByTestId } = render( { /> ); - const analyticsSwitch = getByTestId('analytics'); + const analyticsSwitch = getByTestId('security'); const cloudSwitch = getByTestId('cloud'); const endpointSwitch = getByTestId('endpoint'); diff --git a/x-pack/plugins/serverless_security/public/components/get_started/product_switch.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/product_switch.tsx similarity index 80% rename from x-pack/plugins/serverless_security/public/components/get_started/product_switch.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/product_switch.tsx index 910618c1a3f4c..62f58caaacd6d 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/product_switch.tsx +++ b/x-pack/plugins/security_solution_serverless/public/get_started/product_switch.tsx @@ -5,33 +5,33 @@ * 2.0. */ -import { EuiPanel, EuiSwitch, EuiText, EuiThemeComputed, EuiTitle } from '@elastic/eui'; +import { EuiPanel, EuiSwitch, EuiText, EuiTitle, type EuiThemeComputed } from '@elastic/eui'; import { css } from '@emotion/react'; import React, { useMemo } from 'react'; +import { ProductLine } from '../../common/product'; import * as i18n from './translations'; -import { ProductId, Switch } from './types'; +import type { Switch } from './types'; const switches: Switch[] = [ { - id: ProductId.analytics, + id: ProductLine.security, label: i18n.ANALYTICS_SWITCH_LABEL, }, { - id: ProductId.cloud, + id: ProductLine.cloud, label: i18n.CLOUD_SWITCH_LABEL, }, { - id: ProductId.endpoint, + id: ProductLine.endpoint, label: i18n.ENDPOINT_SWITCH_LABEL, }, ]; const ProductSwitchComponent: React.FC<{ onProductSwitchChanged: (item: Switch) => void; - activeProducts: Set; - shadow?: string; + activeProducts: Set; euiTheme: EuiThemeComputed; -}> = ({ onProductSwitchChanged, activeProducts, euiTheme, shadow = '' }) => { +}> = ({ onProductSwitchChanged, activeProducts, euiTheme }) => { const switchNodes = useMemo( () => switches.map((item) => ( @@ -58,8 +58,7 @@ const ProductSwitchComponent: React.FC<{ paddingSize="none" hasShadow={false} css={css` - padding: ${euiTheme.base * 1.25}px ${euiTheme.base * 2.25}px; - ${shadow}; + padding: ${euiTheme.base * 1.25}px 0; `} borderRadius="none" > diff --git a/x-pack/plugins/serverless_security/public/components/get_started/reducer.test.ts b/x-pack/plugins/security_solution_serverless/public/get_started/reducer.test.ts similarity index 86% rename from x-pack/plugins/serverless_security/public/components/get_started/reducer.test.ts rename to x-pack/plugins/security_solution_serverless/public/get_started/reducer.test.ts index 970b7ac6dbef0..fe38c68a1a160 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/reducer.test.ts +++ b/x-pack/plugins/security_solution_serverless/public/get_started/reducer.test.ts @@ -5,6 +5,7 @@ * 2.0. */ +import { ProductLine } from '../../common/product'; import { reducer, getFinishedStepsInitialStates, @@ -12,41 +13,40 @@ import { getActiveCardsInitialStates, } from './reducer'; import { - ActiveCard, - CardId, GetSetUpCardId, GetStartedPageActions, IntroductionSteps, - ProductId, SectionId, - StepId, - ToggleProductAction, - AddFinishedStepAction, GetMoreFromElasticSecurityCardId, + type ActiveCards, + type CardId, + type StepId, + type ToggleProductAction, + type AddFinishedStepAction, } from './types'; describe('reducer', () => { it('should toggle section correctly', () => { const initialState = { - activeProducts: new Set([ProductId.analytics]), + activeProducts: new Set([ProductLine.security]), finishedSteps: {} as Record>, - activeCards: {} as Record> | null, + activeCards: {} as ActiveCards | null, }; const action: ToggleProductAction = { type: GetStartedPageActions.ToggleProduct, - payload: { section: ProductId.analytics }, + payload: { section: ProductLine.security }, }; const nextState = reducer(initialState, action); - expect(nextState.activeProducts.has(ProductId.analytics)).toBe(false); + expect(nextState.activeProducts.has(ProductLine.security)).toBe(false); expect(nextState.activeCards).toBeNull(); }); it('should add a finished step correctly', () => { const initialState = { - activeProducts: new Set([ProductId.analytics]), + activeProducts: new Set([ProductLine.security]), finishedSteps: {} as Record>, activeCards: { getSetUp: { @@ -56,7 +56,7 @@ describe('reducer', () => { timeInMins: 3, }, }, - } as unknown as Record> | null, + } as unknown as ActiveCards | null, }; const action: AddFinishedStepAction = { @@ -103,17 +103,17 @@ describe('getFinishedStepsInitialStates', () => { describe('getActiveSectionsInitialStates', () => { it('should return the initial states of active sections correctly', () => { - const activeProducts = [ProductId.analytics]; + const activeProducts = [ProductLine.security]; const initialStates = getActiveSectionsInitialStates({ activeProducts }); - expect(initialStates.has(ProductId.analytics)).toBe(true); + expect(initialStates.has(ProductLine.security)).toBe(true); }); }); describe('getActiveCardsInitialStates', () => { it('should return the initial states of active cards correctly', () => { - const activeProducts = new Set([ProductId.analytics]); + const activeProducts = new Set([ProductLine.security]); const finishedSteps = { [GetSetUpCardId.introduction]: new Set([IntroductionSteps.watchOverviewVideo]), } as unknown as Record>; diff --git a/x-pack/plugins/serverless_security/public/components/get_started/reducer.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/reducer.tsx similarity index 90% rename from x-pack/plugins/serverless_security/public/components/get_started/reducer.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/reducer.tsx index 2164bbee177bd..f59911aa11808 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/reducer.tsx +++ b/x-pack/plugins/security_solution_serverless/public/get_started/reducer.tsx @@ -5,15 +5,15 @@ * 2.0. */ +import type { ProductLine } from '../../common/product'; import { setupCards, updateCard } from './helpers'; import { - CardId, + type CardId, + type StepId, + type ToggleProductAction, + type TogglePanelReducer, + type AddFinishedStepAction, GetStartedPageActions, - ProductId, - StepId, - ToggleProductAction, - TogglePanelReducer, - AddFinishedStepAction, } from './types'; export const reducer = ( @@ -80,13 +80,13 @@ export const getFinishedStepsInitialStates = ({ export const getActiveSectionsInitialStates = ({ activeProducts, }: { - activeProducts: ProductId[]; + activeProducts: ProductLine[]; }) => new Set(activeProducts); export const getActiveCardsInitialStates = ({ activeProducts, finishedSteps, }: { - activeProducts: Set; + activeProducts: Set; finishedSteps: Record>; }) => setupCards(finishedSteps, activeProducts); diff --git a/x-pack/plugins/serverless_security/public/components/get_started/sections.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/sections.tsx similarity index 87% rename from x-pack/plugins/serverless_security/public/components/get_started/sections.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/sections.tsx index 4a03eaff2dd76..11b15264d53ea 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/sections.tsx +++ b/x-pack/plugins/security_solution_serverless/public/get_started/sections.tsx @@ -5,24 +5,17 @@ * 2.0. */ import React from 'react'; - import { - Section, - ProductId, SectionId, GetMoreFromElasticSecurityCardId, GetSetUpCardId, IntroductionSteps, + type Section, } from './types'; import * as i18n from './translations'; import respond from './images/respond.svg'; import protect from './images/protect.svg'; - -export const ActiveConditions = { - analyticsToggled: [ProductId.analytics], - cloudToggled: [ProductId.cloud], - endpointToggled: [ProductId.endpoint], -}; +import { ProductLine } from '../../common/product'; export const introductionSteps = [ { @@ -67,7 +60,7 @@ export const sections: Section[] = [ id: GetSetUpCardId.introduction, steps: introductionSteps, timeInMins: introductionSteps.reduce( - (totalMin, { timeInMinutes }) => (totalMin += timeInMinutes), + (totalMin, { timeInMinutes }) => totalMin + timeInMinutes, 0 ), stepsLeft: introductionSteps.length, @@ -85,11 +78,8 @@ export const sections: Section[] = [ { icon: { type: protect, size: 'xl' }, title: i18n.PROTECT_YOUR_ENVIRONMENT_TITLE, - id: GetSetUpCardId.protectYourEnvironmentInRuntime, - productTypeRequired: [ - ...ActiveConditions.cloudToggled, - ...ActiveConditions.endpointToggled, - ], + id: GetSetUpCardId.protectYourEnvironmentInRealtime, + productLineRequired: [ProductLine.cloud, ProductLine.endpoint], }, ], }, diff --git a/x-pack/plugins/serverless_security/public/lib/get_started/storage.test.ts b/x-pack/plugins/security_solution_serverless/public/get_started/storage.test.ts similarity index 91% rename from x-pack/plugins/serverless_security/public/lib/get_started/storage.test.ts rename to x-pack/plugins/security_solution_serverless/public/get_started/storage.test.ts index 158c271470768..a5d013bd5a4e0 100644 --- a/x-pack/plugins/serverless_security/public/lib/get_started/storage.test.ts +++ b/x-pack/plugins/security_solution_serverless/public/get_started/storage.test.ts @@ -6,16 +6,12 @@ */ import { getStartedStorage } from './storage'; -import { - GetSetUpCardId, - IntroductionSteps, - ProductId, - StepId, -} from '../../components/get_started/types'; -import { storage } from '../storage'; -import { MockStorage } from '../__mocks__/storage'; +import { GetSetUpCardId, IntroductionSteps, type StepId } from './types'; +import { storage } from '../common/lib/storage'; +import type { MockStorage } from '../common/lib/__mocks__/storage'; +import { ProductLine } from '../../common/product'; -jest.mock('../storage'); +jest.mock('../common/lib/storage'); describe('useStorage', () => { const mockStorage = storage as unknown as MockStorage; @@ -33,13 +29,13 @@ describe('useStorage', () => { }); it('should toggle active products in storage', () => { - expect(getStartedStorage.toggleActiveProductsInStorage(ProductId.analytics)).toEqual([ - ProductId.analytics, + expect(getStartedStorage.toggleActiveProductsInStorage(ProductLine.security)).toEqual([ + ProductLine.security, ]); - expect(mockStorage.set).toHaveBeenCalledWith('ACTIVE_PRODUCTS', [ProductId.analytics]); + expect(mockStorage.set).toHaveBeenCalledWith('ACTIVE_PRODUCTS', [ProductLine.security]); - mockStorage.set('ACTIVE_PRODUCTS', [ProductId.analytics]); - expect(getStartedStorage.toggleActiveProductsInStorage(ProductId.analytics)).toEqual([]); + mockStorage.set('ACTIVE_PRODUCTS', [ProductLine.security]); + expect(getStartedStorage.toggleActiveProductsInStorage(ProductLine.security)).toEqual([]); expect(mockStorage.set).toHaveBeenCalledWith('ACTIVE_PRODUCTS', []); }); diff --git a/x-pack/plugins/security_solution_serverless/public/get_started/storage.ts b/x-pack/plugins/security_solution_serverless/public/get_started/storage.ts new file mode 100644 index 0000000000000..e01a0c7064df8 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/get_started/storage.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 { ProductLine } from '../../common/product'; +import type { CardId, StepId } from './types'; +import { storage } from '../common/lib/storage'; + +export const ACTIVE_PRODUCTS_STORAGE_KEY = 'ACTIVE_PRODUCTS'; +export const FINISHED_STEPS_STORAGE_KEY = 'FINISHED_STEPS'; + +export const getStartedStorage = { + getActiveProductsFromStorage: () => { + const activeProducts: ProductLine[] = storage.get(ACTIVE_PRODUCTS_STORAGE_KEY); + return activeProducts ?? []; + }, + toggleActiveProductsInStorage: (productId: ProductLine) => { + const activeProducts: ProductLine[] = storage.get(ACTIVE_PRODUCTS_STORAGE_KEY) ?? []; + const index = activeProducts.indexOf(productId); + if (index < 0) { + activeProducts.push(productId); + } else { + activeProducts.splice(index, 1); + } + storage.set(ACTIVE_PRODUCTS_STORAGE_KEY, activeProducts); + return activeProducts; + }, + getFinishedStepsFromStorageByCardId: (cardId: CardId) => { + const finishedSteps = storage.get(FINISHED_STEPS_STORAGE_KEY) ?? {}; + const card: StepId[] = finishedSteps[cardId] ?? []; + return card; + }, + getAllFinishedStepsFromStorage: () => { + const allFinishedSteps: Record = + storage.get(FINISHED_STEPS_STORAGE_KEY) ?? {}; + return allFinishedSteps; + }, + addFinishedStepToStorage: (cardId: CardId, stepId: StepId) => { + const finishedSteps: Record = storage.get(FINISHED_STEPS_STORAGE_KEY) ?? {}; + const card: StepId[] = finishedSteps[cardId] ?? []; + if (card.indexOf(stepId) < 0) { + card.push(stepId); + storage.set(FINISHED_STEPS_STORAGE_KEY, { ...finishedSteps, [cardId]: card }); + } + }, + removeFinishedStepFromStorage: (cardId: CardId, stepId: StepId) => { + const finishedSteps = storage.get(FINISHED_STEPS_STORAGE_KEY) ?? {}; + const steps: StepId[] = finishedSteps[cardId] ?? []; + const index = steps.indexOf(stepId); + if (index >= 0) { + steps.splice(index, 1); + } + storage.set(FINISHED_STEPS_STORAGE_KEY, { ...finishedSteps, [cardId]: steps }); + }, +}; diff --git a/x-pack/plugins/security_solution_serverless/public/get_started/toggle_panel.test.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/toggle_panel.test.tsx new file mode 100644 index 0000000000000..57fead23ad57d --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/get_started/toggle_panel.test.tsx @@ -0,0 +1,95 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import React from 'react'; +import { render } from '@testing-library/react'; +import { TogglePanel } from './toggle_panel'; +import { useSetUpCardSections } from './use_setup_cards'; +import type { ActiveCards, CardId, StepId } from './types'; +import { GetSetUpCardId, IntroductionSteps, SectionId } from './types'; +import { ProductLine } from '../../common/product'; + +jest.mock('@elastic/eui', () => ({ + ...jest.requireActual('@elastic/eui'), + useEuiTheme: jest.fn(() => ({ euiTheme: { base: 16, size: { xs: '4px' } } })), + useEuiShadow: jest.fn(), +})); + +jest.mock('./use_setup_cards', () => ({ + useSetUpCardSections: jest.fn(), +})); + +const finishedSteps = { + [GetSetUpCardId.introduction]: new Set([IntroductionSteps.watchOverviewVideo]), +} as unknown as Record>; +const activeProducts = new Set([ProductLine.security, ProductLine.cloud]); + +const activeCards = { + [SectionId.getSetUp]: { + [GetSetUpCardId.introduction]: { + id: GetSetUpCardId.introduction, + timeInMins: 3, + stepsLeft: 1, + }, + [GetSetUpCardId.bringInYourData]: { + id: GetSetUpCardId.bringInYourData, + timeInMins: 0, + stepsLeft: 0, + }, + [GetSetUpCardId.activateAndCreateRules]: { + id: GetSetUpCardId.activateAndCreateRules, + timeInMins: 0, + stepsLeft: 0, + }, + [GetSetUpCardId.protectYourEnvironmentInRealtime]: { + id: GetSetUpCardId.protectYourEnvironmentInRealtime, + timeInMins: 0, + stepsLeft: 0, + }, + }, +} as ActiveCards; + +describe('TogglePanel', () => { + const mockUseSetUpCardSections = { + setUpSections: jest.fn(() =>
    ), + }; + + const onStepClicked = jest.fn(); + beforeEach(() => { + jest.clearAllMocks(); + + (useSetUpCardSections as jest.Mock).mockReturnValue(mockUseSetUpCardSections); + }); + + it('should render empty prompt', () => { + const { getByText } = render( + + ); + + expect(getByText(`Hmm, there doesn't seem to be anything there`)).toBeInTheDocument(); + expect( + getByText(`Switch on a toggle to continue your curated "Get Started" experience`) + ).toBeInTheDocument(); + }); + + it('should render sections', () => { + const { getByTestId } = render( + + ); + + expect(getByTestId(`mock-sections`)).toBeInTheDocument(); + }); +}); diff --git a/x-pack/plugins/security_solution_serverless/public/get_started/toggle_panel.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/toggle_panel.tsx new file mode 100644 index 0000000000000..a110b33f87545 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/get_started/toggle_panel.tsx @@ -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 React from 'react'; +import { EuiEmptyPrompt, EuiFlexGroup, EuiFlexItem, useEuiShadow, useEuiTheme } from '@elastic/eui'; + +import { css } from '@emotion/react'; + +import * as i18n from './translations'; +import { useSetUpCardSections } from './use_setup_cards'; + +import type { ActiveCards, CardId, IntroductionSteps, SectionId } from './types'; +import type { ProductLine } from '../../common/product'; + +const TogglePanelComponent: React.FC<{ + finishedSteps: Record>; + activeCards: ActiveCards | null; + activeProducts: Set; + onStepClicked: ({ + stepId, + cardId, + sectionId, + }: { + stepId: IntroductionSteps; + cardId: CardId; + sectionId: SectionId; + }) => void; +}> = ({ finishedSteps, activeCards, activeProducts, onStepClicked }) => { + const { euiTheme } = useEuiTheme(); + + const shadow = useEuiShadow('s'); + + const { setUpSections } = useSetUpCardSections({ euiTheme, shadow }); + const sectionNodes = setUpSections({ + onStepClicked, + finishedSteps, + activeCards, + }); + + return ( + + + {activeProducts.size > 0 ? ( + sectionNodes + ) : ( + {i18n.TOGGLE_PANEL_EMPTY_TITLE}} + body={

    {i18n.TOGGLE_PANEL_EMPTY_DESCRIPTION}

    } + css={css` + padding: ${euiTheme.base * 5}px 0; + .euiEmptyPrompt__contentInner { + max-width: none; + } + `} + /> + )} +     +     + ); +}; + +export const TogglePanel = React.memo(TogglePanelComponent); diff --git a/x-pack/plugins/security_solution_serverless/public/get_started/translations.ts b/x-pack/plugins/security_solution_serverless/public/get_started/translations.ts new file mode 100644 index 0000000000000..5f30b5b135d1a --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/get_started/translations.ts @@ -0,0 +1,244 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; + +export const GET_STARTED_PAGE_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.title', + { + defaultMessage: `Welcome`, + } +); + +export const GET_STARTED_PAGE_SUBTITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.subTitle', + { + defaultMessage: `Let's get started`, + } +); + +export const GET_STARTED_PAGE_DESCRIPTION = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.description', + { + defaultMessage: `Set up your Elastic Security workspace. Use the toggles below to curate a list of tasks that best fits your environment`, + } +); + +export const WELCOME_PANEL_PROJECT_CREATED_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.welcomePanel.projectCreated.title', + { + defaultMessage: `Project created`, + } +); + +export const WELCOME_PANEL_PROJECT_CREATED_DESCRIPTION = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.welcomePanel.projectCreated.description', + { + defaultMessage: `View all projects here.`, + } +); + +export const WELCOME_PANEL_INVITE_YOUR_TEAM_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.welcomePanel.inviteYourTeam.title', + { + defaultMessage: 'Invite your team', + } +); + +export const WELCOME_PANEL_INVITE_YOUR_TEAM_DESCRIPTION = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.welcomePanel.inviteYourTeam.description', + { + defaultMessage: `Boost security through collaboration`, + } +); + +export const WELCOME_PANEL_PROGRESS_TRACKER_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.welcomePanel.progressTracker.title', + { + defaultMessage: 'Progress tracker', + } +); + +export const STEP_TIME_MIN = (min: number) => + i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.progressTracker.stepTimeMin', + { + defaultMessage: 'About {min} {min, plural, =1 {min} other {mins}}', + values: { min }, + } + ); + +export const STEPS_LEFT = (steps: number) => + i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.progressTracker.stepsLeft', + { + defaultMessage: '{steps} {steps, plural, =1 {step} other {steps}} left', + values: { steps }, + } + ); + +export const GET_SET_UP_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.getSetUp.title', + { + defaultMessage: 'Get set up', + } +); + +export const INTRODUCTION_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.introduction.title', + { + defaultMessage: 'introduction', + } +); + +export const WATCH_OVERVIEW_VIDEO_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.watchOverviewVideo.title', + { + defaultMessage: 'Watch the overview video', + } +); + +export const PRODUCT_BADGE_ANALYTICS = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.productBadge.analytics', + { + defaultMessage: 'Analytics', + } +); + +export const PRODUCT_BADGE_CLOUD = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.productBadge.cloud', + { + defaultMessage: 'Cloud', + } +); + +export const PRODUCT_BADGE_EDR = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.productBadge.edr', + { + defaultMessage: 'EDR', + } +); + +export const WATCH_OVERVIEW_VIDEO_DESCRIPTION1 = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.watchOverviewVideo.description1', + { + defaultMessage: `Elastic security keeps your organization’s data safe from attack. `, + } +); + +export const WATCH_OVERVIEW_VIDEO_DESCRIPTION2 = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.watchOverviewVideo.description2', + { + defaultMessage: `Our unified security platform combines Analytics, EDR, and cloud security capabilities into a single SaaS product, providing organizations with a comprehensive solution to protect against a wide range of security threats. With centralized management, real-time threat detection and response, and scalability, our platform can help organizations improve their security posture and reduce the risk of data breaches.`, + } +); + +export const WATCH_OVERVIEW_VIDEO_DESCRIPTION3 = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.watchOverviewVideo.description3', + { + defaultMessage: `Watch the video to explore the core features that allow you to keep your data safe.`, + } +); + +export const WATCH_OVERVIEW_VIDEO_HEADER = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.watchOverviewVideo.header', + { + defaultMessage: 'Elastic Security', + } +); + +export const BRING_IN_YOUR_DATA_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.bringInYourData.title', + { + defaultMessage: 'Bring in your data', + } +); + +export const ACTIVATE_AND_CREATE_RULES_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.activateAndCreateRules.title', + { + defaultMessage: 'Activate and create rules', + } +); + +export const PROTECT_YOUR_ENVIRONMENT_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.protectYourEnvironmentInRealtime.title', + { + defaultMessage: 'Protect your environment in realtime', + } +); + +export const GET_MORE_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.getMoreFromElasticSecurity.title', + { + defaultMessage: 'Get more from Elastic Security', + } +); + +export const MASTER_THE_INVESTIGATION_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.masterTheInvestigationsWorkflow.title', + { + defaultMessage: 'Master the investigations workflow', + } +); + +export const RESPOND_TO_THREATS_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.respondToThreatsWithAutomation.title', + { + defaultMessage: 'Respond to threats with automation', + } +); + +export const OPTIMIZE_YOUR_WORKSPACE_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.optimizeYourWorkspace.title', + { + defaultMessage: 'Optimize your workspace', + } +); + +export const TOGGLE_PANEL_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStartedProductLabel.title', + { + defaultMessage: `Curate your Get Started experience:`, + } +); + +export const ANALYTICS_SWITCH_LABEL = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.switch.analytics.label', + { + defaultMessage: 'Analytics', + } +); + +export const CLOUD_SWITCH_LABEL = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.switch.cloud.label', + + { + defaultMessage: 'Cloud', + } +); + +export const ENDPOINT_SWITCH_LABEL = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.switch.endpoint.label', + { + defaultMessage: 'Endpoint', + } +); + +export const TOGGLE_PANEL_EMPTY_TITLE = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.empty.title', + { + defaultMessage: `Hmm, there doesn't seem to be anything there`, + } +); + +export const TOGGLE_PANEL_EMPTY_DESCRIPTION = i18n.translate( + 'xpack.securitySolutionServerless.getStarted.togglePanel.empty.description', + { + defaultMessage: `Switch on a toggle to continue your curated "Get Started" experience`, + } +); diff --git a/x-pack/plugins/security_solution_serverless/public/get_started/types.ts b/x-pack/plugins/security_solution_serverless/public/get_started/types.ts new file mode 100644 index 0000000000000..69c970f398132 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/get_started/types.ts @@ -0,0 +1,108 @@ +/* + * 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 { EuiIconProps } from '@elastic/eui'; +import type React from 'react'; +import type { ProductLine } from '../../common/product'; + +export interface HeaderSection { + description?: string; + icon: EuiIconProps; + id: string; + title: string; +} +export interface Section { + cards?: Card[]; + description?: string; + icon?: EuiIconProps; + id: SectionId; + title: string; +} + +export interface Badge { + name: string; + id: string; +} + +export type StepId = IntroductionSteps; + +export interface Step { + badges: Badge[]; + description?: string[]; + id: StepId; + splitPanel?: React.ReactNode; + title: string; + timeInMinutes?: number; +} + +export type CardId = GetSetUpCardId | GetMoreFromElasticSecurityCardId; + +export interface Card { + productLineRequired?: ProductLine[]; + description?: string | React.ReactNode; + icon?: EuiIconProps; + id: CardId; + steps?: Step[]; + title: string; + timeInMins?: number; + stepsLeft?: number; +} + +export type ActiveCards = Record>; + +export enum SectionId { + getSetUp = 'getSetUp', + getMoreFromElasticSecurity = 'getMoreFromElasticSecurity', +} + +export enum GetSetUpCardId { + activateAndCreateRules = 'activateAndCreateRules', + bringInYourData = 'bringInYourData', + introduction = 'introduction', + protectYourEnvironmentInRealtime = 'protectYourEnvironmentInRealtime', +} + +export enum IntroductionSteps { + watchOverviewVideo = 'watchOverviewVideo', +} + +export enum GetMoreFromElasticSecurityCardId { + masterTheInvestigationsWorkflow = 'masterTheInvestigationsWorkflow', + optimizeYourWorkSpace = 'optimizeYourWorkSpace', + respondToThreats = 'respondToThreats', +} + +export interface ActiveCard { + id: CardId; + timeInMins: number; + stepsLeft: number; +} +export interface TogglePanelReducer { + activeProducts: Set; + finishedSteps: Record>; + activeCards: Record> | null; +} + +export interface ToggleProductAction { + type: GetStartedPageActions.ToggleProduct; + payload: { section: ProductLine }; +} + +export interface AddFinishedStepAction { + type: GetStartedPageActions.AddFinishedStep; + payload: { stepId: StepId; cardId: CardId; sectionId: SectionId }; +} + +export interface Switch { + id: ProductLine; + label: string; +} + +export enum GetStartedPageActions { + AddFinishedStep = 'addFinishedStep', + ToggleProduct = 'toggleProduct', +} diff --git a/x-pack/plugins/serverless_security/public/components/get_started/use_setup_cards.test.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/use_setup_cards.test.tsx similarity index 93% rename from x-pack/plugins/serverless_security/public/components/get_started/use_setup_cards.test.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/use_setup_cards.test.tsx index dcf8c6a3cfb38..efb07e0ade09f 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/use_setup_cards.test.tsx +++ b/x-pack/plugins/security_solution_serverless/public/get_started/use_setup_cards.test.tsx @@ -6,16 +6,14 @@ */ import { renderHook } from '@testing-library/react-hooks'; -import { EuiThemeComputed } from '@elastic/eui'; +import type { EuiThemeComputed } from '@elastic/eui'; import { useSetUpCardSections } from './use_setup_cards'; +import type { ActiveCards, CardId, StepId } from './types'; import { - ActiveCard, - CardId, GetMoreFromElasticSecurityCardId, GetSetUpCardId, IntroductionSteps, SectionId, - StepId, } from './types'; const mockEuiTheme: EuiThemeComputed = { @@ -44,7 +42,7 @@ describe('useSetUpCardSections', () => { id: GetMoreFromElasticSecurityCardId.masterTheInvestigationsWorkflow, }, }, - } as Record>; + } as ActiveCards; const sections = result.current.setUpSections({ activeCards, diff --git a/x-pack/plugins/serverless_security/public/components/get_started/use_setup_cards.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/use_setup_cards.tsx similarity index 89% rename from x-pack/plugins/serverless_security/public/components/get_started/use_setup_cards.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/use_setup_cards.tsx index 082aadeae88ee..5c45e75ea4f93 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/use_setup_cards.tsx +++ b/x-pack/plugins/security_solution_serverless/public/get_started/use_setup_cards.tsx @@ -5,11 +5,11 @@ * 2.0. */ -import { EuiSpacer, EuiThemeComputed } from '@elastic/eui'; +import type { EuiThemeComputed } from '@elastic/eui'; +import { EuiSpacer, EuiFlexGroup, EuiFlexItem, EuiPanel, EuiTitle } from '@elastic/eui'; import React, { useCallback } from 'react'; import { css } from '@emotion/react'; -import { EuiFlexGroup, EuiFlexItem, EuiPanel, EuiTitle } from '@elastic/eui'; -import { ActiveCard, CardId, SectionId, StepId } from './types'; +import type { ActiveCards, CardId, SectionId, StepId } from './types'; import { CardItem } from './card_item'; import { getSections } from './sections'; @@ -30,7 +30,7 @@ export const useSetUpCardSections = ({ }: { onStepClicked: (params: { stepId: StepId; cardId: CardId; sectionId: SectionId }) => void; finishedSteps: Record>; - activeCards: Record> | null; + activeCards: ActiveCards | null; sectionId: SectionId; }) => { const section = activeCards?.[sectionId]; @@ -63,7 +63,7 @@ export const useSetUpCardSections = ({ }: { onStepClicked: (params: { stepId: StepId; cardId: CardId; sectionId: SectionId }) => void; finishedSteps: Record>; - activeCards: Record> | null; + activeCards: ActiveCards | null; }) => getSections().reduce((acc, currentSection) => { const cardNodes = setUpCards({ diff --git a/x-pack/plugins/security_solution_serverless/public/get_started/use_toggle_panel.test.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/use_toggle_panel.test.tsx new file mode 100644 index 0000000000000..41131ec5c5453 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/get_started/use_toggle_panel.test.tsx @@ -0,0 +1,240 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import { renderHook, act } from '@testing-library/react-hooks'; +import { useTogglePanel } from './use_toggle_panel'; +import { getStartedStorage } from './storage'; +import { ProductLine } from '../../common/product'; +import type { SecurityProductTypes } from '../../common/config'; +import { + GetMoreFromElasticSecurityCardId, + GetSetUpCardId, + IntroductionSteps, + SectionId, +} from './types'; + +jest.mock('./storage'); + +describe('useTogglePanel', () => { + const productTypes = [ + { product_line: 'security', product_tier: 'essentials' }, + { product_line: 'endpoint', product_tier: 'complete' }, + ] as SecurityProductTypes; + + beforeEach(() => { + jest.clearAllMocks(); + + (getStartedStorage.getAllFinishedStepsFromStorage as jest.Mock).mockReturnValue({ + [GetSetUpCardId.introduction]: new Set([IntroductionSteps.watchOverviewVideo]), + }); + (getStartedStorage.getActiveProductsFromStorage as jest.Mock).mockReturnValue([ + ProductLine.security, + ProductLine.cloud, + ProductLine.endpoint, + ]); + }); + + test('should initialize state with correct initial values - when no active products from local storage', () => { + (getStartedStorage.getAllFinishedStepsFromStorage as jest.Mock).mockReturnValue({}); + (getStartedStorage.getActiveProductsFromStorage as jest.Mock).mockReturnValue([]); + + const { result } = renderHook(() => useTogglePanel({ productTypes })); + + const { state } = result.current; + + expect(state.activeProducts).toEqual(new Set([ProductLine.security, ProductLine.endpoint])); + expect(state.finishedSteps).toEqual({}); + + expect(state.activeCards).toEqual( + expect.objectContaining({ + [SectionId.getSetUp]: { + [GetSetUpCardId.introduction]: { + id: GetSetUpCardId.introduction, + timeInMins: 3, + stepsLeft: 1, + }, + [GetSetUpCardId.activateAndCreateRules]: { + id: GetSetUpCardId.activateAndCreateRules, + timeInMins: 0, + stepsLeft: 0, + }, + [GetSetUpCardId.bringInYourData]: { + id: GetSetUpCardId.bringInYourData, + timeInMins: 0, + stepsLeft: 0, + }, + [GetSetUpCardId.protectYourEnvironmentInRealtime]: { + id: GetSetUpCardId.protectYourEnvironmentInRealtime, + timeInMins: 0, + stepsLeft: 0, + }, + }, + [SectionId.getMoreFromElasticSecurity]: { + [GetMoreFromElasticSecurityCardId.masterTheInvestigationsWorkflow]: { + id: GetMoreFromElasticSecurityCardId.masterTheInvestigationsWorkflow, + timeInMins: 0, + stepsLeft: 0, + }, + [GetMoreFromElasticSecurityCardId.optimizeYourWorkSpace]: { + id: GetMoreFromElasticSecurityCardId.optimizeYourWorkSpace, + timeInMins: 0, + stepsLeft: 0, + }, + [GetMoreFromElasticSecurityCardId.respondToThreats]: { + id: GetMoreFromElasticSecurityCardId.respondToThreats, + timeInMins: 0, + stepsLeft: 0, + }, + }, + }) + ); + }); + + test('should initialize state with correct initial values - when all products active', () => { + const { result } = renderHook(() => useTogglePanel({ productTypes })); + + const { state } = result.current; + + expect(state.activeProducts).toEqual( + new Set([ProductLine.security, ProductLine.cloud, ProductLine.endpoint]) + ); + expect(state.finishedSteps).toEqual({ + [GetSetUpCardId.introduction]: new Set([IntroductionSteps.watchOverviewVideo]), + }); + + expect(state.activeCards).toEqual( + expect.objectContaining({ + [SectionId.getSetUp]: { + [GetSetUpCardId.introduction]: { + id: GetSetUpCardId.introduction, + timeInMins: 0, + stepsLeft: 0, + }, + [GetSetUpCardId.activateAndCreateRules]: { + id: GetSetUpCardId.activateAndCreateRules, + timeInMins: 0, + stepsLeft: 0, + }, + [GetSetUpCardId.bringInYourData]: { + id: GetSetUpCardId.bringInYourData, + timeInMins: 0, + stepsLeft: 0, + }, + [GetSetUpCardId.protectYourEnvironmentInRealtime]: { + id: GetSetUpCardId.protectYourEnvironmentInRealtime, + timeInMins: 0, + stepsLeft: 0, + }, + }, + [SectionId.getMoreFromElasticSecurity]: { + [GetMoreFromElasticSecurityCardId.masterTheInvestigationsWorkflow]: { + id: GetMoreFromElasticSecurityCardId.masterTheInvestigationsWorkflow, + timeInMins: 0, + stepsLeft: 0, + }, + [GetMoreFromElasticSecurityCardId.optimizeYourWorkSpace]: { + id: GetMoreFromElasticSecurityCardId.optimizeYourWorkSpace, + timeInMins: 0, + stepsLeft: 0, + }, + [GetMoreFromElasticSecurityCardId.respondToThreats]: { + id: GetMoreFromElasticSecurityCardId.respondToThreats, + timeInMins: 0, + stepsLeft: 0, + }, + }, + }) + ); + }); + + test('should initialize state with correct initial values - when only security product active', () => { + (getStartedStorage.getActiveProductsFromStorage as jest.Mock).mockReturnValue([ + ProductLine.security, + ]); + const { result } = renderHook(() => useTogglePanel({ productTypes })); + + const { state } = result.current; + + expect(state.activeProducts).toEqual(new Set([ProductLine.security])); + expect(state.finishedSteps).toEqual({ + [GetSetUpCardId.introduction]: new Set([IntroductionSteps.watchOverviewVideo]), + }); + + expect(state.activeCards).toEqual( + expect.objectContaining({ + [SectionId.getSetUp]: { + [GetSetUpCardId.introduction]: { + id: GetSetUpCardId.introduction, + timeInMins: 0, + stepsLeft: 0, + }, + [GetSetUpCardId.activateAndCreateRules]: { + id: GetSetUpCardId.activateAndCreateRules, + timeInMins: 0, + stepsLeft: 0, + }, + [GetSetUpCardId.bringInYourData]: { + id: GetSetUpCardId.bringInYourData, + timeInMins: 0, + stepsLeft: 0, + }, + }, + [SectionId.getMoreFromElasticSecurity]: { + [GetMoreFromElasticSecurityCardId.masterTheInvestigationsWorkflow]: { + id: GetMoreFromElasticSecurityCardId.masterTheInvestigationsWorkflow, + timeInMins: 0, + stepsLeft: 0, + }, + [GetMoreFromElasticSecurityCardId.optimizeYourWorkSpace]: { + id: GetMoreFromElasticSecurityCardId.optimizeYourWorkSpace, + timeInMins: 0, + stepsLeft: 0, + }, + [GetMoreFromElasticSecurityCardId.respondToThreats]: { + id: GetMoreFromElasticSecurityCardId.respondToThreats, + timeInMins: 0, + stepsLeft: 0, + }, + }, + }) + ); + }); + + test('should call addFinishedStepToStorage', () => { + const { result } = renderHook(() => useTogglePanel({ productTypes })); + + const { onStepClicked } = result.current; + + act(() => { + onStepClicked({ + stepId: IntroductionSteps.watchOverviewVideo, + cardId: GetSetUpCardId.introduction, + sectionId: SectionId.getSetUp, + }); + }); + + expect(getStartedStorage.addFinishedStepToStorage).toHaveBeenCalledTimes(1); + expect(getStartedStorage.addFinishedStepToStorage).toHaveBeenCalledWith( + GetSetUpCardId.introduction, + IntroductionSteps.watchOverviewVideo + ); + }); + + test('should call toggleActiveProductsInStorage', () => { + const { result } = renderHook(() => useTogglePanel({ productTypes })); + + const { onProductSwitchChanged } = result.current; + + act(() => { + onProductSwitchChanged({ id: ProductLine.security, label: 'Analytics' }); + }); + + expect(getStartedStorage.toggleActiveProductsInStorage).toHaveBeenCalledTimes(1); + expect(getStartedStorage.toggleActiveProductsInStorage).toHaveBeenCalledWith( + ProductLine.security + ); + }); +}); diff --git a/x-pack/plugins/security_solution_serverless/public/get_started/use_toggle_panel.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/use_toggle_panel.tsx new file mode 100644 index 0000000000000..4ea767ae498ba --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/get_started/use_toggle_panel.tsx @@ -0,0 +1,79 @@ +/* + * 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 { useCallback, useMemo, useReducer } from 'react'; +import { ProductLine } from '../../common/product'; +import type { SecurityProductTypes } from '../../common/config'; +import { getStartedStorage } from './storage'; +import { + getActiveCardsInitialStates, + getActiveSectionsInitialStates, + getFinishedStepsInitialStates, + reducer, +} from './reducer'; +import type { CardId, SectionId, StepId, Switch } from './types'; +import { GetStartedPageActions } from './types'; + +export const useTogglePanel = ({ productTypes }: { productTypes: SecurityProductTypes }) => { + const { + getAllFinishedStepsFromStorage, + getActiveProductsFromStorage, + toggleActiveProductsInStorage, + addFinishedStepToStorage, + } = getStartedStorage; + + const finishedStepsInitialStates = useMemo( + () => getFinishedStepsInitialStates({ finishedSteps: getAllFinishedStepsFromStorage() }), + [getAllFinishedStepsFromStorage] + ); + + const activeSectionsInitialStates = useMemo(() => { + const activeProductsFromStorage = getActiveSectionsInitialStates({ + activeProducts: getActiveProductsFromStorage(), + }); + return activeProductsFromStorage.size > 0 + ? activeProductsFromStorage + : new Set(productTypes.map(({ product_line: productLine }) => ProductLine[productLine])) ?? + new Set([ProductLine.security, ProductLine.endpoint, ProductLine.cloud]); + }, [getActiveProductsFromStorage, productTypes]); + + const activeCardsInitialStates = useMemo( + () => + getActiveCardsInitialStates({ + activeProducts: activeSectionsInitialStates, + finishedSteps: finishedStepsInitialStates, + }), + [activeSectionsInitialStates, finishedStepsInitialStates] + ); + + const [state, dispatch] = useReducer(reducer, { + activeProducts: activeSectionsInitialStates, + finishedSteps: finishedStepsInitialStates, + activeCards: activeCardsInitialStates, + }); + + const onStepClicked = useCallback( + ({ stepId, cardId, sectionId }: { stepId: StepId; cardId: CardId; sectionId: SectionId }) => { + dispatch({ + type: GetStartedPageActions.AddFinishedStep, + payload: { stepId, cardId, sectionId }, + }); + addFinishedStepToStorage(cardId, stepId); + }, + [addFinishedStepToStorage] + ); + + const onProductSwitchChanged = useCallback( + (section: Switch) => { + dispatch({ type: GetStartedPageActions.ToggleProduct, payload: { section: section.id } }); + toggleActiveProductsInStorage(section.id); + }, + [toggleActiveProductsInStorage] + ); + + return { state, onStepClicked, onProductSwitchChanged }; +}; diff --git a/x-pack/plugins/serverless_security/public/components/get_started/welcome_panel.test.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/welcome_panel.test.tsx similarity index 96% rename from x-pack/plugins/serverless_security/public/components/get_started/welcome_panel.test.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/welcome_panel.test.tsx index 27a68f640e175..a15c70df33428 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/welcome_panel.test.tsx +++ b/x-pack/plugins/security_solution_serverless/public/get_started/welcome_panel.test.tsx @@ -6,7 +6,7 @@ */ import React from 'react'; -import { render, RenderResult } from '@testing-library/react'; +import { render, type RenderResult } from '@testing-library/react'; import { WelcomePanel } from './welcome_panel'; jest.mock('@elastic/eui', () => { const original = jest.requireActual('@elastic/eui'); diff --git a/x-pack/plugins/serverless_security/public/components/get_started/welcome_panel.tsx b/x-pack/plugins/security_solution_serverless/public/get_started/welcome_panel.tsx similarity index 98% rename from x-pack/plugins/serverless_security/public/components/get_started/welcome_panel.tsx rename to x-pack/plugins/security_solution_serverless/public/get_started/welcome_panel.tsx index c6e25a085998d..79eecfbac7a33 100644 --- a/x-pack/plugins/serverless_security/public/components/get_started/welcome_panel.tsx +++ b/x-pack/plugins/security_solution_serverless/public/get_started/welcome_panel.tsx @@ -10,7 +10,7 @@ import { css } from '@emotion/react'; import React from 'react'; import progress from './images/progress.svg'; import invite from './images/invite.svg'; -import { HeaderSection } from './types'; +import type { HeaderSection } from './types'; import { WELCOME_PANEL_PROJECT_CREATED_TITLE, WELCOME_PANEL_PROJECT_CREATED_DESCRIPTION, diff --git a/x-pack/plugins/security_solution_serverless/public/index.ts b/x-pack/plugins/security_solution_serverless/public/index.ts new file mode 100644 index 0000000000000..20c00e6985332 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/index.ts @@ -0,0 +1,20 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { PluginInitializerContext } from '@kbn/core/public'; +import { SecuritySolutionServerlessPlugin } from './plugin'; + +// This exports static code and TypeScript types, +// as well as, Kibana Platform `plugin()` initializer. +export function plugin(initializerContext: PluginInitializerContext) { + return new SecuritySolutionServerlessPlugin(initializerContext); +} + +export type { + SecuritySolutionServerlessPluginSetup, + SecuritySolutionServerlessPluginStart, +} from './types'; diff --git a/x-pack/plugins/security_solution_serverless/public/jest.config.js b/x-pack/plugins/security_solution_serverless/public/jest.config.js new file mode 100644 index 0000000000000..cf3ad9340c14d --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/jest.config.js @@ -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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + /** all nested directories have their own Jest config file */ + testMatch: [ + '/x-pack/plugins/security_solution_serverless/public/**/*.test.{js,mjs,ts,tsx}', + ], + roots: ['/x-pack/plugins/security_solution_serverless/public'], + coverageDirectory: + '/target/kibana-coverage/jest/x-pack/plugins/security_solution_serverless/public', + coverageReporters: ['text', 'html'], + collectCoverageFrom: [ + '/x-pack/plugins/security_solution_serverless/public/**/*.{ts,tsx}', + '!/x-pack/plugins/security_solution_serverless/public/*.test.{ts,tsx}', + '!/x-pack/plugins/security_solution_serverless/public/{__test__,__snapshots__,__examples__,*mock*,tests,test_helpers,integration_tests,types}/**/*', + '!/x-pack/plugins/security_solution_serverless/public/*mock*.{ts,tsx}', + '!/x-pack/plugins/security_solution_serverless/public/*.test.{ts,tsx}', + '!/x-pack/plugins/security_solution_serverless/public/*.d.ts', + '!/x-pack/plugins/security_solution_serverless/public/*.config.ts', + '!/x-pack/plugins/security_solution_serverless/public/index.{js,ts,tsx}', + ], +}; diff --git a/x-pack/plugins/security_solution_serverless/public/navigation/breadcrumbs.ts b/x-pack/plugins/security_solution_serverless/public/navigation/breadcrumbs.ts new file mode 100644 index 0000000000000..195a1a070abcf --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/navigation/breadcrumbs.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 type { Services } from '../common/services'; + +export const subscribeBreadcrumbs = (services: Services) => { + const { securitySolution, serverless } = services; + securitySolution.getBreadcrumbsNav$().subscribe((breadcrumbsNav) => { + serverless.setBreadcrumbs(breadcrumbsNav.trailing); + }); +}; diff --git a/x-pack/plugins/security_solution_serverless/public/navigation/index.ts b/x-pack/plugins/security_solution_serverless/public/navigation/index.ts new file mode 100644 index 0000000000000..226c20997ef5e --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/navigation/index.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { APP_PATH, MANAGE_PATH } from '@kbn/security-solution-plugin/common'; +import type { Services } from '../common/services'; +import { subscribeBreadcrumbs } from './breadcrumbs'; +import { subscribeNavigationTree } from './navigation_tree'; +import { getSecuritySideNavComponent } from './side_navigation'; + +const SECURITY_MANAGE_PATH = `${APP_PATH}${MANAGE_PATH}`; + +/** + * Configures the serverless project navigation + */ +export const setServerlessNavigation = (services: Services) => { + const { serverless, securitySolution, management } = services; + securitySolution.setIsSidebarEnabled(false); + management.setLandingPageRedirect(SECURITY_MANAGE_PATH); + + serverless.setProjectHome(APP_PATH); + serverless.setSideNavComponent(getSecuritySideNavComponent(services)); + + subscribeNavigationTree(services); + subscribeBreadcrumbs(services); +}; diff --git a/x-pack/plugins/security_solution_serverless/public/navigation/links/index.ts b/x-pack/plugins/security_solution_serverless/public/navigation/links/index.ts new file mode 100644 index 0000000000000..7271c36bbdfdf --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/navigation/links/index.ts @@ -0,0 +1,8 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +export { getProjectNavLinks$ } from './nav_links'; +export type { ProjectNavLinks, ProjectNavigationLink } from './types'; diff --git a/x-pack/plugins/security_solution_serverless/public/navigation/links/nav_links.ts b/x-pack/plugins/security_solution_serverless/public/navigation/links/nav_links.ts new file mode 100644 index 0000000000000..289d0a0c55708 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/navigation/links/nav_links.ts @@ -0,0 +1,18 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { map, type Observable } from 'rxjs'; +import type { NavigationLink } from '@kbn/security-solution-plugin/public'; +import type { ProjectNavLinks, ProjectNavigationLink } from './types'; + +export const getProjectNavLinks$ = (navLinks$: Observable): ProjectNavLinks => { + return navLinks$.pipe(map(processNavLinks)); +}; + +// TODO: This is a placeholder function that will be used to process the nav links, +// It will mix internal Security nav links with the external links to other plugins, in the correct order. +const processNavLinks = (navLinks: NavigationLink[]): ProjectNavigationLink[] => navLinks; diff --git a/x-pack/plugins/security_solution_serverless/public/navigation/links/types.ts b/x-pack/plugins/security_solution_serverless/public/navigation/links/types.ts new file mode 100644 index 0000000000000..47930f64dd6d8 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/navigation/links/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. + */ + +import type { Observable } from 'rxjs'; +import type { NavigationLink } from '@kbn/security-solution-plugin/public'; + +export interface ProjectNavigationLink extends NavigationLink { + // The appId for external links + appId?: string; +} + +export type ProjectNavLinks = Observable; diff --git a/x-pack/plugins/security_solution_serverless/public/navigation/navigation_tree.test.ts b/x-pack/plugins/security_solution_serverless/public/navigation/navigation_tree.test.ts new file mode 100644 index 0000000000000..b1e619a30fc13 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/navigation/navigation_tree.test.ts @@ -0,0 +1,285 @@ +/* + * 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 { ChromeNavLink } from '@kbn/core/public'; +import { APP_UI_ID, SecurityPageName } from '@kbn/security-solution-plugin/common'; +import { subscribeNavigationTree } from './navigation_tree'; +import { BehaviorSubject } from 'rxjs'; +import { mockServices, mockProjectNavLinks } from '../common/__mocks__/services.mock'; +import type { ProjectNavigationLink } from './links'; + +const mockChromeNavLinks = jest.fn((): ChromeNavLink[] => []); +const mockChromeGetNavLinks = jest.fn(() => new BehaviorSubject(mockChromeNavLinks())); +const mockChromeNavLinksGet = jest.fn((id: string): ChromeNavLink | undefined => + mockChromeNavLinks().find((link) => link.id === id) +); +const mockChromeNavLinksHas = jest.fn((id: string): boolean => + mockChromeNavLinks().some((link) => link.id === id) +); + +const testServices = { + ...mockServices, + chrome: { + ...mockServices.chrome, + navLinks: { + ...mockServices.chrome.navLinks, + get: mockChromeNavLinksGet, + has: mockChromeNavLinksHas, + getNavLinks$: mockChromeGetNavLinks, + }, + }, +}; + +const link1Id = 'link-1' as SecurityPageName; +const link2Id = 'link-2' as SecurityPageName; + +const link1: ProjectNavigationLink = { id: link1Id, title: 'link 1' }; +const link2: ProjectNavigationLink = { id: link2Id, title: 'link 2' }; + +const chromeNavLink1: ChromeNavLink = { + id: `${APP_UI_ID}:${link1.id}`, + title: link1.title, + href: '/link1', + url: '/link1', + baseUrl: '', +}; +const chromeNavLink2: ChromeNavLink = { + id: `${APP_UI_ID}:${link2.id}`, + title: link2.title, + href: '/link2', + url: '/link2', + baseUrl: '', +}; + +const waitForDebounce = async () => new Promise((resolve) => setTimeout(resolve, 150)); + +describe('subscribeNavigationTree', () => { + beforeEach(() => { + jest.clearAllMocks(); + mockChromeNavLinks.mockReturnValue([chromeNavLink1, chromeNavLink2]); + }); + + it('should call serverless setNavigation', async () => { + mockProjectNavLinks.mockReturnValueOnce([link1]); + + subscribeNavigationTree(testServices); + await waitForDebounce(); + + expect(testServices.serverless.setNavigation).toHaveBeenCalledWith({ + navigationTree: [ + { + id: 'root', + title: 'Root', + path: ['root'], + breadcrumbStatus: 'hidden', + children: [ + { + id: chromeNavLink1.id, + title: link1.title, + path: ['root', chromeNavLink1.id], + deepLink: chromeNavLink1, + }, + ], + }, + ], + }); + }); + + it('should call serverless setNavigation with external link', async () => { + const externalLink = { ...link1, appId: 'externalAppId' }; + const chromeNavLinkExpected = { + ...chromeNavLink1, + id: `${externalLink.appId}:${externalLink.id}`, + }; + mockChromeNavLinks.mockReturnValue([chromeNavLinkExpected]); + mockProjectNavLinks.mockReturnValueOnce([externalLink]); + + subscribeNavigationTree(testServices); + await waitForDebounce(); + + expect(testServices.serverless.setNavigation).toHaveBeenCalledWith({ + navigationTree: [ + { + id: 'root', + title: 'Root', + path: ['root'], + breadcrumbStatus: 'hidden', + children: [ + { + id: chromeNavLinkExpected.id, + title: externalLink.title, + path: ['root', chromeNavLinkExpected.id], + deepLink: chromeNavLinkExpected, + }, + ], + }, + ], + }); + }); + + it('should call serverless setNavigation with nested children', async () => { + mockProjectNavLinks.mockReturnValueOnce([{ ...link1, links: [link2] }]); + + subscribeNavigationTree(testServices); + await waitForDebounce(); + + expect(testServices.serverless.setNavigation).toHaveBeenCalledWith({ + navigationTree: [ + { + id: 'root', + title: 'Root', + path: ['root'], + breadcrumbStatus: 'hidden', + children: [ + { + id: chromeNavLink1.id, + title: link1.title, + path: ['root', chromeNavLink1.id], + deepLink: chromeNavLink1, + children: [ + { + id: chromeNavLink2.id, + title: link2.title, + path: ['root', chromeNavLink1.id, chromeNavLink2.id], + deepLink: chromeNavLink2, + }, + ], + }, + ], + }, + ], + }); + }); + + it('should not call serverless setNavigation when projectNavLinks is empty', async () => { + mockProjectNavLinks.mockReturnValueOnce([]); + + subscribeNavigationTree(testServices); + await waitForDebounce(); + + expect(testServices.serverless.setNavigation).not.toHaveBeenCalled(); + }); + + it('should not call serverless setNavigation when chrome navLinks is empty', async () => { + mockChromeNavLinks.mockReturnValue([]); + mockProjectNavLinks.mockReturnValueOnce([link1]); + + subscribeNavigationTree(testServices); + await waitForDebounce(); + + expect(testServices.serverless.setNavigation).not.toHaveBeenCalled(); + }); + + it('should debounce updates', async () => { + const id = 'expectedId' as SecurityPageName; + const linkExpected = { ...link1, id }; + const chromeNavLinkExpected = { ...chromeNavLink1, id: `${APP_UI_ID}:${id}` }; + + const chromeGetNavLinks$ = new BehaviorSubject([chromeNavLink1]); + mockChromeGetNavLinks.mockReturnValue(chromeGetNavLinks$); + + mockChromeNavLinks.mockReturnValue([chromeNavLink1, chromeNavLink2, chromeNavLinkExpected]); + mockProjectNavLinks.mockReturnValueOnce([linkExpected]); + + subscribeNavigationTree(testServices); + + chromeGetNavLinks$.next([chromeNavLink1]); + chromeGetNavLinks$.next([chromeNavLink2]); + chromeGetNavLinks$.next([chromeNavLinkExpected]); + + expect(testServices.serverless.setNavigation).not.toHaveBeenCalled(); + + await waitForDebounce(); + + expect(testServices.serverless.setNavigation).toHaveBeenCalledTimes(1); + expect(testServices.serverless.setNavigation).toHaveBeenCalledWith({ + navigationTree: [ + { + id: 'root', + title: 'Root', + path: ['root'], + breadcrumbStatus: 'hidden', + children: [ + { + id: chromeNavLinkExpected.id, + title: link1.title, + path: ['root', chromeNavLinkExpected.id], + deepLink: chromeNavLinkExpected, + }, + ], + }, + ], + }); + }); + + it('should not include links that are not in the chrome navLinks', async () => { + mockChromeNavLinks.mockReturnValue([chromeNavLink2]); + mockProjectNavLinks.mockReturnValueOnce([link1, link2]); + + subscribeNavigationTree(testServices); + await waitForDebounce(); + + expect(testServices.serverless.setNavigation).toHaveBeenCalledWith({ + navigationTree: [ + { + id: 'root', + title: 'Root', + path: ['root'], + breadcrumbStatus: 'hidden', + children: [ + { + id: chromeNavLink2.id, + title: link2.title, + path: ['root', chromeNavLink2.id], + deepLink: chromeNavLink2, + }, + ], + }, + ], + }); + }); + + it('should set hidden breadcrumb for blacklisted links', async () => { + const chromeNavLinkTest = { + ...chromeNavLink1, + id: `${APP_UI_ID}:${SecurityPageName.usersEvents}`, // userEvents link is blacklisted + }; + mockChromeNavLinks.mockReturnValue([chromeNavLinkTest, chromeNavLink2]); + mockProjectNavLinks.mockReturnValueOnce([ + { ...link1, id: SecurityPageName.usersEvents }, + link2, + ]); + + subscribeNavigationTree(testServices); + await waitForDebounce(); + + expect(testServices.serverless.setNavigation).toHaveBeenCalledWith({ + navigationTree: [ + { + id: 'root', + title: 'Root', + path: ['root'], + breadcrumbStatus: 'hidden', + children: [ + { + id: chromeNavLinkTest.id, + title: link1.title, + path: ['root', chromeNavLinkTest.id], + deepLink: chromeNavLinkTest, + breadcrumbStatus: 'hidden', + }, + { + id: chromeNavLink2.id, + title: link2.title, + path: ['root', chromeNavLink2.id], + deepLink: chromeNavLink2, + }, + ], + }, + ], + }); + }); +}); diff --git a/x-pack/plugins/security_solution_serverless/public/navigation/navigation_tree.ts b/x-pack/plugins/security_solution_serverless/public/navigation/navigation_tree.ts new file mode 100644 index 0000000000000..82555ae54332f --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/navigation/navigation_tree.ts @@ -0,0 +1,86 @@ +/* + * 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 { ChromeNavLinks, ChromeProjectNavigationNode } from '@kbn/core-chrome-browser'; +import { APP_UI_ID, SecurityPageName } from '@kbn/security-solution-plugin/common'; +import { combineLatest, skipWhile, debounceTime } from 'rxjs'; +import type { Services } from '../common/services'; +import type { ProjectNavigationLink } from './links/types'; + +// We need to hide breadcrumbs for some pages (tabs) because they appear duplicated. +// These breadcrumbs are incorrectly processed as trailing breadcrumbs in SecuritySolution, because of `SpyRoute` architecture limitations. +// They are navLinks tree with a SecurityPageName, so they should be treated as leading breadcrumbs in ESS as well. +// TODO: Improve the breadcrumbs logic in `use_breadcrumbs_nav` to avoid this workaround. +const HIDDEN_BREADCRUMBS = new Set([ + SecurityPageName.networkDns, + SecurityPageName.networkHttp, + SecurityPageName.networkTls, + SecurityPageName.networkAnomalies, + SecurityPageName.networkEvents, + SecurityPageName.usersAuthentications, + SecurityPageName.usersAnomalies, + SecurityPageName.usersRisk, + SecurityPageName.usersEvents, + SecurityPageName.uncommonProcesses, + SecurityPageName.hostsAnomalies, + SecurityPageName.hostsEvents, + SecurityPageName.hostsRisk, + SecurityPageName.sessions, +]); + +export const subscribeNavigationTree = (services: Services): void => { + const { chrome, serverless, getProjectNavLinks$ } = services; + + combineLatest([ + getProjectNavLinks$().pipe(skipWhile((navLink) => navLink.length === 0)), + chrome.navLinks.getNavLinks$().pipe(skipWhile((chromeNavLinks) => chromeNavLinks.length === 0)), + ]) + .pipe(debounceTime(100)) // avoid multiple calls in a short time + .subscribe(([projectNavLinks]) => { + // The root link is temporary until the issue about having multiple links at first level is solved. + // TODO: Assign the navigationTree nodes when the issue is solved: + // const navigationTree = formatChromeProjectNavNodes(chrome.navLinks, projectNavLinks), + const navigationTree: ChromeProjectNavigationNode[] = [ + { + id: 'root', + title: 'Root', + path: ['root'], + breadcrumbStatus: 'hidden', + children: formatChromeProjectNavNodes(chrome.navLinks, projectNavLinks, ['root']), + }, + ]; + serverless.setNavigation({ navigationTree }); + }); +}; + +const formatChromeProjectNavNodes = ( + chromeNavLinks: ChromeNavLinks, + projectNavLinks: ProjectNavigationLink[], + path: string[] = [] +): ChromeProjectNavigationNode[] => + projectNavLinks.reduce((navNodes, navLink) => { + const { id: deepLinkId, appId = APP_UI_ID, links, title } = navLink; + + const id = deepLinkId ? `${appId}:${deepLinkId}` : appId; + + if (chromeNavLinks.has(id)) { + const breadcrumbHidden = appId === APP_UI_ID && HIDDEN_BREADCRUMBS.has(deepLinkId); + const link: ChromeProjectNavigationNode = { + id, + title, + path: [...path, id], + deepLink: chromeNavLinks.get(id), + ...(breadcrumbHidden && { breadcrumbStatus: 'hidden' }), + }; + + if (links?.length) { + link.children = formatChromeProjectNavNodes(chromeNavLinks, links, link.path); + } + navNodes.push(link); + } + return navNodes; + }, []); diff --git a/x-pack/plugins/serverless_security/public/hooks/__mocks__/use_side_nav_items.ts b/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/__mocks__/use_side_nav_items.ts similarity index 100% rename from x-pack/plugins/serverless_security/public/hooks/__mocks__/use_side_nav_items.ts rename to x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/__mocks__/use_side_nav_items.ts diff --git a/x-pack/plugins/serverless_security/public/components/side_navigation/categories.ts b/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/categories.ts similarity index 100% rename from x-pack/plugins/serverless_security/public/components/side_navigation/categories.ts rename to x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/categories.ts diff --git a/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/index.tsx b/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/index.tsx new file mode 100644 index 0000000000000..c749131300b5d --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/index.tsx @@ -0,0 +1,20 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import React from 'react'; + +import type { SideNavComponent } from '@kbn/core-chrome-browser/src/project_navigation'; +import { SecuritySideNavigation } from './lazy'; +import { KibanaServicesProvider, type Services } from '../../common/services'; + +export const getSecuritySideNavComponent = (services: Services): SideNavComponent => + function SecuritySideNavComponent() { + return ( + + + + ); + }; diff --git a/x-pack/plugins/serverless_security/public/components/side_navigation/lazy.tsx b/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/lazy.tsx similarity index 100% rename from x-pack/plugins/serverless_security/public/components/side_navigation/lazy.tsx rename to x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/lazy.tsx diff --git a/x-pack/plugins/serverless_security/public/components/side_navigation/side_navigation.test.tsx b/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/side_navigation.test.tsx similarity index 85% rename from x-pack/plugins/serverless_security/public/components/side_navigation/side_navigation.test.tsx rename to x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/side_navigation.test.tsx index 5309dbf3e1295..1df7e2ca3008f 100644 --- a/x-pack/plugins/serverless_security/public/components/side_navigation/side_navigation.test.tsx +++ b/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/side_navigation.test.tsx @@ -8,11 +8,12 @@ import React from 'react'; import { render } from '@testing-library/react'; import { SecuritySideNavigation } from './side_navigation'; -import { useSideNavItems, useSideNavSelectedId } from '../../hooks/use_side_nav_items'; +import { useSideNavItems, useSideNavSelectedId } from './use_side_nav_items'; import { SecurityPageName } from '@kbn/security-solution-plugin/common'; -import { KibanaServicesProvider } from '../../services.mock'; +import { ServicesWrapper } from '../../common/__mocks__/services.mock'; + +jest.mock('./use_side_nav_items'); -jest.mock('../../hooks/use_side_nav_items'); const mockUseSideNavItems = useSideNavItems as jest.Mock; const mockUseSideNavSelectedId = useSideNavSelectedId as jest.Mock; @@ -54,22 +55,22 @@ describe('SecuritySideNavigation', () => { it('should render loading when not items received', () => { mockUseSideNavItems.mockReturnValueOnce([]); - const component = render(, { wrapper: KibanaServicesProvider }); + const component = render(, { wrapper: ServicesWrapper }); expect(component.queryByTestId('sideNavLoader')).toBeInTheDocument(); }); it('should not render loading when items received', () => { - const component = render(, { wrapper: KibanaServicesProvider }); + const component = render(, { wrapper: ServicesWrapper }); expect(component.queryByTestId('sideNavLoader')).not.toBeInTheDocument(); }); it('should render the SideNav when items received', () => { - const component = render(, { wrapper: KibanaServicesProvider }); + const component = render(, { wrapper: ServicesWrapper }); expect(component.queryByTestId('solutionSideNav')).toBeInTheDocument(); }); it('should pass item props to the SolutionSideNav component', () => { - render(, { wrapper: KibanaServicesProvider }); + render(, { wrapper: ServicesWrapper }); expect(mockSolutionSideNav).toHaveBeenCalledWith( expect.objectContaining({ @@ -79,7 +80,7 @@ describe('SecuritySideNavigation', () => { }); it('should selectedId the SolutionSideNav component', () => { - render(, { wrapper: KibanaServicesProvider }); + render(, { wrapper: ServicesWrapper }); expect(mockSolutionSideNav).toHaveBeenCalledWith( expect.objectContaining({ diff --git a/x-pack/plugins/serverless_security/public/components/side_navigation/side_navigation.tsx b/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/side_navigation.tsx similarity index 79% rename from x-pack/plugins/serverless_security/public/components/side_navigation/side_navigation.tsx rename to x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/side_navigation.tsx index b38ff02dd3417..5ba20e26cac21 100644 --- a/x-pack/plugins/serverless_security/public/components/side_navigation/side_navigation.tsx +++ b/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/side_navigation.tsx @@ -9,7 +9,7 @@ import React from 'react'; import { EuiLoadingSpinner, useEuiTheme } from '@elastic/eui'; import { SolutionNav } from '@kbn/shared-ux-page-solution-nav'; import { SolutionSideNav } from '@kbn/security-solution-side-nav'; -import { useSideNavItems, useSideNavSelectedId } from '../../hooks/use_side_nav_items'; +import { useSideNavItems, useSideNavSelectedId } from './use_side_nav_items'; import { CATEGORIES } from './categories'; export const SecuritySideNavigation: React.FC = () => { @@ -26,19 +26,18 @@ export const SecuritySideNavigation: React.FC = () => { canBeCollapsed={false} name={'Security'} icon={'logoSecurity'} - children={ - - } closeFlyoutButtonPosition={'inside'} headingProps={{ 'data-test-subj': 'securitySolutionNavHeading', }} - /> + > + + ); }; diff --git a/x-pack/plugins/serverless_security/public/hooks/use_side_nav_items.test.tsx b/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/use_side_nav_items.test.tsx similarity index 76% rename from x-pack/plugins/serverless_security/public/hooks/use_side_nav_items.test.tsx rename to x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/use_side_nav_items.test.tsx index 38a1f4e578427..2145961e36aa5 100644 --- a/x-pack/plugins/serverless_security/public/hooks/use_side_nav_items.test.tsx +++ b/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/use_side_nav_items.test.tsx @@ -7,17 +7,11 @@ import { renderHook } from '@testing-library/react-hooks'; import { useSideNavItems, useSideNavSelectedId } from './use_side_nav_items'; -import { BehaviorSubject } from 'rxjs'; -import type { NavigationLink } from '@kbn/security-solution-plugin/public/common/links/types'; import { SecurityPageName } from '@kbn/security-solution-plugin/common'; -import { KibanaServicesProvider, servicesMocks } from '../services.mock'; +import { mockServices, mockProjectNavLinks } from '../../common/__mocks__/services.mock'; -jest.mock('./use_link_props'); - -const mockNavLinks = jest.fn((): NavigationLink[] => []); -servicesMocks.securitySolution.getNavLinks$.mockImplementation( - () => new BehaviorSubject(mockNavLinks()) -); +jest.mock('../../common/hooks/use_link_props'); +jest.mock('../../common/services'); const mockUseLocation = jest.fn(() => ({ pathname: '/' })); jest.mock('react-router-dom', () => ({ @@ -31,20 +25,19 @@ describe('useSideNavItems', () => { }); it('should return empty items', async () => { - const { result } = renderHook(useSideNavItems, { wrapper: KibanaServicesProvider }); - + const { result } = renderHook(useSideNavItems); const items = result.current; expect(items).toEqual([]); - expect(servicesMocks.securitySolution.getNavLinks$).toHaveBeenCalledTimes(1); + expect(mockServices.getProjectNavLinks$).toHaveBeenCalledTimes(1); }); it('should return main items', async () => { - mockNavLinks.mockReturnValueOnce([ + mockProjectNavLinks.mockReturnValueOnce([ { id: SecurityPageName.alerts, title: 'Alerts' }, { id: SecurityPageName.case, title: 'Cases' }, ]); - const { result } = renderHook(useSideNavItems, { wrapper: KibanaServicesProvider }); + const { result } = renderHook(useSideNavItems); const items = result.current; expect(items).toEqual([ @@ -66,14 +59,14 @@ describe('useSideNavItems', () => { }); it('should return secondary items', async () => { - mockNavLinks.mockReturnValueOnce([ + mockProjectNavLinks.mockReturnValueOnce([ { id: SecurityPageName.dashboards, title: 'Dashboards', links: [{ id: SecurityPageName.detectionAndResponse, title: 'Detection & Response' }], }, ]); - const { result } = renderHook(useSideNavItems, { wrapper: KibanaServicesProvider }); + const { result } = renderHook(useSideNavItems); const items = result.current; expect(items).toEqual([ @@ -96,14 +89,14 @@ describe('useSideNavItems', () => { }); it('should return get started link', async () => { - mockNavLinks.mockReturnValueOnce([ + mockProjectNavLinks.mockReturnValueOnce([ { id: SecurityPageName.landing, title: 'Get Started', sideNavIcon: 'launch', }, ]); - const { result } = renderHook(useSideNavItems, { wrapper: KibanaServicesProvider }); + const { result } = renderHook(useSideNavItems); const items = result.current; @@ -142,10 +135,7 @@ describe('useSideNavSelectedId', () => { }, ]; - const { result } = renderHook(useSideNavSelectedId, { - wrapper: KibanaServicesProvider, - initialProps: items, - }); + const { result } = renderHook(useSideNavSelectedId, { initialProps: items }); const selectedId = result.current; expect(selectedId).toEqual(''); @@ -168,10 +158,7 @@ describe('useSideNavSelectedId', () => { }, ]; - const { result } = renderHook(useSideNavSelectedId, { - wrapper: KibanaServicesProvider, - initialProps: items, - }); + const { result } = renderHook(useSideNavSelectedId, { initialProps: items }); const selectedId = result.current; expect(selectedId).toEqual(SecurityPageName.alerts); @@ -196,10 +183,7 @@ describe('useSideNavSelectedId', () => { }, ]; - const { result } = renderHook(useSideNavSelectedId, { - wrapper: KibanaServicesProvider, - initialProps: items, - }); + const { result } = renderHook(useSideNavSelectedId, { initialProps: items }); const selectedId = result.current; expect(selectedId).toEqual(SecurityPageName.dashboards); diff --git a/x-pack/plugins/serverless_security/public/hooks/use_side_nav_items.ts b/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/use_side_nav_items.ts similarity index 93% rename from x-pack/plugins/serverless_security/public/hooks/use_side_nav_items.ts rename to x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/use_side_nav_items.ts index d352a779e9444..779dd86764d74 100644 --- a/x-pack/plugins/serverless_security/public/hooks/use_side_nav_items.ts +++ b/x-pack/plugins/security_solution_serverless/public/navigation/side_navigation/use_side_nav_items.ts @@ -8,10 +8,13 @@ import { useMemo } from 'react'; import { matchPath, useLocation } from 'react-router-dom'; import { SecurityPageName } from '@kbn/security-solution-plugin/common'; -import { SolutionSideNavItem, SolutionSideNavItemPosition } from '@kbn/security-solution-side-nav'; -import { useKibana } from '../services'; -import { type GetLinkProps, useGetLinkProps } from './use_link_props'; -import { useNavLinks } from './use_nav_links'; +import { + SolutionSideNavItemPosition, + type SolutionSideNavItem, +} from '@kbn/security-solution-side-nav'; +import { useKibana } from '../../common/services'; +import { type GetLinkProps, useGetLinkProps } from '../../common/hooks/use_link_props'; +import { useNavLinks } from '../../common/hooks/use_nav_links'; type NavigationLink = ReturnType[number]; diff --git a/x-pack/plugins/security_solution_serverless/public/plugin.ts b/x-pack/plugins/security_solution_serverless/public/plugin.ts new file mode 100644 index 0000000000000..307a438c6e9c3 --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/plugin.ts @@ -0,0 +1,62 @@ +/* + * 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/public'; + +import { getSecurityGetStartedComponent } from './get_started'; +import type { + SecuritySolutionServerlessPluginSetup, + SecuritySolutionServerlessPluginStart, + SecuritySolutionServerlessPluginSetupDeps, + SecuritySolutionServerlessPluginStartDeps, + ServerlessSecurityPublicConfig, +} from './types'; +import { registerUpsellings } from './upselling'; +import { createServices } from './common/services'; +import { setServerlessNavigation } from './navigation'; + +export class SecuritySolutionServerlessPlugin + implements + Plugin< + SecuritySolutionServerlessPluginSetup, + SecuritySolutionServerlessPluginStart, + SecuritySolutionServerlessPluginSetupDeps, + SecuritySolutionServerlessPluginStartDeps + > +{ + private config: ServerlessSecurityPublicConfig; + + constructor(private readonly initializerContext: PluginInitializerContext) { + this.config = this.initializerContext.config.get(); + } + + public setup( + _core: CoreSetup, + setupDeps: SecuritySolutionServerlessPluginSetupDeps + ): SecuritySolutionServerlessPluginSetup { + registerUpsellings(setupDeps.securitySolution.upselling, this.config.productTypes); + return {}; + } + + public start( + core: CoreStart, + startDeps: SecuritySolutionServerlessPluginStartDeps + ): SecuritySolutionServerlessPluginStart { + const { securitySolution } = startDeps; + const { productTypes } = this.config; + + const services = createServices(core, startDeps); + + securitySolution.setGetStartedPage(getSecurityGetStartedComponent(services, productTypes)); + + setServerlessNavigation(services); + + return {}; + } + + public stop() {} +} diff --git a/x-pack/plugins/security_solution_serverless/public/types.ts b/x-pack/plugins/security_solution_serverless/public/types.ts new file mode 100644 index 0000000000000..e65813aa68f6c --- /dev/null +++ b/x-pack/plugins/security_solution_serverless/public/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 { SecurityPluginSetup, SecurityPluginStart } from '@kbn/security-plugin/public'; +import type { + PluginSetup as SecuritySolutionPluginSetup, + PluginStart as SecuritySolutionPluginStart, +} from '@kbn/security-solution-plugin/public'; +import type { ServerlessPluginSetup, ServerlessPluginStart } from '@kbn/serverless/public'; +import type { ManagementSetup, ManagementStart } from '@kbn/management-plugin/public'; +import type { SecurityProductTypes } from '../common/config'; + +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface SecuritySolutionServerlessPluginSetup {} + +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface SecuritySolutionServerlessPluginStart {} + +export interface SecuritySolutionServerlessPluginSetupDeps { + security: SecurityPluginSetup; + securitySolution: SecuritySolutionPluginSetup; + serverless: ServerlessPluginSetup; + management: ManagementSetup; +} + +export interface SecuritySolutionServerlessPluginStartDeps { + security: SecurityPluginStart; + securitySolution: SecuritySolutionPluginStart; + serverless: ServerlessPluginStart; + management: ManagementStart; +} + +export interface ServerlessSecurityPublicConfig { + productTypes: SecurityProductTypes; +} diff --git a/x-pack/plugins/serverless_security/public/components/upselling/hooks/use_product_type_by_pli.ts b/x-pack/plugins/security_solution_serverless/public/upselling/hooks/use_product_type_by_pli.ts similarity index 93% rename from x-pack/plugins/serverless_security/public/components/upselling/hooks/use_product_type_by_pli.ts rename to x-pack/plugins/security_solution_serverless/public/upselling/hooks/use_product_type_by_pli.ts index f1486469247cb..df4a97e3b0347 100644 --- a/x-pack/plugins/serverless_security/public/components/upselling/hooks/use_product_type_by_pli.ts +++ b/x-pack/plugins/security_solution_serverless/public/upselling/hooks/use_product_type_by_pli.ts @@ -6,7 +6,7 @@ */ import type { AppFeatureKey } from '@kbn/security-solution-plugin/common'; -import { PLI_APP_FEATURES } from '../../../../common/pli/pli_config'; +import { PLI_APP_FEATURES } from '../../../common/pli/pli_config'; export const useProductTypeByPLI = (requiredPLI: AppFeatureKey): string | null => { if (PLI_APP_FEATURES.security.essentials.includes(requiredPLI)) { diff --git a/x-pack/plugins/serverless_security/public/components/upselling/index.ts b/x-pack/plugins/security_solution_serverless/public/upselling/index.ts similarity index 100% rename from x-pack/plugins/serverless_security/public/components/upselling/index.ts rename to x-pack/plugins/security_solution_serverless/public/upselling/index.ts diff --git a/x-pack/plugins/serverless_security/public/components/upselling/pages/generic_upselling_page.tsx b/x-pack/plugins/security_solution_serverless/public/upselling/pages/generic_upselling_page.tsx similarity index 83% rename from x-pack/plugins/serverless_security/public/components/upselling/pages/generic_upselling_page.tsx rename to x-pack/plugins/security_solution_serverless/public/upselling/pages/generic_upselling_page.tsx index aed8d76898495..cc6440358da61 100644 --- a/x-pack/plugins/serverless_security/public/components/upselling/pages/generic_upselling_page.tsx +++ b/x-pack/plugins/security_solution_serverless/public/upselling/pages/generic_upselling_page.tsx @@ -11,16 +11,16 @@ import type { AppFeatureKey } from '@kbn/security-solution-plugin/common'; import { useProductTypeByPLI } from '../hooks/use_product_type_by_pli'; export const GenericUpsellingPage: React.FC<{ requiredPLI: AppFeatureKey }> = React.memo( - ({ requiredPLI }) => { + function GenericUpsellingPage({ requiredPLI }) { const productTypeRequired = useProductTypeByPLI(requiredPLI); return ( This is a testing component for a Serverless upselling prompt.} + title={<>{'This is a testing component for a Serverless upselling prompt.'}} body={ <> - Get {productTypeRequired} to enable this feature + {'Get'} {productTypeRequired} {'to enable this feature'}