diff --git a/.buildkite/ftr_configs.yml b/.buildkite/ftr_configs.yml index 1400d1fdee4cf..bdd704bc76ba2 100644 --- a/.buildkite/ftr_configs.yml +++ b/.buildkite/ftr_configs.yml @@ -47,6 +47,9 @@ 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/plugins/profiling/e2e/ftr_config_open.ts + - x-pack/plugins/profiling/e2e/ftr_config_runner.ts + - x-pack/plugins/profiling/e2e/ftr_config.ts # Elastic Synthetics configs - x-pack/plugins/synthetics/e2e/config.ts @@ -68,6 +71,9 @@ disabled: # Scalability testing config that we run in its own pipeline - x-pack/test/scalability/config.ts + # Asset Manager configs, in tech preview, will move to enabled after more stability introduced + - x-pack/test/api_integration/apis/asset_manager/config.ts + defaultQueue: 'n2-4-spot' enabled: - test/accessibility/config.ts @@ -146,6 +152,7 @@ enabled: - x-pack/test/api_integration/config_security_basic.ts - x-pack/test/api_integration/config_security_trial.ts - x-pack/test/api_integration/apis/aiops/config.ts + - x-pack/test/api_integration/apis/asset_manager/config_when_disabled.ts - x-pack/test/api_integration/apis/cases/config.ts - x-pack/test/api_integration/apis/cloud_security_posture/config.ts - x-pack/test/api_integration/apis/console/config.ts diff --git a/.buildkite/pipelines/on_merge.yml b/.buildkite/pipelines/on_merge.yml index 2af74cbda6b9f..392c2acab92ec 100644 --- a/.buildkite/pipelines/on_merge.yml +++ b/.buildkite/pipelines/on_merge.yml @@ -81,6 +81,8 @@ steps: - command: '.buildkite/scripts/steps/functional/on_merge_unsupported_ftrs.sh' label: Trigger unsupported ftr tests timeout_in_minutes: 10 + depends_on: + - build agents: queue: 'kibana-default' diff --git a/.buildkite/pipelines/on_merge_unsupported_ftrs.yml b/.buildkite/pipelines/on_merge_unsupported_ftrs.yml index 3244823c6c2e3..935d0ed628ff0 100644 --- a/.buildkite/pipelines/on_merge_unsupported_ftrs.yml +++ b/.buildkite/pipelines/on_merge_unsupported_ftrs.yml @@ -35,6 +35,19 @@ steps: - exit_status: '*' limit: 1 + - command: .buildkite/scripts/steps/functional/profiling_cypress.sh + label: 'Profling Cypress Tests' + agents: + queue: n2-4-spot + depends_on: build + timeout_in_minutes: 120 + parallelism: 4 + retry: + automatic: + - exit_status: '-1' + limit: 3 + - exit_status: '*' + limit: 1 - command: .buildkite/scripts/steps/functional/security_solution.sh label: 'Security Solution Tests' diff --git a/.buildkite/pipelines/pull_request/profiling_cypress.yml b/.buildkite/pipelines/pull_request/profiling_cypress.yml new file mode 100644 index 0000000000000..ca345f2c78dd3 --- /dev/null +++ b/.buildkite/pipelines/pull_request/profiling_cypress.yml @@ -0,0 +1,14 @@ +steps: + - command: .buildkite/scripts/steps/functional/profiling_cypress.sh + label: 'Profiling Cypress Tests' + agents: + queue: n2-4-spot + depends_on: build + timeout_in_minutes: 120 + parallelism: 2 + retry: + automatic: + - exit_status: '-1' + limit: 3 + - exit_status: '*' + limit: 1 diff --git a/.buildkite/scripts/pipelines/pull_request/pipeline.ts b/.buildkite/scripts/pipelines/pull_request/pipeline.ts index 5fb29fc87c228..ac1d5c7ecc077 100644 --- a/.buildkite/scripts/pipelines/pull_request/pipeline.ts +++ b/.buildkite/scripts/pipelines/pull_request/pipeline.ts @@ -115,6 +115,13 @@ const uploadPipeline = (pipelineContent: string | object) => { pipeline.push(getPipeline('.buildkite/pipelines/pull_request/apm_cypress.yml')); } + if ( + (await doAnyChangesMatch([/^x-pack\/plugins\/profiling/])) || + GITHUB_PR_LABELS.includes('ci:all-cypress-suites') + ) { + pipeline.push(getPipeline('.buildkite/pipelines/pull_request/profiling_cypress.yml')); + } + if ( (await doAnyChangesMatch([/^x-pack\/plugins\/fleet/, /^x-pack\/test\/fleet_cypress/])) || GITHUB_PR_LABELS.includes('ci:all-cypress-suites') diff --git a/.buildkite/scripts/steps/artifacts/docker_image.sh b/.buildkite/scripts/steps/artifacts/docker_image.sh index da6403251c927..1744a02fe4243 100755 --- a/.buildkite/scripts/steps/artifacts/docker_image.sh +++ b/.buildkite/scripts/steps/artifacts/docker_image.sh @@ -82,6 +82,7 @@ if [[ "$BUILDKITE_BRANCH" == "$KIBANA_BASE_BRANCH" ]]; then cat << EOF | buildkite-agent pipeline upload steps: - trigger: k8s-gitops-update-image-tag + async: true label: ":argo: Update image tag for Kibana" branches: main build: diff --git a/.buildkite/scripts/steps/functional/profiling_cypress.sh b/.buildkite/scripts/steps/functional/profiling_cypress.sh new file mode 100644 index 0000000000000..38799acc90778 --- /dev/null +++ b/.buildkite/scripts/steps/functional/profiling_cypress.sh @@ -0,0 +1,17 @@ +#!/usr/bin/env bash + +set -euo pipefail + +source .buildkite/scripts/common/util.sh + +.buildkite/scripts/bootstrap.sh +.buildkite/scripts/download_build_artifacts.sh + +export JOB=kibana-profiling-cypress + +echo "--- Profiling Cypress Tests" + +cd "$XPACK_DIR" + +node plugins/profiling/scripts/test/e2e.js \ + --kibana-install-dir "$KIBANA_BUILD_LOCATION" \ \ No newline at end of file diff --git a/.eslintrc.js b/.eslintrc.js index f32b6498d9981..51cd3440b87d5 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -897,6 +897,18 @@ module.exports = { ], }, }, + { + files: [ + 'x-pack/plugins/apm/**/*.{js,mjs,ts,tsx}', + 'x-pack/plugins/observability/**/*.{js,mjs,ts,tsx}', + 'x-pack/plugins/ux/**/*.{js,mjs,ts,tsx}', + 'x-pack/plugins/synthetics/**/*.{js,mjs,ts,tsx}', + 'x-pack/plugins/infra/**/*.{js,mjs,ts,tsx}', + ], + rules: { + '@kbn/telemetry/event_generating_elements_should_be_instrumented': 'error', + }, + }, { // require explicit return types in route handlers for performance reasons files: ['x-pack/plugins/apm/server/**/route.ts'], diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 8d851831d01fb..fbab2ccea81b0 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -42,6 +42,7 @@ packages/kbn-apm-synthtrace-client @elastic/apm-ui packages/kbn-apm-utils @elastic/apm-ui test/plugin_functional/plugins/app_link_test @elastic/kibana-core x-pack/test/usage_collection/plugins/application_usage_test @elastic/kibana-core +x-pack/plugins/asset_manager @jasonrhodes x-pack/test/security_api_integration/plugins/audit_log @elastic/kibana-security packages/kbn-axe-config @elastic/kibana-qa packages/kbn-babel-preset @elastic/kibana-operations @@ -334,6 +335,7 @@ packages/kbn-eslint-config @elastic/kibana-operations packages/kbn-eslint-plugin-disable @elastic/kibana-operations 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 src/plugins/event_annotation @elastic/kibana-visualizations x-pack/test/plugin_api_integration/plugins/event_log @elastic/response-ops @@ -464,6 +466,7 @@ src/plugins/navigation @elastic/appex-sharedux src/plugins/newsfeed @elastic/kibana-core test/common/plugins/newsfeed @elastic/kibana-core x-pack/plugins/notifications @elastic/appex-sharedux +packages/kbn-object-versioning @elastic/appex-sharedux x-pack/test/cases_api_integration/common/plugins/observability @elastic/response-ops x-pack/plugins/observability @elastic/actionable-observability x-pack/test/security_api_integration/plugins/oidc_provider @elastic/kibana-security @@ -528,6 +531,8 @@ x-pack/test/security_api_integration/packages/helpers @elastic/kibana-core x-pack/plugins/security @elastic/kibana-security x-pack/test/cases_api_integration/common/plugins/security_solution @elastic/response-ops x-pack/plugins/security_solution @elastic/security-solution +packages/security-solution/side_nav @elastic/security-threat-hunting-explore +packages/security-solution/storybook/config @elastic/security-threat-hunting-explore x-pack/test/security_functional/plugins/test_endpoints @elastic/kibana-security packages/kbn-securitysolution-autocomplete @elastic/security-solution-platform packages/kbn-securitysolution-ecs @elastic/security-threat-hunting-explore @@ -771,6 +776,9 @@ packages/kbn-yarn-lock-validator @elastic/kibana-operations # Actionable Observability /x-pack/test/observability_functional @elastic/actionable-observability +# Observability robots +/.github/workflows/deploy-my-kibana.yml @elastic/observablt-robots + # Infra Monitoring /x-pack/test/functional/apps/infra @elastic/infra-monitoring-ui /x-pack/test/api_integration/apis/infra @elastic/infra-monitoring-ui diff --git a/.github/workflows/deploy-my-kibana.yml b/.github/workflows/deploy-my-kibana.yml new file mode 100644 index 0000000000000..e756b648a1802 --- /dev/null +++ b/.github/workflows/deploy-my-kibana.yml @@ -0,0 +1,30 @@ +--- +## +## This the automation to let Observability team members to deploy a Kibana instance +## using the Observability test environments. +## It will deploy a new instance for those who add a comment /oblt-deploy +## only supported for Elasticians. +## +## Owner: @elastic/observablt-robots +## Further details: https://ela.st/oblt-deploy-my-kibana +## +name: deploy-my-kibana + +on: + issue_comment: + types: + - created + +permissions: + contents: read + +jobs: + deploy-my-kibana: + if: ${{ github.event.issue.pull_request && github.event.comment.body == '/oblt-deploy'}} + runs-on: ubuntu-latest + steps: + - uses: elastic/apm-pipeline-library/.github/actions/deploy-my-kibana@current + with: + vaultUrl: ${{ secrets.OBLT_VAULT_ADDR }} + vaultRoleId: ${{ secrets.OBLT_VAULT_ROLE_ID }} + vaultSecretId: ${{ secrets.OBLT_VAULT_SECRET_ID }} diff --git a/.i18nrc.json b/.i18nrc.json index b17c42b9a64ab..9ea9a3c338713 100644 --- a/.i18nrc.json +++ b/.i18nrc.json @@ -79,6 +79,7 @@ "server": "src/legacy/server", "share": "src/plugins/share", "sharedUXPackages": "packages/shared-ux", + "securitySolutionPackages": "packages/security-solution", "coloring": "packages/kbn-coloring/src", "languageDocumentationPopover": "packages/kbn-language-documentation-popover/src", "statusPage": "src/legacy/core_plugins/status_page", diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index 1cff4313a5a2c..bde409ea38dc2 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] --- import actionsObj from './actions.devdocs.json'; diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index cd4c0dc722546..da6128d9df024 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-03-09 +date: 2023-03-21 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 e1b23a80e89fb..518028bd7ed42 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-03-09 +date: 2023-03-21 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 4cfb55b465603..bf6fff9249dc1 100644 --- a/api_docs/alerting.devdocs.json +++ b/api_docs/alerting.devdocs.json @@ -99,7 +99,7 @@ "section": "def-common.RuleLastRun", "text": "RuleLastRun" }, - " | null | undefined; nextRun?: Date | null | undefined; running?: boolean | null | undefined; viewInAppRelativeUrl?: string | undefined; }" + " | null | undefined; nextRun?: Date | null | undefined; revision: number; running?: boolean | null | undefined; viewInAppRelativeUrl?: string | undefined; }" ], "path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts", "deprecated": false, @@ -867,6 +867,144 @@ } ], "functions": [ + { + "parentPluginId": "alerting", + "id": "def-server.createConcreteWriteIndex", + "type": "Function", + "tags": [], + "label": "createConcreteWriteIndex", + "description": [ + "\nInstalls index template that uses installed component template\nPrior to installation, simulates the installation to check for possible\nconflicts. Simulate should return an empty mapping if a template\nconflicts with an already installed template." + ], + "signature": [ + "({ logger, esClient, indexPatterns, totalFieldsLimit, }: CreateConcreteWriteIndexOpts) => Promise" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_concrete_write_index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.createConcreteWriteIndex.$1", + "type": "Object", + "tags": [], + "label": "{\n logger,\n esClient,\n indexPatterns,\n totalFieldsLimit,\n}", + "description": [], + "signature": [ + "CreateConcreteWriteIndexOpts" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_concrete_write_index.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.createOrUpdateComponentTemplate", + "type": "Function", + "tags": [], + "label": "createOrUpdateComponentTemplate", + "description": [], + "signature": [ + "({ logger, esClient, template, totalFieldsLimit, }: CreateOrUpdateComponentTemplateOpts) => Promise" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_component_template.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.createOrUpdateComponentTemplate.$1", + "type": "Object", + "tags": [], + "label": "{\n logger,\n esClient,\n template,\n totalFieldsLimit,\n}", + "description": [], + "signature": [ + "CreateOrUpdateComponentTemplateOpts" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_component_template.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.createOrUpdateIlmPolicy", + "type": "Function", + "tags": [], + "label": "createOrUpdateIlmPolicy", + "description": [ + "\nCreates ILM policy if it doesn't already exist, updates it if it does" + ], + "signature": [ + "({ logger, esClient, name, policy, }: CreateOrUpdateIlmPolicyOpts) => Promise" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_ilm_policy.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.createOrUpdateIlmPolicy.$1", + "type": "Object", + "tags": [], + "label": "{\n logger,\n esClient,\n name,\n policy,\n}", + "description": [], + "signature": [ + "CreateOrUpdateIlmPolicyOpts" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_ilm_policy.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.createOrUpdateIndexTemplate", + "type": "Function", + "tags": [], + "label": "createOrUpdateIndexTemplate", + "description": [ + "\nInstalls index template that uses installed component template\nPrior to installation, simulates the installation to check for possible\nconflicts. Simulate should return an empty mapping if a template\nconflicts with an already installed template." + ], + "signature": [ + "({ logger, esClient, template, }: CreateOrUpdateIndexTemplateOpts) => Promise" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.createOrUpdateIndexTemplate.$1", + "type": "Object", + "tags": [], + "label": "{\n logger,\n esClient,\n template,\n}", + "description": [], + "signature": [ + "CreateOrUpdateIndexTemplateOpts" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "alerting", "id": "def-server.getComponentTemplate", @@ -936,6 +1074,135 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "alerting", + "id": "def-server.getIndexTemplate", + "type": "Function", + "tags": [], + "label": "getIndexTemplate", + "description": [], + "signature": [ + "(kibanaVersion: string, ilmPolicyName: string, indexPatterns: ", + "IIndexPatternString", + ", componentTemplateRefs: string[], totalFieldsLimit: number) => ", + "IndicesPutIndexTemplateRequest" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.getIndexTemplate.$1", + "type": "string", + "tags": [], + "label": "kibanaVersion", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "alerting", + "id": "def-server.getIndexTemplate.$2", + "type": "string", + "tags": [], + "label": "ilmPolicyName", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "alerting", + "id": "def-server.getIndexTemplate.$3", + "type": "Object", + "tags": [], + "label": "indexPatterns", + "description": [], + "signature": [ + "IIndexPatternString" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "alerting", + "id": "def-server.getIndexTemplate.$4", + "type": "Array", + "tags": [], + "label": "componentTemplateRefs", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "alerting", + "id": "def-server.getIndexTemplate.$5", + "type": "number", + "tags": [], + "label": "totalFieldsLimit", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.installWithTimeout", + "type": "Function", + "tags": [], + "label": "installWithTimeout", + "description": [], + "signature": [ + "({ description, installFn, pluginStop$, logger, timeoutMs, }: InstallWithTimeoutOpts) => Promise" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/install_with_timeout.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.installWithTimeout.$1", + "type": "Object", + "tags": [], + "label": "{\n description,\n installFn,\n pluginStop$,\n logger,\n timeoutMs = INSTALLATION_TIMEOUT,\n}", + "description": [], + "signature": [ + "InstallWithTimeoutOpts" + ], + "path": "x-pack/plugins/alerting/server/alerts_service/lib/install_with_timeout.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "alerting", "id": "def-server.isRuleSnoozed", @@ -1297,6 +1564,21 @@ "path": "x-pack/plugins/alerting/server/rules_client/methods/bulk_edit.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditOptionsFilter.shouldIncrementRevision", + "type": "Function", + "tags": [], + "label": "shouldIncrementRevision", + "description": [], + "signature": [ + "ShouldIncrementRevision", + " | undefined" + ], + "path": "x-pack/plugins/alerting/server/rules_client/methods/bulk_edit.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -1371,6 +1653,21 @@ "path": "x-pack/plugins/alerting/server/rules_client/methods/bulk_edit.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditOptionsIds.shouldIncrementRevision", + "type": "Function", + "tags": [], + "label": "shouldIncrementRevision", + "description": [], + "signature": [ + "ShouldIncrementRevision", + " | undefined" + ], + "path": "x-pack/plugins/alerting/server/rules_client/methods/bulk_edit.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -3864,6 +4161,21 @@ "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": [ @@ -3880,10 +4192,10 @@ "children": [ { "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.policy", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY._meta", "type": "Object", "tags": [], - "label": "policy", + "label": "_meta", "description": [], "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", "deprecated": false, @@ -3891,34 +4203,34 @@ "children": [ { "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.policy._meta", - "type": "Object", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY._meta.managed", + "type": "boolean", "tags": [], - "label": "_meta", + "label": "managed", "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.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 - } - ] - }, + "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.policy.phases", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot", "type": "Object", "tags": [], - "label": "phases", + "label": "hot", "description": [], "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", "deprecated": false, @@ -3926,10 +4238,10 @@ "children": [ { "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.policy.phases.hot", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions", "type": "Object", "tags": [], - "label": "hot", + "label": "actions", "description": [], "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", "deprecated": false, @@ -3937,10 +4249,10 @@ "children": [ { "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.policy.phases.hot.actions", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions.rollover", "type": "Object", "tags": [], - "label": "actions", + "label": "rollover", "description": [], "path": "x-pack/plugins/alerting/server/alerts_service/default_lifecycle_policy.ts", "deprecated": false, @@ -3948,38 +4260,25 @@ "children": [ { "parentPluginId": "alerting", - "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.policy.phases.hot.actions.rollover", - "type": "Object", + "id": "def-server.DEFAULT_ALERTS_ILM_POLICY.phases.hot.actions.rollover.max_age", + "type": "string", "tags": [], - "label": "rollover", + "label": "max_age", "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.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.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 - } - ] + "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 } ] } @@ -6612,6 +6911,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "alerting", + "id": "def-common.Rule.revision", + "type": "number", + "tags": [], + "label": "revision", + "description": [], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "alerting", "id": "def-common.Rule.running", @@ -8861,7 +9171,7 @@ "section": "def-common.RuleLastRun", "text": "RuleLastRun" }, - " | null | undefined; nextRun?: Date | null | undefined; running?: boolean | null | undefined; viewInAppRelativeUrl?: string | undefined; }" + " | null | undefined; nextRun?: Date | null | undefined; revision: number; running?: boolean | null | undefined; viewInAppRelativeUrl?: string | undefined; }" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index a598a47caeb40..57d1a1d25fbae 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-03-09 +date: 2023-03-21 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 | |-------------------|-----------|------------------------|-----------------| -| 531 | 1 | 515 | 40 | +| 550 | 1 | 531 | 42 | ## Client diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json index 82c3d641ea6d6..0dee9e539989a 100644 --- a/api_docs/apm.devdocs.json +++ b/api_docs/apm.devdocs.json @@ -202,9 +202,9 @@ "APMPluginSetupDependencies", ") => { config$: ", "Observable", - "; searchAggregatedTransactions: ", + "; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; forceSyntheticSource: boolean; }>>; getApmIndices: () => Promise>; createApmEventClient: ({ request, context, debug, }: { debug?: boolean | undefined; request: ", + "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; }>>; getApmIndices: () => Promise>; createApmEventClient: ({ request, context, debug, }: { debug?: boolean | undefined; request: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -448,9 +448,9 @@ "label": "config", "description": [], "signature": [ - "{ readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", + "{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: 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 indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; readonly forceSyntheticSource: boolean; }" + "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; }" ], "path": "x-pack/plugins/apm/server/routes/typings.ts", "deprecated": false, @@ -546,7 +546,7 @@ "section": "def-server.LicensingPluginStart", "text": "LicensingPluginStart" }, - ">; }; observability: { setup: { getAlertDetailsConfig(): Readonly<{} & { uptime: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; metrics: Readonly<{} & { enabled: boolean; }>; logs: Readonly<{} & { enabled: boolean; }>; }>; getScopedAnnotationsClient: (requestContext: ", + ">; }; observability: { setup: { getAlertDetailsConfig(): Readonly<{} & { uptime: Readonly<{} & { enabled: boolean; }>; metrics: Readonly<{} & { enabled: boolean; }>; logs: Readonly<{} & { enabled: boolean; }>; }>; getScopedAnnotationsClient: (requestContext: ", { "pluginId": "@kbn/core-http-request-handler-context-server", "scope": "common", @@ -840,9 +840,9 @@ "label": "APMConfig", "description": [], "signature": [ - "{ readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", + "{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: 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 indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; readonly forceSyntheticSource: boolean; }" + "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; }" ], "path": "x-pack/plugins/apm/server/index.ts", "deprecated": false, @@ -932,7 +932,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { terms: { label: string; count: number; }[]; }, ", + ", { terms: ", + "MobileTermsByFieldResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/mobile-services/{serviceName}/location/stats\": ", { @@ -1260,7 +1262,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { mobileFilters: MobileFilters; }, ", + ", { mobileFilters: ", + "MobileFiltersResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/agent_instances\": ", { @@ -1320,7 +1324,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { items: { serviceNode?: string | undefined; environments: string[]; agentVersion: string; lastReport: string; }[]; }, ", + ", { items: ", + "AgentExplorerAgentInstancesResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/get_agents_per_service\": ", { @@ -1382,9 +1388,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { items: { serviceName: string; environments: string[]; agentName: ", - "AgentName", - "; agentVersion: string[]; agentDocsPageUrl?: string | undefined; instances: number; }[]; }, ", + ", ", + "AgentExplorerAgentsResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/settings/labs\": ", { @@ -1810,7 +1816,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { tracesPerMinute: number; numberOfServices: number; totalSize: number; diskSpaceUsedPct: number; estimatedIncrementalSize: number; dailyDataGeneration: number; }, ", + ", ", + "StorageExplorerSummaryStatisticsResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/storage_explorer/privileges\": ", { @@ -1908,7 +1916,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { storageTimeSeries: { serviceName: string; timeseries: { x: number; y: number; }[]; }[]; }, ", + ", { storageTimeSeries: ", + "SizeTimeseriesResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/storage_details\": ", { @@ -1992,15 +2002,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { processorEventStats: { processorEvent: ", - { - "pluginId": "observability", - "scope": "common", - "docId": "kibObservabilityPluginApi", - "section": "def-common.ProcessorEvent", - "text": "ProcessorEvent" - }, - "; docs: number; size: number; }[]; indicesStats: { indexName: string; numberOfDocs: number; primary?: string | number | undefined; replica?: string | number | undefined; size?: number | undefined; dataStream?: string | undefined; lifecyclePhase?: string | undefined; }[]; }, ", + ", ", + "StorageDetailsResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/storage_explorer\": ", { @@ -2080,9 +2084,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { serviceStatistics: { serviceName: string; environments: string[]; size?: number | undefined; agentName: ", - "AgentName", - "; sampling: number; }[]; }, ", + ", { serviceStatistics: ", + "StorageExplorerServiceStatisticsResponse", + "; }, ", "APMRouteCreateOptions", ">; \"POST /api/apm/agent_keys\": ", { @@ -2118,9 +2122,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { agentKey: ", - "SecurityCreateApiKeyResponse", - "; }, ", + ", ", + "CreateAgentKeyResponse", + ", ", "APMRouteCreateOptions", ">; \"POST /internal/apm/api_key/invalidate\": ", { @@ -2144,7 +2148,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { invalidatedAgentKeys: string[]; }, ", + ", ", + "InvalidateAgentKeyResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/agent_keys/privileges\": ", { @@ -2162,7 +2168,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { areApiKeysEnabled: boolean; isAdmin: boolean; canManage: boolean; }, ", + ", ", + "AgentKeysPrivilegesResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/agent_keys\": ", { @@ -2180,15 +2188,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { agentKeys: ", - { - "pluginId": "security", - "scope": "common", - "docId": "kibSecurityPluginApi", - "section": "def-common.ApiKey", - "text": "ApiKey" - }, - "[]; }, ", + ", ", + "AgentKeysResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/event_metadata/{processorEvent}/{id}\": ", { @@ -2374,11 +2376,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { failedTransactionsCorrelations: ", - "FailedTransactionsCorrelation", - "[]; ccsWarning: boolean; fallbackResult?: ", - "FailedTransactionsCorrelation", - " | undefined; }, ", + ", ", + "PValuesResponse", + ", ", "APMRouteCreateOptions", ">; \"POST /internal/apm/correlations/significant_correlations/transactions\": ", { @@ -2456,11 +2456,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { latencyCorrelations: ", - "LatencyCorrelation", - "[]; ccsWarning: boolean; totalDocCount: number; fallbackResult?: ", - "LatencyCorrelation", - " | undefined; }, ", + ", ", + "SignificantCorrelationsResponse", + ", ", "APMRouteCreateOptions", ">; \"POST /internal/apm/correlations/field_value_pairs/transactions\": ", { @@ -2526,9 +2524,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { fieldValuePairs: ", - "FieldValuePair", - "[]; errors: any[]; }, ", + ", ", + "FieldValuePairsResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/correlations/field_value_stats/transactions\": ", { @@ -2662,7 +2660,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { fieldCandidates: string[]; }, ", + ", ", + "DurationFieldCandidatesResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/dependencies/operations/spans\": ", { @@ -2788,11 +2788,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { allSpansDistribution: ", - "OverallLatencyDistributionResponse", - "; failedSpansDistribution: ", - "OverallLatencyDistributionResponse", - "; }, ", + ", ", + "DependencyLatencyDistributionResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/dependencies/operations\": ", { @@ -2984,7 +2982,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentTimeseries: { x: number; y: number | null; }[]; comparisonTimeseries: { x: number; y: number | null; }[] | null; }, ", + ", ", + "ThroughputChartsForDependencyResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/dependencies/charts/latency\": ", { @@ -3048,7 +3048,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentTimeseries: { x: number; y: number; }[]; comparisonTimeseries: { x: number; y: number; }[] | null; }, ", + ", ", + "LatencyChartsDependencyResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/dependencies/metadata\": ", { @@ -3080,7 +3082,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { metadata: { spanType: string | undefined; spanSubtype: string | undefined; }; }, ", + ", { metadata: ", + "MetadataForDependencyResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/dependencies/upstream_services\": ", { @@ -3150,25 +3154,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { services: { currentStats: { latency: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; throughput: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; errorRate: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; totalTime: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; } & { impact: number; }; previousStats: ({ latency: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; throughput: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; errorRate: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; totalTime: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; } & { impact: number; }) | null; location: ", - "Node", - "; }[]; }, ", + ", ", + "UpstreamServicesForDependencyResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/dependencies/top_dependencies\": ", { @@ -3232,25 +3220,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { dependencies: { currentStats: { latency: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; throughput: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; errorRate: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; totalTime: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; } & { impact: number; }; previousStats: ({ latency: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; throughput: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; errorRate: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; totalTime: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; } & { impact: number; }) | null; location: ", - "Node", - "; }[]; }, ", + ", ", + "TopDependenciesResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/fleet/java_agent_versions\": ", { @@ -3312,15 +3284,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { has_cloud_agent_policy: boolean; has_cloud_apm_package_policy: boolean; cloud_apm_migration_enabled: boolean; has_required_role: boolean | undefined; cloud_apm_package_policy: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicy", - "text": "PackagePolicy" - }, - " | undefined; has_apm_integrations: boolean; latest_apm_package_version: string; }, ", + ", ", + "RunMigrationCheckResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/fleet/apm_server_schema/unsupported\": ", { @@ -3338,7 +3304,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { unsupported: { key: string; value: any; }[]; }, ", + ", { unsupported: ", + "UnsupportedApmServerSchema", + "; }, ", "APMRouteCreateOptions", ">; \"POST /api/apm/fleet/apm_server_schema\": ", { @@ -3384,7 +3352,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { cloudStandaloneSetup: { apmServerUrl: string | undefined; secretToken: string | undefined; } | undefined; fleetAgents: never[]; isFleetEnabled: false; } | { cloudStandaloneSetup: { apmServerUrl: string | undefined; secretToken: string | undefined; } | undefined; isFleetEnabled: true; fleetAgents: { id: string; name: string; apmServerUrl: any; secretToken: any; }[]; }, ", + ", ", + "FleetAgentResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/fleet/has_apm_policies\": ", { @@ -3508,9 +3478,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { artifacts: ", - "ArtifactSourceMap", - "[]; total: number; } | undefined, ", + ", ", + "ListSourceMapArtifactsResponse", + " | undefined, ", "APMRouteCreateOptions", ">; \"DELETE /internal/apm/settings/custom_links/{id}\": ", { @@ -3754,9 +3724,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", ", - "ApmIndicesConfig", - ", ", + ", Readonly<{ error: string; onboarding: string; span: string; transaction: string; metric: string; }>, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/settings/apm-index-settings\": ", { @@ -3774,7 +3742,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { apmIndexSettings: { configurationName: \"error\" | \"metric\" | \"span\" | \"transaction\" | \"onboarding\"; defaultValue: string; savedValue: string | undefined; }[]; }, ", + ", { apmIndexSettings: ", + "ApmIndexSettingsResponse", + "; }, ", "APMRouteCreateOptions", ">; \"POST /internal/apm/settings/anomaly-detection/update_to_v3\": ", { @@ -3920,7 +3890,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { environments: { name: string; alreadyConfigured: boolean; }[]; }, ", + ", { environments: ", + "EnvironmentsResponse", + "; }, ", "APMRouteCreateOptions", ">; \"POST /api/apm/settings/agent-configuration/search\": ", { @@ -4168,7 +4140,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { latencyChartPreview: { name: string; data: { x: number; y: number | null; }[]; }[]; }, ", + ", { latencyChartPreview: ", + "TransactionDurationChartPreviewResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/rule_types/error_count/chart_preview\": ", { @@ -4312,7 +4286,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { errorRateChartPreview: { x: number; y: number; }[]; }, ", + ", { errorRateChartPreview: ", + "TransactionErrorRateChartPreviewResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\": ", { @@ -4380,13 +4356,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: { transactionColdstartRate: ", - "Coordinate", - "[]; average: number | null; }; previousPeriod: { transactionColdstartRate: { x: number; y: ", - "Maybe", - "; }[]; average: number | null; } | { transactionColdstartRate: { x: number; y: ", - "Maybe", - "; }[]; average: null; }; }, ", + ", ", + "ColdstartRateResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\": ", { @@ -4452,13 +4424,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: { transactionColdstartRate: ", - "Coordinate", - "[]; average: number | null; }; previousPeriod: { transactionColdstartRate: { x: number; y: ", - "Maybe", - "; }[]; average: number | null; } | { transactionColdstartRate: { x: number; y: ", - "Maybe", - "; }[]; average: null; }; }, ", + ", ", + "ColdstartRateResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\": ", { @@ -4528,13 +4496,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: { timeseries: ", - "Coordinate", - "[]; average: number | null; }; previousPeriod: { timeseries: { x: number; y: ", - "Maybe", - "; }[]; average: number | null; } | { timeseries: { x: number; y: ", - "Maybe", - "; }[]; average: null; }; }, ", + ", ", + "FailedTransactionRateResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\": ", { @@ -4598,7 +4562,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { timeseries: { title: string; color: string; type: string; data: { x: number; y: number | null; }[]; hideLegend: boolean; legendValue: string; }[]; }, ", + ", ", + "TransactionBreakdownResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\": ", { @@ -4670,7 +4636,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { traceSamples: { transactionId: string; traceId: string; }[]; }, ", + ", ", + "TransactionTraceSamplesResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\": ", { @@ -4754,11 +4722,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: { overallAvgDuration: number | null; latencyTimeseries: { x: number; y: number | null; }[]; }; previousPeriod: { latencyTimeseries: { x: number; y: ", - "Maybe", - "; }[]; overallAvgDuration: number | null; } | { latencyTimeseries: { x: number; y: ", - "Maybe", - "; }[]; overallAvgDuration: null; }; }, ", + ", ", + "TransactionLatencyResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\": ", { @@ -4840,23 +4806,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: ", - "Dictionary", - "<{ transactionName: string; latency: ", - "Coordinate", - "[]; throughput: ", - "Coordinate", - "[]; errorRate: ", - "Coordinate", - "[]; impact: number; }>; previousPeriod: ", - "Dictionary", - "<{ errorRate: { x: number; y: ", - "Maybe", - "; }[]; throughput: { x: number; y: ", - "Maybe", - "; }[]; latency: { x: number; y: ", - "Maybe", - "; }[]; transactionName: string; impact: number; }>; }, ", + ", ", + "ServiceTransactionGroupDetailedStatisticsResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\": ", { @@ -4930,7 +4882,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { transactionGroups: { transactionType: string; name: string; latency: number | null; throughput: number; errorRate: number; impact: number; }[]; transactionOverflowCount: number; maxTransactionGroupsExceeded: boolean; }, ", + ", ", + "ServiceTransactionGroupsResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/traces/{traceId}/spans/{spanId}\": ", { @@ -5126,7 +5080,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { traceSamples: { traceId: string; transactionId: string; }[]; }, ", + ", { traceSamples: ", + "TraceSamplesResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/transactions/{transactionId}\": ", { @@ -5234,11 +5190,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { items: { key: ", - "BucketKey", - "; serviceName: string; transactionName: string; averageResponseTime: number | null; transactionsPerMinute: number; transactionType: string; impact: number; agentName: ", - "AgentName", - "; }[]; }, ", + ", ", + "TopTracesPrimaryStatsResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/traces/{traceId}\": ", { @@ -5366,9 +5320,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { items: { serviceName: string; environments: string[]; agentName: ", - "AgentName", - "; }[]; }, ", + ", { items: ", + "LookupServicesResponse", + "; }, ", "APMRouteCreateOptions", ">; \"DELETE /internal/apm/service-group\": ", { @@ -5652,7 +5606,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { breakdown: { title: string; data: { x: number; y: number; }[]; }[]; }, ", + ", { breakdown: ", + "ServiceDependenciesBreakdownResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/dependencies\": ", { @@ -5712,25 +5668,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { serviceDependencies: { currentStats: { latency: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; throughput: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; errorRate: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; totalTime: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; } & { impact: number; }; previousStats: ({ latency: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; throughput: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; errorRate: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; totalTime: { value: number | null; timeseries: ", - "Coordinate", - "[]; }; } & { impact: number; }) | null; location: ", - "Node", - "; }[]; }, ", + ", { serviceDependencies: ", + "ServiceDependenciesResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\": ", { @@ -5812,31 +5752,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: ", - "Dictionary", - "<{ serviceNodeName: string; errorRate?: ", - "Coordinate", - "[] | undefined; latency?: ", - "Coordinate", - "[] | undefined; throughput?: ", - "Coordinate", - "[] | undefined; cpuUsage?: ", - "Coordinate", - "[] | undefined; memoryUsage?: ", - "Coordinate", - "[] | undefined; }>; previousPeriod: ", - "Dictionary", - "<{ cpuUsage: { x: number; y: ", - "Maybe", - "; }[]; errorRate: { x: number; y: ", - "Maybe", - "; }[]; latency: { x: number; y: ", - "Maybe", - "; }[]; memoryUsage: { x: number; y: ", - "Maybe", - "; }[]; throughput: { x: number; y: ", - "Maybe", - "; }[]; serviceNodeName: string; }>; }, ", + ", ", + "ServiceInstancesDetailedStatisticsResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\": ", { @@ -5914,7 +5832,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: { serviceNodeName: string; errorRate?: number | undefined; latency?: number | undefined; throughput?: number | undefined; cpuUsage?: number | null | undefined; memoryUsage?: number | null | undefined; }[]; previousPeriod: { serviceNodeName: string; errorRate?: number | undefined; latency?: number | undefined; throughput?: number | undefined; cpuUsage?: number | null | undefined; memoryUsage?: number | null | undefined; }[]; }, ", + ", { currentPeriod: ", + "ServiceInstanceMainStatisticsResponse", + "; previousPeriod: ", + "ServiceInstanceMainStatisticsResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/throughput\": ", { @@ -5984,9 +5906,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: { x: number; y: number | null; }[]; previousPeriod: { x: number; y: ", - "Maybe", - "; }[]; }, ", + ", { currentPeriod: ", + "ServiceThroughputResponse", + "; previousPeriod: ", + "ServiceThroughputResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\": ", { @@ -6018,29 +5942,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { '@timestamp': string; agent: (", - "Agent", - " & { name: string; version: string; }) | ({ name: string; version: string; } & ", - "Agent", - "); service: ", - "Service", - " | (", - "Service", - " & { name: string; node?: { name: string; } | undefined; environment?: string | undefined; version?: string | undefined; }) | (", - "Service", - " & { node?: { name: string; } | undefined; }) | (", - "Service", - " & { name: string; node?: { name: string; } | undefined; environment?: string | undefined; version?: string | undefined; } & { node?: { name: string; } | undefined; }) | (", - "Service", - " & { node?: { name: string; } | undefined; } & { name: string; node?: { name: string; } | undefined; environment?: string | undefined; version?: string | undefined; }); container: ", - "Container", - " | undefined; kubernetes: ", - "Kubernetes", - " | undefined; host: ", - "Host", - " | undefined; cloud: ", - "Cloud", - " | undefined; }, ", + ", ", + "ServiceInstanceMetadataDetailsResponse", + " & ({} | ", + "ServiceInstanceContainerMetadataDetails", + "), ", "APMRouteCreateOptions", ">; \"POST /api/apm/services/{serviceName}/annotation\": ", { @@ -6142,9 +6048,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { annotations: ", - "Annotation", - "[]; }, ", + ", ", + "ServiceAnnotationResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\": ", { @@ -6202,7 +6108,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { host: string | number; containerId: string | number; }, ", + ", ", + "ServiceNodeMetadataResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/transaction_types\": ", { @@ -6232,7 +6140,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { transactionTypes: string[]; }, ", + ", ", + "ServiceTransactionTypesResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/agent\": ", { @@ -6262,9 +6172,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { agentName?: string | undefined; runtimeName?: string | undefined; serverlessType?: ", - "ServerlessType", - " | undefined; }, ", + ", ", + "ServiceAgentResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/metadata/icons\": ", { @@ -6432,11 +6342,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: ", - "Dictionary", - "<{ serviceName: string; latency: { x: number; y: number | null; }[]; transactionErrorRate: { x: number; y: number; }[]; throughput: { x: number; y: number; }[]; }>; previousPeriod: ", - "Dictionary", - "<{ serviceName: string; latency: { x: number; y: number | null; }[]; transactionErrorRate: { x: number; y: number; }[]; throughput: { x: number; y: number; }[]; }>; }, ", + ", ", + "ServiceTransactionDetailedStatPeriodsResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services\": ", { @@ -6532,21 +6440,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { items: ", - "JoinedReturnType", - "<{ serviceName: string; transactionType: string; environments: string[]; agentName: ", - "AgentName", - "; latency: number | null; transactionErrorRate: number; throughput: number; } | { serviceName: string; environments: string[]; agentName: ", - "AgentName", - "; } | { serviceName: string; healthStatus: ", - "ServiceHealthStatus", - "; } | { serviceName: string; alertsCount: number; }, { serviceName: string; transactionType: string; environments: string[]; agentName: ", - "AgentName", - "; latency: number | null; transactionErrorRate: number; throughput: number; } & { serviceName: string; environments: string[]; agentName: ", - "AgentName", - "; } & { serviceName: string; healthStatus: ", - "ServiceHealthStatus", - "; } & { serviceName: string; alertsCount: number; }>; maxServiceCountExceeded: boolean; serviceOverflowCount: number; }, ", + ", ", + "ServicesItemsResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/service-map/dependency\": ", { @@ -6602,11 +6498,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: ", - "NodeStats", - "; previousPeriod: ", - "NodeStats", - " | undefined; }, ", + ", ", + "ServiceMapServiceDependencyInfoResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/service-map/service/{serviceName}\": ", { @@ -6662,11 +6556,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: ", - "NodeStats", - "; previousPeriod: ", - "NodeStats", - " | undefined; }, ", + ", ", + "ServiceMapServiceNodeInfoResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/service-map\": ", { @@ -6722,11 +6614,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { elements: (", - "ConnectionElement", - " | { data: { id: string; 'span.type': string; label: string; groupedConnections: ({ 'service.name': string; 'service.environment': string | null; 'agent.name': string; serviceAnomalyStats?: ", - "ServiceAnomalyStats", - " | undefined; label: string | undefined; id?: string | undefined; parent?: string | undefined; position?: cytoscape.Position | undefined; } | { 'span.destination.service.resource': string; 'span.type': string; 'span.subtype': string; label: string | undefined; id?: string | undefined; parent?: string | undefined; position?: cytoscape.Position | undefined; } | { id: string; source: string | undefined; target: string | undefined; label: string | undefined; bidirectional?: boolean | undefined; isInverseEdge?: boolean | undefined; } | undefined)[]; }; } | { data: { id: string; source: string; target: string; }; })[]; }, ", + ", ", + "GroupResourceNodesResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/observability_overview/has_data\": ", { @@ -6744,9 +6634,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { hasData: boolean; indices: ", - "ApmIndicesConfig", - "; }, ", + ", ", + "HasDataResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/observability_overview\": ", { @@ -6780,7 +6670,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { serviceCount: number; transactionPerMinute: { value: undefined; timeseries: never[]; } | { value: number; timeseries: { x: number; y: number | null; }[]; }; }, ", + ", ", + "ObservabilityOverviewResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/metrics/serverless/active_instances\": ", { @@ -6900,7 +6792,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { serverlessFunctionsOverview: { serverlessId: string; serverlessFunctionName: string; serverlessDurationAvg: number | null; billedDurationAvg: number | null; coldStartCount: number | null; avgMemoryUsed: number | undefined; memorySize: number | null; }[]; }, ", + ", { serverlessFunctionsOverview: ", + "ServerlessFunctionsOverviewResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/metrics/serverless/summary\": ", { @@ -6960,7 +6854,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { memoryUsageAvgRate: number | undefined; serverlessFunctionsTotal: number | undefined; serverlessDurationAvg: number | null | undefined; billedDurationAvg: number | null | undefined; estimatedCost: number | undefined; }, ", + ", ", + "ServerlessSummaryResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/metrics/serverless/charts\": ", { @@ -7020,19 +6916,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { charts: [", - "FetchAndTransformMetrics", - ", ", - "FetchAndTransformMetrics", - ", { series: { overallValue: number; data: { x: number; y: number | null | undefined; }[]; title: string; key: string; type: ", - "ChartType", - "; color: string; }[]; title: string; key: string; yUnit: ", - "YUnit", - "; description?: string | undefined; }, ", - "FetchAndTransformMetrics", - ", ", + ", { charts: ", "FetchAndTransformMetrics", - "]; }, ", + "[]; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/metrics/nodes\": ", { @@ -7088,7 +6974,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { serviceNodes: { name: string; cpu: number | null; heapMemory: number | null; hostName: string | null | undefined; nonHeapMemory: number | null; threadCount: number | null; }[]; }, ", + ", { serviceNodes: ", + "ServiceNodesResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/metrics/charts\": ", { @@ -7320,7 +7208,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { topErroneousTransactions: { transactionName: string; currentPeriodTimeseries: { x: number; y: number; }[]; previousPeriodTimeseries: { x: number; y: number; }[]; transactionType: string | undefined; occurrences: number; }[]; }, ", + ", ", + "TopErroneousTransactionsResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/errors/distribution\": ", { @@ -7384,9 +7274,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: { x: number; y: number; }[]; previousPeriod: { x: number; y: ", - "Maybe", - "; }[]; bucketSize: number; }, ", + ", ", + "ErrorDistributionResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/errors/{groupId}/error/{errorId}\": ", { @@ -7446,11 +7336,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { transaction: ", - "Transaction", - " | undefined; error: ", - "APMError", - "; }, ", + ", ", + "ErrorSampleDetailsResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/errors/{groupId}/samples\": ", { @@ -7508,7 +7396,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { errorSampleIds: string[]; occurrencesCount: number; }, ", + ", ", + "ErrorGroupSampleIdsResponse", + ", ", "APMRouteCreateOptions", ">; \"POST /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\": ", { @@ -7576,15 +7466,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: ", - "Dictionary", - "<{ groupId: string; timeseries: ", - "Coordinate", - "[]; }>; previousPeriod: ", - "Dictionary", - "<{ timeseries: { x: number; y: ", - "Maybe", - "; }[]; groupId: string; }>; }, ", + ", ", + "ErrorGroupPeriodsResponse", + ", ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics_by_transaction_name\": ", { @@ -7648,7 +7532,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { errorGroups: { groupId: string; name: string; lastSeen: number; occurrences: number; culprit: string | undefined; handled: boolean | undefined; type: string | undefined; }[]; }, ", + ", { errorGroups: ", + "ErrorGroupMainStatisticsResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\": ", { @@ -7714,7 +7600,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { errorGroups: { groupId: string; name: string; lastSeen: number; occurrences: number; culprit: string | undefined; handled: boolean | undefined; type: string | undefined; }[]; }, ", + ", { errorGroups: ", + "ErrorGroupMainStatisticsResponse", + "; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/environments\": ", { @@ -7831,9 +7719,9 @@ "description": [], "signature": [ "Observable", - "; searchAggregatedTransactions: ", + "; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; forceSyntheticSource: boolean; }>>" + "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; }>>" ], "path": "x-pack/plugins/apm/server/types.ts", "deprecated": false, diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index 3d679c1e77a61..c19ff2991b751 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] --- import apmObj from './apm.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) for ques | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 42 | 0 | 42 | 65 | +| 42 | 0 | 42 | 108 | ## Client diff --git a/api_docs/asset_manager.devdocs.json b/api_docs/asset_manager.devdocs.json new file mode 100644 index 0000000000000..3e2a37dacf417 --- /dev/null +++ b/api_docs/asset_manager.devdocs.json @@ -0,0 +1,72 @@ +{ + "id": "assetManager", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "assetManager", + "id": "def-server.AssetManagerConfig", + "type": "Interface", + "tags": [], + "label": "AssetManagerConfig", + "description": [], + "path": "x-pack/plugins/asset_manager/server/plugin.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "assetManager", + "id": "def-server.AssetManagerConfig.alphaEnabled", + "type": "CompoundType", + "tags": [], + "label": "alphaEnabled", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/asset_manager/server/plugin.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "assetManager", + "id": "def-server.WriteSamplesPostBody", + "type": "Type", + "tags": [], + "label": "WriteSamplesPostBody", + "description": [], + "signature": [ + "{ baseDateTime?: string | number | undefined; excludeEans?: string[] | undefined; refresh?: boolean | \"wait_for\" | undefined; } | null" + ], + "path": "x-pack/plugins/asset_manager/server/routes/sample_assets.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/asset_manager.mdx b/api_docs/asset_manager.mdx new file mode 100644 index 0000000000000..0d18a62dd202b --- /dev/null +++ b/api_docs/asset_manager.mdx @@ -0,0 +1,33 @@ +--- +#### +#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system. +#### Reach out in #docs-engineering for more info. +#### +id: kibAssetManagerPluginApi +slug: /kibana-dev-docs/api/assetManager +title: "assetManager" +image: https://source.unsplash.com/400x175/?github +description: API docs for the assetManager plugin +date: 2023-03-21 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager'] +--- +import assetManagerObj from './asset_manager.devdocs.json'; + +Asset manager plugin for entity assets (inventory, topology, etc) + +Contact @jasonrhodes for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 3 | 0 | 3 | 0 | + +## Server + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index ea20772d893e5..77fc3d93e38a5 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] --- import bannersObj from './banners.devdocs.json'; diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index a6180cdb09994..0baa175a1a271 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-03-09 +date: 2023-03-21 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 c5b23cb2b4369..edee07329f3a8 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-03-09 +date: 2023-03-21 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 035ee24c863b6..a2142365e3ee9 100644 --- a/api_docs/cases.devdocs.json +++ b/api_docs/cases.devdocs.json @@ -1170,10 +1170,10 @@ "interfaces": [ { "parentPluginId": "cases", - "id": "def-server.PluginSetupContract", + "id": "def-server.CasesSetup", "type": "Interface", "tags": [], - "label": "PluginSetupContract", + "label": "CasesSetup", "description": [], "path": "x-pack/plugins/cases/server/types.ts", "deprecated": false, @@ -1181,7 +1181,7 @@ "children": [ { "parentPluginId": "cases", - "id": "def-server.PluginSetupContract.attachmentFramework", + "id": "def-server.CasesSetup.attachmentFramework", "type": "Object", "tags": [], "label": "attachmentFramework", @@ -1198,10 +1198,10 @@ }, { "parentPluginId": "cases", - "id": "def-server.PluginStartContract", + "id": "def-server.CasesStart", "type": "Interface", "tags": [], - "label": "PluginStartContract", + "label": "CasesStart", "description": [ "\nCases server exposed contract for interacting with cases entities." ], @@ -1211,7 +1211,7 @@ "children": [ { "parentPluginId": "cases", - "id": "def-server.PluginStartContract.getCasesClientWithRequest", + "id": "def-server.CasesStart.getCasesClientWithRequest", "type": "Function", "tags": [], "label": "getCasesClientWithRequest", @@ -1243,7 +1243,7 @@ "children": [ { "parentPluginId": "cases", - "id": "def-server.PluginStartContract.getCasesClientWithRequest.$1", + "id": "def-server.CasesStart.getCasesClientWithRequest.$1", "type": "Object", "tags": [], "label": "request", @@ -1269,6 +1269,40 @@ "returnComment": [ "a {@link CasesClient }" ] + }, + { + "parentPluginId": "cases", + "id": "def-server.CasesStart.getExternalReferenceAttachmentTypeRegistry", + "type": "Function", + "tags": [], + "label": "getExternalReferenceAttachmentTypeRegistry", + "description": [], + "signature": [ + "() => ", + "ExternalReferenceAttachmentTypeRegistry" + ], + "path": "x-pack/plugins/cases/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "cases", + "id": "def-server.CasesStart.getPersistableStateAttachmentTypeRegistry", + "type": "Function", + "tags": [], + "label": "getPersistableStateAttachmentTypeRegistry", + "description": [], + "signature": [ + "() => ", + "PersistableStateAttachmentTypeRegistry" + ], + "path": "x-pack/plugins/cases/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index d0d9c3d89997a..922cea76e9675 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-03-09 +date: 2023-03-21 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 | |-------------------|-----------|------------------------|-----------------| -| 94 | 0 | 77 | 28 | +| 96 | 0 | 79 | 30 | ## Client diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index 4a7b606909632..e13685419c8de 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] --- import chartsObj from './charts.devdocs.json'; diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index 7a1a8d535d5a9..2404ecb05f897 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] --- import cloudObj from './cloud.devdocs.json'; diff --git a/api_docs/cloud_chat.mdx b/api_docs/cloud_chat.mdx index 40ed9af1aebb3..4a2f72b9effa9 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat'] --- import cloudChatObj from './cloud_chat.devdocs.json'; diff --git a/api_docs/cloud_data_migration.mdx b/api_docs/cloud_data_migration.mdx index 6ecd4d9dcefb8..09bd4188baef6 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration'] --- import cloudDataMigrationObj from './cloud_data_migration.devdocs.json'; diff --git a/api_docs/cloud_defend.mdx b/api_docs/cloud_defend.mdx index ffa49010fb809..2cd0534ce8750 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend'] --- import cloudDefendObj from './cloud_defend.devdocs.json'; diff --git a/api_docs/cloud_experiments.mdx b/api_docs/cloud_experiments.mdx index f5ea2844dc50c..0d24378fa8468 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-03-09 +date: 2023-03-21 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 cea2a7fb7f484..fb63c8d313400 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] --- import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json'; diff --git a/api_docs/console.mdx b/api_docs/console.mdx index e009d3efb2de4..9b571e0173ecf 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] --- import consoleObj from './console.devdocs.json'; diff --git a/api_docs/content_management.devdocs.json b/api_docs/content_management.devdocs.json index 0b70a55a41998..8e1c319c19919 100644 --- a/api_docs/content_management.devdocs.json +++ b/api_docs/content_management.devdocs.json @@ -51,7 +51,7 @@ "section": "def-common.GetIn", "text": "GetIn" }, - ", O = unknown>(input: I) => { queryKey: readonly [string, string]; queryFn: () => Promise; }; search: , O = unknown>(_input: I) => { queryKey: readonly [string, string]; queryFn: () => Promise; }; search: , O = unknown>(input: I) => { queryKey: readonly [string, \"search\", unknown]; queryFn: () => Promise; }; }" + ", O = unknown>(_input: I) => { queryKey: readonly [string, \"search\", unknown]; queryFn: () => Promise; }; }" ], "path": "src/plugins/content_management/public/content_client/content_client.tsx", "deprecated": false, @@ -108,6 +108,21 @@ "deprecated": false, "trackAdoption": false, "isRequired": true + }, + { + "parentPluginId": "contentManagement", + "id": "def-public.ContentClient.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "contentTypeRegistry", + "description": [], + "signature": [ + "ContentTypeRegistry" + ], + "path": "src/plugins/content_management/public/content_client/content_client.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true } ], "returnComment": [] @@ -1666,6 +1681,58 @@ "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-server.StorageContext.version", + "type": "Object", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "{ request: number; latest: number; }" + ], + "path": "src/plugins/content_management/server/core/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-server.StorageContext.utils", + "type": "Object", + "tags": [], + "label": "utils", + "description": [], + "signature": [ + "{ getTransforms: (definitions: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ServiceDefinitionVersioned", + "text": "ServiceDefinitionVersioned" + }, + ", requestVersion: number, _compiled?: { [path: string]: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectMigrationDefinition", + "text": "ObjectMigrationDefinition" + }, + "; } | undefined) => ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ServiceTransforms", + "text": "ServiceTransforms" + }, + "; }" + ], + "path": "src/plugins/content_management/server/core/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -1767,6 +1834,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "contentManagement", + "id": "def-common.BulkGetIn.version", + "type": "number", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/content_management/common/rpc/bulk_get.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "contentManagement", "id": "def-common.BulkGetIn.options", @@ -1833,6 +1914,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "contentManagement", + "id": "def-common.CreateIn.version", + "type": "number", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/content_management/common/rpc/create.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "contentManagement", "id": "def-common.CreateIn.options", @@ -1896,6 +1991,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "contentManagement", + "id": "def-common.DeleteIn.version", + "type": "number", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/content_management/common/rpc/delete.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "contentManagement", "id": "def-common.DeleteIn.options", @@ -1959,6 +2068,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "contentManagement", + "id": "def-common.GetIn.version", + "type": "number", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/content_management/common/rpc/get.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "contentManagement", "id": "def-common.GetIn.options", @@ -2025,7 +2148,7 @@ "section": "def-common.Type", "text": "Type" }, - "" + " | undefined" ], "path": "src/plugins/content_management/common/rpc/types.ts", "deprecated": false, @@ -2083,6 +2206,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "contentManagement", + "id": "def-common.SearchIn.version", + "type": "number", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/content_management/common/rpc/search.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "contentManagement", "id": "def-common.SearchIn.options", @@ -2160,6 +2297,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "contentManagement", + "id": "def-common.UpdateIn.version", + "type": "number", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/content_management/common/rpc/update.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "contentManagement", "id": "def-common.UpdateIn.options", @@ -2226,22 +2377,6 @@ "initialIsOpen": false } ], - "objects": [ - { - "parentPluginId": "contentManagement", - "id": "def-common.procedureNames", - "type": "Object", - "tags": [], - "label": "procedureNames", - "description": [], - "signature": [ - "readonly [\"get\", \"bulkGet\", \"create\", \"update\", \"delete\", \"search\"]" - ], - "path": "src/plugins/content_management/common/rpc/constants.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - } - ] + "objects": [] } } \ No newline at end of file diff --git a/api_docs/content_management.mdx b/api_docs/content_management.mdx index 722b4625a4320..cb09a51a5fc60 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement'] --- import contentManagementObj from './content_management.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 | |-------------------|-----------|------------------------|-----------------| -| 110 | 0 | 96 | 3 | +| 118 | 0 | 104 | 4 | ## Client @@ -56,9 +56,6 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh ## Common -### Objects - - ### Interfaces diff --git a/api_docs/controls.devdocs.json b/api_docs/controls.devdocs.json index 16932ee849930..19afef8df6bc3 100644 --- a/api_docs/controls.devdocs.json +++ b/api_docs/controls.devdocs.json @@ -3735,7 +3735,7 @@ "label": "chainingSystem", "description": [], "signature": [ - "\"NONE\" | \"HIERARCHICAL\"" + "\"HIERARCHICAL\" | \"NONE\"" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, @@ -5631,7 +5631,7 @@ "label": "chainingSystem", "description": [], "signature": [ - "\"NONE\" | \"HIERARCHICAL\"" + "\"HIERARCHICAL\" | \"NONE\"" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index 642b19462026a..3af24d0011df2 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] --- import controlsObj from './controls.devdocs.json'; diff --git a/api_docs/custom_integrations.devdocs.json b/api_docs/custom_integrations.devdocs.json index 21e9c00a00a89..aca72e69c6202 100644 --- a/api_docs/custom_integrations.devdocs.json +++ b/api_docs/custom_integrations.devdocs.json @@ -438,7 +438,7 @@ "label": "categories", "description": [], "signature": [ - "(\"monitoring\" | \"security\" | \"infrastructure\" | \"cloud\" | \"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" + "string[]" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, @@ -488,7 +488,7 @@ "\nA category applicable to an Integration." ], "signature": [ - "\"monitoring\" | \"security\" | \"infrastructure\" | \"cloud\" | \"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" + "string" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, @@ -728,7 +728,7 @@ "label": "categories", "description": [], "signature": [ - "(\"monitoring\" | \"security\" | \"infrastructure\" | \"cloud\" | \"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" + "string[]" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, @@ -833,13 +833,10 @@ { "parentPluginId": "customIntegrations", "id": "def-common.IntegrationCategoryCount.id", - "type": "CompoundType", + "type": "string", "tags": [], "label": "id", "description": [], - "signature": [ - "\"monitoring\" | \"security\" | \"infrastructure\" | \"cloud\" | \"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" - ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, "trackAdoption": false @@ -860,7 +857,7 @@ "\nThe list of all available categories." ], "signature": [ - "(\"monitoring\" | \"security\" | \"infrastructure\" | \"cloud\" | \"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" + "string[]" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, @@ -877,7 +874,7 @@ "\nA category applicable to an Integration." ], "signature": [ - "\"monitoring\" | \"security\" | \"infrastructure\" | \"cloud\" | \"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" + "string" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, @@ -1032,304 +1029,1033 @@ { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.aws", - "type": "string", + "type": "Object", "tags": [], "label": "aws", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.aws.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.aws.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.azure", - "type": "string", + "type": "Object", "tags": [], "label": "azure", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.azure.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.azure.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.cloud", - "type": "string", + "type": "Object", "tags": [], "label": "cloud", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.cloud.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.cloud.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.config_management", - "type": "string", + "type": "Object", "tags": [], "label": "config_management", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.config_management.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.config_management.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.containers", - "type": "string", + "type": "Object", "tags": [], "label": "containers", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.containers.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.containers.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.crm", - "type": "string", + "type": "Object", "tags": [], "label": "crm", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.crm.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.crm.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.custom", - "type": "string", + "type": "Object", "tags": [], "label": "custom", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.custom.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.custom.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.datastore", - "type": "string", + "type": "Object", "tags": [], "label": "datastore", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.datastore.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.datastore.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.elastic_stack", - "type": "string", + "type": "Object", "tags": [], "label": "elastic_stack", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.elastic_stack.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.elastic_stack.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.google_cloud", - "type": "string", + "type": "Object", "tags": [], "label": "google_cloud", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.google_cloud.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.google_cloud.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.infrastructure", - "type": "string", + "type": "Object", "tags": [], "label": "infrastructure", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.infrastructure.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.infrastructure.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.kubernetes", - "type": "string", + "type": "Object", "tags": [], "label": "kubernetes", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.kubernetes.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.kubernetes.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.languages", - "type": "string", + "type": "Object", "tags": [], "label": "languages", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.languages.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.languages.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.message_queue", - "type": "string", + "type": "Object", "tags": [], "label": "message_queue", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.message_queue.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.message_queue.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.microsoft_365", - "type": "string", + "type": "Object", "tags": [], "label": "microsoft_365", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.microsoft_365.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.microsoft_365.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.monitoring", - "type": "string", + "type": "Object", "tags": [], "label": "monitoring", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.monitoring.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.monitoring.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.network", - "type": "string", + "type": "Object", "tags": [], "label": "network", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.network.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.network.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.notification", - "type": "string", + "type": "Object", "tags": [], "label": "notification", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.notification.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.notification.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.os_system", - "type": "string", + "type": "Object", "tags": [], "label": "os_system", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.os_system.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.os_system.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.productivity", - "type": "string", + "type": "Object", "tags": [], "label": "productivity", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.productivity.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.productivity.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.security", - "type": "string", + "type": "Object", "tags": [], "label": "security", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.security.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.security.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.sample_data", - "type": "string", + "type": "Object", "tags": [], "label": "sample_data", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.sample_data.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.sample_data.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.support", - "type": "string", + "type": "Object", "tags": [], "label": "support", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.support.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.support.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.threat_intel", - "type": "string", + "type": "Object", "tags": [], "label": "threat_intel", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.threat_intel.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.threat_intel.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.ticketing", - "type": "string", + "type": "Object", "tags": [], "label": "ticketing", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.ticketing.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.ticketing.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.version_control", - "type": "string", + "type": "Object", "tags": [], "label": "version_control", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.version_control.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.version_control.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.web", - "type": "string", + "type": "Object", "tags": [], "label": "web", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.web.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.web.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.communications", - "type": "string", + "type": "Object", "tags": [], "label": "communications", "description": [ @@ -1337,73 +2063,262 @@ ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.communications.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.communications.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.enterprise_search", - "type": "string", + "type": "Object", "tags": [], "label": "enterprise_search", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.enterprise_search.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.enterprise_search.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.file_storage", - "type": "string", + "type": "Object", "tags": [], "label": "file_storage", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.file_storage.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.file_storage.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.language_client", - "type": "string", + "type": "Object", "tags": [], "label": "language_client", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.language_client.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.language_client.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.upload_file", - "type": "string", + "type": "Object", "tags": [], "label": "upload_file", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.upload_file.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.upload_file.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.website_search", - "type": "string", + "type": "Object", "tags": [], "label": "website_search", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.website_search.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.website_search.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.geo", - "type": "string", + "type": "Object", "tags": [], "label": "geo", "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [ + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.geo.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.geo.parent_id", + "type": "Uncategorized", + "tags": [], + "label": "parent_id", + "description": [], + "signature": [ + "undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] } ], "initialIsOpen": false diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index 05ca008c417b7..6f9c2bd3b27d5 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] --- import customIntegrationsObj from './custom_integrations.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 | |-------------------|-----------|------------------------|-----------------| -| 107 | 0 | 88 | 1 | +| 175 | 0 | 156 | 1 | ## Client diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index 8564485c9e694..23bb0d3d1908e 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-03-09 +date: 2023-03-21 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 2907dceee7b86..8e432a3edbff9 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-03-09 +date: 2023-03-21 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 7cf44eb94b574..aec4ebb516f7b 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -5696,59 +5696,6 @@ "deprecated": false, "trackAdoption": false }, - { - "parentPluginId": "data", - "id": "def-public.AggFunctionsMapping.aggGeoHash", - "type": "Object", - "tags": [], - "label": "aggGeoHash", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggGeoHash\", any, Arguments, ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggExpressionType", - "text": "AggExpressionType" - }, - ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - { - "pluginId": "@kbn/utility-types", - "scope": "common", - "docId": "kibKbnUtilityTypesPluginApi", - "section": "def-common.SerializableRecord", - "text": "SerializableRecord" - }, - ">>" - ], - "path": "src/plugins/data/common/search/aggs/types.ts", - "deprecated": false, - "trackAdoption": false - }, { "parentPluginId": "data", "id": "def-public.AggFunctionsMapping.aggHistogram", @@ -10990,10 +10937,6 @@ "plugin": "@kbn/core", "path": "src/core/types/index.ts" }, - { - "plugin": "apm", - "path": "x-pack/plugins/apm/server/routes/settings/apm_indices/route.ts" - }, { "plugin": "savedObjectsTaggingOss", "path": "src/plugins/saved_objects_tagging_oss/public/api.ts" @@ -15059,10 +15002,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/common/data_views/data_views.ts" }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/register_index_pattern_usage_collection.ts" - }, { "plugin": "dataViewManagement", "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" @@ -18331,33 +18270,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -18739,7 +18652,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -18917,7 +18832,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -18943,7 +18860,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -19207,6 +19144,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -22682,10 +22621,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/common/data_views/data_views.ts" }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/register_index_pattern_usage_collection.ts" - }, { "plugin": "dataViewManagement", "path": "src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/scripted_fields_table.tsx" @@ -28767,10 +28702,6 @@ "plugin": "@kbn/core", "path": "src/core/types/index.ts" }, - { - "plugin": "apm", - "path": "x-pack/plugins/apm/server/routes/settings/apm_indices/route.ts" - }, { "plugin": "savedObjectsTaggingOss", "path": "src/plugins/saved_objects_tagging_oss/public/api.ts" diff --git a/api_docs/data.mdx b/api_docs/data.mdx index 5592b5a27ee89..180c341bec823 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-03-09 +date: 2023-03-21 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 | |-------------------|-----------|------------------------|-----------------| -| 3282 | 119 | 2586 | 27 | +| 3273 | 119 | 2577 | 27 | ## Client diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index a59d0bbc695a8..dc56c2ddda197 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-03-09 +date: 2023-03-21 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 | |-------------------|-----------|------------------------|-----------------| -| 3282 | 119 | 2586 | 27 | +| 3273 | 119 | 2577 | 27 | ## Client diff --git a/api_docs/data_search.devdocs.json b/api_docs/data_search.devdocs.json index e2a5d49653fa9..5c6bcb55054d8 100644 --- a/api_docs/data_search.devdocs.json +++ b/api_docs/data_search.devdocs.json @@ -3,6 +3,79 @@ "client": { "classes": [], "functions": [ + { + "parentPluginId": "data", + "id": "def-public.getSearchErrorOverrideDisplay", + "type": "Function", + "tags": [], + "label": "getSearchErrorOverrideDisplay", + "description": [], + "signature": [ + "({\n error,\n application,\n}: { error: Error; application: ", + { + "pluginId": "@kbn/core-application-browser", + "scope": "common", + "docId": "kibKbnCoreApplicationBrowserPluginApi", + "section": "def-common.ApplicationStart", + "text": "ApplicationStart" + }, + "; }) => { title: string; body: React.ReactNode; } | undefined" + ], + "path": "src/plugins/data/public/search/search_interceptor/utils.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.getSearchErrorOverrideDisplay.$1", + "type": "Object", + "tags": [], + "label": "{\n error,\n application,\n}", + "description": [], + "path": "src/plugins/data/public/search/search_interceptor/utils.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.getSearchErrorOverrideDisplay.$1.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "src/plugins/data/public/search/search_interceptor/utils.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "data", + "id": "def-public.getSearchErrorOverrideDisplay.$1.application", + "type": "Object", + "tags": [], + "label": "application", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-application-browser", + "scope": "common", + "docId": "kibKbnCoreApplicationBrowserPluginApi", + "section": "def-common.ApplicationStart", + "text": "ApplicationStart" + } + ], + "path": "src/plugins/data/public/search/search_interceptor/utils.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-public.isEsError", @@ -11846,23 +11919,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.aggGeoHash", - "type": "Function", - "tags": [], - "label": "aggGeoHash", - "description": [], - "signature": [ - "() => FunctionDefinition" - ], - "path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.aggGeoTile", @@ -14281,39 +14337,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.getGeoHashBucketAgg", - "type": "Function", - "tags": [], - "label": "getGeoHashBucketAgg", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.BucketAggType", - "text": "BucketAggType" - }, - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IBucketAggConfig", - "text": "IBucketAggConfig" - }, - ">" - ], - "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.getGeoTitleBucketAgg", @@ -18117,59 +18140,6 @@ "deprecated": false, "trackAdoption": false }, - { - "parentPluginId": "data", - "id": "def-common.AggFunctionsMapping.aggGeoHash", - "type": "Object", - "tags": [], - "label": "aggGeoHash", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"aggGeoHash\", any, Arguments, ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggExpressionType", - "text": "AggExpressionType" - }, - ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - { - "pluginId": "@kbn/utility-types", - "scope": "common", - "docId": "kibKbnUtilityTypesPluginApi", - "section": "def-common.SerializableRecord", - "text": "SerializableRecord" - }, - ">>" - ], - "path": "src/plugins/data/common/search/aggs/types.ts", - "deprecated": false, - "trackAdoption": false - }, { "parentPluginId": "data", "id": "def-common.AggFunctionsMapping.aggHistogram", @@ -21712,125 +21682,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.AggParamsGeoHash", - "type": "Interface", - "tags": [], - "label": "AggParamsGeoHash", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsGeoHash", - "text": "AggParamsGeoHash" - }, - " extends ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.BaseAggParams", - "text": "BaseAggParams" - } - ], - "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.AggParamsGeoHash.field", - "type": "string", - "tags": [], - "label": "field", - "description": [], - "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "data", - "id": "def-common.AggParamsGeoHash.autoPrecision", - "type": "CompoundType", - "tags": [], - "label": "autoPrecision", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "data", - "id": "def-common.AggParamsGeoHash.precision", - "type": "number", - "tags": [], - "label": "precision", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "data", - "id": "def-common.AggParamsGeoHash.useGeocentroid", - "type": "CompoundType", - "tags": [], - "label": "useGeocentroid", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "data", - "id": "def-common.AggParamsGeoHash.isFilteredByCollar", - "type": "CompoundType", - "tags": [], - "label": "isFilteredByCollar", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "data", - "id": "def-common.AggParamsGeoHash.boundingBox", - "type": "CompoundType", - "tags": [], - "label": "boundingBox", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.GeoBoundingBox", - "text": "GeoBoundingBox" - }, - " | undefined" - ], - "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.AggParamsGeoTile", @@ -22326,26 +22177,6 @@ "deprecated": false, "trackAdoption": false }, - { - "parentPluginId": "data", - "id": "def-common.AggParamsMapping.BUCKET_TYPES.GEOHASH_GRID", - "type": "Object", - "tags": [], - "label": "[BUCKET_TYPES.GEOHASH_GRID]", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsGeoHash", - "text": "AggParamsGeoHash" - } - ], - "path": "src/plugins/data/common/search/aggs/types.ts", - "deprecated": false, - "trackAdoption": false - }, { "parentPluginId": "data", "id": "def-common.AggParamsMapping.BUCKET_TYPES.HISTOGRAM", @@ -31864,21 +31695,6 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.aggGeoHashFnName", - "type": "string", - "tags": [], - "label": "aggGeoHashFnName", - "description": [], - "signature": [ - "\"aggGeoHash\"" - ], - "path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.aggGeoTileFnName", diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index acbc4eaf24b00..d8b89594411ac 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-03-09 +date: 2023-03-21 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 | |-------------------|-----------|------------------------|-----------------| -| 3282 | 119 | 2586 | 27 | +| 3273 | 119 | 2577 | 27 | ## Client diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 06f34fec2d4d6..4b132cd8de6dc 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-03-09 +date: 2023-03-21 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 408de7dc65e91..cb48f3c86668a 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-03-09 +date: 2023-03-21 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 f71b6494df4a0..7f0bf88f8c31f 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-03-09 +date: 2023-03-21 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 2019272ce296a..7becaf0b75f2b 100644 --- a/api_docs/data_views.devdocs.json +++ b/api_docs/data_views.devdocs.json @@ -14447,33 +14447,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -14855,7 +14829,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -15033,7 +15009,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -15059,7 +15037,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -15323,6 +15321,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -21536,7 +21536,7 @@ "signature": [ "Pick<", "Toast", - ", \"prefix\" | \"defaultValue\" | \"children\" | \"is\" | \"slot\" | \"style\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"css\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"color\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"iconType\" | \"onClose\" | \"toastLifeTimeMs\"> & { title?: string | ", + ", \"prefix\" | \"defaultValue\" | \"children\" | \"is\" | \"security\" | \"slot\" | \"style\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"css\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"color\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"iconType\" | \"onClose\" | \"toastLifeTimeMs\"> & { title?: string | ", { "pluginId": "@kbn/core-mount-utils-browser", "scope": "common", @@ -25637,7 +25637,7 @@ "signature": [ "Pick<", "Toast", - ", \"prefix\" | \"defaultValue\" | \"children\" | \"is\" | \"slot\" | \"style\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"css\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"color\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"iconType\" | \"onClose\" | \"toastLifeTimeMs\"> & { title?: string | ", + ", \"prefix\" | \"defaultValue\" | \"children\" | \"is\" | \"security\" | \"slot\" | \"style\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"css\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"color\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"iconType\" | \"onClose\" | \"toastLifeTimeMs\"> & { title?: string | ", { "pluginId": "@kbn/core-mount-utils-browser", "scope": "common", @@ -26196,10 +26196,6 @@ "plugin": "@kbn/core", "path": "src/core/types/index.ts" }, - { - "plugin": "apm", - "path": "x-pack/plugins/apm/server/routes/settings/apm_indices/route.ts" - }, { "plugin": "savedObjectsTaggingOss", "path": "src/plugins/saved_objects_tagging_oss/public/api.ts" diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index 6618540818f41..af89f842fee48 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] --- import dataViewsObj from './data_views.devdocs.json'; diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index 2844235eab4ce..e6729850dfd89 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-03-09 +date: 2023-03-21 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 d2aa4e5ef559a..735249fce213c 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -37,12 +37,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | alerting, discover, securitySolution | - | | | alerting, discover, securitySolution | - | | | actions, alerting | - | -| | @kbn/core-saved-objects-migration-server-internal, actions, dataViews, data, alerting, savedObjectsTagging, savedSearch, canvas, lens, cases, graph, lists, maps, securitySolution, dashboard, visualizations, @kbn/core-test-helpers-so-type-serializer | - | +| | @kbn/core-saved-objects-migration-server-internal, actions, dataViews, data, alerting, lens, cases, savedObjectsTagging, savedSearch, canvas, graph, lists, maps, securitySolution, dashboard, visualizations, @kbn/core-test-helpers-so-type-serializer | - | | | discover | - | | | data, discover, imageEmbeddable, embeddable | - | | | advancedSettings, discover | - | -| | @kbn/core-saved-objects-common, @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, home, dataViews, savedObjectsTagging, fleet, canvas, osquery, securitySolution, synthetics, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-import-export-server-internal, apm, savedObjectsTaggingOss, cases, lists, upgradeAssistant, savedObjectsManagement, @kbn/core-ui-settings-server-internal, dashboard | - | -| | @kbn/core-saved-objects-common, @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, home, dataViews, savedObjectsTagging, fleet, canvas, osquery, securitySolution, synthetics, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-import-export-server-internal, apm, savedObjectsTaggingOss, cases, lists, upgradeAssistant, savedObjectsManagement, @kbn/core-ui-settings-server-internal, data | - | +| | @kbn/core-saved-objects-common, @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, home, dataViews, savedObjectsTagging, fleet, canvas, osquery, securitySolution, synthetics, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-import-export-server-internal, savedObjectsTaggingOss, cases, lists, upgradeAssistant, savedObjectsManagement, @kbn/core-ui-settings-server-internal, dashboard | - | +| | @kbn/core-saved-objects-common, @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, home, dataViews, savedObjectsTagging, fleet, canvas, osquery, securitySolution, synthetics, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-import-export-server-internal, savedObjectsTaggingOss, cases, lists, upgradeAssistant, savedObjectsManagement, @kbn/core-ui-settings-server-internal, data | - | | | securitySolution | - | | | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - | | | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - | @@ -57,7 +57,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | securitySolution | - | | | securitySolution | - | | | monitoring | - | -| | @kbn/core-saved-objects-api-browser, @kbn/core, savedObjects, savedObjectsManagement, visualizations, savedObjectsTagging, lens, fleet, graph, dashboard, savedObjectsTaggingOss, kibanaUtils, expressions, dataViews, data, embeddable, controls, uiActionsEnhanced, maps, canvas, cases, dashboardEnhanced, globalSearchProviders, infra | - | +| | @kbn/core-saved-objects-api-browser, @kbn/core, savedObjects, savedObjectsManagement, visualizations, savedObjectsTagging, lens, fleet, graph, dashboard, savedObjectsTaggingOss, kibanaUtils, expressions, dataViews, data, embeddable, controls, uiActionsEnhanced, cases, maps, canvas, dashboardEnhanced, globalSearchProviders, infra | - | | | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, savedSearch, visualizations, dashboard, lens, maps, infra, graph, synthetics | - | | | @kbn/core-saved-objects-browser-mocks, home, @kbn/core-saved-objects-browser-internal | - | | | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, visualizations, dashboard, maps, infra, graph | - | diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index bc57e2dfed98b..975c4421d5d8e 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -333,8 +333,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/apm/server/routes/settings/apm_indices/route.ts#:~:text=SavedObject) | - | -| | [route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/apm/server/routes/settings/apm_indices/route.ts#:~:text=SavedObject), [route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/apm/server/routes/settings/apm_indices/route.ts#:~:text=SavedObject), [route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/apm/server/routes/settings/apm_indices/route.ts#:~:text=SavedObject) | - | | | [create_static_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/apm/server/routes/data_view/create_static_data_view.ts#:~:text=title), [create_static_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/apm/server/routes/data_view/create_static_data_view.ts#:~:text=title) | - | | | [create_static_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/apm/server/routes/data_view/create_static_data_view.ts#:~:text=title), [create_static_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/apm/server/routes/data_view/create_static_data_view.ts#:~:text=title) | - | | | [create_static_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/apm/server/routes/data_view/create_static_data_view.ts#:~:text=title) | - | @@ -400,7 +398,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [overview_tab.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/public/pages/findings/findings_flyout/overview_tab.tsx#:~:text=indexPatternId) | - | +| | [overview_tab.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/overview_tab.tsx#:~:text=indexPatternId) | - | | | [use_csp_rules.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/public/pages/rules/use_csp_rules.ts#:~:text=savedObjects) | - | | | [use_csp_rules.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/public/pages/rules/use_csp_rules.ts#:~:text=find) | - | | | [use_csp_rules.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cloud_security_posture/public/pages/rules/use_csp_rules.ts#:~:text=get) | - | @@ -519,12 +517,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [data_view.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.ts#:~:text=flattenHit) | - | | | [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), [register_index_pattern_usage_collection.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/server/register_index_pattern_usage_collection.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields) | - | +| | [data_view.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_view.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_views.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_views.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields) | - | | | [data_view.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.ts#:~:text=title), [data_view.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.ts#:~:text=title), [data_view.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.ts#:~:text=title), [data_view.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.ts#:~:text=title), [update_data_view.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/server/rest_api_routes/update_data_view.ts#:~:text=title), [update_data_view.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/server/rest_api_routes/update_data_view.ts#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_views.ts#:~:text=title) | - | | | [data_view.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.ts#:~:text=flattenHit) | - | | | [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), [register_index_pattern_usage_collection.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/server/register_index_pattern_usage_collection.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields) | - | +| | [data_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) | - | | | [saved_objects_client_wrapper.ts](https://github.com/elastic/kibana/tree/main/src/plugins/data_views/public/saved_objects_client_wrapper.ts#:~:text=create) | - | diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index e9e8c30fa57d4..024d40b6f1f5d 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index 3ed900e268c8c..60cc1b4a4e6bd 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] --- import devToolsObj from './dev_tools.devdocs.json'; diff --git a/api_docs/discover.devdocs.json b/api_docs/discover.devdocs.json index c494514113808..12e7039d39ac0 100644 --- a/api_docs/discover.devdocs.json +++ b/api_docs/discover.devdocs.json @@ -1176,7 +1176,7 @@ }, { "plugin": "cloudSecurityPosture", - "path": "x-pack/plugins/cloud_security_posture/public/pages/findings/findings_flyout/overview_tab.tsx" + "path": "x-pack/plugins/cloud_security_posture/public/pages/configurations/findings_flyout/overview_tab.tsx" }, { "plugin": "discoverEnhanced", diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index c7a29c5cbeb50..7cd722b3102bc 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-03-09 +date: 2023-03-21 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 665684d77f3fe..fe42cfa1d796e 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-03-09 +date: 2023-03-21 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 70ad15de40277..8c74abe6f8574 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard'] --- import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json'; diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index a2f6b3876a311..aa5155cc11ca6 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] --- import embeddableObj from './embeddable.devdocs.json'; diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index 23b2ed31c361b..d2909b97b26b4 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-03-09 +date: 2023-03-21 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 2fe54cdf8739f..9e0055ac3e3c8 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-03-09 +date: 2023-03-21 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 cb4602f89a913..53edb9dd22568 100644 --- a/api_docs/enterprise_search.devdocs.json +++ b/api_docs/enterprise_search.devdocs.json @@ -52,7 +52,7 @@ "label": "ConfigType", "description": [], "signature": [ - "{ readonly host?: string | undefined; readonly customHeaders?: Readonly<{} & {}> | undefined; readonly ssl: Readonly<{ certificateAuthorities?: string | string[] | undefined; } & { verificationMode: \"none\" | \"full\" | \"certificate\"; }>; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }" + "{ readonly host?: string | undefined; readonly customHeaders?: Readonly<{} & {}> | undefined; readonly ssl: Readonly<{ certificateAuthorities?: string | string[] | undefined; } & { verificationMode: \"none\" | \"full\" | \"certificate\"; }>; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; readonly canDeployEntSearch: boolean; readonly hasConnectors: boolean; readonly hasDefaultIngestPipeline: boolean; readonly hasNativeConnectors: boolean; readonly hasWebCrawler: boolean; }" ], "path": "x-pack/plugins/enterprise_search/server/index.ts", "deprecated": false, @@ -167,7 +167,7 @@ "section": "def-common.Type", "text": "Type" }, - "; customHeaders: ", + "; canDeployEntSearch: ", { "pluginId": "@kbn/config-schema", "scope": "common", @@ -175,7 +175,47 @@ "section": "def-common.Type", "text": "Type" }, - " | undefined>; host: ", + "; customHeaders: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + " | undefined>; hasConnectors: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + "; hasDefaultIngestPipeline: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + "; hasNativeConnectors: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + "; hasWebCrawler: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + "; host: ", { "pluginId": "@kbn/config-schema", "scope": "common", diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index 71f4a7875d21f..ffeaa3ad29640 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-03-09 +date: 2023-03-21 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 74f69cdeb5eca..80699dce87a70 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] --- import esUiSharedObj from './es_ui_shared.devdocs.json'; diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index 3cb4fc356e98c..6024bfeb5a87e 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] --- import eventAnnotationObj from './event_annotation.devdocs.json'; diff --git a/api_docs/event_log.devdocs.json b/api_docs/event_log.devdocs.json index e0bdaa48bd824..8e5d09f93f4ae 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; description?: string | undefined; category?: string | undefined; version?: string | undefined; uuid?: string | undefined; license?: 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; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: 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; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ uuid?: 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; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: 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; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | 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; code?: string | undefined; url?: string | undefined; created?: string | undefined; severity?: string | number | undefined; duration?: string | number | undefined; original?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; provider?: 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<{ 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; description?: string | undefined; category?: string | undefined; version?: string | undefined; uuid?: string | undefined; license?: 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; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: 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; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ uuid?: 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; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: 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; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | 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; code?: string | undefined; url?: string | undefined; severity?: string | number | undefined; duration?: string | number | undefined; created?: string | undefined; original?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; provider?: 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<{ 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; description?: string | undefined; category?: string | undefined; version?: string | undefined; uuid?: string | undefined; license?: 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; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: 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; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ uuid?: 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; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: 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; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | 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; code?: string | undefined; url?: string | undefined; created?: string | undefined; severity?: string | number | undefined; duration?: string | number | undefined; original?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; provider?: 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<{ 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; description?: string | undefined; category?: string | undefined; version?: string | undefined; uuid?: string | undefined; license?: 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; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: 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; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ uuid?: 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; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: 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; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | 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; code?: string | undefined; url?: string | undefined; severity?: string | number | undefined; duration?: string | number | undefined; created?: string | undefined; original?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; provider?: 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<{ 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; description?: string | undefined; category?: string | undefined; version?: string | undefined; uuid?: string | undefined; license?: 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; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: 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; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ uuid?: 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; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: 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; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | 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; code?: string | undefined; url?: string | undefined; created?: string | undefined; severity?: string | number | undefined; duration?: string | number | undefined; original?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; provider?: 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<{ 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; description?: string | undefined; category?: string | undefined; version?: string | undefined; uuid?: string | undefined; license?: 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; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: 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; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ uuid?: 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; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: 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; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | 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; code?: string | undefined; url?: string | undefined; severity?: string | number | undefined; duration?: string | number | undefined; created?: string | undefined; original?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; provider?: 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<{ 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 683144bc3b585..83e6a58c5624a 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] --- import eventLogObj from './event_log.devdocs.json'; diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx index d29975d188924..a41054bf74e44 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] --- import expressionErrorObj from './expression_error.devdocs.json'; diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx index 4c73941725f98..31292dbc160f9 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] --- import expressionGaugeObj from './expression_gauge.devdocs.json'; diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index ee7ba05a89e8d..ba2e3bc84df77 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-03-09 +date: 2023-03-21 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 0e74b5135d91b..b4a6fb5ba4ee4 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-03-09 +date: 2023-03-21 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 b1e05b10186db..d0e8e778b2c57 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-03-09 +date: 2023-03-21 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 9b155f73a9908..7332d2357e6ba 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] --- import expressionMetricObj from './expression_metric.devdocs.json'; diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx index 34b5e2dd9bf27..4ddfb958642cd 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-03-09 +date: 2023-03-21 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 b79178ba2aaf0..46c7d5243659c 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-03-09 +date: 2023-03-21 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 5551698521e02..1661b753edc5a 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-03-09 +date: 2023-03-21 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 cb899cc068bfc..3fd10e92ad762 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] --- import expressionRevealImageObj from './expression_reveal_image.devdocs.json'; diff --git a/api_docs/expression_shape.devdocs.json b/api_docs/expression_shape.devdocs.json index cb0dd0c5e8484..3c6d97d7ce0f4 100644 --- a/api_docs/expression_shape.devdocs.json +++ b/api_docs/expression_shape.devdocs.json @@ -635,7 +635,7 @@ "label": "strokeLinecap", "description": [], "signature": [ - "\"inherit\" | \"square\" | \"butt\" | \"round\" | undefined" + "\"inherit\" | \"butt\" | \"round\" | \"square\" | undefined" ], "path": "src/plugins/expression_shape/public/components/reusable/types.tsx", "deprecated": false, diff --git a/api_docs/expression_shape.mdx b/api_docs/expression_shape.mdx index f28cc85a8560d..f493484e9d3a2 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-03-09 +date: 2023-03-21 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 0bdfd96cac0c6..3890bd62321cc 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-03-09 +date: 2023-03-21 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 78e6aa0828084..81301b9f25a67 100644 --- a/api_docs/expression_x_y.devdocs.json +++ b/api_docs/expression_x_y.devdocs.json @@ -3402,7 +3402,7 @@ "label": "YScaleType", "description": [], "signature": [ - "\"log\" | \"time\" | \"sqrt\" | \"linear\"" + "\"log\" | \"time\" | \"linear\" | \"sqrt\"" ], "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 c6129b13b13be..adc8d7eb1abe6 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] --- import expressionXYObj from './expression_x_y.devdocs.json'; diff --git a/api_docs/expressions.devdocs.json b/api_docs/expressions.devdocs.json index 3d3855cad3b00..9ac913a878dcb 100644 --- a/api_docs/expressions.devdocs.json +++ b/api_docs/expressions.devdocs.json @@ -12556,7 +12556,7 @@ "\nAllowed column names in a PointSeries" ], "signature": [ - "\"text\" | \"color\" | \"x\" | \"y\" | \"size\"" + "\"text\" | \"color\" | \"size\" | \"y\" | \"x\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, @@ -22374,7 +22374,7 @@ "\nAllowed column names in a PointSeries" ], "signature": [ - "\"text\" | \"color\" | \"x\" | \"y\" | \"size\"" + "\"text\" | \"color\" | \"size\" | \"y\" | \"x\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, @@ -37790,7 +37790,7 @@ "\nAllowed column names in a PointSeries" ], "signature": [ - "\"text\" | \"color\" | \"x\" | \"y\" | \"size\"" + "\"text\" | \"color\" | \"size\" | \"y\" | \"x\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index f8e454f53e241..2ac777e305b90 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-03-09 +date: 2023-03-21 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 8c7ee2f787f07..5283996b4f408 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; disabled?: boolean | undefined; ui: readonly string[]; app?: readonly string[] | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: 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\" | \"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; disabled?: boolean | undefined; ui: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; 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, @@ -1317,7 +1317,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; disabled?: boolean | undefined; ui: readonly string[]; app?: readonly string[] | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: 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\" | \"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; disabled?: boolean | undefined; ui: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; 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, @@ -3082,7 +3082,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; disabled?: boolean | undefined; ui: readonly string[]; app?: readonly string[] | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: 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\" | \"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; disabled?: boolean | undefined; ui: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; 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, @@ -3346,7 +3346,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; disabled?: boolean | undefined; ui: readonly string[]; app?: readonly string[] | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: 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\" | \"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; disabled?: boolean | undefined; ui: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; 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, @@ -3383,7 +3383,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; disabled?: boolean | undefined; ui: readonly string[]; app?: readonly string[] | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: 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\" | \"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; disabled?: boolean | undefined; ui: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; 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, @@ -3427,7 +3427,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; disabled?: boolean | undefined; ui: readonly string[]; app?: readonly string[] | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: 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\" | \"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; disabled?: boolean | undefined; ui: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; 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, diff --git a/api_docs/features.mdx b/api_docs/features.mdx index cdc78347cc120..c0028fc33867b 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-03-09 +date: 2023-03-21 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 8063afb72c658..22e00be7dd113 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-03-09 +date: 2023-03-21 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 94e0e77e390c8..a9cd4ef1be10d 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-03-09 +date: 2023-03-21 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 3823480b372f4..251f81e7a611e 100644 --- a/api_docs/files.devdocs.json +++ b/api_docs/files.devdocs.json @@ -936,33 +936,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -1344,7 +1318,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -1522,7 +1498,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -1548,7 +1526,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -1812,6 +1810,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", diff --git a/api_docs/files.mdx b/api_docs/files.mdx index 79bd32f09ba56..71e1b99431a6e 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-03-09 +date: 2023-03-21 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 a787305f636dd..4a8acd3bd32fe 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-03-09 +date: 2023-03-21 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 df2aca4d29022..b7a340acda454 100644 --- a/api_docs/fleet.devdocs.json +++ b/api_docs/fleet.devdocs.json @@ -4427,7 +4427,7 @@ "section": "def-server.Artifact", "text": "Artifact" }, - ", \"decodedSha256\" | \"identifier\">>({ identifier, decodedSha256, }: T) => string" + ", \"identifier\" | \"decodedSha256\">>({ identifier, decodedSha256, }: T) => string" ], "path": "x-pack/plugins/fleet/server/services/artifacts/mappings.ts", "deprecated": false, @@ -9331,33 +9331,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -9739,7 +9713,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -9917,7 +9893,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -9943,7 +9921,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -10207,6 +10205,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -10666,33 +10666,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -11074,7 +11048,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -11252,7 +11228,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -11278,7 +11256,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -11542,6 +11540,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -12014,33 +12014,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -12422,7 +12396,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -12600,7 +12576,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -12626,7 +12604,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -12890,6 +12888,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -13359,33 +13359,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -13767,7 +13741,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -13945,7 +13921,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -13971,7 +13949,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -14235,6 +14233,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -14707,33 +14707,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -15115,7 +15089,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -15293,7 +15269,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -15319,7 +15297,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -15583,6 +15581,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -21800,7 +21800,7 @@ "label": "[RegistryVarsEntryKeys.type]", "description": [], "signature": [ - "\"string\" | \"text\" | \"integer\" | \"textarea\" | \"bool\" | \"password\" | \"yaml\"" + "\"string\" | \"text\" | \"integer\" | \"select\" | \"textarea\" | \"bool\" | \"password\" | \"yaml\"" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, @@ -21848,6 +21848,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.options", + "type": "Array", + "tags": [], + "label": "[RegistryVarsEntryKeys.options]", + "description": [], + "signature": [ + "{ value: string; text: string; }[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "fleet", "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.default", @@ -25032,6 +25046,22 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getAgentsByActionsPath", + "type": "Function", + "tags": [], + "label": "getAgentsByActionsPath", + "description": [], + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index d6ee2a65cd394..17d80e07178f2 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-03-09 +date: 2023-03-21 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 | |-------------------|-----------|------------------------|-----------------| -| 1094 | 3 | 989 | 27 | +| 1096 | 3 | 991 | 27 | ## Client diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index 5334cb9b7af40..89a1b415de367 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-03-09 +date: 2023-03-21 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 a6ddac775ca7a..8fa4e975e68ec 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding'] --- import guidedOnboardingObj from './guided_onboarding.devdocs.json'; diff --git a/api_docs/home.devdocs.json b/api_docs/home.devdocs.json index ccda886c9fcdd..c33d628213a1d 100644 --- a/api_docs/home.devdocs.json +++ b/api_docs/home.devdocs.json @@ -1714,7 +1714,7 @@ "label": "InstructionSetSchema", "description": [], "signature": [ - "{ readonly title?: string | undefined; readonly callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; readonly statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; readonly instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }" + "{ readonly title?: string | undefined; readonly callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; readonly statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record; }>; }> | undefined; readonly instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts", "deprecated": false, @@ -1729,7 +1729,7 @@ "label": "InstructionsSchema", "description": [], "signature": [ - "{ readonly params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; readonly instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }" + "{ readonly params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; readonly instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts", "deprecated": false, @@ -1856,7 +1856,7 @@ "section": "def-server.TutorialContext", "text": "TutorialContext" }, - ") => Readonly<{ savedObjects?: any[] | undefined; euiIconType?: string | undefined; isBeta?: boolean | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { id: string; name: string; category: \"security\" | \"metrics\" | \"other\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>" + ") => Readonly<{ savedObjects?: any[] | undefined; euiIconType?: string | undefined; isBeta?: boolean | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { id: string; name: string; category: \"security\" | \"metrics\" | \"other\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "deprecated": false, @@ -1894,7 +1894,7 @@ "label": "TutorialSchema", "description": [], "signature": [ - "{ readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly isBeta?: boolean | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly id: string; readonly name: string; readonly category: \"security\" | \"metrics\" | \"other\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }" + "{ readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly isBeta?: boolean | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly id: string; readonly name: string; readonly category: \"security\" | \"metrics\" | \"other\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts", "deprecated": false, diff --git a/api_docs/home.mdx b/api_docs/home.mdx index 659f2eafc45ec..769ad0711a597 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-03-09 +date: 2023-03-21 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 c053e8210d559..a1c277fb41b09 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-03-09 +date: 2023-03-21 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 daaa6d4a98a46..6a62c1c45fdc9 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-03-09 +date: 2023-03-21 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 3a128d3474f8e..bfdd40f900a37 100644 --- a/api_docs/index_management.devdocs.json +++ b/api_docs/index_management.devdocs.json @@ -2627,7 +2627,7 @@ "label": "TemplateType", "description": [], "signature": [ - "\"default\" | \"system\" | \"managed\" | \"cloudManaged\"" + "\"managed\" | \"default\" | \"system\" | \"cloudManaged\"" ], "path": "x-pack/plugins/index_management/common/types/templates.ts", "deprecated": false, diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index 2186de71c2074..d3f5f832c8e3c 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] --- import indexManagementObj from './index_management.devdocs.json'; diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index 8af608feaa9ff..deab7825a89b7 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] --- import infraObj from './infra.devdocs.json'; diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index c6e63a81e4f6a..9b3ebf5b76fd3 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-03-09 +date: 2023-03-21 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 6aa9e23b7b459..e71bd91eaf1b2 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-03-09 +date: 2023-03-21 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 73ec62649c485..7decc1def2859 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-03-09 +date: 2023-03-21 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 379dc78a3f03c..ff1bf14ce0744 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-03-09 +date: 2023-03-21 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 fb059f845a018..51214562369d0 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils'] --- import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json'; diff --git a/api_docs/kbn_alerts.mdx b/api_docs/kbn_alerts.mdx index 030e18b65602e..c20a78b31eef7 100644 --- a/api_docs/kbn_alerts.mdx +++ b/api_docs/kbn_alerts.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts title: "@kbn/alerts" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerts plugin -date: 2023-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts'] --- import kbnAlertsObj from './kbn_alerts.devdocs.json'; diff --git a/api_docs/kbn_alerts_as_data_utils.mdx b/api_docs/kbn_alerts_as_data_utils.mdx index 8551561f8f560..8942083ce658e 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-as-data-utils'] --- import kbnAlertsAsDataUtilsObj from './kbn_alerts_as_data_utils.devdocs.json'; diff --git a/api_docs/kbn_alerts_ui_shared.mdx b/api_docs/kbn_alerts_ui_shared.mdx index 98c6c959b9303..f5d9fbce90d7e 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared'] --- import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.devdocs.json'; diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index fda22f331c776..ad9e94f342170 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-03-09 +date: 2023-03-21 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 0a76e063abadc..bc6531328a4e1 100644 --- a/api_docs/kbn_analytics_client.devdocs.json +++ b/api_docs/kbn_analytics_client.devdocs.json @@ -734,6 +734,18 @@ "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": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_client.ts" + }, { "plugin": "@kbn/core-analytics-browser-mocks", "path": "packages/core/analytics/core-analytics-browser-mocks/src/analytics_service.mock.ts" @@ -810,6 +822,14 @@ "plugin": "infra", "path": "x-pack/plugins/infra/public/services/telemetry/telemetry_service.test.ts" }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_service.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_service.test.ts" + }, { "plugin": "@kbn/core-status-server-internal", "path": "packages/core/status/core-status-server-internal/src/status_service.test.ts" @@ -1232,6 +1252,10 @@ "plugin": "telemetry", "path": "src/plugins/telemetry/public/plugin.ts" }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/lib/telemetry/telemetry_service.ts" + }, { "plugin": "@kbn/core-analytics-browser-mocks", "path": "packages/core/analytics/core-analytics-browser-mocks/src/analytics_service.mock.ts" diff --git a/api_docs/kbn_analytics_client.mdx b/api_docs/kbn_analytics_client.mdx index aa8836b75670c..2b5b9ac2b95ed 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client'] --- import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx index e63a534279466..6f593b42c9e9e 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser'] --- import kbnAnalyticsShippersElasticV3BrowserObj from './kbn_analytics_shippers_elastic_v3_browser.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx index f9317de120286..8539ae1328661 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common'] --- import kbnAnalyticsShippersElasticV3CommonObj from './kbn_analytics_shippers_elastic_v3_common.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx index e1fcba5ec5066..c7b5e0c3a1202 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-03-09 +date: 2023-03-21 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 7fcd13fe834b8..30ec7116fa29e 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-03-09 +date: 2023-03-21 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 f1f21005bdf0f..5036c9bc7cbec 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-03-09 +date: 2023-03-21 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 fb5323d53f6c1..05c8dbada68da 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-03-09 +date: 2023-03-21 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 4e9b38045b5dc..11fbbae8d715e 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace'] --- import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json'; diff --git a/api_docs/kbn_apm_synthtrace_client.devdocs.json b/api_docs/kbn_apm_synthtrace_client.devdocs.json index 5d07732e93a5a..4aeb6fc81e78a 100644 --- a/api_docs/kbn_apm_synthtrace_client.devdocs.json +++ b/api_docs/kbn_apm_synthtrace_client.devdocs.json @@ -2336,7 +2336,7 @@ "section": "def-common.ApmFields", "text": "ApmFields" }, - ", \"@timestamp\" | \"metricset.name\" | \"ecs.version\" | \"event.ingested\" | \"observer.type\" | \"observer.version_major\" | \"observer.version\" | \"processor.event\" | \"processor.name\"> & Partial<{ 'labels.etag': string; agent_config_applied: number; 'event.agent_id_status': string; }>" + ", \"@timestamp\" | \"ecs.version\" | \"event.ingested\" | \"metricset.name\" | \"observer.type\" | \"observer.version_major\" | \"observer.version\" | \"processor.event\" | \"processor.name\"> & Partial<{ 'labels.etag': string; agent_config_applied: number; 'event.agent_id_status': string; }>" ], "path": "packages/kbn-apm-synthtrace-client/src/lib/agent_config/agent_config_fields.ts", "deprecated": false, @@ -2355,7 +2355,7 @@ "GeoLocation", "; 'client.geo.region_iso_code': string; 'client.geo.region_name': string; 'client.ip': string; 'cloud.account.id': string; 'cloud.account.name': string; 'cloud.availability_zone': string; 'cloud.machine.type': string; 'cloud.project.id': string; 'cloud.project.name': string; 'cloud.provider': string; 'cloud.region': string; 'cloud.service.name': string; 'container.id': string; 'destination.address': string; 'destination.port': number; 'device.id': string; 'device.manufacturer': string; 'device.model.identifier': string; 'device.model.name': string; 'ecs.version': string; 'error.exception': ", "ApmException", - "[]; 'error.grouping_key': string; 'error.grouping_name': string; 'error.id': string; 'event.ingested': number; 'event.name': string; 'event.outcome': string; 'event.outcome_numeric': number | { sum: number; value_count: number; }; 'faas.coldstart': boolean; 'faas.execution': string; 'faas.id': string; 'faas.name': string; 'faas.trigger.type': string; 'faas.version': string; 'host.architecture': string; 'host.hostname': string; 'host.name': string; 'host.os.full': string; 'host.os.name': string; 'host.os.platform': string; 'host.os.type': string; 'host.os.version': string; 'http.request.method': string; 'http.response.status_code': number; 'kubernetes.pod.name': string; 'kubernetes.pod.uid': string; 'labels.name': string; 'metricset.name': string; 'network.carrier.icc': string; 'network.carrier.mcc': string; 'network.carrier.mnc': string; 'network.carrier.name': string; 'network.connection.subtype': string; 'network.connection.type': string; 'observer.type': string; 'observer.version_major': number; 'observer.version': string; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'session.id': string; 'trace.id': string; 'transaction.aggregation.overflow_count': number; 'transaction.duration.us': number; 'transaction.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'service.environment': string; 'service.framework.name': string; 'service.framework.version': string; 'service.language.name': string; 'service.language.version': string; 'service.name': string; 'service.node.name': string; 'service.runtime.name': string; 'service.runtime.version': string; 'service.target.name': string; 'service.target.type': string; 'service.version': string; 'span.action': string; 'span.destination.service.resource': string; 'span.destination.service.response_time.count': number; 'span.destination.service.response_time.sum.us': number; 'span.duration.us': number; 'span.id': string; 'span.name': string; 'span.self_time.count': number; 'span.self_time.sum.us': number; 'span.subtype': string; 'span.type': string; 'transaction.result': string; 'transaction.sampled': true; 'span.links': { trace: { id: string; }; span: { id: string; }; }[]; 'url.original': string; }> & Partial<{ 'system.process.memory.size': number; 'system.memory.actual.free': number; 'system.memory.total': number; 'system.cpu.total.norm.pct': number; 'system.process.memory.rss.bytes': number; 'system.process.cpu.total.norm.pct': number; 'jvm.memory.heap.used': number; 'jvm.memory.non_heap.used': number; 'jvm.thread.count': number; 'faas.billed_duration': number; 'faas.timeout': number; 'faas.coldstart_duration': number; 'faas.duration': number; }> & Partial<{ 'metricset.interval': string; 'transaction.duration.summary': string; }>" + "[]; 'error.grouping_key': string; 'error.grouping_name': string; 'error.id': string; 'event.ingested': number; 'event.name': string; 'event.outcome': string; 'event.outcome_numeric': number | { sum: number; value_count: number; }; 'faas.coldstart': boolean; 'faas.execution': string; 'faas.id': string; 'faas.name': string; 'faas.trigger.type': string; 'faas.version': string; 'host.architecture': string; 'host.hostname': string; 'host.name': string; 'host.os.full': string; 'host.os.name': string; 'host.os.platform': string; 'host.os.type': string; 'host.os.version': string; 'http.request.method': string; 'http.response.status_code': number; 'kubernetes.pod.name': string; 'kubernetes.pod.uid': string; 'labels.name': string; 'labels.telemetry_auto_version': string; 'metricset.name': string; 'network.carrier.icc': string; 'network.carrier.mcc': string; 'network.carrier.mnc': string; 'network.carrier.name': string; 'network.connection.subtype': string; 'network.connection.type': string; 'observer.type': string; 'observer.version_major': number; 'observer.version': string; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'session.id': string; 'trace.id': string; 'transaction.aggregation.overflow_count': number; 'transaction.duration.us': number; 'transaction.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'service.environment': string; 'service.framework.name': string; 'service.framework.version': string; 'service.language.name': string; 'service.language.version': string; 'service.name': string; 'service.node.name': string; 'service.runtime.name': string; 'service.runtime.version': string; 'service.target.name': string; 'service.target.type': string; 'service.version': string; 'span.action': string; 'span.destination.service.resource': string; 'span.destination.service.response_time.count': number; 'span.destination.service.response_time.sum.us': number; 'span.duration.us': number; 'span.id': string; 'span.name': string; 'span.self_time.count': number; 'span.self_time.sum.us': number; 'span.subtype': string; 'span.type': string; 'transaction.result': string; 'transaction.sampled': true; 'span.links': { trace: { id: string; }; span: { id: string; }; }[]; 'url.original': string; }> & Partial<{ 'system.process.memory.size': number; 'system.memory.actual.free': number; 'system.memory.total': number; 'system.cpu.total.norm.pct': number; 'system.process.memory.rss.bytes': number; 'system.process.cpu.total.norm.pct': number; 'jvm.memory.heap.used': number; 'jvm.memory.non_heap.used': number; 'jvm.thread.count': number; 'faas.billed_duration': number; 'faas.timeout': number; 'faas.coldstart_duration': number; 'faas.duration': number; }> & Partial<{ 'metricset.interval': string; 'transaction.duration.summary': string; }>" ], "path": "packages/kbn-apm-synthtrace-client/src/lib/apm/apm_fields.ts", "deprecated": false, diff --git a/api_docs/kbn_apm_synthtrace_client.mdx b/api_docs/kbn_apm_synthtrace_client.mdx index 15abd120a1771..f04e9b0c7b8f1 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-03-09 +date: 2023-03-21 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 a432b3ad5c989..33e9666c10c50 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-03-09 +date: 2023-03-21 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 db25d2c35c90a..e87bcddd1f236 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-03-09 +date: 2023-03-21 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 224812965a790..3970e5c7099ed 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cases-components'] --- import kbnCasesComponentsObj from './kbn_cases_components.devdocs.json'; diff --git a/api_docs/kbn_cell_actions.mdx b/api_docs/kbn_cell_actions.mdx index 36df0ce4b8f86..836b24b591648 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cell-actions'] --- import kbnCellActionsObj from './kbn_cell_actions.devdocs.json'; diff --git a/api_docs/kbn_chart_expressions_common.mdx b/api_docs/kbn_chart_expressions_common.mdx index 86cc619d08b49..c455a1339f5fb 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-03-09 +date: 2023-03-21 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 644f6b7a032d6..094e0c159da01 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-03-09 +date: 2023-03-21 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 5cea780840e23..ccb4b003ab343 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-03-09 +date: 2023-03-21 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 f67cd274d8d6d..fda3e42bb621e 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-03-09 +date: 2023-03-21 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 4660e472804bd..f30695f7f461d 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-03-09 +date: 2023-03-21 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 82943a329b6d1..0fa3b862db96b 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-03-09 +date: 2023-03-21 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 293bbd826936f..6dc0104771aba 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-03-09 +date: 2023-03-21 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 128ed65f76116..d436113832f01 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-03-09 +date: 2023-03-21 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 70db974ae8722..3600c8e07114e 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-03-09 +date: 2023-03-21 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 620b15d042d8f..2be9032392de9 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] --- import kbnConfigObj from './kbn_config.devdocs.json'; diff --git a/api_docs/kbn_config_mocks.mdx b/api_docs/kbn_config_mocks.mdx index ec8f5ecd0e7f5..ff8c8da6cfd14 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-03-09 +date: 2023-03-21 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 b74a8bab5368c..58ca9d1759176 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-03-09 +date: 2023-03-21 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 20a8bfc638a53..21f0433d4599b 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-content-editor'] --- import kbnContentManagementContentEditorObj from './kbn_content_management_content_editor.devdocs.json'; diff --git a/api_docs/kbn_content_management_table_list.mdx b/api_docs/kbn_content_management_table_list.mdx index 05cb08207daf5..0801cdd30b3b2 100644 --- a/api_docs/kbn_content_management_table_list.mdx +++ b/api_docs/kbn_content_management_table_list.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-table-list title: "@kbn/content-management-table-list" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-table-list plugin -date: 2023-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-table-list'] --- import kbnContentManagementTableListObj from './kbn_content_management_table_list.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_browser.mdx b/api_docs/kbn_core_analytics_browser.mdx index 9ca1f628b471f..d0f802a9ae215 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-03-09 +date: 2023-03-21 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 235f9c61fe187..b5af206425ce6 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-03-09 +date: 2023-03-21 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 652c4f9b22ce7..5d9e1a17cff6d 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-03-09 +date: 2023-03-21 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 ad28840e2fc99..6adbdba2b7c7d 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-03-09 +date: 2023-03-21 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 2f9e09dad6c08..c8da1d9c55287 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-03-09 +date: 2023-03-21 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 7e2e303aeef50..5091b6bf0cdda 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-03-09 +date: 2023-03-21 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 a36e62e4b18c7..558cdce3edaf4 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-03-09 +date: 2023-03-21 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 577c3c9f760b6..eb1ebd753efad 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-browser-internal'] --- import kbnCoreApplicationBrowserInternalObj from './kbn_core_application_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_application_browser_mocks.mdx b/api_docs/kbn_core_application_browser_mocks.mdx index 01f90019478ac..ad1bf6f60b6c0 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-03-09 +date: 2023-03-21 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 56dea207d4219..fceb3232c6bcc 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-03-09 +date: 2023-03-21 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 08e7111dcc8f1..ac58ab38a297a 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-03-09 +date: 2023-03-21 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 e4406ff5d5630..97e3afb4d34a6 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-03-09 +date: 2023-03-21 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 311f1f829329c..0b84c281eca33 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-03-09 +date: 2023-03-21 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 a39ba8b1e0612..36bc4d7fd0d37 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-03-09 +date: 2023-03-21 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 84d39d9a5846e..563aad30ef370 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-03-09 +date: 2023-03-21 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 1a79d20cbd929..f4e5dcb8e04cb 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-03-09 +date: 2023-03-21 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 a7bf9f3180cd9..9b8c6294f7f08 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-03-09 +date: 2023-03-21 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 e4a2cddc606ed..fd7fc772be68f 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-03-09 +date: 2023-03-21 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 1f21a729af724..3f947f88dfdbd 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-03-09 +date: 2023-03-21 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 bae71b7ecf453..619d405dc307f 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-03-09 +date: 2023-03-21 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 1a848eacabe2d..a1a9f5e9e18c1 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-server-mocks'] --- import kbnCoreCapabilitiesServerMocksObj from './kbn_core_capabilities_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_chrome_browser.mdx b/api_docs/kbn_core_chrome_browser.mdx index 17f3c6870fcf3..523d27aa5029a 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-chrome-browser'] --- import kbnCoreChromeBrowserObj from './kbn_core_chrome_browser.devdocs.json'; diff --git a/api_docs/kbn_core_chrome_browser_mocks.mdx b/api_docs/kbn_core_chrome_browser_mocks.mdx index 92733f73bb62f..81a90c89463e5 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-03-09 +date: 2023-03-21 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 5bbcabee6abb2..153f581071aa5 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-03-09 +date: 2023-03-21 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 0924b836d3e45..83a87ee813e4e 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-03-09 +date: 2023-03-21 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 15781b0a29cc9..6032f69b96411 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-03-09 +date: 2023-03-21 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 8c972df70bc15..9fc9d9c814e8e 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-03-09 +date: 2023-03-21 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 8647dab1c7714..db729eeb5f682 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-03-09 +date: 2023-03-21 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 68cba61d1e84e..2921e24737d3a 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-03-09 +date: 2023-03-21 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 cfab7dd850c24..47f530589f1dc 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-server-internal'] --- import kbnCoreCustomBrandingServerInternalObj from './kbn_core_custom_branding_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_server_mocks.mdx b/api_docs/kbn_core_custom_branding_server_mocks.mdx index 1d8b166f7ed08..bc4f4d862d066 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-03-09 +date: 2023-03-21 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 42631374a0475..cc277c905174a 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-03-09 +date: 2023-03-21 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 5d64a00028055..d9e3fa48e9c5a 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-03-09 +date: 2023-03-21 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 54e08b122da7c..240a8557b67d2 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-03-09 +date: 2023-03-21 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 4e88d025df5c7..941673ccec16f 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-03-09 +date: 2023-03-21 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 60b80463f5ee6..5e51a16818c54 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-03-09 +date: 2023-03-21 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 452833d3ee1a0..3785cb287a027 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-03-09 +date: 2023-03-21 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 d8c4515670f59..eef38e0a47864 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-03-09 +date: 2023-03-21 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 75381ba153baf..3ff50d16c1a88 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser'] --- import kbnCoreDocLinksBrowserObj from './kbn_core_doc_links_browser.devdocs.json'; diff --git a/api_docs/kbn_core_doc_links_browser_mocks.mdx b/api_docs/kbn_core_doc_links_browser_mocks.mdx index 5dcd100b6bcff..13ec7ed7d596f 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-03-09 +date: 2023-03-21 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 8d124fcc286a2..a943c066cf3c8 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-03-09 +date: 2023-03-21 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 5fc506af57ff0..bdee4a5353fbd 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_core_elasticsearch_client_server_internal.devdocs.json index 4c68d1b3a5c5e..d249733c20b94 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_internal.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_client_server_internal.devdocs.json @@ -225,7 +225,22 @@ "signature": [ "(event: ", "DiagnosticResult", - ") => { url: string; body: string; statusCode: number | null; method: string; }" + ", apisToRedactInLogs: ", + { + "pluginId": "@kbn/core-elasticsearch-server", + "scope": "common", + "docId": "kibKbnCoreElasticsearchServerPluginApi", + "section": "def-common.ElasticsearchApiToRedactInLogs", + "text": "ElasticsearchApiToRedactInLogs" + }, + "[] | undefined) => ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-internal", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerInternalPluginApi", + "section": "def-common.RequestDebugMeta", + "text": "RequestDebugMeta" + } ], "path": "packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.ts", "deprecated": false, @@ -246,6 +261,28 @@ "deprecated": false, "trackAdoption": false, "isRequired": true + }, + { + "parentPluginId": "@kbn/core-elasticsearch-client-server-internal", + "id": "def-common.getRequestDebugMeta.$2", + "type": "Array", + "tags": [], + "label": "apisToRedactInLogs", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-elasticsearch-server", + "scope": "common", + "docId": "kibKbnCoreElasticsearchServerPluginApi", + "section": "def-common.ElasticsearchApiToRedactInLogs", + "text": "ElasticsearchApiToRedactInLogs" + }, + "[] | undefined" + ], + "path": "packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false } ], "returnComment": [], @@ -293,6 +330,77 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-elasticsearch-client-server-internal", + "id": "def-common.RequestDebugMeta", + "type": "Interface", + "tags": [], + "label": "RequestDebugMeta", + "description": [ + "\nThe logger-relevant request meta of an ES request" + ], + "path": "packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-elasticsearch-client-server-internal", + "id": "def-common.RequestDebugMeta.method", + "type": "string", + "tags": [], + "label": "method", + "description": [ + "\nThe requested method" + ], + "path": "packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-elasticsearch-client-server-internal", + "id": "def-common.RequestDebugMeta.url", + "type": "string", + "tags": [], + "label": "url", + "description": [ + "\nThe requested endpoint + querystring" + ], + "path": "packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-elasticsearch-client-server-internal", + "id": "def-common.RequestDebugMeta.body", + "type": "string", + "tags": [], + "label": "body", + "description": [ + "\nThe request body (it may be redacted)" + ], + "path": "packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-elasticsearch-client-server-internal", + "id": "def-common.RequestDebugMeta.statusCode", + "type": "CompoundType", + "tags": [], + "label": "statusCode", + "description": [ + "\nThe status code of the response" + ], + "signature": [ + "number | null" + ], + "path": "packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false } ], "enums": [], diff --git a/api_docs/kbn_core_elasticsearch_client_server_internal.mdx b/api_docs/kbn_core_elasticsearch_client_server_internal.mdx index 8e7b882d1c6a7..85dbb0ff1ed57 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-client-server-internal'] --- import kbnCoreElasticsearchClientServerInternalObj from './kbn_core_elasticsearch_client_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 | |-------------------|-----------|------------------------|-----------------| -| 16 | 0 | 12 | 1 | +| 22 | 0 | 13 | 1 | ## Common 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 4486c24f734a4..a605c8268586c 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json @@ -401,51 +401,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; security: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.DeeplyMockedApi", - "text": "DeeplyMockedApi" - }, - "<", - "default", - ">; ping: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.ClientApiMockInstance", - "text": "ClientApiMockInstance" - }, - ", [params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined]>; nodes: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.DeeplyMockedApi", - "text": "DeeplyMockedApi" - }, - "<", - "default", - ">; indices: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.DeeplyMockedApi", - "text": "DeeplyMockedApi" - }, - "<", - "default", - ">; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined]>; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -807,7 +763,17 @@ "IndexRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; info: ", + " | undefined]>; indices: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.DeeplyMockedApi", + "text": "DeeplyMockedApi" + }, + "<", + "default", + ">; info: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -953,7 +919,17 @@ "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptions", - " | undefined]>; openPointInTime: ", + " | undefined]>; nodes: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.DeeplyMockedApi", + "text": "DeeplyMockedApi" + }, + "<", + "default", + ">; openPointInTime: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -969,6 +945,20 @@ "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptions", + " | undefined]>; ping: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.ClientApiMockInstance", + "text": "ClientApiMockInstance" + }, + ", [params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", " | undefined]>; putScript: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -1147,6 +1137,16 @@ }, "<", "default", + ">; security: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.DeeplyMockedApi", + "text": "DeeplyMockedApi" + }, + "<", + "default", ">; shutdown: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -1508,51 +1508,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; security: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.DeeplyMockedApi", - "text": "DeeplyMockedApi" - }, - "<", - "default", - ">; ping: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.ClientApiMockInstance", - "text": "ClientApiMockInstance" - }, - ", [params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined]>; nodes: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.DeeplyMockedApi", - "text": "DeeplyMockedApi" - }, - "<", - "default", - ">; indices: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.DeeplyMockedApi", - "text": "DeeplyMockedApi" - }, - "<", - "default", - ">; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined]>; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -1914,7 +1870,17 @@ "IndexRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; info: ", + " | undefined]>; indices: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.DeeplyMockedApi", + "text": "DeeplyMockedApi" + }, + "<", + "default", + ">; info: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -2060,7 +2026,17 @@ "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptions", - " | undefined]>; openPointInTime: ", + " | undefined]>; nodes: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.DeeplyMockedApi", + "text": "DeeplyMockedApi" + }, + "<", + "default", + ">; openPointInTime: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -2076,6 +2052,20 @@ "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptions", + " | undefined]>; ping: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.ClientApiMockInstance", + "text": "ClientApiMockInstance" + }, + ", [params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", " | undefined]>; putScript: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -2254,6 +2244,16 @@ }, "<", "default", + ">; security: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.DeeplyMockedApi", + "text": "DeeplyMockedApi" + }, + "<", + "default", ">; shutdown: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -2569,51 +2569,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; security: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.DeeplyMockedApi", - "text": "DeeplyMockedApi" - }, - "<", - "default", - ">; ping: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.ClientApiMockInstance", - "text": "ClientApiMockInstance" - }, - ", [params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined]>; nodes: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.DeeplyMockedApi", - "text": "DeeplyMockedApi" - }, - "<", - "default", - ">; indices: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.DeeplyMockedApi", - "text": "DeeplyMockedApi" - }, - "<", - "default", - ">; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined]>; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -2975,7 +2931,17 @@ "IndexRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; info: ", + " | undefined]>; indices: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.DeeplyMockedApi", + "text": "DeeplyMockedApi" + }, + "<", + "default", + ">; info: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -3121,7 +3087,17 @@ "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptions", - " | undefined]>; openPointInTime: ", + " | undefined]>; nodes: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.DeeplyMockedApi", + "text": "DeeplyMockedApi" + }, + "<", + "default", + ">; openPointInTime: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -3137,6 +3113,20 @@ "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptions", + " | undefined]>; ping: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.ClientApiMockInstance", + "text": "ClientApiMockInstance" + }, + ", [params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", " | undefined]>; putScript: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -3315,6 +3305,16 @@ }, "<", "default", + ">; security: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.DeeplyMockedApi", + "text": "DeeplyMockedApi" + }, + "<", + "default", ">; shutdown: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -3721,51 +3721,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; security: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.DeeplyMockedApi", - "text": "DeeplyMockedApi" - }, - "<", - "default", - ">; ping: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.ClientApiMockInstance", - "text": "ClientApiMockInstance" - }, - ", [params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined]>; nodes: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.DeeplyMockedApi", - "text": "DeeplyMockedApi" - }, - "<", - "default", - ">; indices: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "common", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-common.DeeplyMockedApi", - "text": "DeeplyMockedApi" - }, - "<", - "default", - ">; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined]>; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -4127,7 +4083,17 @@ "IndexRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; info: ", + " | undefined]>; indices: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.DeeplyMockedApi", + "text": "DeeplyMockedApi" + }, + "<", + "default", + ">; info: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -4273,7 +4239,17 @@ "MtermvectorsRequest", " | undefined, options?: ", "TransportRequestOptions", - " | undefined]>; openPointInTime: ", + " | undefined]>; nodes: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.DeeplyMockedApi", + "text": "DeeplyMockedApi" + }, + "<", + "default", + ">; openPointInTime: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -4289,6 +4265,20 @@ "OpenPointInTimeRequest", ", options?: ", "TransportRequestOptions", + " | undefined]>; ping: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.ClientApiMockInstance", + "text": "ClientApiMockInstance" + }, + ", [params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", " | undefined]>; putScript: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -4467,6 +4457,16 @@ }, "<", "default", + ">; security: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "common", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-common.DeeplyMockedApi", + "text": "DeeplyMockedApi" + }, + "<", + "default", ">; shutdown: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", diff --git a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx index 7457d5d227154..347292af59ed1 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-03-09 +date: 2023-03-21 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 0d13d0516f3f7..2fa0afea256a4 100644 --- a/api_docs/kbn_core_elasticsearch_server.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_server.devdocs.json @@ -20,6 +20,54 @@ "classes": [], "functions": [], "interfaces": [ + { + "parentPluginId": "@kbn/core-elasticsearch-server", + "id": "def-common.ElasticsearchApiToRedactInLogs", + "type": "Interface", + "tags": [], + "label": "ElasticsearchApiToRedactInLogs", + "description": [ + "\nDefinition of an API that should redact the requested body in the logs" + ], + "path": "packages/core/elasticsearch/core-elasticsearch-server/src/client/client_config.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-elasticsearch-server", + "id": "def-common.ElasticsearchApiToRedactInLogs.path", + "type": "CompoundType", + "tags": [], + "label": "path", + "description": [ + "\nThe ES path.\n- If specified as a string, it'll be checked as `contains`.\n- If specified as a RegExp, it'll be tested against the path." + ], + "signature": [ + "string | RegExp" + ], + "path": "packages/core/elasticsearch/core-elasticsearch-server/src/client/client_config.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-elasticsearch-server", + "id": "def-common.ElasticsearchApiToRedactInLogs.method", + "type": "string", + "tags": [], + "label": "method", + "description": [ + "\nHTTP method.\nIf not provided, the path will be checked for all methods." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/elasticsearch/core-elasticsearch-server/src/client/client_config.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-elasticsearch-server", "id": "def-common.ElasticsearchClientConfig", @@ -276,6 +324,27 @@ "path": "packages/core/elasticsearch/core-elasticsearch-server/src/client/client_config.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-elasticsearch-server", + "id": "def-common.ElasticsearchClientConfig.apisToRedactInLogs", + "type": "Array", + "tags": [], + "label": "apisToRedactInLogs", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-elasticsearch-server", + "scope": "common", + "docId": "kibKbnCoreElasticsearchServerPluginApi", + "section": "def-common.ElasticsearchApiToRedactInLogs", + "text": "ElasticsearchApiToRedactInLogs" + }, + "[] | undefined" + ], + "path": "packages/core/elasticsearch/core-elasticsearch-server/src/client/client_config.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -1123,33 +1192,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -1531,7 +1574,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -1709,7 +1754,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -1735,7 +1782,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -1999,6 +2066,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -2553,6 +2622,29 @@ "path": "packages/core/elasticsearch/core-elasticsearch-server/src/elasticsearch_config.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-elasticsearch-server", + "id": "def-common.IElasticsearchConfig.apisToRedactInLogs", + "type": "Array", + "tags": [], + "label": "apisToRedactInLogs", + "description": [ + "\nExtends the list of APIs that should be redacted in logs." + ], + "signature": [ + { + "pluginId": "@kbn/core-elasticsearch-server", + "scope": "common", + "docId": "kibKbnCoreElasticsearchServerPluginApi", + "section": "def-common.ElasticsearchApiToRedactInLogs", + "text": "ElasticsearchApiToRedactInLogs" + }, + "[]" + ], + "path": "packages/core/elasticsearch/core-elasticsearch-server/src/elasticsearch_config.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -2766,33 +2858,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -3174,7 +3240,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -3352,7 +3420,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -3378,7 +3448,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -3642,6 +3732,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -3968,33 +4060,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -4376,7 +4442,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -4554,7 +4622,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -4580,7 +4650,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -4844,6 +4934,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -5423,33 +5515,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -5831,7 +5897,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -6009,7 +6077,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -6035,7 +6105,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -6299,6 +6389,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", diff --git a/api_docs/kbn_core_elasticsearch_server.mdx b/api_docs/kbn_core_elasticsearch_server.mdx index 0d2c1e7f2059c..40069116881ac 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server'] --- import kbnCoreElasticsearchServerObj from './kbn_core_elasticsearch_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 | |-------------------|-----------|------------------------|-----------------| -| 103 | 0 | 53 | 0 | +| 108 | 0 | 54 | 0 | ## Common diff --git a/api_docs/kbn_core_elasticsearch_server_internal.devdocs.json b/api_docs/kbn_core_elasticsearch_server_internal.devdocs.json index 0b19e6e87fab8..e61d0f6b28377 100644 --- a/api_docs/kbn_core_elasticsearch_server_internal.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_server_internal.devdocs.json @@ -246,33 +246,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -654,7 +628,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -832,7 +808,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -858,7 +836,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -1122,6 +1120,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -1876,33 +1876,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -2284,7 +2258,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -2462,7 +2438,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -2488,7 +2466,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -2752,6 +2750,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -2949,7 +2949,7 @@ "label": "ElasticsearchConfigType", "description": [], "signature": [ - "{ readonly username?: string | undefined; readonly password?: string | undefined; readonly serviceAccountToken?: string | undefined; readonly healthCheck: Readonly<{} & { delay: moment.Duration; }>; readonly ssl: Readonly<{ key?: string | undefined; certificateAuthorities?: string | string[] | undefined; certificate?: string | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"full\" | \"certificate\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; readonly requestTimeout: moment.Duration; readonly compression: boolean; readonly customHeaders: Record; readonly hosts: string | string[]; readonly sniffOnStart: boolean; readonly sniffInterval: false | moment.Duration; readonly sniffOnConnectionFault: boolean; readonly maxSockets: number; readonly maxIdleSockets: number; readonly idleSocketTimeout: moment.Duration; readonly requestHeadersWhitelist: string | string[]; readonly shardTimeout: moment.Duration; readonly pingTimeout: moment.Duration; readonly logQueries: boolean; readonly apiVersion: string; readonly ignoreVersionMismatch: boolean; readonly skipStartupConnectionCheck: boolean; }" + "{ readonly username?: string | undefined; readonly password?: string | undefined; readonly serviceAccountToken?: string | undefined; readonly healthCheck: Readonly<{} & { delay: moment.Duration; }>; readonly ssl: Readonly<{ key?: string | undefined; certificateAuthorities?: string | string[] | undefined; certificate?: string | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"full\" | \"certificate\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; readonly requestTimeout: moment.Duration; readonly compression: boolean; readonly customHeaders: Record; readonly hosts: string | string[]; readonly sniffOnStart: boolean; readonly sniffInterval: false | moment.Duration; readonly sniffOnConnectionFault: boolean; readonly maxSockets: number; readonly maxIdleSockets: number; readonly idleSocketTimeout: moment.Duration; readonly requestHeadersWhitelist: string | string[]; readonly shardTimeout: moment.Duration; readonly pingTimeout: moment.Duration; readonly logQueries: boolean; readonly apiVersion: string; readonly ignoreVersionMismatch: boolean; readonly skipStartupConnectionCheck: boolean; readonly apisToRedactInLogs: Readonly<{ method?: string | undefined; } & { path: string; }>[]; }" ], "path": "packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_config.ts", "deprecated": false, @@ -3255,7 +3255,15 @@ "section": "def-common.ConditionalType", "text": "ConditionalType" }, - "; }>" + "; apisToRedactInLogs: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + "[]>; }>" ], "path": "packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_config.ts", "deprecated": false, diff --git a/api_docs/kbn_core_elasticsearch_server_internal.mdx b/api_docs/kbn_core_elasticsearch_server_internal.mdx index 6379de05e289f..25e01dbc60e09 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server-internal'] --- import kbnCoreElasticsearchServerInternalObj from './kbn_core_elasticsearch_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_server_mocks.mdx index dcbc695a3b3fa..8ad7df26d4b04 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-03-09 +date: 2023-03-21 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 bcdf8d9bd22a0..15343ee3bf722 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-03-09 +date: 2023-03-21 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 7206324114ab9..e701d8e867b37 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-03-09 +date: 2023-03-21 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 096402a198b4d..52c9c83233151 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-03-09 +date: 2023-03-21 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 271273cfd662e..2cb80d9bb8b8f 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-03-09 +date: 2023-03-21 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 84a3207c9ff69..9be366ff4e3a2 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-03-09 +date: 2023-03-21 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 9b24f22f700df..0cf4f2a6f6203 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-03-09 +date: 2023-03-21 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 29eac7797c723..fcaea80cc192b 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-03-09 +date: 2023-03-21 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 483133412fccc..f9f5559572871 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-03-09 +date: 2023-03-21 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 2b17bd725e44d..24ae3df7e7deb 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-03-09 +date: 2023-03-21 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 6105a55dfe5ab..427c6b1a8a17b 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-03-09 +date: 2023-03-21 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 b6cace01956e7..cf32dcdbfb40f 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-03-09 +date: 2023-03-21 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 d565af256da31..a43744552acfc 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-03-09 +date: 2023-03-21 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 ee0109737b0a8..d17c43a85ecbf 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-internal'] --- import kbnCoreHttpBrowserInternalObj from './kbn_core_http_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_browser_mocks.mdx b/api_docs/kbn_core_http_browser_mocks.mdx index e9ccaff15d52d..3990160ea4ef4 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-mocks'] --- import kbnCoreHttpBrowserMocksObj from './kbn_core_http_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_common.mdx b/api_docs/kbn_core_http_common.mdx index 0e644995d6f83..2e92e1960aed2 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-common'] --- import kbnCoreHttpCommonObj from './kbn_core_http_common.devdocs.json'; diff --git a/api_docs/kbn_core_http_context_server_mocks.mdx b/api_docs/kbn_core_http_context_server_mocks.mdx index 62b9dd47c24c9..01f24f779af73 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-03-09 +date: 2023-03-21 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 1971a641f6be5..261b360a9f67d 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_core_http_resources_server.devdocs.json index a8899047410a4..1b3ef39af611e 100644 --- a/api_docs/kbn_core_http_resources_server.devdocs.json +++ b/api_docs/kbn_core_http_resources_server.devdocs.json @@ -309,11 +309,11 @@ "signature": [ "(options: ", { - "pluginId": "@kbn/core-http-server", + "pluginId": "@kbn/core-http-resources-server", "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibKbnCoreHttpResourcesServerPluginApi", + "section": "def-common.HttpResourcesResponseOptions", + "text": "HttpResourcesResponseOptions" }, ") => ", { @@ -338,11 +338,11 @@ "description": [], "signature": [ { - "pluginId": "@kbn/core-http-server", + "pluginId": "@kbn/core-http-resources-server", "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibKbnCoreHttpResourcesServerPluginApi", + "section": "def-common.HttpResourcesResponseOptions", + "text": "HttpResourcesResponseOptions" } ], "path": "packages/core/http/core-http-resources-server/src/types.ts", @@ -365,11 +365,11 @@ "signature": [ "(options: ", { - "pluginId": "@kbn/core-http-server", + "pluginId": "@kbn/core-http-resources-server", "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibKbnCoreHttpResourcesServerPluginApi", + "section": "def-common.HttpResourcesResponseOptions", + "text": "HttpResourcesResponseOptions" }, ") => ", { @@ -394,11 +394,11 @@ "description": [], "signature": [ { - "pluginId": "@kbn/core-http-server", + "pluginId": "@kbn/core-http-resources-server", "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibKbnCoreHttpResourcesServerPluginApi", + "section": "def-common.HttpResourcesResponseOptions", + "text": "HttpResourcesResponseOptions" } ], "path": "packages/core/http/core-http-resources-server/src/types.ts", @@ -421,11 +421,11 @@ "signature": [ "(options: ", { - "pluginId": "@kbn/core-http-server", + "pluginId": "@kbn/core-http-resources-server", "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibKbnCoreHttpResourcesServerPluginApi", + "section": "def-common.HttpResourcesResponseOptions", + "text": "HttpResourcesResponseOptions" }, ") => ", { @@ -450,11 +450,11 @@ "description": [], "signature": [ { - "pluginId": "@kbn/core-http-server", + "pluginId": "@kbn/core-http-resources-server", "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibKbnCoreHttpResourcesServerPluginApi", + "section": "def-common.HttpResourcesResponseOptions", + "text": "HttpResourcesResponseOptions" } ], "path": "packages/core/http/core-http-resources-server/src/types.ts", @@ -670,7 +670,8 @@ "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" - } + }, + "" ], "path": "packages/core/http/core-http-resources-server/src/types.ts", "deprecated": false, diff --git a/api_docs/kbn_core_http_resources_server.mdx b/api_docs/kbn_core_http_resources_server.mdx index 69b860357f14b..34d0a0ce02341 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-03-09 +date: 2023-03-21 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 876e1dea05a28..a6b31630dc9df 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-03-09 +date: 2023-03-21 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 12acbace23682..0ce3d88b19cbf 100644 --- a/api_docs/kbn_core_http_resources_server_mocks.devdocs.json +++ b/api_docs/kbn_core_http_resources_server_mocks.devdocs.json @@ -295,19 +295,19 @@ }, ", [options: ", { - "pluginId": "@kbn/core-http-server", + "pluginId": "@kbn/core-http-resources-server", "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibKbnCoreHttpResourcesServerPluginApi", + "section": "def-common.HttpResourcesResponseOptions", + "text": "HttpResourcesResponseOptions" }, "]> & ((options: ", { - "pluginId": "@kbn/core-http-server", + "pluginId": "@kbn/core-http-resources-server", "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibKbnCoreHttpResourcesServerPluginApi", + "section": "def-common.HttpResourcesResponseOptions", + "text": "HttpResourcesResponseOptions" }, ") => ", { @@ -327,19 +327,19 @@ }, ", [options: ", { - "pluginId": "@kbn/core-http-server", + "pluginId": "@kbn/core-http-resources-server", "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibKbnCoreHttpResourcesServerPluginApi", + "section": "def-common.HttpResourcesResponseOptions", + "text": "HttpResourcesResponseOptions" }, "]> & ((options: ", { - "pluginId": "@kbn/core-http-server", + "pluginId": "@kbn/core-http-resources-server", "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibKbnCoreHttpResourcesServerPluginApi", + "section": "def-common.HttpResourcesResponseOptions", + "text": "HttpResourcesResponseOptions" }, ") => ", { @@ -359,19 +359,19 @@ }, ", [options: ", { - "pluginId": "@kbn/core-http-server", + "pluginId": "@kbn/core-http-resources-server", "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibKbnCoreHttpResourcesServerPluginApi", + "section": "def-common.HttpResourcesResponseOptions", + "text": "HttpResourcesResponseOptions" }, "]> & ((options: ", { - "pluginId": "@kbn/core-http-server", + "pluginId": "@kbn/core-http-resources-server", "scope": "common", - "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibKbnCoreHttpResourcesServerPluginApi", + "section": "def-common.HttpResourcesResponseOptions", + "text": "HttpResourcesResponseOptions" }, ") => ", { @@ -389,7 +389,17 @@ "section": "def-common.IKibanaResponse", "text": "IKibanaResponse" }, - ", [options?: ", + " | Error | Buffer | ", + "Stream", + " | { message: string | Error; attributes?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "common", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-common.ResponseErrorAttributes", + "text": "ResponseErrorAttributes" + }, + " | undefined; } | undefined>, [options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -397,7 +407,27 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | Error | Buffer | ", + "Stream", + " | { message: string | Error; attributes?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "common", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-common.ResponseErrorAttributes", + "text": "ResponseErrorAttributes" + }, + " | undefined; } | undefined> | undefined]> & ( | Error | Buffer | ", + "Stream", + " | { message: string | Error; attributes?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "common", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-common.ResponseErrorAttributes", + "text": "ResponseErrorAttributes" + }, + " | undefined; } | undefined = any>(options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -405,7 +435,7 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined) => ", + " | undefined) => ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -413,7 +443,7 @@ "section": "def-common.IKibanaResponse", "text": "IKibanaResponse" }, - "); accepted: jest.MockInstance<", + "); accepted: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -421,7 +451,17 @@ "section": "def-common.IKibanaResponse", "text": "IKibanaResponse" }, - ", [options?: ", + " | Error | Buffer | ", + "Stream", + " | { message: string | Error; attributes?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "common", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-common.ResponseErrorAttributes", + "text": "ResponseErrorAttributes" + }, + " | undefined; } | undefined>, [options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -429,7 +469,27 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | Error | Buffer | ", + "Stream", + " | { message: string | Error; attributes?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "common", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-common.ResponseErrorAttributes", + "text": "ResponseErrorAttributes" + }, + " | undefined; } | undefined> | undefined]> & ( | Error | Buffer | ", + "Stream", + " | { message: string | Error; attributes?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "common", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-common.ResponseErrorAttributes", + "text": "ResponseErrorAttributes" + }, + " | undefined; } | undefined = any>(options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -437,7 +497,7 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined) => ", + " | undefined) => ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -445,7 +505,7 @@ "section": "def-common.IKibanaResponse", "text": "IKibanaResponse" }, - "); noContent: jest.MockInstance<", + "); noContent: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -461,7 +521,7 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | undefined]> & ((options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -469,7 +529,7 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined) => ", + " | undefined) => ", { "pluginId": "@kbn/core-http-server", "scope": "common", diff --git a/api_docs/kbn_core_http_resources_server_mocks.mdx b/api_docs/kbn_core_http_resources_server_mocks.mdx index 09ff1e2fd8cdc..a60dad62ca918 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-03-09 +date: 2023-03-21 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 2c6b9e0ff8e44..f1fe5495eaa53 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-router-server-internal'] --- import kbnCoreHttpRouterServerInternalObj from './kbn_core_http_router_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_router_server_mocks.mdx b/api_docs/kbn_core_http_router_server_mocks.mdx index 096a789f25489..078065e4131b6 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-03-09 +date: 2023-03-21 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 93fafbae8bd76..36aaed21cc7a6 100644 --- a/api_docs/kbn_core_http_server.devdocs.json +++ b/api_docs/kbn_core_http_server.devdocs.json @@ -1057,6 +1057,16 @@ "description": [ "\nHTTP response parameters" ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "common", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-common.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + "" + ], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, "trackAdoption": false, @@ -1064,16 +1074,14 @@ { "parentPluginId": "@kbn/core-http-server", "id": "def-common.HttpResponseOptions.body", - "type": "CompoundType", + "type": "Uncategorized", "tags": [], "label": "body", "description": [ "HTTP message to send to the client" ], "signature": [ - "string | Record | Buffer | ", - "Stream", - " | undefined" + "T | undefined" ], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, @@ -2682,7 +2690,8 @@ "docId": "kibKbnCoreHttpServerPluginApi", "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" - } + }, + "" ], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, @@ -5045,7 +5054,17 @@ "\nThe request has succeeded.\nStatus code: `200`." ], "signature": [ - "(options?: ", + " | Error | Buffer | ", + "Stream", + " | { message: string | Error; attributes?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "common", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-common.ResponseErrorAttributes", + "text": "ResponseErrorAttributes" + }, + " | undefined; } | undefined = any>(options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -5053,7 +5072,7 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined) => ", + " | undefined) => ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -5061,7 +5080,7 @@ "section": "def-common.IKibanaResponse", "text": "IKibanaResponse" }, - "" + "" ], "path": "packages/core/http/core-http-server/src/router/response_factory.ts", "deprecated": false, @@ -5084,7 +5103,7 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined" + " | undefined" ], "path": "packages/core/http/core-http-server/src/router/response_factory.ts", "deprecated": false, @@ -5104,7 +5123,17 @@ "\nThe request has been accepted for processing.\nStatus code: `202`." ], "signature": [ - "(options?: ", + " | Error | Buffer | ", + "Stream", + " | { message: string | Error; attributes?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "common", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-common.ResponseErrorAttributes", + "text": "ResponseErrorAttributes" + }, + " | undefined; } | undefined = any>(options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -5112,7 +5141,7 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined) => ", + " | undefined) => ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -5120,7 +5149,7 @@ "section": "def-common.IKibanaResponse", "text": "IKibanaResponse" }, - "" + "" ], "path": "packages/core/http/core-http-server/src/router/response_factory.ts", "deprecated": false, @@ -5143,7 +5172,7 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined" + " | undefined" ], "path": "packages/core/http/core-http-server/src/router/response_factory.ts", "deprecated": false, @@ -5171,7 +5200,7 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined) => ", + " | undefined) => ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -5202,7 +5231,7 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined" + " | undefined" ], "path": "packages/core/http/core-http-server/src/router/response_factory.ts", "deprecated": false, @@ -8543,7 +8572,7 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " & { headers: { location: string; }; }" + " & { headers: { location: string; }; }" ], "path": "packages/core/http/core-http-server/src/router/response.ts", "deprecated": false, diff --git a/api_docs/kbn_core_http_server.mdx b/api_docs/kbn_core_http_server.mdx index 6dad2b3b2c69e..5fb49519e6b94 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-03-09 +date: 2023-03-21 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.mdx b/api_docs/kbn_core_http_server_internal.mdx index 7d8bf7e023cea..7876858317859 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server-internal'] --- import kbnCoreHttpServerInternalObj from './kbn_core_http_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_server_mocks.mdx b/api_docs/kbn_core_http_server_mocks.mdx index 9f588ffd0224b..fb441118c6b6e 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-03-09 +date: 2023-03-21 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 032fbe0c03de8..9f2056c949010 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-03-09 +date: 2023-03-21 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 84b487f6c5cc5..0dfbc35959d81 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-03-09 +date: 2023-03-21 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 d43299bedfde4..3d27867ef090d 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-03-09 +date: 2023-03-21 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 51d76ed163eeb..7a6a5d411e161 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-03-09 +date: 2023-03-21 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 676a1e04f9554..64a9fad1efc04 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-03-09 +date: 2023-03-21 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 9ee4e141d1862..0e55e6f531501 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-03-09 +date: 2023-03-21 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 b48516b422f02..f78342bd54159 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-integrations-browser-internal'] --- import kbnCoreIntegrationsBrowserInternalObj from './kbn_core_integrations_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_integrations_browser_mocks.mdx b/api_docs/kbn_core_integrations_browser_mocks.mdx index f906f4abb9062..c34506a1d0467 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-integrations-browser-mocks'] --- import kbnCoreIntegrationsBrowserMocksObj from './kbn_core_integrations_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_browser.mdx b/api_docs/kbn_core_lifecycle_browser.mdx index 9960b9aa956c5..81e31b1c89fe7 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-03-09 +date: 2023-03-21 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 6dbd5cb58f515..b366bf385edb9 100644 --- a/api_docs/kbn_core_lifecycle_browser_mocks.devdocs.json +++ b/api_docs/kbn_core_lifecycle_browser_mocks.devdocs.json @@ -161,8 +161,8 @@ "pluginId": "@kbn/utility-types-jest", "scope": "common", "docId": "kibKbnUtilityTypesJestPluginApi", - "section": "def-common.MockedKeys", - "text": "MockedKeys" + "section": "def-common.DeeplyMockedKeys", + "text": "DeeplyMockedKeys" }, "<", { @@ -406,8 +406,8 @@ "pluginId": "@kbn/utility-types-jest", "scope": "common", "docId": "kibKbnUtilityTypesJestPluginApi", - "section": "def-common.MockedKeys", - "text": "MockedKeys" + "section": "def-common.DeeplyMockedKeys", + "text": "DeeplyMockedKeys" }, "<", { diff --git a/api_docs/kbn_core_lifecycle_browser_mocks.mdx b/api_docs/kbn_core_lifecycle_browser_mocks.mdx index f5d3cdc39153a..46378c9213736 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-03-09 +date: 2023-03-21 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 910315776afb0..a44fd53577400 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-server'] --- import kbnCoreLifecycleServerObj from './kbn_core_lifecycle_server.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_server_mocks.mdx b/api_docs/kbn_core_lifecycle_server_mocks.mdx index 0787f48b9426f..6f80b6b195dab 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-03-09 +date: 2023-03-21 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 8d4d6f0b90412..9d9696cb1ab7e 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-03-09 +date: 2023-03-21 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 277cc443001fb..cb44b77e3dd67 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_core_logging_server.devdocs.json index edacae8c2aa44..08590316d064b 100644 --- a/api_docs/kbn_core_logging_server.devdocs.json +++ b/api_docs/kbn_core_logging_server.devdocs.json @@ -223,7 +223,7 @@ "label": "level", "description": [], "signature": [ - "\"error\" | \"all\" | \"off\" | \"debug\" | \"info\" | \"warn\" | \"trace\" | \"fatal\"" + "\"error\" | \"info\" | \"all\" | \"off\" | \"debug\" | \"warn\" | \"trace\" | \"fatal\"" ], "path": "packages/core/logging/core-logging-server/src/logger.ts", "deprecated": false, diff --git a/api_docs/kbn_core_logging_server.mdx b/api_docs/kbn_core_logging_server.mdx index 84defb0441e85..8f16e98e3eaff 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_core_logging_server_internal.devdocs.json index fd6f6dc3b8731..a47e3929b5f8e 100644 --- a/api_docs/kbn_core_logging_server_internal.devdocs.json +++ b/api_docs/kbn_core_logging_server_internal.devdocs.json @@ -135,15 +135,7 @@ "section": "def-common.Type", "text": "Type" }, - " | Readonly<{ pattern?: string | undefined; highlight?: boolean | undefined; } & { type: \"pattern\"; }>; }> | Readonly<{} & { type: \"file\"; fileName: string; layout: Readonly<{} & { type: \"json\"; }> | Readonly<{ pattern?: string | undefined; highlight?: boolean | undefined; } & { type: \"pattern\"; }>; }> | Readonly<{} & { type: \"rewrite\"; policy: Readonly<{} & { type: \"meta\"; mode: \"update\" | \"remove\"; properties: Readonly<{ value?: string | number | boolean | null | undefined; } & { path: string; }>[]; }>; appenders: string[]; }> | Readonly<{} & { type: \"rolling-file\"; strategy: ", - { - "pluginId": "@kbn/core-logging-server", - "scope": "common", - "docId": "kibKbnCoreLoggingServerPluginApi", - "section": "def-common.NumericRollingStrategyConfig", - "text": "NumericRollingStrategyConfig" - }, - "; fileName: string; policy: Readonly<{} & { type: \"size-limit\"; size: ", + " | Readonly<{ pattern?: string | undefined; highlight?: boolean | undefined; } & { type: \"pattern\"; }>; }> | Readonly<{} & { type: \"file\"; fileName: string; layout: Readonly<{} & { type: \"json\"; }> | Readonly<{ pattern?: string | undefined; highlight?: boolean | undefined; } & { type: \"pattern\"; }>; }> | Readonly<{} & { type: \"rewrite\"; policy: Readonly<{} & { type: \"meta\"; mode: \"update\" | \"remove\"; properties: Readonly<{ value?: string | number | boolean | null | undefined; } & { path: string; }>[]; }>; appenders: string[]; }> | Readonly<{} & { type: \"rolling-file\"; policy: Readonly<{} & { type: \"size-limit\"; size: ", { "pluginId": "@kbn/config-schema", "scope": "common", @@ -151,7 +143,15 @@ "section": "def-common.ByteSizeValue", "text": "ByteSizeValue" }, - "; }> | Readonly<{} & { type: \"time-interval\"; interval: moment.Duration; modulate: boolean; }>; layout: Readonly<{} & { type: \"json\"; }> | Readonly<{ pattern?: string | undefined; highlight?: boolean | undefined; } & { type: \"pattern\"; }>; }>>" + "; }> | Readonly<{} & { type: \"time-interval\"; interval: moment.Duration; modulate: boolean; }>; strategy: ", + { + "pluginId": "@kbn/core-logging-server", + "scope": "common", + "docId": "kibKbnCoreLoggingServerPluginApi", + "section": "def-common.NumericRollingStrategyConfig", + "text": "NumericRollingStrategyConfig" + }, + "; fileName: string; layout: Readonly<{} & { type: \"json\"; }> | Readonly<{ pattern?: string | undefined; highlight?: boolean | undefined; } & { type: \"pattern\"; }>; }>>" ], "path": "packages/core/logging/core-logging-server-internal/src/appenders/appenders.ts", "deprecated": false, @@ -199,7 +199,7 @@ "section": "def-common.Type", "text": "Type" }, - "[]>; }>" + "[]>; }>" ], "path": "packages/core/logging/core-logging-server-internal/src/logging_config.ts", "deprecated": false, @@ -247,7 +247,7 @@ "section": "def-common.Type", "text": "Type" }, - "<\"error\" | \"all\" | \"off\" | \"debug\" | \"info\" | \"warn\" | \"trace\" | \"fatal\">; }>" + "<\"error\" | \"info\" | \"all\" | \"off\" | \"debug\" | \"warn\" | \"trace\" | \"fatal\">; }>" ], "path": "packages/core/logging/core-logging-server-internal/src/logging_config.ts", "deprecated": false, diff --git a/api_docs/kbn_core_logging_server_internal.mdx b/api_docs/kbn_core_logging_server_internal.mdx index 9309f619108e5..9bdd7219eefe5 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-03-09 +date: 2023-03-21 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 3b38dac13cff5..612f71dd6ff66 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-03-09 +date: 2023-03-21 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 ddbbbdbf9d847..6b1e15da96590 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-03-09 +date: 2023-03-21 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 5d6f41f3454ef..178bee23317ec 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-03-09 +date: 2023-03-21 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 4981220d86d7c..8f788f5a3410d 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-03-09 +date: 2023-03-21 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 c4eafdbd1beb3..da01e97e6a8b1 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-03-09 +date: 2023-03-21 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 d5af2f2e42bdc..152d3e96fecb8 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-03-09 +date: 2023-03-21 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 d046288c6160f..036e5b7c541e3 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-03-09 +date: 2023-03-21 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 73562eaf4100d..25ba9cc2820b8 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-03-09 +date: 2023-03-21 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 64768e0369b80..6f6f9479107db 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-03-09 +date: 2023-03-21 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 51f0bf4fa50bb..e2247c236fb0a 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_core_notifications_browser.devdocs.json index 67b0e25e4cda8..5d44379591cb3 100644 --- a/api_docs/kbn_core_notifications_browser.devdocs.json +++ b/api_docs/kbn_core_notifications_browser.devdocs.json @@ -632,6 +632,61 @@ "path": "packages/core/notifications/core-notifications-browser/src/contracts.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-notifications-browser", + "id": "def-common.NotificationsStart.showErrorDialog", + "type": "Function", + "tags": [], + "label": "showErrorDialog", + "description": [], + "signature": [ + "(options: { title: string; error: Error; }) => void" + ], + "path": "packages/core/notifications/core-notifications-browser/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-notifications-browser", + "id": "def-common.NotificationsStart.showErrorDialog.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "packages/core/notifications/core-notifications-browser/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-notifications-browser", + "id": "def-common.NotificationsStart.showErrorDialog.$1.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "packages/core/notifications/core-notifications-browser/src/contracts.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-notifications-browser", + "id": "def-common.NotificationsStart.showErrorDialog.$1.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "packages/core/notifications/core-notifications-browser/src/contracts.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -681,7 +736,7 @@ "signature": [ "Pick<", "Toast", - ", \"prefix\" | \"defaultValue\" | \"children\" | \"is\" | \"slot\" | \"style\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"css\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"color\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"iconType\" | \"onClose\" | \"toastLifeTimeMs\"> & { title?: string | ", + ", \"prefix\" | \"defaultValue\" | \"children\" | \"is\" | \"security\" | \"slot\" | \"style\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"css\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"color\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"iconType\" | \"onClose\" | \"toastLifeTimeMs\"> & { title?: string | ", { "pluginId": "@kbn/core-mount-utils-browser", "scope": "common", @@ -740,7 +795,7 @@ "signature": [ "Pick<", "Toast", - ", \"prefix\" | \"defaultValue\" | \"children\" | \"is\" | \"slot\" | \"style\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"css\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"color\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"iconType\" | \"onClose\" | \"toastLifeTimeMs\"> & { title?: string | ", + ", \"prefix\" | \"defaultValue\" | \"children\" | \"is\" | \"security\" | \"slot\" | \"style\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"css\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"color\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"iconType\" | \"onClose\" | \"toastLifeTimeMs\"> & { title?: string | ", { "pluginId": "@kbn/core-mount-utils-browser", "scope": "common", diff --git a/api_docs/kbn_core_notifications_browser.mdx b/api_docs/kbn_core_notifications_browser.mdx index 0189a51ebf170..562e88e356aa0 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-notifications-browser'] --- import kbnCoreNotificationsBrowserObj from './kbn_core_notifications_browser.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 | |-------------------|-----------|------------------------|-----------------| -| 35 | 4 | 23 | 0 | +| 39 | 4 | 27 | 0 | ## Common diff --git a/api_docs/kbn_core_notifications_browser_internal.mdx b/api_docs/kbn_core_notifications_browser_internal.mdx index b494eaacf1f25..08edad9de9c0a 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_core_notifications_browser_mocks.devdocs.json index b1afc5e9469d8..a3bccfa1c095b 100644 --- a/api_docs/kbn_core_notifications_browser_mocks.devdocs.json +++ b/api_docs/kbn_core_notifications_browser_mocks.devdocs.json @@ -103,8 +103,8 @@ "pluginId": "@kbn/utility-types-jest", "scope": "common", "docId": "kibKbnUtilityTypesJestPluginApi", - "section": "def-common.MockedKeys", - "text": "MockedKeys" + "section": "def-common.DeeplyMockedKeys", + "text": "DeeplyMockedKeys" }, "<", { diff --git a/api_docs/kbn_core_notifications_browser_mocks.mdx b/api_docs/kbn_core_notifications_browser_mocks.mdx index 17bcc4ae5f263..59386e999d96a 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-03-09 +date: 2023-03-21 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 21983170a2d98..b3c0e6b9c1cc3 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-03-09 +date: 2023-03-21 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 e8708bb109b34..8729d2b36d1fe 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-03-09 +date: 2023-03-21 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 a6203b7b48396..0244eb2909b8c 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-03-09 +date: 2023-03-21 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 d3ad2be011e19..14ee66c011fea 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-03-09 +date: 2023-03-21 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 76ab6e9cbb3ef..a2cafc22fbf91 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-03-09 +date: 2023-03-21 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 ebc8e72e2b5aa..9226fc9e9b70c 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-03-09 +date: 2023-03-21 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 97804d8f88b6f..bc8d1be66183c 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-03-09 +date: 2023-03-21 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 5bbcb2eb43324..7dca9ec3b6031 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server'] --- import kbnCorePrebootServerObj from './kbn_core_preboot_server.devdocs.json'; diff --git a/api_docs/kbn_core_preboot_server_mocks.mdx b/api_docs/kbn_core_preboot_server_mocks.mdx index dd69369c9b62a..bd62411f47716 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-03-09 +date: 2023-03-21 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 d5d2e5e6a5882..bdfbcba6ebfa2 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-03-09 +date: 2023-03-21 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 d03ea5d847886..284ede44e7538 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-03-09 +date: 2023-03-21 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 925dd5233f046..8935cd76f83ad 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-03-09 +date: 2023-03-21 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 305d67a189190..2fce10ea08d50 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-root-server-internal'] --- import kbnCoreRootServerInternalObj from './kbn_core_root_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_api_browser.mdx b/api_docs/kbn_core_saved_objects_api_browser.mdx index 32efe8ad69260..e2cd390501fc1 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-browser'] --- import kbnCoreSavedObjectsApiBrowserObj from './kbn_core_saved_objects_api_browser.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_api_server.mdx b/api_docs/kbn_core_saved_objects_api_server.mdx index 240959948ca2b..7c2782f375d27 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-03-09 +date: 2023-03-21 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_internal.mdx b/api_docs/kbn_core_saved_objects_api_server_internal.mdx index ee44da841167a..036537e0b2c96 100644 --- a/api_docs/kbn_core_saved_objects_api_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_api_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server-internal title: "@kbn/core-saved-objects-api-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-server-internal plugin -date: 2023-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-server-internal'] --- import kbnCoreSavedObjectsApiServerInternalObj from './kbn_core_saved_objects_api_server_internal.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 9592e54773f9c..d73399d76f10c 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-server-mocks'] --- import kbnCoreSavedObjectsApiServerMocksObj from './kbn_core_saved_objects_api_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_base_server_internal.mdx b/api_docs/kbn_core_saved_objects_base_server_internal.mdx index da0d2bfd26e4b..b05e2987cf67a 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-03-09 +date: 2023-03-21 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 83e3c3856a76d..f69b87a68dbdd 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-03-09 +date: 2023-03-21 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 4805fe1d1c347..38e5f4ba09cb5 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-03-09 +date: 2023-03-21 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 b8be2e2f977e1..750fa6a6a8b47 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser-internal'] --- import kbnCoreSavedObjectsBrowserInternalObj from './kbn_core_saved_objects_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_browser_mocks.mdx b/api_docs/kbn_core_saved_objects_browser_mocks.mdx index f694fe442d589..f4e9ea27e2c2b 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-03-09 +date: 2023-03-21 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 58fdd0d6a056b..5408ca3f6c8f1 100644 --- a/api_docs/kbn_core_saved_objects_common.devdocs.json +++ b/api_docs/kbn_core_saved_objects_common.devdocs.json @@ -1495,10 +1495,6 @@ "plugin": "@kbn/core", "path": "src/core/types/index.ts" }, - { - "plugin": "apm", - "path": "x-pack/plugins/apm/server/routes/settings/apm_indices/route.ts" - }, { "plugin": "savedObjectsTaggingOss", "path": "src/plugins/saved_objects_tagging_oss/public/api.ts" @@ -3020,6 +3016,34 @@ "plugin": "lens", "path": "x-pack/plugins/lens/common/embeddable_factory/index.ts" }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/attachment_framework/so_references.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/attachment_framework/so_references.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/attachment_framework/so_references.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/attachment_framework/so_references.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/services/so_references.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/services/so_references.ts" + }, + { + "plugin": "cases", + "path": "x-pack/plugins/cases/server/services/so_references.ts" + }, { "plugin": "maps", "path": "x-pack/plugins/maps/common/migrations/references.ts" @@ -3096,34 +3120,6 @@ "plugin": "canvas", "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts" }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/attachment_framework/so_references.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/attachment_framework/so_references.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/attachment_framework/so_references.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/attachment_framework/so_references.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/so_references.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/so_references.ts" - }, - { - "plugin": "cases", - "path": "x-pack/plugins/cases/server/services/so_references.ts" - }, { "plugin": "dashboardEnhanced", "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts" diff --git a/api_docs/kbn_core_saved_objects_common.mdx b/api_docs/kbn_core_saved_objects_common.mdx index 6f11da3455e0b..65254b4b086fb 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-03-09 +date: 2023-03-21 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 30e717fff16e1..6df66d72faa57 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-03-09 +date: 2023-03-21 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 5e48830159c8c..6d9430c1a81d6 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-03-09 +date: 2023-03-21 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 108ffe98f9f8f..0ac282ddb307d 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 @@ -2389,33 +2389,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -2797,7 +2771,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -2975,7 +2951,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -3001,7 +2979,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -3265,6 +3263,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", 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 c4f78c6520b05..a0f4b807f5a45 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-migration-server-internal'] --- import kbnCoreSavedObjectsMigrationServerInternalObj from './kbn_core_saved_objects_migration_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx b/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx index 0d2a9f736e672..3fb18022f11a6 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-03-09 +date: 2023-03-21 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 03d126043fb9e..301652fc19689 100644 --- a/api_docs/kbn_core_saved_objects_server.devdocs.json +++ b/api_docs/kbn_core_saved_objects_server.devdocs.json @@ -9489,22 +9489,6 @@ "plugin": "alerting", "path": "x-pack/plugins/alerting/server/saved_objects/index.ts" }, - { - "plugin": "savedObjectsTagging", - "path": "x-pack/plugins/saved_objects_tagging/server/saved_objects/tag.ts" - }, - { - "plugin": "savedSearch", - "path": "src/plugins/saved_search/server/saved_objects/search.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/server/saved_objects/workpad.ts" - }, - { - "plugin": "canvas", - "path": "x-pack/plugins/canvas/server/saved_objects/custom_element.ts" - }, { "plugin": "lens", "path": "x-pack/plugins/lens/server/saved_objects.ts" @@ -9529,6 +9513,22 @@ "plugin": "cases", "path": "x-pack/plugins/cases/server/saved_object_types/connector_mappings.ts" }, + { + "plugin": "savedObjectsTagging", + "path": "x-pack/plugins/saved_objects_tagging/server/saved_objects/tag.ts" + }, + { + "plugin": "savedSearch", + "path": "src/plugins/saved_search/server/saved_objects/search.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/saved_objects/workpad.ts" + }, + { + "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" diff --git a/api_docs/kbn_core_saved_objects_server.mdx b/api_docs/kbn_core_saved_objects_server.mdx index f43866ab71b27..eb3d0533585cd 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server'] --- import kbnCoreSavedObjectsServerObj from './kbn_core_saved_objects_server.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_server_internal.mdx b/api_docs/kbn_core_saved_objects_server_internal.mdx index bf4ff00c4abae..464a5a79d2001 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-03-09 +date: 2023-03-21 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 81ee083941f12..f7097b64ff253 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-03-09 +date: 2023-03-21 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 7f86eee1a9945..1f52148a001d0 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-03-09 +date: 2023-03-21 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.mdx b/api_docs/kbn_core_status_common.mdx index 977bcb708a7f0..66123c2902e4b 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-common'] --- import kbnCoreStatusCommonObj from './kbn_core_status_common.devdocs.json'; diff --git a/api_docs/kbn_core_status_common_internal.mdx b/api_docs/kbn_core_status_common_internal.mdx index 98fa33d379978..5322b9dc3e7da 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-common-internal'] --- import kbnCoreStatusCommonInternalObj from './kbn_core_status_common_internal.devdocs.json'; diff --git a/api_docs/kbn_core_status_server.mdx b/api_docs/kbn_core_status_server.mdx index e52dfd732b1b0..51523a64c2693 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-03-09 +date: 2023-03-21 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 c5256494a2689..62b6935b5c369 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-03-09 +date: 2023-03-21 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 a65e944a7fdc5..93c4052a03bf7 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-03-09 +date: 2023-03-21 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 9a9091b4d0c49..29f3a802785d2 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-deprecations-getters'] --- import kbnCoreTestHelpersDeprecationsGettersObj from './kbn_core_test_helpers_deprecations_getters.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_http_setup_browser.mdx b/api_docs/kbn_core_test_helpers_http_setup_browser.mdx index b0045b7ebb9ac..50d35665f9d44 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-03-09 +date: 2023-03-21 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 f8d729f20d119..771abe5c2abaa 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-03-09 +date: 2023-03-21 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 9230849caf50a..befe69fbca6e6 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-03-09 +date: 2023-03-21 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 cc6d41c2a8126..eb68c5901aee3 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-03-09 +date: 2023-03-21 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 9aa902178dc5c..f861929459580 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-03-09 +date: 2023-03-21 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 2c0b8fae47cec..e3354ba8361b7 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-03-09 +date: 2023-03-21 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 2251e84453f25..44400758575ed 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-03-09 +date: 2023-03-21 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 9c2b7203691ca..58e9d991a1ec7 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-03-09 +date: 2023-03-21 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 ba4c38f5b79b1..77ca2d08e2880 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-03-09 +date: 2023-03-21 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 03bca26be62b3..e855b695a6c71 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_core_ui_settings_common.devdocs.json index 75913bf8f3cad..7fd88652aec3a 100644 --- a/api_docs/kbn_core_ui_settings_common.devdocs.json +++ b/api_docs/kbn_core_ui_settings_common.devdocs.json @@ -441,7 +441,7 @@ "\nDenotes the scope of the setting" ], "signature": [ - "\"global\" | \"namespace\"" + "\"namespace\" | \"global\"" ], "path": "packages/core/ui-settings/core-ui-settings-common/src/ui_settings.ts", "deprecated": false, diff --git a/api_docs/kbn_core_ui_settings_common.mdx b/api_docs/kbn_core_ui_settings_common.mdx index 2fea6626cbe16..0fc13c4127a5c 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-03-09 +date: 2023-03-21 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 4b5260aa63514..8eb1d346131fb 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server'] --- import kbnCoreUiSettingsServerObj from './kbn_core_ui_settings_server.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_server_internal.mdx b/api_docs/kbn_core_ui_settings_server_internal.mdx index 4b0d22d61d418..c5d96088ddf0c 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-03-09 +date: 2023-03-21 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 40d626dfdf8b9..d68a03bfd5dde 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-03-09 +date: 2023-03-21 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 acc4c70e26af8..f39daad9f3a73 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-03-09 +date: 2023-03-21 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 b7bf539029799..91008c1fa4061 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server-internal'] --- import kbnCoreUsageDataServerInternalObj from './kbn_core_usage_data_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_usage_data_server_mocks.mdx b/api_docs/kbn_core_usage_data_server_mocks.mdx index b0ded0ae45d27..f215cff856a39 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-03-09 +date: 2023-03-21 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_crypto.mdx b/api_docs/kbn_crypto.mdx index c333a0295b8e9..e1725a8d77545 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-03-09 +date: 2023-03-21 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 20852302e88d8..763d512f88abd 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-03-09 +date: 2023-03-21 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 a72eb6cae6bf9..0f1b95cd8274d 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cypress-config'] --- import kbnCypressConfigObj from './kbn_cypress_config.devdocs.json'; diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index 8df77e19b10f1..89e5a1214b0b0 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] --- import kbnDatemathObj from './kbn_datemath.devdocs.json'; diff --git a/api_docs/kbn_dev_cli_errors.mdx b/api_docs/kbn_dev_cli_errors.mdx index 08a2711ad0df2..9a0b3971ff208 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_dev_cli_runner.devdocs.json index 0b98f6d345d60..d0d8b3be799bc 100644 --- a/api_docs/kbn_dev_cli_runner.devdocs.json +++ b/api_docs/kbn_dev_cli_runner.devdocs.json @@ -1526,7 +1526,7 @@ "label": "log", "description": [], "signature": [ - "{ defaultLevel?: \"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"silent\" | \"verbose\" | undefined; } | undefined" + "{ defaultLevel?: \"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run.ts", "deprecated": false, @@ -1585,7 +1585,7 @@ "label": "log", "description": [], "signature": [ - "{ defaultLevel?: \"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"silent\" | \"verbose\" | undefined; } | undefined" + "{ defaultLevel?: \"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined" ], "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", "deprecated": false, diff --git a/api_docs/kbn_dev_cli_runner.mdx b/api_docs/kbn_dev_cli_runner.mdx index 28614eca38545..eed42a63502f9 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-03-09 +date: 2023-03-21 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 2e8175a200590..a0286da77f147 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-03-09 +date: 2023-03-21 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 36338cbaea4c9..e558a59ef8079 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] --- import kbnDevUtilsObj from './kbn_dev_utils.devdocs.json'; diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index d1d919ae654c9..55248c1c94d37 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links'] --- import kbnDocLinksObj from './kbn_doc_links.devdocs.json'; diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index 183ab1fd2b5a8..c8ef77676ad24 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-utils'] --- import kbnDocsUtilsObj from './kbn_docs_utils.devdocs.json'; diff --git a/api_docs/kbn_ebt_tools.mdx b/api_docs/kbn_ebt_tools.mdx index 443f41099e8e2..5acafa0b2d638 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-03-09 +date: 2023-03-21 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 ed97d67fac04c..637ac3a552d9c 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-03-09 +date: 2023-03-21 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 5b6e5e3e9d744..fecf75fb1383d 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ecs-data-quality-dashboard'] --- import kbnEcsDataQualityDashboardObj from './kbn_ecs_data_quality_dashboard.devdocs.json'; diff --git a/api_docs/kbn_es.mdx b/api_docs/kbn_es.mdx index 4c229f69031b2..2dd0e535b67b5 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-03-09 +date: 2023-03-21 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 0e07c28700dcc..d69acb2a586f5 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-03-09 +date: 2023-03-21 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 2d3782b5f9460..773ff81adbb33 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-errors'] --- import kbnEsErrorsObj from './kbn_es_errors.devdocs.json'; diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index 31fff259cfa6f..d092f5440505d 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query'] --- import kbnEsQueryObj from './kbn_es_query.devdocs.json'; diff --git a/api_docs/kbn_es_types.devdocs.json b/api_docs/kbn_es_types.devdocs.json index fc197d24736da..32c29543af11a 100644 --- a/api_docs/kbn_es_types.devdocs.json +++ b/api_docs/kbn_es_types.devdocs.json @@ -393,7 +393,7 @@ "signature": [ "Omit<", "SearchHit", - ", \"fields\" | \"_source\"> & (TSource extends false ? {} : { _source: TSource; }) & (TFields extends (string | ", + ", \"_source\" | \"fields\"> & (TSource extends false ? {} : { _source: TSource; }) & (TFields extends (string | ", "QueryDslFieldAndFormat", ")[] ? { fields: Partial, unknown[]>>; } : {}) & (TDocValueFields extends DocValueFields ? { fields: Partial, unknown[]>>; } : {})" ], diff --git a/api_docs/kbn_es_types.mdx b/api_docs/kbn_es_types.mdx index db6380d1adc2e..d9067cec50736 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-03-09 +date: 2023-03-21 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 34691767fb1ac..4a63262758b17 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] --- import kbnEslintPluginImportsObj from './kbn_eslint_plugin_imports.devdocs.json'; diff --git a/api_docs/kbn_expandable_flyout.mdx b/api_docs/kbn_expandable_flyout.mdx index c4380f17bc37e..5ce2892e0e339 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-03-09 +date: 2023-03-21 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 0129006fefa58..e57f10a6e878c 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-03-09 +date: 2023-03-21 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 807cb42228dd6..a87a0d3c3c624 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-03-09 +date: 2023-03-21 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 97da9eff246d0..e40baccfed149 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-03-09 +date: 2023-03-21 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 08e0b0b284a10..9054d041932cb 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] --- import kbnGenerateObj from './kbn_generate.devdocs.json'; diff --git a/api_docs/kbn_guided_onboarding.mdx b/api_docs/kbn_guided_onboarding.mdx index f6241782e4d47..30b98a98c66fc 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-03-09 +date: 2023-03-21 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 ec0993cd6121c..5e526f9d5161f 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-03-09 +date: 2023-03-21 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 3c1004cb3ae87..d811816049987 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-03-09 +date: 2023-03-21 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 b6344957a3810..487df23f6b485 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-03-09 +date: 2023-03-21 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 4c28f12f92227..c9bfbcebd86c8 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-03-09 +date: 2023-03-21 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 55dda17a9259a..e553bde785281 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-03-09 +date: 2023-03-21 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 261745025c694..809e2316134d6 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-03-09 +date: 2023-03-21 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 97b8ed9c2f126..ac674433d22e6 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-03-09 +date: 2023-03-21 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 56150b825a5d3..8e459a57d5139 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] --- import kbnImportResolverObj from './kbn_import_resolver.devdocs.json'; diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index 68942d1515563..589f7b66d39b5 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter'] --- import kbnInterpreterObj from './kbn_interpreter.devdocs.json'; diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx index bb5ca935e1d59..885e4c4ed1730 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-03-09 +date: 2023-03-21 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 a6367252c208e..17890dd3eb88b 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] --- import kbnJestSerializersObj from './kbn_jest_serializers.devdocs.json'; diff --git a/api_docs/kbn_journeys.mdx b/api_docs/kbn_journeys.mdx index 0790930d2e41b..f7b6800698289 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-03-09 +date: 2023-03-21 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 00e09a6989945..3a089ed1793cc 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-03-09 +date: 2023-03-21 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 d42540e98bd32..1612adde467d7 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-03-09 +date: 2023-03-21 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 153b73666905e..53f87cbf77cd0 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-03-09 +date: 2023-03-21 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 8fb32c29ab734..6acfbacd4e523 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] --- import kbnLoggingObj from './kbn_logging.devdocs.json'; diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index 551003b264819..b3393ab74bf47 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-03-09 +date: 2023-03-21 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 628d5d80249c4..eb8f04bd00d05 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/managed-vscode-config'] --- import kbnManagedVscodeConfigObj from './kbn_managed_vscode_config.devdocs.json'; diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index b21d758b5dbd4..8b23cb7b1771c 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] --- import kbnMapboxGlObj from './kbn_mapbox_gl.devdocs.json'; diff --git a/api_docs/kbn_ml_agg_utils.mdx b/api_docs/kbn_ml_agg_utils.mdx index 63b44ca043221..5de0d2cae6dd3 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-03-09 +date: 2023-03-21 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_date_picker.mdx b/api_docs/kbn_ml_date_picker.mdx index 35dbbe668e468..cc7366e2bbef5 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-03-09 +date: 2023-03-21 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_is_defined.mdx b/api_docs/kbn_ml_is_defined.mdx index bbad1646d9a3f..f615462f54061 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-03-09 +date: 2023-03-21 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 dc954552d26d4..316cc1fa661be 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-is-populated-object'] --- import kbnMlIsPopulatedObjectObj from './kbn_ml_is_populated_object.devdocs.json'; diff --git a/api_docs/kbn_ml_local_storage.mdx b/api_docs/kbn_ml_local_storage.mdx index 98c34c33fd443..c829b8870bbff 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-03-09 +date: 2023-03-21 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 238fbf59820fd..8f9920c34a825 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-03-09 +date: 2023-03-21 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_query_utils.mdx b/api_docs/kbn_ml_query_utils.mdx index 7e3f24bc19439..a085535afacf6 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-03-09 +date: 2023-03-21 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_string_hash.mdx b/api_docs/kbn_ml_string_hash.mdx index 4e723f80a8c6a..51fbfdc21d544 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-03-09 +date: 2023-03-21 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_url_state.mdx b/api_docs/kbn_ml_url_state.mdx index 7ae8c4556e98e..987ffc961e78d 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_monaco.devdocs.json index 364fa6046fc99..2b0acc3ca3903 100644 --- a/api_docs/kbn_monaco.devdocs.json +++ b/api_docs/kbn_monaco.devdocs.json @@ -588,7 +588,7 @@ "label": "kind", "description": [], "signature": [ - "\"type\" | \"keyword\" | \"property\" | \"field\" | \"method\" | \"class\" | \"constructor\"" + "\"type\" | \"keyword\" | \"property\" | \"method\" | \"field\" | \"class\" | \"constructor\"" ], "path": "packages/kbn-monaco/src/painless/types.ts", "deprecated": false, @@ -756,7 +756,7 @@ "label": "PainlessCompletionKind", "description": [], "signature": [ - "\"type\" | \"keyword\" | \"property\" | \"field\" | \"method\" | \"class\" | \"constructor\"" + "\"type\" | \"keyword\" | \"property\" | \"method\" | \"field\" | \"class\" | \"constructor\"" ], "path": "packages/kbn-monaco/src/painless/types.ts", "deprecated": false, diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index 26d48c92bffca..cbe9edac061e9 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco'] --- import kbnMonacoObj from './kbn_monaco.devdocs.json'; diff --git a/api_docs/kbn_object_versioning.devdocs.json b/api_docs/kbn_object_versioning.devdocs.json new file mode 100644 index 0000000000000..0a448f8b89991 --- /dev/null +++ b/api_docs/kbn_object_versioning.devdocs.json @@ -0,0 +1,1258 @@ +{ + "id": "@kbn/object-versioning", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.compile", + "type": "Function", + "tags": [], + "label": "compile", + "description": [ + "\nConvert a versionned service definition to a flattened service definition\nwhere _each object_ is versioned (at the leaf).\n" + ], + "signature": [ + "(definitions: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ServiceDefinitionVersioned", + "text": "ServiceDefinitionVersioned" + }, + ") => { [path: string]: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectMigrationDefinition", + "text": "ObjectMigrationDefinition" + }, + "; }" + ], + "path": "packages/kbn-object-versioning/lib/content_management_services_versioning.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.compile.$1", + "type": "Object", + "tags": [], + "label": "definitions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ServiceDefinitionVersioned", + "text": "ServiceDefinitionVersioned" + } + ], + "path": "packages/kbn-object-versioning/lib/content_management_services_versioning.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.getTransforms", + "type": "Function", + "tags": [], + "label": "getTransforms", + "description": [], + "signature": [ + "(definitions: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ServiceDefinitionVersioned", + "text": "ServiceDefinitionVersioned" + }, + ", requestVersion: number, _compiled?: { [path: string]: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectMigrationDefinition", + "text": "ObjectMigrationDefinition" + }, + "; } | undefined) => ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ServiceTransforms", + "text": "ServiceTransforms" + } + ], + "path": "packages/kbn-object-versioning/lib/content_management_services_versioning.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.getTransforms.$1", + "type": "Object", + "tags": [], + "label": "definitions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ServiceDefinitionVersioned", + "text": "ServiceDefinitionVersioned" + } + ], + "path": "packages/kbn-object-versioning/lib/content_management_services_versioning.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.getTransforms.$2", + "type": "number", + "tags": [], + "label": "requestVersion", + "description": [], + "signature": [ + "number" + ], + "path": "packages/kbn-object-versioning/lib/content_management_services_versioning.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.getTransforms.$3", + "type": "Object", + "tags": [], + "label": "_compiled", + "description": [], + "path": "packages/kbn-object-versioning/lib/content_management_services_versioning.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.getTransforms.$3.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[path: string]: ObjectMigrationDefinition", + "description": [], + "signature": [ + "[path: string]: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectMigrationDefinition", + "text": "ObjectMigrationDefinition" + } + ], + "path": "packages/kbn-object-versioning/lib/content_management_services_versioning.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.initTransform", + "type": "Function", + "tags": [], + "label": "initTransform", + "description": [ + "\nInitiate a transform for a specific request version. After we initiate the transforms\nfor a specific version we can then pass different `ObjectMigrationDefinition` to the provided\nhandler to start up/down transforming different object based on this request version.\n" + ], + "signature": [ + "(requestVersion: number) => (migrationDefinition: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectMigrationDefinition", + "text": "ObjectMigrationDefinition" + }, + ") => ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "" + ], + "path": "packages/kbn-object-versioning/lib/object_transform.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.initTransform.$1", + "type": "number", + "tags": [], + "label": "requestVersion", + "description": [ + "The starting version before up/down transforming" + ], + "signature": [ + "number" + ], + "path": "packages/kbn-object-versioning/lib/object_transform.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "A handler to pass an object migration definition" + ], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectMigrationDefinition", + "type": "Interface", + "tags": [], + "label": "ObjectMigrationDefinition", + "description": [], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectMigrationDefinition.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[version: number]: VersionableObject", + "description": [], + "signature": [ + "[version: number]: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + "" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms", + "type": "Interface", + "tags": [], + "label": "ObjectTransforms", + "description": [], + "signature": [ + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms.up", + "type": "Function", + "tags": [], + "label": "up", + "description": [], + "signature": [ + "(obj: Current, version?: number | \"latest\" | undefined, options?: { validate?: boolean | undefined; } | undefined) => ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.TransformReturn", + "text": "TransformReturn" + }, + "" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms.up.$1", + "type": "Uncategorized", + "tags": [], + "label": "obj", + "description": [], + "signature": [ + "Current" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms.up.$2", + "type": "CompoundType", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "number | \"latest\" | undefined" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms.up.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms.up.$3.validate", + "type": "CompoundType", + "tags": [], + "label": "validate", + "description": [ + "Validate the object _before_ up transform" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms.down", + "type": "Function", + "tags": [], + "label": "down", + "description": [], + "signature": [ + "(obj: Current, version?: number | \"latest\" | undefined, options?: { validate?: boolean | undefined; } | undefined) => ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.TransformReturn", + "text": "TransformReturn" + }, + "" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms.down.$1", + "type": "Uncategorized", + "tags": [], + "label": "obj", + "description": [], + "signature": [ + "Current" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms.down.$2", + "type": "CompoundType", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "number | \"latest\" | undefined" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms.down.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms.down.$3.validate", + "type": "CompoundType", + "tags": [], + "label": "validate", + "description": [ + "Validate the object _before_ down transform" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms.validate", + "type": "Function", + "tags": [], + "label": "validate", + "description": [], + "signature": [ + "(obj: any, version?: number | undefined) => ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.ValidationError", + "text": "ValidationError" + }, + " | null" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms.validate.$1", + "type": "Any", + "tags": [], + "label": "obj", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransforms.validate.$2", + "type": "number", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServiceDefinitionVersioned", + "type": "Interface", + "tags": [], + "label": "ServiceDefinitionVersioned", + "description": [], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServiceDefinitionVersioned.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[version: number]: ServicesDefinition", + "description": [], + "signature": [ + "[version: number]: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ServicesDefinition", + "text": "ServicesDefinition" + } + ], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServicesDefinition", + "type": "Interface", + "tags": [], + "label": "ServicesDefinition", + "description": [], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServicesDefinition.get", + "type": "Object", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "{ in?: { options?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; } | undefined; out?: { result?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; } | undefined; } | undefined" + ], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServicesDefinition.bulkGet", + "type": "Object", + "tags": [], + "label": "bulkGet", + "description": [], + "signature": [ + "{ in?: { options?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; } | undefined; out?: { result?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; } | undefined; } | undefined" + ], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServicesDefinition.create", + "type": "Object", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "{ in?: { data?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; options?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; } | undefined; out?: { result?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; } | undefined; } | undefined" + ], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServicesDefinition.update", + "type": "Object", + "tags": [], + "label": "update", + "description": [], + "signature": [ + "{ in?: { data?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; options?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; } | undefined; out?: { result?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; } | undefined; } | undefined" + ], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServicesDefinition.delete", + "type": "Object", + "tags": [], + "label": "delete", + "description": [], + "signature": [ + "{ in?: { options?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; } | undefined; out?: { result?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; } | undefined; } | undefined" + ], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServicesDefinition.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [], + "signature": [ + "{ in?: { query?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; options?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; } | undefined; out?: { result?: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + " | undefined; } | undefined; } | undefined" + ], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServiceTransforms", + "type": "Interface", + "tags": [], + "label": "ServiceTransforms", + "description": [], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServiceTransforms.get", + "type": "Object", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "{ in: { options: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; }; out: { result: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; }; }" + ], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServiceTransforms.bulkGet", + "type": "Object", + "tags": [], + "label": "bulkGet", + "description": [], + "signature": [ + "{ in: { options: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; }; out: { result: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; }; }" + ], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServiceTransforms.create", + "type": "Object", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "{ in: { data: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; options: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; }; out: { result: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; }; }" + ], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServiceTransforms.update", + "type": "Object", + "tags": [], + "label": "update", + "description": [], + "signature": [ + "{ in: { data: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; options: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; }; out: { result: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; }; }" + ], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServiceTransforms.delete", + "type": "Object", + "tags": [], + "label": "delete", + "description": [], + "signature": [ + "{ in: { options: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; }; out: { result: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; }; }" + ], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ServiceTransforms.search", + "type": "Object", + "tags": [], + "label": "search", + "description": [], + "signature": [ + "{ in: { query: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; options: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; }; out: { result: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransforms", + "text": "ObjectTransforms" + }, + "; }; }" + ], + "path": "packages/kbn-object-versioning/lib/content_management_types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.VersionableObject", + "type": "Interface", + "tags": [], + "label": "VersionableObject", + "description": [], + "signature": [ + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.VersionableObject", + "text": "VersionableObject" + }, + "" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.VersionableObject.schema", + "type": "Object", + "tags": [], + "label": "schema", + "description": [], + "signature": [ + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.Type", + "text": "Type" + }, + " | undefined" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.VersionableObject.down", + "type": "Function", + "tags": [], + "label": "down", + "description": [], + "signature": [ + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransform", + "text": "ObjectTransform" + }, + " | undefined" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.VersionableObject.up", + "type": "Function", + "tags": [], + "label": "up", + "description": [], + "signature": [ + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectTransform", + "text": "ObjectTransform" + }, + " | undefined" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.GetTransformsFn", + "type": "Type", + "tags": [], + "label": "GetTransformsFn", + "description": [], + "signature": [ + "(definitions: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ServiceDefinitionVersioned", + "text": "ServiceDefinitionVersioned" + }, + ", requestVersion: number, _compiled?: { [path: string]: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectMigrationDefinition", + "text": "ObjectMigrationDefinition" + }, + "; } | undefined) => ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ServiceTransforms", + "text": "ServiceTransforms" + } + ], + "path": "packages/kbn-object-versioning/lib/content_management_services_versioning.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.GetTransformsFn.$1", + "type": "Object", + "tags": [], + "label": "definitions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ServiceDefinitionVersioned", + "text": "ServiceDefinitionVersioned" + } + ], + "path": "packages/kbn-object-versioning/lib/content_management_services_versioning.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.GetTransformsFn.$2", + "type": "number", + "tags": [], + "label": "requestVersion", + "description": [], + "path": "packages/kbn-object-versioning/lib/content_management_services_versioning.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.GetTransformsFn.$3", + "type": "Object", + "tags": [], + "label": "_compiled", + "description": [], + "signature": [ + "{ [path: string]: ", + { + "pluginId": "@kbn/object-versioning", + "scope": "common", + "docId": "kibKbnObjectVersioningPluginApi", + "section": "def-common.ObjectMigrationDefinition", + "text": "ObjectMigrationDefinition" + }, + "; } | undefined" + ], + "path": "packages/kbn-object-versioning/lib/content_management_services_versioning.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransform", + "type": "Type", + "tags": [], + "label": "ObjectTransform", + "description": [], + "signature": [ + "(input: I) => O" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.ObjectTransform.$1", + "type": "Uncategorized", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "I" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.TransformReturn", + "type": "Type", + "tags": [], + "label": "TransformReturn", + "description": [], + "signature": [ + "{ value: T; error: null; } | { value: null; error: Error | ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.ValidationError", + "text": "ValidationError" + }, + "; }" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/object-versioning", + "id": "def-common.Version", + "type": "Type", + "tags": [], + "label": "Version", + "description": [], + "signature": [ + "number" + ], + "path": "packages/kbn-object-versioning/lib/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_object_versioning.mdx b/api_docs/kbn_object_versioning.mdx new file mode 100644 index 0000000000000..b4d9ebea4d207 --- /dev/null +++ b/api_docs/kbn_object_versioning.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: kibKbnObjectVersioningPluginApi +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-03-21 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/object-versioning'] +--- +import kbnObjectVersioningObj from './kbn_object_versioning.devdocs.json'; + + + +Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 53 | 1 | 48 | 0 | + +## Common + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index 1798193215023..63085140621c7 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-03-09 +date: 2023-03-21 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 9a5c5f552c424..ab895e64ac1c4 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-03-09 +date: 2023-03-21 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 b6c2b470a5ae4..31e5c8997b43c 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-03-09 +date: 2023-03-21 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 e067ea380bae6..7c4d000c7aa09 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-03-09 +date: 2023-03-21 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 de247317c8ac3..13841b96de48e 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-03-09 +date: 2023-03-21 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 e1f8da4b25797..1f9dc2f14ccd0 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] --- import kbnPluginHelpersObj from './kbn_plugin_helpers.devdocs.json'; diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx index adea46e770b69..0ff46360ffc40 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-03-09 +date: 2023-03-21 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 5b3929f19ff8f..4874bc1d0f21e 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-03-09 +date: 2023-03-21 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 2f9ebadf30c09..da071d0c86d94 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-03-09 +date: 2023-03-21 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 5ed06a52ffab8..64fd27f101ca7 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-03-09 +date: 2023-03-21 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 ce9b3fdcbf9e7..c285579e24ab4 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-source-classifier'] --- import kbnRepoSourceClassifierObj from './kbn_repo_source_classifier.devdocs.json'; diff --git a/api_docs/kbn_rison.mdx b/api_docs/kbn_rison.mdx index e8689a3a783a3..367333d09971a 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rison'] --- import kbnRisonObj from './kbn_rison.devdocs.json'; diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index 78fea4f67d6fa..dc2fdf64b356a 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rule-data-utils'] --- import kbnRuleDataUtilsObj from './kbn_rule_data_utils.devdocs.json'; diff --git a/api_docs/kbn_security_solution_side_nav.devdocs.json b/api_docs/kbn_security_solution_side_nav.devdocs.json new file mode 100644 index 0000000000000..5aeb3211a5516 --- /dev/null +++ b/api_docs/kbn_security_solution_side_nav.devdocs.json @@ -0,0 +1,524 @@ +{ + "id": "@kbn/security-solution-side-nav", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNav", + "type": "Function", + "tags": [], + "label": "SolutionSideNav", + "description": [], + "signature": [ + "(props: ", + { + "pluginId": "@kbn/security-solution-side-nav", + "scope": "common", + "docId": "kibKbnSecuritySolutionSideNavPluginApi", + "section": "def-common.SolutionSideNavProps", + "text": "SolutionSideNavProps" + }, + ") => JSX.Element" + ], + "path": "packages/security-solution/side_nav/src/index.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNav.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + { + "pluginId": "@kbn/security-solution-side-nav", + "scope": "common", + "docId": "kibKbnSecuritySolutionSideNavPluginApi", + "section": "def-common.SolutionSideNavProps", + "text": "SolutionSideNavProps" + } + ], + "path": "packages/security-solution/side_nav/src/index.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.LinkCategory", + "type": "Interface", + "tags": [], + "label": "LinkCategory", + "description": [], + "signature": [ + { + "pluginId": "@kbn/security-solution-side-nav", + "scope": "common", + "docId": "kibKbnSecuritySolutionSideNavPluginApi", + "section": "def-common.LinkCategory", + "text": "LinkCategory" + }, + "" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.LinkCategory.label", + "type": "string", + "tags": [], + "label": "label", + "description": [], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.LinkCategory.linkIds", + "type": "Object", + "tags": [], + "label": "linkIds", + "description": [], + "signature": [ + "readonly T[]" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavItem", + "type": "Interface", + "tags": [], + "label": "SolutionSideNavItem", + "description": [], + "signature": [ + { + "pluginId": "@kbn/security-solution-side-nav", + "scope": "common", + "docId": "kibKbnSecuritySolutionSideNavPluginApi", + "section": "def-common.SolutionSideNavItem", + "text": "SolutionSideNavItem" + }, + "" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavItem.id", + "type": "Uncategorized", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "T" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavItem.label", + "type": "string", + "tags": [], + "label": "label", + "description": [], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavItem.href", + "type": "string", + "tags": [], + "label": "href", + "description": [], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavItem.onClick", + "type": "Function", + "tags": [], + "label": "onClick", + "description": [], + "signature": [ + "React.MouseEventHandler | undefined" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavItem.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavItem.items", + "type": "Array", + "tags": [], + "label": "items", + "description": [], + "signature": [ + { + "pluginId": "@kbn/security-solution-side-nav", + "scope": "common", + "docId": "kibKbnSecuritySolutionSideNavPluginApi", + "section": "def-common.SolutionSideNavItem", + "text": "SolutionSideNavItem" + }, + "[] | undefined" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavItem.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" + }, + "[] | undefined" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavItem.iconType", + "type": "CompoundType", + "tags": [], + "label": "iconType", + "description": [], + "signature": [ + "IconType", + " | undefined" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavItem.labelSize", + "type": "CompoundType", + "tags": [], + "label": "labelSize", + "description": [], + "signature": [ + "\"m\" | \"s\" | \"xs\" | \"l\" | undefined" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavItem.appendSeparator", + "type": "CompoundType", + "tags": [], + "label": "appendSeparator", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavItem.isBeta", + "type": "CompoundType", + "tags": [], + "label": "isBeta", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavItem.betaOptions", + "type": "Object", + "tags": [], + "label": "betaOptions", + "description": [], + "signature": [ + "{ text: string; } | undefined" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavProps", + "type": "Interface", + "tags": [], + "label": "SolutionSideNavProps", + "description": [], + "path": "packages/security-solution/side_nav/src/solution_side_nav.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavProps.items", + "type": "Array", + "tags": [], + "label": "items", + "description": [], + "signature": [ + { + "pluginId": "@kbn/security-solution-side-nav", + "scope": "common", + "docId": "kibKbnSecuritySolutionSideNavPluginApi", + "section": "def-common.SolutionSideNavItem", + "text": "SolutionSideNavItem" + }, + "[]" + ], + "path": "packages/security-solution/side_nav/src/solution_side_nav.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavProps.selectedId", + "type": "string", + "tags": [], + "label": "selectedId", + "description": [], + "path": "packages/security-solution/side_nav/src/solution_side_nav.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavProps.footerItems", + "type": "Array", + "tags": [], + "label": "footerItems", + "description": [], + "signature": [ + { + "pluginId": "@kbn/security-solution-side-nav", + "scope": "common", + "docId": "kibKbnSecuritySolutionSideNavPluginApi", + "section": "def-common.SolutionSideNavItem", + "text": "SolutionSideNavItem" + }, + "[] | undefined" + ], + "path": "packages/security-solution/side_nav/src/solution_side_nav.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavProps.panelBottomOffset", + "type": "string", + "tags": [], + "label": "panelBottomOffset", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/security-solution/side_nav/src/solution_side_nav.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavProps.panelTopOffset", + "type": "string", + "tags": [], + "label": "panelTopOffset", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/security-solution/side_nav/src/solution_side_nav.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.SolutionSideNavProps.tracker", + "type": "Function", + "tags": [], + "label": "tracker", + "description": [], + "signature": [ + { + "pluginId": "@kbn/security-solution-side-nav", + "scope": "common", + "docId": "kibKbnSecuritySolutionSideNavPluginApi", + "section": "def-common.Tracker", + "text": "Tracker" + }, + " | undefined" + ], + "path": "packages/security-solution/side_nav/src/solution_side_nav.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.LinkCategories", + "type": "Type", + "tags": [], + "label": "LinkCategories", + "description": [], + "signature": [ + "readonly ", + { + "pluginId": "@kbn/security-solution-side-nav", + "scope": "common", + "docId": "kibKbnSecuritySolutionSideNavPluginApi", + "section": "def-common.LinkCategory", + "text": "LinkCategory" + }, + "[]" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.Tracker", + "type": "Type", + "tags": [], + "label": "Tracker", + "description": [], + "signature": [ + "(type: string, event: string | string[], count?: number | undefined) => void" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.Tracker.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.Tracker.$2", + "type": "CompoundType", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "string | string[]" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/security-solution-side-nav", + "id": "def-common.Tracker.$3", + "type": "number", + "tags": [], + "label": "count", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/security-solution/side_nav/src/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_security_solution_side_nav.mdx b/api_docs/kbn_security_solution_side_nav.mdx new file mode 100644 index 0000000000000..147d82c8f2d92 --- /dev/null +++ b/api_docs/kbn_security_solution_side_nav.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: kibKbnSecuritySolutionSideNavPluginApi +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-03-21 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-side-nav'] +--- +import kbnSecuritySolutionSideNavObj from './kbn_security_solution_side_nav.devdocs.json'; + + + +Contact [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 30 | 0 | 30 | 0 | + +## Common + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_security_solution_storybook_config.devdocs.json b/api_docs/kbn_security_solution_storybook_config.devdocs.json new file mode 100644 index 0000000000000..a2606da4952d3 --- /dev/null +++ b/api_docs/kbn_security_solution_storybook_config.devdocs.json @@ -0,0 +1,62 @@ +{ + "id": "@kbn/security-solution-storybook-config", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/security-solution-storybook-config", + "id": "def-common.TITLE", + "type": "string", + "tags": [], + "label": "TITLE", + "description": [ + "The title of the Storybook." + ], + "signature": [ + "\"Security Solution Storybook\"" + ], + "path": "packages/security-solution/storybook/config/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/security-solution-storybook-config", + "id": "def-common.URL", + "type": "string", + "tags": [], + "label": "URL", + "description": [ + "The remote URL of the root from which Storybook loads stories for Security Solution." + ], + "signature": [ + "\"https://github.com/elastic/kibana/tree/main/packages/security_solution\"" + ], + "path": "packages/security-solution/storybook/config/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_security_solution_storybook_config.mdx b/api_docs/kbn_security_solution_storybook_config.mdx new file mode 100644 index 0000000000000..72c36533ad17c --- /dev/null +++ b/api_docs/kbn_security_solution_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: kibKbnSecuritySolutionStorybookConfigPluginApi +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-03-21 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-storybook-config'] +--- +import kbnSecuritySolutionStorybookConfigObj from './kbn_security_solution_storybook_config.devdocs.json'; + + + +Contact [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) 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_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index 2a282cb7bd3ad..b98357bebc9ce 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete'] --- import kbnSecuritysolutionAutocompleteObj from './kbn_securitysolution_autocomplete.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_ecs.mdx b/api_docs/kbn_securitysolution_ecs.mdx index f754cded0292d..38c14bff7141a 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_securitysolution_es_utils.devdocs.json index e21a4c67cb4ac..34dafefba3cab 100644 --- a/api_docs/kbn_securitysolution_es_utils.devdocs.json +++ b/api_docs/kbn_securitysolution_es_utils.devdocs.json @@ -655,33 +655,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; asyncSearch: ", "default", @@ -1059,7 +1033,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -1237,7 +1213,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -1263,7 +1241,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -1527,6 +1525,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -1899,33 +1899,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; asyncSearch: ", "default", @@ -2303,7 +2277,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -2481,7 +2457,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -2507,7 +2485,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -2771,6 +2769,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index f2b821f9485f7..ea0334780a441 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-03-09 +date: 2023-03-21 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 562bde31e9f31..a03c05c30692d 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\" | \"source\" | \"desc\" | \"filter\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"meta\" | \"title\" | \"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\" | \"slot\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"style\" | \"summary\" | \"table\" | \"template\" | \"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\" | \"pattern\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"stop\" | \"switch\" | \"textPath\" | \"tspan\" | \"use\" | \"view\"" + "\"symbol\" | \"object\" | \"source\" | \"desc\" | \"filter\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"meta\" | \"title\" | \"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\" | \"slot\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"style\" | \"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\" | \"pattern\" | \"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\" | \"source\" | \"desc\" | \"filter\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"meta\" | \"title\" | \"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\" | \"slot\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"style\" | \"summary\" | \"table\" | \"template\" | \"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\" | \"pattern\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"stop\" | \"switch\" | \"textPath\" | \"tspan\" | \"use\" | \"view\"" + "\"symbol\" | \"object\" | \"source\" | \"desc\" | \"filter\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"meta\" | \"title\" | \"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\" | \"slot\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"style\" | \"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\" | \"pattern\" | \"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\" | \"source\" | \"desc\" | \"filter\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"meta\" | \"title\" | \"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\" | \"slot\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"style\" | \"summary\" | \"table\" | \"template\" | \"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\" | \"pattern\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"stop\" | \"switch\" | \"textPath\" | \"tspan\" | \"use\" | \"view\"" + "\"symbol\" | \"object\" | \"source\" | \"desc\" | \"filter\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"meta\" | \"title\" | \"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\" | \"slot\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"style\" | \"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\" | \"pattern\" | \"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\" | \"source\" | \"desc\" | \"filter\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"meta\" | \"title\" | \"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\" | \"slot\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"style\" | \"summary\" | \"table\" | \"template\" | \"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\" | \"pattern\" | \"polygon\" | \"polyline\" | \"radialGradient\" | \"rect\" | \"stop\" | \"switch\" | \"textPath\" | \"tspan\" | \"use\" | \"view\"" + "\"symbol\" | \"object\" | \"source\" | \"desc\" | \"filter\" | \"big\" | \"link\" | \"small\" | \"sub\" | \"sup\" | \"text\" | \"map\" | \"head\" | React.ComponentType | \"meta\" | \"title\" | \"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\" | \"slot\" | \"script\" | \"section\" | \"select\" | \"span\" | \"strong\" | \"style\" | \"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\" | \"pattern\" | \"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 e260940ff4f66..d90aa140aedb6 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_securitysolution_grouping.devdocs.json index b85a58ac7e7e1..5fc1109006f0e 100644 --- a/api_docs/kbn_securitysolution_grouping.devdocs.json +++ b/api_docs/kbn_securitysolution_grouping.devdocs.json @@ -27,7 +27,7 @@ "label": "getGroupingQuery", "description": [], "signature": [ - "({ additionalFilters, additionalAggregationsRoot, additionalStatsAggregationsFields0, additionalStatsAggregationsFields1, from, runtimeMappings, stackByMultipleFields0, stackByMultipleFields0Size, stackByMultipleFields0From, stackByMultipleFields0Sort, stackByMultipleFields1, stackByMultipleFields1Size, stackByMultipleFields1From, stackByMultipleFields1Sort, to, }: ", + "({ additionalFilters, from, groupByFields, metricsAggregations, pageNumber, rootAggregations, runtimeMappings, size, sort, to, }: ", "GroupingQueryArgs", ") => ", "GroupingQuery" @@ -41,7 +41,7 @@ "id": "def-common.getGroupingQuery.$1", "type": "Object", "tags": [], - "label": "{\n additionalFilters = [],\n additionalAggregationsRoot,\n additionalStatsAggregationsFields0,\n additionalStatsAggregationsFields1,\n from,\n runtimeMappings,\n stackByMultipleFields0,\n stackByMultipleFields0Size = DEFAULT_STACK_BY_FIELD0_SIZE,\n stackByMultipleFields0From,\n stackByMultipleFields0Sort,\n stackByMultipleFields1,\n stackByMultipleFields1Size = DEFAULT_STACK_BY_FIELD1_SIZE,\n stackByMultipleFields1From,\n stackByMultipleFields1Sort,\n to,\n}", + "label": "{\n additionalFilters = [],\n from,\n groupByFields,\n metricsAggregations,\n pageNumber,\n rootAggregations,\n runtimeMappings,\n size = DEFAULT_GROUP_BY_FIELD_SIZE,\n sort,\n to,\n}", "description": [], "signature": [ "GroupingQueryArgs" @@ -133,7 +133,7 @@ "label": "useGrouping", "description": [], "signature": [ - "({ defaultGroupingOptions, fields, groupingId, }: GroupingArgs) => Grouping" + "({ defaultGroupingOptions, fields, groupingId, onGroupChangeCallback, tracker, }: GroupingArgs) => Grouping" ], "path": "packages/kbn-securitysolution-grouping/src/hooks/use_grouping.tsx", "deprecated": false, @@ -144,7 +144,7 @@ "id": "def-common.useGrouping.$1", "type": "Object", "tags": [], - "label": "{\n defaultGroupingOptions,\n fields,\n groupingId,\n}", + "label": "{\n defaultGroupingOptions,\n fields,\n groupingId,\n onGroupChangeCallback,\n tracker,\n}", "description": [], "signature": [ "GroupingArgs" @@ -185,10 +185,10 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-grouping", - "id": "def-common.GroupingAggregation.stackByMultipleFields0", + "id": "def-common.GroupingAggregation.groupByFields", "type": "Object", "tags": [], - "label": "stackByMultipleFields0", + "label": "groupByFields", "description": [], "signature": [ "{ buckets?: ", @@ -207,10 +207,10 @@ }, { "parentPluginId": "@kbn/securitysolution-grouping", - "id": "def-common.GroupingAggregation.groupCount0", + "id": "def-common.GroupingAggregation.groupsCount", "type": "Object", "tags": [], - "label": "groupCount0", + "label": "groupsCount", "description": [], "signature": [ "{ value?: number | null | undefined; } | undefined" @@ -221,10 +221,10 @@ }, { "parentPluginId": "@kbn/securitysolution-grouping", - "id": "def-common.GroupingAggregation.unitCount0", + "id": "def-common.GroupingAggregation.unitsCount", "type": "Object", "tags": [], - "label": "unitCount0", + "label": "unitsCount", "description": [], "signature": [ "{ value?: number | null | undefined; } | undefined" diff --git a/api_docs/kbn_securitysolution_grouping.mdx b/api_docs/kbn_securitysolution_grouping.mdx index b7fa32ace4ad6..74bf09f4f53c3 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-03-09 +date: 2023-03-21 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 36a7c93f036eb..6068adae39539 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_securitysolution_io_ts_alerting_types.devdocs.json index d5040fec287c8..542e7ce207adb 100644 --- a/api_docs/kbn_securitysolution_io_ts_alerting_types.devdocs.json +++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.devdocs.json @@ -128,7 +128,7 @@ "label": "Language", "description": [], "signature": [ - "\"kuery\" | \"eql\" | \"lucene\"" + "\"eql\" | \"kuery\" | \"lucene\"" ], "path": "packages/kbn-securitysolution-io-ts-alerting-types/src/language/index.ts", "deprecated": false, @@ -143,7 +143,7 @@ "label": "LanguageOrUndefined", "description": [], "signature": [ - "\"kuery\" | \"eql\" | \"lucene\" | undefined" + "\"eql\" | \"kuery\" | \"lucene\" | undefined" ], "path": "packages/kbn-securitysolution-io-ts-alerting-types/src/language/index.ts", "deprecated": false, @@ -741,7 +741,7 @@ "label": "ThreatLanguage", "description": [], "signature": [ - "\"kuery\" | \"eql\" | \"lucene\" | undefined" + "\"eql\" | \"kuery\" | \"lucene\" | undefined" ], "path": "packages/kbn-securitysolution-io-ts-alerting-types/src/threat_mapping/index.ts", "deprecated": false, @@ -756,7 +756,7 @@ "label": "ThreatLanguageOrUndefined", "description": [], "signature": [ - "\"kuery\" | \"eql\" | \"lucene\" | undefined" + "\"eql\" | \"kuery\" | \"lucene\" | undefined" ], "path": "packages/kbn-securitysolution-io-ts-alerting-types/src/threat_mapping/index.ts", "deprecated": false, @@ -936,7 +936,7 @@ "label": "Type", "description": [], "signature": [ - "\"query\" | \"eql\" | \"threshold\" | \"machine_learning\" | \"saved_query\" | \"threat_match\" | \"new_terms\"" + "\"eql\" | \"query\" | \"threshold\" | \"machine_learning\" | \"saved_query\" | \"threat_match\" | \"new_terms\"" ], "path": "packages/kbn-securitysolution-io-ts-alerting-types/src/type/index.ts", "deprecated": false, @@ -951,7 +951,7 @@ "label": "TypeOrUndefined", "description": [], "signature": [ - "\"query\" | \"eql\" | \"threshold\" | \"machine_learning\" | \"saved_query\" | \"threat_match\" | \"new_terms\" | undefined" + "\"eql\" | \"query\" | \"threshold\" | \"machine_learning\" | \"saved_query\" | \"threat_match\" | \"new_terms\" | undefined" ], "path": "packages/kbn-securitysolution-io-ts-alerting-types/src/type/index.ts", "deprecated": false, diff --git a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx index 6fca3a8e96121..7946a3d60cafc 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-03-09 +date: 2023-03-21 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 ff6d487051967..18b2ea662da4c 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-03-09 +date: 2023-03-21 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 934b73b7385c4..32836773ff1fc 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-03-09 +date: 2023-03-21 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 06e2b5dedd786..50010bc49dbe9 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-03-09 +date: 2023-03-21 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 c9673ec1ae605..235bf635a0c16 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api'] --- import kbnSecuritysolutionListApiObj from './kbn_securitysolution_list_api.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index c3492940b9dd6..5dbf131ed5c61 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-03-09 +date: 2023-03-21 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 0891b65001cb2..117a33952dba8 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-03-09 +date: 2023-03-21 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 3f9d36700e9e5..e3760a4c45480 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_securitysolution_rules.devdocs.json index d0e85be6d439e..c1667dd08bb43 100644 --- a/api_docs/kbn_securitysolution_rules.devdocs.json +++ b/api_docs/kbn_securitysolution_rules.devdocs.json @@ -75,7 +75,7 @@ "label": "isRuleType", "description": [], "signature": [ - "(ruleType: unknown) => ruleType is \"query\" | \"eql\" | \"threshold\" | \"machine_learning\" | \"saved_query\" | \"threat_match\" | \"new_terms\"" + "(ruleType: unknown) => ruleType is \"eql\" | \"query\" | \"threshold\" | \"machine_learning\" | \"saved_query\" | \"threat_match\" | \"new_terms\"" ], "path": "packages/kbn-securitysolution-rules/src/utils.ts", "deprecated": false, @@ -244,7 +244,7 @@ "label": "RuleType", "description": [], "signature": [ - "\"query\" | \"eql\" | \"threshold\" | \"machine_learning\" | \"saved_query\" | \"threat_match\" | \"new_terms\"" + "\"eql\" | \"query\" | \"threshold\" | \"machine_learning\" | \"saved_query\" | \"threat_match\" | \"new_terms\"" ], "path": "packages/kbn-securitysolution-rules/src/rule_type_mappings.ts", "deprecated": false, diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index 71ad50bc4eeab..acc873266f2c8 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-03-09 +date: 2023-03-21 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 1ecfe2d977ee0..6d124385d515a 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-03-09 +date: 2023-03-21 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 0abfe76e01f3f..f8da0b4b795f3 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-03-09 +date: 2023-03-21 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 5bb3c6624ef5b..a9efddbe28fd5 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-03-09 +date: 2023-03-21 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 8211d849e7c84..6ab1fd41171ec 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository'] --- import kbnServerRouteRepositoryObj from './kbn_server_route_repository.devdocs.json'; diff --git a/api_docs/kbn_shared_svg.mdx b/api_docs/kbn_shared_svg.mdx index de2bcff897bce..f701f1b5b21ef 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-03-09 +date: 2023-03-21 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 ee48928ec965d..f6cad90a06071 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-03-09 +date: 2023-03-21 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 5b8f95496c7c1..6131833a95c1c 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-03-09 +date: 2023-03-21 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 2013dec4e56c5..b90052eda4188 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-03-09 +date: 2023-03-21 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 385234f0e2c09..1132808ee75ba 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-exit-full-screen-mocks'] --- import kbnSharedUxButtonExitFullScreenMocksObj from './kbn_shared_ux_button_exit_full_screen_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_button_toolbar.mdx b/api_docs/kbn_shared_ux_button_toolbar.mdx index 46317725ab924..10012cb95b17a 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-toolbar'] --- import kbnSharedUxButtonToolbarObj from './kbn_shared_ux_button_toolbar.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_card_no_data.devdocs.json b/api_docs/kbn_shared_ux_card_no_data.devdocs.json index 8c7dec127aee0..99ac076aca8fd 100644 --- a/api_docs/kbn_shared_ux_card_no_data.devdocs.json +++ b/api_docs/kbn_shared_ux_card_no_data.devdocs.json @@ -184,11 +184,11 @@ "\nProps for the `NoDataCard` sevice-connected component." ], "signature": [ - "{ prefix?: string | undefined; id?: string | undefined; defaultValue?: string | number | readonly string[] | undefined; children?: React.ReactNode; description?: React.ReactNode; category?: string | undefined; is?: string | undefined; title?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; button?: React.ReactNode; footer?: React.ReactNode; slot?: string | undefined; style?: React.CSSProperties | undefined; image?: string | React.ReactElement> | undefined; className?: string | undefined; 'aria-label'?: string | undefined; 'data-test-subj'?: string | undefined; css?: ", + "{ prefix?: string | undefined; id?: string | undefined; defaultValue?: string | number | readonly string[] | undefined; children?: React.ReactNode; description?: React.ReactNode; category?: string | undefined; is?: string | undefined; title?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; security?: string | undefined; button?: React.ReactNode; footer?: React.ReactNode; slot?: string | undefined; style?: React.CSSProperties | undefined; image?: string | React.ReactElement> | undefined; className?: string | undefined; 'aria-label'?: string | undefined; 'data-test-subj'?: string | undefined; css?: ", "Interpolation", "<", "Theme", - ">; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; hidden?: boolean | undefined; lang?: string | undefined; placeholder?: string | undefined; spellCheck?: Booleanish | undefined; tabIndex?: number | 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; security?: string | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"search\" | \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | 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-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; onChange?: React.FormEventHandler | 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; paddingSize?: \"m\" | \"none\" | \"s\" | \"xs\" | \"l\" | \"xl\" | undefined; href?: string | undefined; rel?: string | undefined; target?: string | undefined; icon?: React.ReactElement<", + ">; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; hidden?: boolean | undefined; lang?: string | undefined; placeholder?: string | undefined; spellCheck?: Booleanish | undefined; tabIndex?: number | 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\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | 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-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; onChange?: React.FormEventHandler | 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; paddingSize?: \"m\" | \"none\" | \"s\" | \"xs\" | \"l\" | \"xl\" | undefined; href?: string | undefined; rel?: string | undefined; target?: string | undefined; icon?: React.ReactElement<", "EuiIconProps", ", string | React.JSXElementConstructor> | null | undefined; hasBorder?: boolean | undefined; textAlign?: \"right\" | \"left\" | \"center\" | undefined; titleElement?: \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | \"span\" | undefined; titleSize?: \"s\" | \"xs\" | undefined; betaBadgeProps?: (", "CommonProps", @@ -340,7 +340,7 @@ "DisambiguateSet", " & ", "DisambiguateSet", - "<{ tooltipContent: React.ReactNode; title?: string | undefined; }, { title: string; tooltipContent?: React.ReactNode; }> & { title: string; tooltipContent?: React.ReactNode; } & { label: React.ReactNode; }) | undefined; display?: \"warning\" | \"success\" | \"plain\" | \"subdued\" | \"primary\" | \"accent\" | \"danger\" | \"transparent\" | undefined; selectable?: (", + "<{ tooltipContent: React.ReactNode; title?: string | undefined; }, { title: string; tooltipContent?: React.ReactNode; }> & { title: string; tooltipContent?: React.ReactNode; } & { label: React.ReactNode; }) | undefined; display?: \"warning\" | \"success\" | \"subdued\" | \"primary\" | \"accent\" | \"danger\" | \"transparent\" | \"plain\" | undefined; selectable?: (", "DisambiguateSet", "<", "EuiButtonPropsForAnchor", diff --git a/api_docs/kbn_shared_ux_card_no_data.mdx b/api_docs/kbn_shared_ux_card_no_data.mdx index 149be98b02b0b..b7b5f983252ea 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-03-09 +date: 2023-03-21 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 ecf3f914b81f6..1e6ccac372c1b 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-03-09 +date: 2023-03-21 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_file_context.mdx b/api_docs/kbn_shared_ux_file_context.mdx index 46d29ba17bfe5..72ab073de32ff 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-03-09 +date: 2023-03-21 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 876508dc2c880..591cc6d9828c3 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-03-09 +date: 2023-03-21 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 7d75906fb5531..7a52e50a9e98a 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-03-09 +date: 2023-03-21 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 f8d5f230986b9..e11c46eba8894 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-03-09 +date: 2023-03-21 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 e62d4d4cdd84e..3fbb133616f53 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-03-09 +date: 2023-03-21 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 bd980874d0c36..c4ad0e64db081 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-03-09 +date: 2023-03-21 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 1422db76d698e..59cbed529a3d5 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-03-09 +date: 2023-03-21 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 ff76e1aefaa1b..2e5b2fd299ea9 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-03-09 +date: 2023-03-21 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 70a521de0921d..ab48c53c921c8 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-03-09 +date: 2023-03-21 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 690799c56469a..80b2b22f8fd34 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-03-09 +date: 2023-03-21 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 9c7326af092d7..38cf26e8b4ae4 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-03-09 +date: 2023-03-21 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 1dbb1d5e4e58e..8a44ef7777828 100644 --- a/api_docs/kbn_shared_ux_markdown_mocks.devdocs.json +++ b/api_docs/kbn_shared_ux_markdown_mocks.devdocs.json @@ -435,11 +435,11 @@ "signature": [ "() => { prefix?: string | undefined; value?: string | undefined; id?: string | undefined; defaultValue?: string | number | readonly string[] | undefined; children?: React.ReactNode; errors?: ", "EuiMarkdownParseError", - "[] | undefined; is?: string | undefined; title?: string | undefined; slot?: string | undefined; style?: React.CSSProperties | undefined; className?: string | undefined; 'aria-label'?: string | undefined; 'data-test-subj'?: string | undefined; css?: ", + "[] | undefined; is?: string | undefined; title?: string | undefined; security?: string | undefined; slot?: string | undefined; style?: React.CSSProperties | undefined; className?: string | undefined; 'aria-label'?: string | undefined; 'data-test-subj'?: string | undefined; css?: ", "Interpolation", "<", "Theme", - ">; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; hidden?: boolean | undefined; lang?: string | undefined; placeholder?: string | undefined; spellCheck?: Booleanish | undefined; tabIndex?: number | 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; security?: string | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"search\" | \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | 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-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; onChange?: ((value: string) => void) | 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; height?: number | \"full\" | undefined; readOnly: boolean; maxHeight?: number | undefined; autoExpandPreview?: boolean | undefined; parsingPluginList?: ", + ">; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; hidden?: boolean | undefined; lang?: string | undefined; placeholder?: string | undefined; spellCheck?: Booleanish | undefined; tabIndex?: number | 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\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | 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-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; onChange?: ((value: string) => void) | 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; height?: number | \"full\" | undefined; readOnly: boolean; maxHeight?: number | undefined; autoExpandPreview?: boolean | undefined; parsingPluginList?: ", "PluggableList", "<", "Settings", diff --git a/api_docs/kbn_shared_ux_markdown_mocks.mdx b/api_docs/kbn_shared_ux_markdown_mocks.mdx index b880384e6efa7..fa59c26d5c953 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-03-09 +date: 2023-03-21 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 cbac73c7352ce..699da77f66fde 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-03-09 +date: 2023-03-21 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 0e355e35b3fba..be2077c794bca 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-03-09 +date: 2023-03-21 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 d4fb4518f3e30..22f1cc4796aa9 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-03-09 +date: 2023-03-21 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 732dc8eb355e4..d692e731c7494 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-03-09 +date: 2023-03-21 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 d063aff58eabf..86ca949f56eeb 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-03-09 +date: 2023-03-21 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 f82b37477aca5..9d2e49cfb8910 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-03-09 +date: 2023-03-21 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 3048252f995f4..a9df5603a57b5 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-03-09 +date: 2023-03-21 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 5f0e0450e58b7..5302fa2087200 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-03-09 +date: 2023-03-21 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 18b3fd74422d4..3b83bd819070f 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-03-09 +date: 2023-03-21 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 8d99849330b95..926eac356d40d 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-03-09 +date: 2023-03-21 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 698d903d12dc1..235a8fba41871 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_shared_ux_prompt_no_data_views.devdocs.json index 348accba9641d..241bf46504f01 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views.devdocs.json +++ b/api_docs/kbn_shared_ux_prompt_no_data_views.devdocs.json @@ -241,7 +241,7 @@ "The background color of the prompt; defaults to `plain`." ], "signature": [ - "\"warning\" | \"success\" | \"plain\" | \"subdued\" | \"primary\" | \"accent\" | \"danger\" | \"transparent\" | undefined" + "\"warning\" | \"success\" | \"subdued\" | \"primary\" | \"accent\" | \"danger\" | \"transparent\" | \"plain\" | undefined" ], "path": "packages/shared-ux/prompt/no_data_views/types/index.d.ts", "deprecated": false, 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 982344bb543e0..9d9e7cbc39588 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-03-09 +date: 2023-03-21 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 63d66ac6f7d7f..e6dbc41a4c9ba 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-03-09 +date: 2023-03-21 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 c5aefe4a5d102..855802cb6bac8 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-03-09 +date: 2023-03-21 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 e4d3b3100602a..23d9cd99cfc4d 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-03-09 +date: 2023-03-21 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 47c4883f638b3..20efcb3957121 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-03-09 +date: 2023-03-21 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 66633f64fb6e0..54a4ec86604fd 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-03-09 +date: 2023-03-21 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 ccc5787a65b9e..7370115e8f193 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-03-09 +date: 2023-03-21 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 589ebafc470e9..666b1f68153ee 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-03-09 +date: 2023-03-21 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 a368fed9d859c..041ae583bdda2 100644 --- a/api_docs/kbn_slo_schema.devdocs.json +++ b/api_docs/kbn_slo_schema.devdocs.json @@ -390,7 +390,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 | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; } & { settings?: { timestampField?: string | undefined; syncDelay?: string | undefined; frequency?: string | undefined; } | 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; } & { settings?: { timestampField?: string | undefined; syncDelay?: string | undefined; frequency?: string | undefined; } | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -405,7 +405,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 | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -445,7 +445,7 @@ "section": "def-common.Duration", "text": "Duration" }, - " | undefined; } | undefined; }" + " | undefined; } | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -520,7 +520,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 | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; })[]; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -535,7 +535,7 @@ "label": "GetSLOResponse", "description": [], "signature": [ - "{ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; } & { index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -580,7 +580,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 | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -595,7 +595,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 | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; } & { summary: { status: \"HEALTHY\" | \"NO_DATA\" | \"DEGRADING\" | \"VIOLATED\"; sliValue: number; errorBudget: { initial: number; consumed: number; remaining: number; isEstimated: boolean; }; }; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -610,7 +610,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 | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; } | undefined; timeWindow?: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; } | undefined; budgetingMethod?: \"occurrences\" | \"timeslices\" | undefined; objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }) | undefined; settings?: { timestampField?: string | undefined; syncDelay?: string | undefined; frequency?: string | undefined; } | 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; } | undefined; timeWindow?: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; } | undefined; budgetingMethod?: \"occurrences\" | \"timeslices\" | undefined; objective?: ({ target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }) | undefined; settings?: { timestampField?: string | undefined; syncDelay?: string | undefined; frequency?: string | undefined; } | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -625,7 +625,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 | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; } | undefined; timeWindow?: { duration: ", { "pluginId": "@kbn/slo-schema", "scope": "common", @@ -665,7 +665,7 @@ "section": "def-common.Duration", "text": "Duration" }, - " | undefined; } | undefined; }" + " | undefined; } | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -680,7 +680,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 | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -750,11 +750,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>" ], @@ -818,7 +818,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -832,9 +834,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>" ], @@ -962,11 +962,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -1000,7 +1000,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -1014,9 +1016,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -1116,7 +1116,11 @@ "section": "def-common.Duration", "text": "Duration" }, - ", string, unknown>; }>; }>]>; }>" + ", string, unknown>; }>; tags: ", + "ArrayC", + "<", + "StringC", + ">; }>]>; }>" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -1400,11 +1404,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -1438,7 +1442,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -1452,9 +1458,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -1556,7 +1560,11 @@ }, ", string, unknown>; }>; enabled: ", "BooleanC", - "; createdAt: ", + "; tags: ", + "ArrayC", + "<", + "StringC", + ">; createdAt: ", "Type", "; updatedAt: ", "Type", @@ -1593,6 +1601,26 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/slo-schema", + "id": "def-common.getSLODiagnosisParamsSchema", + "type": "Object", + "tags": [], + "label": "getSLODiagnosisParamsSchema", + "description": [], + "signature": [ + "TypeC", + "<{ path: ", + "TypeC", + "<{ id: ", + "StringC", + "; }>; }>" + ], + "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/slo-schema", "id": "def-common.getSLOParamsSchema", @@ -1666,11 +1694,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -1704,7 +1732,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -1718,9 +1748,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -1822,7 +1850,11 @@ }, ", string, unknown>; }>; enabled: ", "BooleanC", - "; createdAt: ", + "; tags: ", + "ArrayC", + "<", + "StringC", + ">; createdAt: ", "Type", "; updatedAt: ", "Type", @@ -1972,11 +2004,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -2010,7 +2042,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -2024,9 +2058,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -2305,6 +2337,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/slo-schema", + "id": "def-common.sloIdSchema", + "type": "Object", + "tags": [], + "label": "sloIdSchema", + "description": [], + "signature": [ + "StringC" + ], + "path": "packages/kbn-slo-schema/src/schema/slo.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/slo-schema", "id": "def-common.sloResponseSchema", @@ -2356,11 +2403,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -2394,7 +2441,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -2408,9 +2457,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -2512,7 +2559,11 @@ }, ", string, unknown>; }>; enabled: ", "BooleanC", - "; createdAt: ", + "; tags: ", + "ArrayC", + "<", + "StringC", + ">; createdAt: ", "Type", "; updatedAt: ", "Type", @@ -2574,11 +2625,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -2612,7 +2663,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -2626,9 +2679,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -2730,7 +2781,11 @@ "NumberC", "; enabled: ", "BooleanC", - "; createdAt: ", + "; tags: ", + "ArrayC", + "<", + "StringC", + ">; createdAt: ", "Type", "; updatedAt: ", "Type", @@ -2794,11 +2849,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -2832,7 +2887,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -2846,9 +2903,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -2950,7 +3005,11 @@ }, ", string, unknown>; }>; enabled: ", "BooleanC", - "; createdAt: ", + "; tags: ", + "ArrayC", + "<", + "StringC", + ">; createdAt: ", "Type", "; updatedAt: ", "Type", @@ -3040,11 +3099,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -3078,7 +3137,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -3092,9 +3153,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -3196,7 +3255,11 @@ "NumberC", "; enabled: ", "BooleanC", - "; createdAt: ", + "; tags: ", + "ArrayC", + "<", + "StringC", + ">; createdAt: ", "Type", "; updatedAt: ", "Type", @@ -3295,6 +3358,24 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/slo-schema", + "id": "def-common.tagsSchema", + "type": "Object", + "tags": [], + "label": "tagsSchema", + "description": [], + "signature": [ + "ArrayC", + "<", + "StringC", + ">" + ], + "path": "packages/kbn-slo-schema/src/schema/slo.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/slo-schema", "id": "def-common.timeslicesBudgetingMethodSchema", @@ -3412,11 +3493,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -3450,7 +3531,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -3464,9 +3547,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -3564,7 +3645,11 @@ "section": "def-common.Duration", "text": "Duration" }, - ", string, unknown>; }>; }>; }>" + ", string, unknown>; }>; tags: ", + "ArrayC", + "<", + "StringC", + ">; }>; }>" ], "path": "packages/kbn-slo-schema/src/rest_specs/slo.ts", "deprecated": false, @@ -3622,11 +3707,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -3660,7 +3745,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -3674,9 +3761,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -3778,7 +3863,11 @@ }, ", string, unknown>; }>; enabled: ", "BooleanC", - "; createdAt: ", + "; tags: ", + "ArrayC", + "<", + "StringC", + ">; createdAt: ", "Type", "; updatedAt: ", "Type", diff --git a/api_docs/kbn_slo_schema.mdx b/api_docs/kbn_slo_schema.mdx index 169de61763f05..8806afcab8a44 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-03-09 +date: 2023-03-21 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 | |-------------------|-----------|------------------------|-----------------| -| 75 | 0 | 75 | 0 | +| 78 | 0 | 78 | 0 | ## Common diff --git a/api_docs/kbn_some_dev_log.devdocs.json b/api_docs/kbn_some_dev_log.devdocs.json index 32ec9c850c881..aa82f7d6bcb16 100644 --- a/api_docs/kbn_some_dev_log.devdocs.json +++ b/api_docs/kbn_some_dev_log.devdocs.json @@ -343,7 +343,7 @@ "\nBasic set of log-level flags, the common levels implemented between\nthe ToolingLog and the kbn_pm logger" ], "signature": [ - "\"debug\" | \"info\" | \"verbose\" | \"quiet\"" + "\"info\" | \"debug\" | \"verbose\" | \"quiet\"" ], "path": "packages/kbn-some-dev-log/src/some_dev_log.ts", "deprecated": false, diff --git a/api_docs/kbn_some_dev_log.mdx b/api_docs/kbn_some_dev_log.mdx index 5e8660f71e403..d69bf7918ad28 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-03-09 +date: 2023-03-21 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 34da57ab78902..35485e03caaab 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-03-09 +date: 2023-03-21 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 3093097093eff..f7e04bdd17489 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-03-09 +date: 2023-03-21 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 548e2f812bbd7..c88577cb5e4c0 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-03-09 +date: 2023-03-21 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 add11b7944941..af35320fc8783 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-03-09 +date: 2023-03-21 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 44ee176445991..3f85d28d54705 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-03-09 +date: 2023-03-21 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 8b9273f05b076..06a53b8e753f2 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-03-09 +date: 2023-03-21 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 f7ec956ce01b6..cec8bbc572b55 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-subj-selector'] --- import kbnTestSubjSelectorObj from './kbn_test_subj_selector.devdocs.json'; diff --git a/api_docs/kbn_tooling_log.devdocs.json b/api_docs/kbn_tooling_log.devdocs.json index 3608a64f9f3dc..08dccf7bc7c05 100644 --- a/api_docs/kbn_tooling_log.devdocs.json +++ b/api_docs/kbn_tooling_log.devdocs.json @@ -603,7 +603,7 @@ "label": "level", "description": [], "signature": [ - "\"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"silent\" | \"verbose\"" + "\"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"silent\" | \"verbose\"" ], "path": "packages/kbn-tooling-log/src/tooling_log_collecting_writer.ts", "deprecated": false, @@ -700,7 +700,7 @@ "label": "level", "description": [], "signature": [ - "{ name: \"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"silent\" | \"verbose\"; flags: { error: boolean; warning: boolean; success: boolean; debug: boolean; info: boolean; silent: boolean; verbose: boolean; }; }" + "{ name: \"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; info: boolean; warning: boolean; success: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }" ], "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", "deprecated": false, @@ -926,7 +926,7 @@ "label": "parseLogLevel", "description": [], "signature": [ - "(name: \"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"silent\" | \"verbose\") => { name: \"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"silent\" | \"verbose\"; flags: { error: boolean; warning: boolean; success: boolean; debug: boolean; info: boolean; silent: boolean; verbose: boolean; }; }" + "(name: \"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"silent\" | \"verbose\") => { name: \"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; info: boolean; warning: boolean; success: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }" ], "path": "packages/kbn-tooling-log/src/log_levels.ts", "deprecated": false, @@ -940,7 +940,7 @@ "label": "name", "description": [], "signature": [ - "\"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"silent\" | \"verbose\"" + "\"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"silent\" | \"verbose\"" ], "path": "packages/kbn-tooling-log/src/log_levels.ts", "deprecated": false, @@ -959,7 +959,7 @@ "label": "pickLevelFromFlags", "description": [], "signature": [ - "(flags: Record, options: { default?: \"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"silent\" | \"verbose\" | undefined; }) => \"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"silent\" | \"verbose\"" + "(flags: Record, options: { default?: \"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"silent\" | \"verbose\" | undefined; }) => \"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"silent\" | \"verbose\"" ], "path": "packages/kbn-tooling-log/src/log_levels.ts", "deprecated": false, @@ -999,7 +999,7 @@ "label": "default", "description": [], "signature": [ - "\"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"silent\" | \"verbose\" | undefined" + "\"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"silent\" | \"verbose\" | undefined" ], "path": "packages/kbn-tooling-log/src/log_levels.ts", "deprecated": false, @@ -1036,7 +1036,7 @@ "level/type of message" ], "signature": [ - "\"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"write\" | \"verbose\"" + "\"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"write\" | \"verbose\"" ], "path": "packages/kbn-tooling-log/src/message.ts", "deprecated": false, @@ -1164,7 +1164,7 @@ "\nLog level, messages below this level will be ignored" ], "signature": [ - "\"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"silent\" | \"verbose\"" + "\"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"silent\" | \"verbose\"" ], "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", "deprecated": false, @@ -1312,7 +1312,7 @@ "label": "LogLevel", "description": [], "signature": [ - "\"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"silent\" | \"verbose\"" + "\"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"silent\" | \"verbose\"" ], "path": "packages/kbn-tooling-log/src/log_levels.ts", "deprecated": false, @@ -1327,7 +1327,7 @@ "label": "ParsedLogLevel", "description": [], "signature": [ - "{ name: \"error\" | \"warning\" | \"success\" | \"debug\" | \"info\" | \"silent\" | \"verbose\"; flags: { error: boolean; warning: boolean; success: boolean; debug: boolean; info: boolean; silent: boolean; verbose: boolean; }; }" + "{ name: \"error\" | \"info\" | \"warning\" | \"success\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; info: boolean; warning: boolean; success: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }" ], "path": "packages/kbn-tooling-log/src/log_levels.ts", "deprecated": false, diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index 4f617b3f3eba8..795f7c38e613e 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-03-09 +date: 2023-03-21 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 8961538ce4089..be80c682efe5e 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-03-09 +date: 2023-03-21 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 9ad3a266c8858..1398f4b0ec687 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-03-09 +date: 2023-03-21 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 10ba4f0ef47aa..b9aae0d95f669 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-03-09 +date: 2023-03-21 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 19b2d09fedcde..65dcf8da6692f 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-03-09 +date: 2023-03-21 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 f2b662de16071..ae2b31f33851c 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] --- import kbnUiThemeObj from './kbn_ui_theme.devdocs.json'; diff --git a/api_docs/kbn_user_profile_components.mdx b/api_docs/kbn_user_profile_components.mdx index f78fc9b77fc25..3e3268d299f5f 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-03-09 +date: 2023-03-21 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.devdocs.json b/api_docs/kbn_utility_types.devdocs.json index 6b15b19ce87c3..821e2d7a40523 100644 --- a/api_docs/kbn_utility_types.devdocs.json +++ b/api_docs/kbn_utility_types.devdocs.json @@ -759,6 +759,23 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/utility-types", + "id": "def-common.WithRequiredProperty", + "type": "Type", + "tags": [], + "label": "WithRequiredProperty", + "description": [ + "\nTakes a type and makes selected properties required.\n" + ], + "signature": [ + "Omit & { [Property in Key]-?: Type[Property]; }" + ], + "path": "packages/kbn-utility-types/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/utility-types", "id": "def-common.Writable", diff --git a/api_docs/kbn_utility_types.mdx b/api_docs/kbn_utility_types.mdx index c6642fb08a6f9..a425f399f9710 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types'] --- import kbnUtilityTypesObj from './kbn_utility_types.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 | |-------------------|-----------|------------------------|-----------------| -| 35 | 0 | 15 | 1 | +| 36 | 0 | 15 | 1 | ## Common diff --git a/api_docs/kbn_utility_types_jest.mdx b/api_docs/kbn_utility_types_jest.mdx index 3762ec6203681..4c80c58ff5afd 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-03-09 +date: 2023-03-21 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 1465063df11b6..5c4fabb9cb25d 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-03-09 +date: 2023-03-21 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 ba16e0f1e3a5b..928aca8a1d417 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-03-09 +date: 2023-03-21 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 d0da9ebd3ca5c..9164661d9afdd 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview'] --- import kibanaOverviewObj from './kibana_overview.devdocs.json'; diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index b29bc6af7d55a..cc543f7ecc09a 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact'] --- import kibanaReactObj from './kibana_react.devdocs.json'; diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index 0f8507afe5b7b..1d477ee078047 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-03-09 +date: 2023-03-21 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 383df0c92ff87..39e092eaa221a 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-03-09 +date: 2023-03-21 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 def9e6a6371e5..b51e8d542f4a6 100644 --- a/api_docs/lens.devdocs.json +++ b/api_docs/lens.devdocs.json @@ -9722,7 +9722,7 @@ "label": "YScaleType", "description": [], "signature": [ - "\"log\" | \"time\" | \"sqrt\" | \"linear\"" + "\"log\" | \"time\" | \"linear\" | \"sqrt\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, @@ -11178,7 +11178,7 @@ "label": "OperationTypePost712", "description": [], "signature": [ - "\"min\" | \"max\" | \"sum\" | \"median\" | \"count\" | \"range\" | \"cumulative_sum\" | \"date_histogram\" | \"filters\" | \"terms\" | \"percentile\" | \"average\" | \"moving_average\" | \"unique_count\" | \"last_value\" | \"counter_rate\" | \"differences\"" + "\"min\" | \"max\" | \"sum\" | \"median\" | \"count\" | \"range\" | \"filters\" | \"date_histogram\" | \"percentile\" | \"average\" | \"terms\" | \"cumulative_sum\" | \"moving_average\" | \"unique_count\" | \"last_value\" | \"counter_rate\" | \"differences\"" ], "path": "x-pack/plugins/lens/server/migrations/types.ts", "deprecated": false, @@ -11193,7 +11193,7 @@ "label": "OperationTypePre712", "description": [], "signature": [ - "\"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | \"count\" | \"range\" | \"cardinality\" | \"cumulative_sum\" | \"date_histogram\" | \"derivative\" | \"filters\" | \"terms\" | \"percentile\" | \"moving_average\" | \"last_value\" | \"counter_rate\"" + "\"min\" | \"max\" | \"sum\" | \"avg\" | \"median\" | \"count\" | \"range\" | \"filters\" | \"date_histogram\" | \"percentile\" | \"terms\" | \"cumulative_sum\" | \"derivative\" | \"moving_average\" | \"last_value\" | \"counter_rate\" | \"cardinality\"" ], "path": "x-pack/plugins/lens/server/migrations/types.ts", "deprecated": false, diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index 23fda70d84730..a6a09d7608f86 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] --- import lensObj from './lens.devdocs.json'; diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index 2ac302dda4148..af0152a95e0d3 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-03-09 +date: 2023-03-21 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 a171be2cae29b..d51059ac03f19 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement'] --- import licenseManagementObj from './license_management.devdocs.json'; diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index 23a0aa37b461b..c503964d678ff 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] --- import licensingObj from './licensing.devdocs.json'; diff --git a/api_docs/lists.devdocs.json b/api_docs/lists.devdocs.json index 60eab49b1edaa..ef7473ee326ff 100644 --- a/api_docs/lists.devdocs.json +++ b/api_docs/lists.devdocs.json @@ -4271,33 +4271,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -4679,7 +4653,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -4857,7 +4833,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -4883,7 +4861,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -5147,6 +5145,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index 12fcd4401096e..d080a3ce05074 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] --- import listsObj from './lists.devdocs.json'; diff --git a/api_docs/management.mdx b/api_docs/management.mdx index 54218f838eaa3..e84b6dcb608fd 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] --- import managementObj from './management.devdocs.json'; diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index ec567dcc0adbf..bc8a00e8e21e0 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] --- import mapsObj from './maps.devdocs.json'; diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index 189a519784cf6..9fdd601846263 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] --- import mapsEmsObj from './maps_ems.devdocs.json'; diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index 3abe3617d3173..9a1fdfc0cfd91 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] --- import mlObj from './ml.devdocs.json'; diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index cd381495f7217..bdb80fcf6abca 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-03-09 +date: 2023-03-21 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 3843623aef188..7006438b362df 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-03-09 +date: 2023-03-21 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 df35f11fe01ad..5accd8096ffab 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-03-09 +date: 2023-03-21 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 da637e3534c9f..db2f58d387b9e 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-03-09 +date: 2023-03-21 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 d723b866de400..62fa113c61311 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-03-09 +date: 2023-03-21 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 6a432e216c8e5..d1a066ae0a912 100644 --- a/api_docs/observability.devdocs.json +++ b/api_docs/observability.devdocs.json @@ -53,6 +53,41 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "observability", + "id": "def-public.AlertSummary", + "type": "Function", + "tags": [], + "label": "AlertSummary", + "description": [], + "signature": [ + "({ alert, alertSummaryFields }: ", + "AlertSummaryProps", + ") => JSX.Element" + ], + "path": "x-pack/plugins/observability/public/pages/alert_details/components/alert_summary.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observability", + "id": "def-public.AlertSummary.$1", + "type": "Object", + "tags": [], + "label": "{ alert, alertSummaryFields }", + "description": [], + "signature": [ + "AlertSummaryProps" + ], + "path": "x-pack/plugins/observability/public/pages/alert_details/components/alert_summary.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-public.calculateTimeRangeBucketSize", @@ -1020,7 +1055,13 @@ "description": [], "signature": [ "React.ExoticComponent | undefined; alerts?: Record[] | undefined; isInApp?: boolean | undefined; observabilityRuleTypeRegistry: { register: (type: ", { "pluginId": "observability", @@ -1039,7 +1080,7 @@ }, " | undefined; list: () => string[]; }; selectedAlertId?: string | undefined; } & ", "CommonProps", - " & { as?: \"div\" | undefined; } & _EuiFlyoutProps & Omit, HTMLDivElement>, keyof _EuiFlyoutProps> & Omit, HTMLDivElement>, \"css\" | \"key\" | keyof React.HTMLAttributes> & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }, \"type\" | \"prefix\" | \"id\" | \"defaultValue\" | \"children\" | \"ref\" | \"is\" | \"title\" | \"slot\" | \"style\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"css\" | \"key\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"color\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"paddingSize\" | \"size\" | \"onClose\" | \"as\" | \"maxWidth\" | \"ownFocus\" | \"hideCloseButton\" | \"closeButtonProps\" | \"closeButtonPosition\" | \"maskProps\" | \"outsideClickCloses\" | \"side\" | \"pushMinBreakpoint\" | \"focusTrapProps\" | \"includeFixedHeadersInFocusTrap\">, \"type\" | \"prefix\" | \"id\" | \"defaultValue\" | \"alert\" | \"children\" | \"is\" | \"title\" | \"alerts\" | \"slot\" | \"style\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"css\" | \"key\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"color\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"paddingSize\" | \"size\" | \"onClose\" | \"as\" | \"maxWidth\" | \"ownFocus\" | \"hideCloseButton\" | \"closeButtonProps\" | \"closeButtonPosition\" | \"maskProps\" | \"outsideClickCloses\" | \"side\" | \"pushMinBreakpoint\" | \"focusTrapProps\" | \"includeFixedHeadersInFocusTrap\" | \"isInApp\" | \"observabilityRuleTypeRegistry\" | \"selectedAlertId\"> & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }> & { readonly _result: ({ alert, alerts, isInApp, observabilityRuleTypeRegistry, onClose, selectedAlertId, }: AlertsFlyoutProps) => JSX.Element | null; }" + " & { as?: \"div\" | undefined; } & _EuiFlyoutProps & Omit, HTMLDivElement>, keyof _EuiFlyoutProps> & Omit, HTMLDivElement>, \"css\" | \"key\" | keyof React.HTMLAttributes> & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }, \"type\" | \"prefix\" | \"id\" | \"defaultValue\" | \"children\" | \"ref\" | \"is\" | \"title\" | \"security\" | \"slot\" | \"style\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"css\" | \"key\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"color\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"paddingSize\" | \"size\" | \"onClose\" | \"as\" | \"maxWidth\" | \"ownFocus\" | \"hideCloseButton\" | \"closeButtonProps\" | \"closeButtonPosition\" | \"maskProps\" | \"outsideClickCloses\" | \"side\" | \"pushMinBreakpoint\" | \"focusTrapProps\" | \"includeFixedHeadersInFocusTrap\">, \"type\" | \"prefix\" | \"id\" | \"defaultValue\" | \"alert\" | \"children\" | \"is\" | \"title\" | \"alerts\" | \"security\" | \"slot\" | \"style\" | \"className\" | \"aria-label\" | \"data-test-subj\" | \"css\" | \"key\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"placeholder\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"color\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChange\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClick\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"paddingSize\" | \"size\" | \"onClose\" | \"as\" | \"maxWidth\" | \"ownFocus\" | \"hideCloseButton\" | \"closeButtonProps\" | \"closeButtonPosition\" | \"maskProps\" | \"outsideClickCloses\" | \"side\" | \"pushMinBreakpoint\" | \"focusTrapProps\" | \"includeFixedHeadersInFocusTrap\" | \"isInApp\" | \"observabilityRuleTypeRegistry\" | \"selectedAlertId\"> & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }> & { readonly _result: ({ alert, alerts, isInApp, observabilityRuleTypeRegistry, onClose, selectedAlertId, }: AlertsFlyoutProps) => JSX.Element | null; }" ], "path": "x-pack/plugins/observability/public/index.ts", "deprecated": false, @@ -2097,6 +2138,48 @@ } ], "interfaces": [ + { + "parentPluginId": "observability", + "id": "def-public.AlertSummaryField", + "type": "Interface", + "tags": [], + "label": "AlertSummaryField", + "description": [], + "path": "x-pack/plugins/observability/public/pages/alert_details/components/alert_summary.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observability", + "id": "def-public.AlertSummaryField.label", + "type": "CompoundType", + "tags": [], + "label": "label", + "description": [], + "signature": [ + "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" + ], + "path": "x-pack/plugins/observability/public/pages/alert_details/components/alert_summary.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observability", + "id": "def-public.AlertSummaryField.value", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "string | number" + ], + "path": "x-pack/plugins/observability/public/pages/alert_details/components/alert_summary.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-public.ApmFetchDataResponse", @@ -5469,6 +5552,102 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "observability", + "id": "def-public.TopAlert", + "type": "Interface", + "tags": [], + "label": "TopAlert", + "description": [], + "signature": [ + { + "pluginId": "observability", + "scope": "public", + "docId": "kibObservabilityPluginApi", + "section": "def-public.TopAlert", + "text": "TopAlert" + }, + "" + ], + "path": "x-pack/plugins/observability/public/typings/alerts.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observability", + "id": "def-public.TopAlert.fields", + "type": "CompoundType", + "tags": [], + "label": "fields", + "description": [], + "signature": [ + "OutputOf> & OutputOf> & TAdditionalMetaFields" + ], + "path": "x-pack/plugins/observability/public/typings/alerts.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observability", + "id": "def-public.TopAlert.start", + "type": "number", + "tags": [], + "label": "start", + "description": [], + "path": "x-pack/plugins/observability/public/typings/alerts.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observability", + "id": "def-public.TopAlert.lastUpdated", + "type": "number", + "tags": [], + "label": "lastUpdated", + "description": [], + "path": "x-pack/plugins/observability/public/typings/alerts.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observability", + "id": "def-public.TopAlert.reason", + "type": "string", + "tags": [], + "label": "reason", + "description": [], + "path": "x-pack/plugins/observability/public/typings/alerts.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observability", + "id": "def-public.TopAlert.link", + "type": "string", + "tags": [], + "label": "link", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/observability/public/typings/alerts.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "observability", + "id": "def-public.TopAlert.active", + "type": "boolean", + "tags": [], + "label": "active", + "description": [], + "path": "x-pack/plugins/observability/public/typings/alerts.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-public.UptimeFetchDataResponse", @@ -7123,33 +7302,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -7531,7 +7684,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -7709,7 +7864,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -7735,7 +7892,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -7999,6 +8176,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -8408,33 +8587,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -8816,7 +8969,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -8994,7 +9149,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -9020,7 +9177,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -9284,6 +9461,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -10072,7 +10251,79 @@ "label": "ObservabilityAPIReturnType", "description": [], "signature": [ - "{ \"PUT /api/observability/slos/{id}\": ", + "{ \"GET /internal/observability/slos/{id}/_diagnosis\": ", + { + "pluginId": "@kbn/server-route-repository", + "scope": "common", + "docId": "kibKbnServerRouteRepositoryPluginApi", + "section": "def-common.ServerRoute", + "text": "ServerRoute" + }, + "<\"GET /internal/observability/slos/{id}/_diagnosis\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ id: ", + "StringC", + "; }>; }>, ", + { + "pluginId": "observability", + "scope": "server", + "docId": "kibObservabilityPluginApi", + "section": "def-server.ObservabilityRouteHandlerResources", + "text": "ObservabilityRouteHandlerResources" + }, + ", { sloResources: { [x: string]: string; \"slo-observability.sli\": string; \"slo-observability.sli-mappings\": string; \"slo-observability.sli-settings\": string; }; sloSavedObject: string | ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { timestampField: string; syncDelay: string; frequency: string; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; sloTransformStats: ", + "TransformGetTransformStatsResponse", + "; dataSample: string | ", + "SearchResponse", + ">; }, ", + { + "pluginId": "observability", + "scope": "server", + "docId": "kibObservabilityPluginApi", + "section": "def-server.ObservabilityRouteCreateOptions", + "text": "ObservabilityRouteCreateOptions" + }, + ">; \"GET /internal/observability/slos/_diagnosis\": ", + { + "pluginId": "@kbn/server-route-repository", + "scope": "common", + "docId": "kibKbnServerRouteRepositoryPluginApi", + "section": "def-common.ServerRoute", + "text": "ServerRoute" + }, + "<\"GET /internal/observability/slos/_diagnosis\", undefined, ", + { + "pluginId": "observability", + "scope": "server", + "docId": "kibObservabilityPluginApi", + "section": "def-server.ObservabilityRouteHandlerResources", + "text": "ObservabilityRouteHandlerResources" + }, + ", { licenseAndFeatures: ", + "PublicLicenseJSON", + "; userPrivileges: ", + "SecurityGetUserPrivilegesResponse", + "; sloResources: { [x: string]: string; \"slo-observability.sli\": string; \"slo-observability.sli-mappings\": string; \"slo-observability.sli-settings\": string; }; }, ", + { + "pluginId": "observability", + "scope": "server", + "docId": "kibObservabilityPluginApi", + "section": "def-server.ObservabilityRouteCreateOptions", + "text": "ObservabilityRouteCreateOptions" + }, + ">; \"PUT /api/observability/slos/{id}\": ", { "pluginId": "@kbn/server-route-repository", "scope": "common", @@ -10128,11 +10379,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -10166,7 +10417,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -10180,9 +10433,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -10280,7 +10531,11 @@ "section": "def-common.Duration", "text": "Duration" }, - ", string, unknown>; }>; }>; }>, ", + ", string, unknown>; }>; tags: ", + "ArrayC", + "<", + "StringC", + ">; }>; }>, ", { "pluginId": "observability", "scope": "server", @@ -10288,7 +10543,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; } & { index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }, ", { "pluginId": "observability", "scope": "server", @@ -10318,7 +10573,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; } & { index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; 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", @@ -10366,7 +10621,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; } & { index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; 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", @@ -10550,11 +10805,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -10588,7 +10843,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -10602,9 +10859,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -10704,7 +10959,11 @@ "section": "def-common.Duration", "text": "Duration" }, - ", string, unknown>; }>; }>]>; }>, ", + ", string, unknown>; }>; tags: ", + "ArrayC", + "<", + "StringC", + ">; }>]>; }>, ", { "pluginId": "observability", "scope": "server", @@ -10779,7 +11038,7 @@ "label": "ObservabilityConfig", "description": [], "signature": [ - "{ readonly annotations: Readonly<{} & { enabled: boolean; index: string; }>; readonly unsafe: Readonly<{} & { alertDetails: Readonly<{} & { uptime: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; metrics: Readonly<{} & { enabled: boolean; }>; logs: Readonly<{} & { enabled: boolean; }>; }>; }>; }" + "{ readonly annotations: Readonly<{} & { enabled: boolean; index: string; }>; readonly unsafe: Readonly<{} & { alertDetails: Readonly<{} & { uptime: Readonly<{} & { enabled: boolean; }>; metrics: Readonly<{} & { enabled: boolean; }>; logs: Readonly<{} & { enabled: boolean; }>; }>; }>; }" ], "path": "x-pack/plugins/observability/server/index.ts", "deprecated": false, @@ -10794,7 +11053,79 @@ "label": "ObservabilityServerRouteRepository", "description": [], "signature": [ - "{ \"PUT /api/observability/slos/{id}\": ", + "{ \"GET /internal/observability/slos/{id}/_diagnosis\": ", + { + "pluginId": "@kbn/server-route-repository", + "scope": "common", + "docId": "kibKbnServerRouteRepositoryPluginApi", + "section": "def-common.ServerRoute", + "text": "ServerRoute" + }, + "<\"GET /internal/observability/slos/{id}/_diagnosis\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ id: ", + "StringC", + "; }>; }>, ", + { + "pluginId": "observability", + "scope": "server", + "docId": "kibObservabilityPluginApi", + "section": "def-server.ObservabilityRouteHandlerResources", + "text": "ObservabilityRouteHandlerResources" + }, + ", { sloResources: { [x: string]: string; \"slo-observability.sli\": string; \"slo-observability.sli-mappings\": string; \"slo-observability.sli-settings\": string; }; sloSavedObject: string | ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; settings: { timestampField: string; syncDelay: string; frequency: string; }; revision: number; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }>; sloTransformStats: ", + "TransformGetTransformStatsResponse", + "; dataSample: string | ", + "SearchResponse", + ">; }, ", + { + "pluginId": "observability", + "scope": "server", + "docId": "kibObservabilityPluginApi", + "section": "def-server.ObservabilityRouteCreateOptions", + "text": "ObservabilityRouteCreateOptions" + }, + ">; \"GET /internal/observability/slos/_diagnosis\": ", + { + "pluginId": "@kbn/server-route-repository", + "scope": "common", + "docId": "kibKbnServerRouteRepositoryPluginApi", + "section": "def-common.ServerRoute", + "text": "ServerRoute" + }, + "<\"GET /internal/observability/slos/_diagnosis\", undefined, ", + { + "pluginId": "observability", + "scope": "server", + "docId": "kibObservabilityPluginApi", + "section": "def-server.ObservabilityRouteHandlerResources", + "text": "ObservabilityRouteHandlerResources" + }, + ", { licenseAndFeatures: ", + "PublicLicenseJSON", + "; userPrivileges: ", + "SecurityGetUserPrivilegesResponse", + "; sloResources: { [x: string]: string; \"slo-observability.sli\": string; \"slo-observability.sli-mappings\": string; \"slo-observability.sli-settings\": string; }; }, ", + { + "pluginId": "observability", + "scope": "server", + "docId": "kibObservabilityPluginApi", + "section": "def-server.ObservabilityRouteCreateOptions", + "text": "ObservabilityRouteCreateOptions" + }, + ">; \"PUT /api/observability/slos/{id}\": ", { "pluginId": "@kbn/server-route-repository", "scope": "common", @@ -10850,11 +11181,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -10888,7 +11219,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -10902,9 +11235,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -11002,7 +11333,11 @@ "section": "def-common.Duration", "text": "Duration" }, - ", string, unknown>; }>; }>; }>, ", + ", string, unknown>; }>; tags: ", + "ArrayC", + "<", + "StringC", + ">; }>; }>, ", { "pluginId": "observability", "scope": "server", @@ -11010,7 +11345,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; } & { index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; tags: string[]; createdAt: string; updatedAt: string; }, ", { "pluginId": "observability", "scope": "server", @@ -11040,7 +11375,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; } & { index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; 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", @@ -11088,7 +11423,7 @@ "section": "def-server.ObservabilityRouteHandlerResources", "text": "ObservabilityRouteHandlerResources" }, - ", { page: number; perPage: number; total: number; results: ({ id: string; name: string; description: string; indicator: { type: \"sli.apm.transactionDuration\"; params: { environment: string; service: string; transactionType: string; transactionName: string; threshold: number; } & { index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.apm.transactionErrorRate\"; params: { environment: string; service: string; transactionType: string; transactionName: string; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; index?: string | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; syncDelay: string; frequency: string; }; enabled: boolean; 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; } & { goodStatusCodes?: (\"2xx\" | \"3xx\" | \"4xx\" | \"5xx\")[] | undefined; filter?: string | undefined; }; } | { type: \"sli.kql.custom\"; params: { index: string; filter: string; good: string; total: string; }; }; timeWindow: { duration: string; isRolling: boolean; } | { duration: string; calendar: { startTime: string; }; }; budgetingMethod: \"occurrences\" | \"timeslices\"; objective: { target: number; } & { timesliceTarget?: number | undefined; timesliceWindow?: string | undefined; }; revision: number; settings: { timestampField: string; 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", @@ -11272,11 +11607,11 @@ "StringC", "]>; threshold: ", "NumberC", + "; index: ", + "StringC", "; }>, ", "PartialC", - "<{ index: ", - "StringC", - "; filter: ", + "<{ filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -11310,7 +11645,9 @@ "LiteralC", "<\"*\">, ", "StringC", - "]>; }>, ", + "]>; index: ", + "StringC", + "; }>, ", "PartialC", "<{ goodStatusCodes: ", "ArrayC", @@ -11324,9 +11661,7 @@ "LiteralC", "<\"4xx\">, ", "LiteralC", - "<\"5xx\">]>>; index: ", - "StringC", - "; filter: ", + "<\"5xx\">]>>; filter: ", "StringC", "; }>]>; }>, ", "TypeC", @@ -11426,7 +11761,11 @@ "section": "def-common.Duration", "text": "Duration" }, - ", string, unknown>; }>; }>]>; }>, ", + ", string, unknown>; }>; tags: ", + "ArrayC", + "<", + "StringC", + ">; }>]>; }>, ", { "pluginId": "observability", "scope": "server", @@ -13620,7 +13959,7 @@ "label": "ObservabilityPluginSetup", "description": [], "signature": [ - "{ getAlertDetailsConfig(): Readonly<{} & { uptime: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; metrics: Readonly<{} & { enabled: boolean; }>; logs: Readonly<{} & { enabled: boolean; }>; }>; getScopedAnnotationsClient: (requestContext: ", + "{ getAlertDetailsConfig(): Readonly<{} & { uptime: Readonly<{} & { enabled: boolean; }>; metrics: Readonly<{} & { enabled: boolean; }>; logs: Readonly<{} & { enabled: boolean; }>; }>; getScopedAnnotationsClient: (requestContext: ", { "pluginId": "@kbn/core-http-request-handler-context-server", "scope": "common", diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index 1e55f29e92627..050ae064c0c3b 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-03-09 +date: 2023-03-21 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 | |-------------------|-----------|------------------------|-----------------| -| 640 | 44 | 634 | 34 | +| 652 | 44 | 646 | 34 | ## Client diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index cbb0d2e7bb81e..cbff3603770f6 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-03-09 +date: 2023-03-21 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 9a71f35ab5c81..d88fc596f81d4 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -15,13 +15,13 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Count | Plugins or Packages with a
public API | Number of teams | |--------------|----------|------------------------| -| 577 | 473 | 38 | +| 582 | 477 | 39 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 68002 | 516 | 58695 | 1239 | +| 68211 | 517 | 58885 | 1288 | ## Plugin Directory @@ -30,12 +30,13 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 259 | 8 | 254 | 26 | | | [@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. | 12 | 0 | 1 | 2 | -| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 531 | 1 | 515 | 40 | -| | [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) | The user interface for Elastic APM | 42 | 0 | 42 | 65 | +| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 550 | 1 | 531 | 42 | +| | [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) | The user interface for Elastic APM | 42 | 0 | 42 | 108 | +| | @jasonrhodes | 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. | 89 | 1 | 74 | 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 | 94 | 0 | 77 | 28 | +| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | The Case management system in Kibana | 96 | 0 | 79 | 30 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 270 | 16 | 255 | 9 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 41 | 0 | 11 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | Chat available on Elastic Cloud deployments for quicker assistance. | 1 | 0 | 0 | 0 | @@ -47,14 +48,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | cloudLinks | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | Adds the links to the Elastic Cloud console | 0 | 0 | 0 | 0 | | | [@elastic/kibana-cloud-security-posture](https://github.com/orgs/elastic/teams/kibana-cloud-security-posture) | The cloud security posture plugin | 17 | 0 | 2 | 2 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 13 | 0 | 13 | 1 | -| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Content management app | 110 | 0 | 96 | 3 | +| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Content management app | 118 | 0 | 104 | 4 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 272 | 0 | 268 | 11 | | crossClusterReplication | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | | customBranding | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Enables customization of Kibana | 0 | 0 | 0 | 0 | -| | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 107 | 0 | 88 | 1 | +| | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 175 | 0 | 156 | 1 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 188 | 0 | 179 | 12 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | - | 54 | 0 | 51 | 0 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3282 | 119 | 2586 | 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. | 3273 | 119 | 2577 | 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 | @@ -90,7 +91,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. | 214 | 0 | 10 | 5 | | | [@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) | - | 1094 | 3 | 989 | 27 | +| | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1096 | 3 | 991 | 27 | | 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 | @@ -127,7 +128,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 34 | 0 | 34 | 2 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 17 | 0 | 17 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 2 | 0 | 2 | 1 | -| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 640 | 44 | 634 | 34 | +| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 652 | 44 | 646 | 34 | | | [@elastic/security-defend-workflows](https://github.com/orgs/elastic/teams/security-defend-workflows) | - | 24 | 0 | 24 | 6 | | painlessLab | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 202 | 7 | 146 | 12 | @@ -146,8 +147,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@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 | 4 | | 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. | 278 | 0 | 94 | 0 | -| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | - | 117 | 0 | 77 | 28 | +| | [@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. | 280 | 0 | 94 | 0 | +| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | - | 118 | 0 | 77 | 28 | | | [@elastic/awp-viz](https://github.com/orgs/elastic/teams/awp-viz) | - | 7 | 0 | 7 | 1 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Adds URL Service and sharing capabilities to Kibana | 118 | 0 | 59 | 10 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 22 | 1 | 22 | 1 | @@ -173,7 +174,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | upgradeAssistant | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 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 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 12 | 0 | 12 | 0 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 58 | 0 | 15 | 1 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 55 | 0 | 16 | 2 | | | [@elastic/uptime](https://github.com/orgs/elastic/teams/uptime) | - | 2 | 0 | 2 | 0 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | The default editor used in most aggregation-based visualizations. | 59 | 0 | 52 | 3 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Contains the gauge chart implementation using the elastic-charts library. The goal is to eventually deprecate the old implementation and keep only this. Until then, the library used is defined by the Legacy charts library advanced setting. | 7 | 0 | 7 | 2 | @@ -271,9 +272,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@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) | - | 5 | 0 | 2 | 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) | - | 16 | 0 | 12 | 1 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 22 | 0 | 13 | 1 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 37 | 1 | 33 | 0 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 103 | 0 | 53 | 0 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 108 | 0 | 54 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 37 | 0 | 33 | 3 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 15 | 1 | 15 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 4 | 1 | @@ -327,7 +328,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 6 | 0 | 0 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 3 | 1 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 5 | 0 | 5 | 0 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 35 | 4 | 23 | 0 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 39 | 4 | 27 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 32 | 0 | 11 | 2 | | | [@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) | - | 63 | 0 | 37 | 0 | @@ -438,6 +439,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 2 | 0 | 1 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 31 | 1 | 24 | 1 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 71 | 0 | 69 | 3 | +| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 53 | 1 | 48 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 45 | 0 | 45 | 10 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 51 | 5 | 34 | 0 | | | [@elastic/security-asset-management](https://github.com/orgs/elastic/teams/security-asset-management) | - | 62 | 0 | 62 | 0 | @@ -451,6 +453,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 6 | 0 | 6 | 1 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 13 | 2 | 8 | 0 | | | [@elastic/security-detections-response](https://github.com/orgs/elastic/teams/security-detections-response) | - | 101 | 0 | 98 | 0 | +| | [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) | - | 30 | 0 | 30 | 0 | +| | [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) | - | 2 | 0 | 0 | 0 | | | [@elastic/security-solution-platform](https://github.com/orgs/elastic/teams/security-solution-platform) | - | 56 | 1 | 41 | 1 | | | [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) | - | 341 | 1 | 337 | 32 | | | [@elastic/security-solution-platform](https://github.com/orgs/elastic/teams/security-solution-platform) | - | 67 | 0 | 61 | 1 | @@ -509,7 +513,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) | - | 75 | 0 | 75 | 0 | +| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 78 | 0 | 78 | 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) | - | 97 | 1 | 64 | 1 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 4 | 0 | 2 | 0 | @@ -525,7 +529,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 45 | 0 | 36 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 7 | 0 | 6 | 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) | - | 35 | 0 | 15 | 1 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 36 | 0 | 15 | 1 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 2 | 0 | 2 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 24 | 0 | 14 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 6 | 0 | 2 | 0 | diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index 57711209c35a9..f52f39e2a12ae 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] --- import presentationUtilObj from './presentation_util.devdocs.json'; diff --git a/api_docs/profiling.mdx b/api_docs/profiling.mdx index 87288293bf7d8..6406271d952e7 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'profiling'] --- import profilingObj from './profiling.devdocs.json'; diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index 2e68530ec647e..b52d594879f97 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-03-09 +date: 2023-03-21 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 2733cbd876970..b3f8cd19e5c00 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting'] --- import reportingObj from './reporting.devdocs.json'; diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx index aace62a20534e..3180318131311 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup'] --- import rollupObj from './rollup.devdocs.json'; diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index 7ec99d35dc4d1..afd81f59928f6 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-03-09 +date: 2023-03-21 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 2d90a880b13b0..4005150a3333f 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-03-09 +date: 2023-03-21 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 10fc4017b46f6..a2901fbdc0590 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-03-09 +date: 2023-03-21 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 a76665b9579ac..9478650c48c52 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-03-09 +date: 2023-03-21 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 62057eb5bdb1c..ebff28150cd2c 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; children?: React.ReactNode; description?: string | undefined; is?: string | undefined; title?: string | undefined; abbr?: string | undefined; footer?: string | React.ReactElement> | ((props: ", + "{ prefix?: string | undefined; scope?: string | undefined; id?: string | undefined; defaultValue?: string | number | readonly string[] | undefined; name: React.ReactNode; children?: React.ReactNode; description?: string | undefined; is?: string | undefined; title?: string | undefined; security?: string | undefined; abbr?: string | undefined; footer?: string | React.ReactElement> | ((props: ", "EuiTableFooterProps", "<", { @@ -308,7 +308,7 @@ "Interpolation", "<", "Theme", - ">; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; hidden?: boolean | undefined; lang?: string | undefined; placeholder?: string | undefined; spellCheck?: Booleanish | undefined; tabIndex?: number | 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; security?: string | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"search\" | \"none\" | \"text\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | 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-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; onChange?: React.FormEventHandler | 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; field: (string & {}) | keyof ", + ">; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; hidden?: boolean | undefined; lang?: string | undefined; placeholder?: string | undefined; spellCheck?: Booleanish | undefined; tabIndex?: number | 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\" | \"tel\" | \"url\" | \"email\" | \"numeric\" | \"decimal\" | 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-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; onChange?: React.FormEventHandler | 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; width?: string | undefined; field: (string & {}) | keyof ", { "pluginId": "savedObjectsManagement", "scope": "public", @@ -316,7 +316,7 @@ "section": "def-public.SavedObjectsManagementRecord", "text": "SavedObjectsManagementRecord" }, - "; width?: string | undefined; headers?: string | undefined; height?: string | number | undefined; readOnly?: boolean | undefined; render?: ((value: any, record: ", + "; headers?: string | undefined; height?: string | number | undefined; readOnly?: boolean | undefined; render?: ((value: any, record: ", { "pluginId": "savedObjectsManagement", "scope": "public", diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx index 1970bd4a1ca5c..e12284ff34dfd 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-03-09 +date: 2023-03-21 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 35d1080f9eea4..8ec9adb23bc4d 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-03-09 +date: 2023-03-21 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 cc8b7ddab7ec0..f25c51527c921 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss'] --- import savedObjectsTaggingOssObj from './saved_objects_tagging_oss.devdocs.json'; diff --git a/api_docs/saved_search.mdx b/api_docs/saved_search.mdx index 96844dfed02f4..d539ed854ceb0 100644 --- a/api_docs/saved_search.mdx +++ b/api_docs/saved_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedSearch title: "savedSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the savedSearch plugin -date: 2023-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedSearch'] --- import savedSearchObj from './saved_search.devdocs.json'; diff --git a/api_docs/screenshot_mode.mdx b/api_docs/screenshot_mode.mdx index 01e3438419254..2401609647b37 100644 --- a/api_docs/screenshot_mode.mdx +++ b/api_docs/screenshot_mode.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/screenshotMode title: "screenshotMode" image: https://source.unsplash.com/400x175/?github description: API docs for the screenshotMode plugin -date: 2023-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode'] --- import screenshotModeObj from './screenshot_mode.devdocs.json'; diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx index 1f1ccd969d9e8..7190452c022e8 100644 --- a/api_docs/screenshotting.mdx +++ b/api_docs/screenshotting.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/screenshotting title: "screenshotting" image: https://source.unsplash.com/400x175/?github description: API docs for the screenshotting plugin -date: 2023-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting'] --- import screenshottingObj from './screenshotting.devdocs.json'; diff --git a/api_docs/security.devdocs.json b/api_docs/security.devdocs.json index 6416e926dce7a..3c47006b075ed 100644 --- a/api_docs/security.devdocs.json +++ b/api_docs/security.devdocs.json @@ -1676,6 +1676,38 @@ "path": "x-pack/plugins/security/server/audit/audit_events.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "security", + "id": "def-server.AuditKibana.unauthorized_spaces", + "type": "Object", + "tags": [], + "label": "unauthorized_spaces", + "description": [ + "\nSet of space IDs that are not authorized for an action." + ], + "signature": [ + "readonly string[] | undefined" + ], + "path": "x-pack/plugins/security/server/audit/audit_events.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "security", + "id": "def-server.AuditKibana.unauthorized_types", + "type": "Object", + "tags": [], + "label": "unauthorized_types", + "description": [ + "\nSet of types that are not authorized for an action." + ], + "signature": [ + "readonly string[] | undefined" + ], + "path": "x-pack/plugins/security/server/audit/audit_events.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false diff --git a/api_docs/security.mdx b/api_docs/security.mdx index 6f57323904bd3..4ba2d55ee89a3 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-03-09 +date: 2023-03-21 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 | |-------------------|-----------|------------------------|-----------------| -| 278 | 0 | 94 | 0 | +| 280 | 0 | 94 | 0 | ## Client diff --git a/api_docs/security_solution.devdocs.json b/api_docs/security_solution.devdocs.json index eea2346c4e160..e57e6f3186b1a 100644 --- a/api_docs/security_solution.devdocs.json +++ b/api_docs/security_solution.devdocs.json @@ -2097,7 +2097,25 @@ "functions": [], "interfaces": [], "enums": [], - "misc": [], + "misc": [ + { + "parentPluginId": "securitySolution", + "id": "def-common.ELASTIC_SECURITY_RULE_ID", + "type": "string", + "tags": [], + "label": "ELASTIC_SECURITY_RULE_ID", + "description": [ + "\nRule signature id (`rule.rule_id`) of the prebuilt \"Endpoint Security\" rule." + ], + "signature": [ + "\"9a1a2dae-0b5f-4c3d-8305-a268d404c306\"" + ], + "path": "x-pack/plugins/security_solution/common/detection_engine/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], "objects": [] } } \ No newline at end of file diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index 867cae72d28a2..985a66dad44d7 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-03-09 +date: 2023-03-21 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 | |-------------------|-----------|------------------------|-----------------| -| 117 | 0 | 77 | 28 | +| 118 | 0 | 77 | 28 | ## Client @@ -51,3 +51,8 @@ Contact [@elastic/security-solution](https://github.com/orgs/elastic/teams/secur ### Consts, variables and types +## Common + +### Consts, variables and types + + diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index 6dfa36814034d..a2064c4974998 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-03-09 +date: 2023-03-21 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 8bbc341f79d5e..ff3a3ce4f236e 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-03-09 +date: 2023-03-21 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 205d50605a5c3..6f262235565f5 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-03-09 +date: 2023-03-21 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 4443f77a61eea..595eb0f684759 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-03-09 +date: 2023-03-21 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 5087b3499d02b..548865352f686 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-03-09 +date: 2023-03-21 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 3f0b9d89b931d..24177f36d01b7 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackConnectors'] --- import stackConnectorsObj from './stack_connectors.devdocs.json'; diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index 8dd6e53abd6e5..a7648a2a5eb05 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] --- import taskManagerObj from './task_manager.devdocs.json'; diff --git a/api_docs/telemetry.devdocs.json b/api_docs/telemetry.devdocs.json index cca1ac23391c3..38561db5d5a0e 100644 --- a/api_docs/telemetry.devdocs.json +++ b/api_docs/telemetry.devdocs.json @@ -617,7 +617,7 @@ "When the data comes from a matching index-pattern, the name of the pattern" ], "signature": [ - "\"search\" | \"apm\" | \"logstash\" | \"metricbeat\" | \"enterprise-search\" | \"app-search\" | \"magento2\" | \"magento\" | \"shopify\" | \"wordpress\" | \"drupal\" | \"joomla\" | \"sharepoint\" | \"squarespace\" | \"sitecore\" | \"weebly\" | \"acquia\" | \"filebeat\" | \"functionbeat\" | \"heartbeat\" | \"fluentd\" | \"telegraf\" | \"prometheusbeat\" | \"fluentbit\" | \"nginx\" | \"apache\" | \"endgame\" | \"logs-endpoint\" | \"metrics-endpoint\" | \"siem-signals\" | \"auditbeat\" | \"winlogbeat\" | \"packetbeat\" | \"tomcat\" | \"artifactory\" | \"aruba\" | \"barracuda\" | \"bluecoat\" | \"arcsight\" | \"checkpoint\" | \"cisco\" | \"citrix\" | \"cyberark\" | \"cylance\" | \"fireeye\" | \"fortinet\" | \"infoblox\" | \"kaspersky\" | \"mcafee\" | \"paloaltonetworks\" | \"rsa\" | \"snort\" | \"sonicwall\" | \"sophos\" | \"squid\" | \"symantec\" | \"tippingpoint\" | \"trendmicro\" | \"tripwire\" | \"zscaler\" | \"zeek\" | \"sigma_doc\" | \"ecs-corelight\" | \"suricata\" | \"wazuh\" | \"meow\" | \"host_risk_score\" | \"user_risk_score\" | undefined" + "\"search\" | \"logstash\" | \"apm\" | \"metricbeat\" | \"enterprise-search\" | \"app-search\" | \"magento2\" | \"magento\" | \"shopify\" | \"wordpress\" | \"drupal\" | \"joomla\" | \"sharepoint\" | \"squarespace\" | \"sitecore\" | \"weebly\" | \"acquia\" | \"filebeat\" | \"functionbeat\" | \"heartbeat\" | \"fluentd\" | \"telegraf\" | \"prometheusbeat\" | \"fluentbit\" | \"nginx\" | \"apache\" | \"endgame\" | \"logs-endpoint\" | \"metrics-endpoint\" | \"siem-signals\" | \"auditbeat\" | \"winlogbeat\" | \"packetbeat\" | \"tomcat\" | \"artifactory\" | \"aruba\" | \"barracuda\" | \"bluecoat\" | \"arcsight\" | \"checkpoint\" | \"cisco\" | \"citrix\" | \"cyberark\" | \"cylance\" | \"fireeye\" | \"fortinet\" | \"infoblox\" | \"kaspersky\" | \"mcafee\" | \"paloaltonetworks\" | \"rsa\" | \"snort\" | \"sonicwall\" | \"sophos\" | \"squid\" | \"symantec\" | \"tippingpoint\" | \"trendmicro\" | \"tripwire\" | \"zscaler\" | \"zeek\" | \"sigma_doc\" | \"ecs-corelight\" | \"suricata\" | \"wazuh\" | \"meow\" | \"host_risk_score\" | \"user_risk_score\" | undefined" ], "path": "src/plugins/telemetry/server/telemetry_collection/get_data_telemetry/get_data_telemetry.ts", "deprecated": false, diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index d36a0ae8995ba..93981db11812b 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetry'] --- import telemetryObj from './telemetry.devdocs.json'; diff --git a/api_docs/telemetry_collection_manager.devdocs.json b/api_docs/telemetry_collection_manager.devdocs.json index d8070080a2028..635e474590ff3 100644 --- a/api_docs/telemetry_collection_manager.devdocs.json +++ b/api_docs/telemetry_collection_manager.devdocs.json @@ -262,33 +262,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -670,7 +644,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -848,7 +824,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -874,7 +852,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -1138,6 +1136,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index a24c82df4d2ec..83f39699616c9 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-03-09 +date: 2023-03-21 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 52c9f7dd21c90..ae3a2f625d684 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-03-09 +date: 2023-03-21 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 9e0333ef03f7a..933bb228be59f 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection'] --- import telemetryManagementSectionObj from './telemetry_management_section.devdocs.json'; diff --git a/api_docs/threat_intelligence.mdx b/api_docs/threat_intelligence.mdx index edee90eb53682..384cf2f90517b 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-03-09 +date: 2023-03-21 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 e42e600471a65..2cc9a92f16706 100644 --- a/api_docs/timelines.devdocs.json +++ b/api_docs/timelines.devdocs.json @@ -2996,7 +2996,7 @@ "label": "language", "description": [], "signature": [ - "\"kuery\" | \"eql\" | \"lucene\"" + "\"eql\" | \"kuery\" | \"lucene\"" ], "path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts", "deprecated": false, @@ -4155,7 +4155,7 @@ "label": "EntityType", "description": [], "signature": [ - "\"alerts\" | \"events\" | \"sessions\"" + "\"alerts\" | \"sessions\" | \"events\"" ], "path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/index.ts", "deprecated": false, diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index eb8be4196ad5b..b7ad979d99825 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-03-09 +date: 2023-03-21 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 354c9ba330297..8dc4b116a306d 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-03-09 +date: 2023-03-21 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 791444d2576da..2feb1e2a00e3d 100644 --- a/api_docs/triggers_actions_ui.devdocs.json +++ b/api_docs/triggers_actions_ui.devdocs.json @@ -4590,7 +4590,7 @@ "label": "setRuleProperty", "description": [], "signature": [ - "(key: Prop, value: ", + "(key: Prop, value: ", "SanitizedRule", "[Prop] | null) => void" ], @@ -7032,10 +7032,10 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddAlertFlyout", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddRuleFlyout", "type": "Function", "tags": [], - "label": "getAddAlertFlyout", + "label": "getAddRuleFlyout", "description": [], "signature": [ "(props: Omit<", @@ -7050,7 +7050,7 @@ "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddAlertFlyout.$1", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddRuleFlyout.$1", "type": "Object", "tags": [], "label": "props", @@ -7070,10 +7070,10 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditAlertFlyout", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditRuleFlyout", "type": "Function", "tags": [], - "label": "getEditAlertFlyout", + "label": "getEditRuleFlyout", "description": [], "signature": [ "(props: Omit<", @@ -7088,7 +7088,7 @@ "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditAlertFlyout.$1", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditRuleFlyout.$1", "type": "Object", "tags": [], "label": "props", diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index 63c37d77d32c6..e60f6e4075703 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi'] --- import triggersActionsUiObj from './triggers_actions_ui.devdocs.json'; diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index 97833531b0352..5df8f9ff8d12c 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-03-09 +date: 2023-03-21 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 c8e94d708e6f7..d2c459df44a54 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] --- import uiActionsEnhancedObj from './ui_actions_enhanced.devdocs.json'; diff --git a/api_docs/unified_field_list.mdx b/api_docs/unified_field_list.mdx index c0afb2cdc8cda..7d747ec3a4676 100644 --- a/api_docs/unified_field_list.mdx +++ b/api_docs/unified_field_list.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedFieldList title: "unifiedFieldList" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedFieldList plugin -date: 2023-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedFieldList'] --- import unifiedFieldListObj from './unified_field_list.devdocs.json'; diff --git a/api_docs/unified_histogram.mdx b/api_docs/unified_histogram.mdx index a3b26f715a8b9..cc468f360ed05 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedHistogram'] --- import unifiedHistogramObj from './unified_histogram.devdocs.json'; diff --git a/api_docs/unified_search.devdocs.json b/api_docs/unified_search.devdocs.json index 5ae3455e2cbad..a1a6e6639b6a6 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" }, - ", \"filters\" | \"indexPatterns\" | \"readOnly\" | \"onFiltersUpdated\" | \"hiddenPanelOptions\" | \"timeRangeForSuggestionsOverride\"> & React.RefAttributes & React.RefAttributes, any, any>>) => JSX.Element" + ", \"indexPatterns\" | \"filters\" | \"readOnly\" | \"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" }, - ", \"filters\" | \"indexPatterns\" | \"readOnly\" | \"onFiltersUpdated\" | \"hiddenPanelOptions\" | \"timeRangeForSuggestionsOverride\"> & React.RefAttributes & React.RefAttributes, any, any>>" + ", \"indexPatterns\" | \"filters\" | \"readOnly\" | \"onFiltersUpdated\" | \"hiddenPanelOptions\" | \"timeRangeForSuggestionsOverride\">, any, any>>" ], "path": "src/plugins/unified_search/public/filter_bar/index.tsx", "deprecated": false, @@ -359,7 +359,15 @@ "label": "props", "description": [], "signature": [ - "{ placeholder?: string | undefined; query?: ", + "{ indexPatterns?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[] | undefined; placeholder?: string | undefined; query?: ", { "pluginId": "@kbn/es-query", "scope": "common", @@ -377,15 +385,7 @@ "section": "def-common.Filter", "text": "Filter" }, - "[] | undefined; dataTestSubj?: string | undefined; isLoading?: boolean | undefined; indexPatterns?: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[] | undefined; isDisabled?: boolean | undefined; timeHistory?: ", + "[] | undefined; dataTestSubj?: string | undefined; isLoading?: boolean | undefined; isDisabled?: boolean | undefined; timeHistory?: ", { "pluginId": "data", "scope": "public", diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx index a55e210f159a5..f03b45e571aaf 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch'] --- import unifiedSearchObj from './unified_search.devdocs.json'; diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx index 3d19073fa751d..be80cc98f0867 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] --- import unifiedSearchAutocompleteObj from './unified_search_autocomplete.devdocs.json'; diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index 74131e655a950..b2338a8bf0373 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'urlForwarding'] --- import urlForwardingObj from './url_forwarding.devdocs.json'; diff --git a/api_docs/usage_collection.devdocs.json b/api_docs/usage_collection.devdocs.json index 2cfbf801d371e..c5fdd2f02bf44 100644 --- a/api_docs/usage_collection.devdocs.json +++ b/api_docs/usage_collection.devdocs.json @@ -531,33 +531,7 @@ "ExistsRequest", ", options?: ", "TransportRequestOptions", - " | undefined): Promise; }; security: ", - "default", - "; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; nodes: ", - "default", - "; indices: ", - "default", - "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + " | undefined): Promise; }; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "default", "; child: (opts: ", "ClientOptions", @@ -939,7 +913,9 @@ "TransportRequestOptions", " | undefined): Promise<", "WriteResponseBase", - ">; }; info: { (this: That, params?: ", + ">; }; indices: ", + "default", + "; info: { (this: That, params?: ", "InfoRequest", " | ", "InfoRequest", @@ -1117,7 +1093,9 @@ "TransportRequestOptions", " | undefined): Promise<", "MtermvectorsResponse", - ">; }; openPointInTime: { (this: That, params: ", + ">; }; nodes: ", + "default", + "; openPointInTime: { (this: That, params: ", "OpenPointInTimeRequest", " | ", "OpenPointInTimeRequest", @@ -1143,7 +1121,27 @@ "TransportRequestOptions", " | undefined): Promise<", "OpenPointInTimeResponse", - ">; }; putScript: { (this: That, params: ", + ">; }; ping: { (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + ">; (this: That, params?: ", + "PingRequest", + " | ", + "PingRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise; }; putScript: { (this: That, params: ", "PutScriptRequest", " | ", "PutScriptRequest", @@ -1407,6 +1405,8 @@ "SearchTemplateResponse", ">; }; searchableSnapshots: ", "default", + "; security: ", + "default", "; shutdown: ", "default", "; slm: ", @@ -1696,67 +1696,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "usageCollection", - "id": "def-server.IncrementCounterParams", - "type": "Interface", - "tags": [], - "label": "IncrementCounterParams", - "description": [ - "\nDetails about the counter to be incremented" - ], - "path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "usageCollection", - "id": "def-server.IncrementCounterParams.counterName", - "type": "string", - "tags": [], - "label": "counterName", - "description": [ - "The name of the counter" - ], - "path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "usageCollection", - "id": "def-server.IncrementCounterParams.counterType", - "type": "string", - "tags": [], - "label": "counterType", - "description": [ - "The counter type (\"count\" by default)" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "usageCollection", - "id": "def-server.IncrementCounterParams.incrementBy", - "type": "number", - "tags": [], - "label": "incrementBy", - "description": [ - "Increment the counter by this number (1 if not specified)" - ], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "usageCollection", "id": "def-server.IUsageCounter", @@ -1781,13 +1720,7 @@ ], "signature": [ "(params: ", - { - "pluginId": "usageCollection", - "scope": "server", - "docId": "kibUsageCollectionPluginApi", - "section": "def-server.IncrementCounterParams", - "text": "IncrementCounterParams" - }, + "IncrementCounterParams", ") => void" ], "path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts", @@ -1804,13 +1737,7 @@ "{@link IncrementCounterParams }" ], "signature": [ - { - "pluginId": "usageCollection", - "scope": "server", - "docId": "kibUsageCollectionPluginApi", - "section": "def-server.IncrementCounterParams", - "text": "IncrementCounterParams" - } + "IncrementCounterParams" ], "path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts", "deprecated": false, @@ -2000,6 +1927,18 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "usageCollection", + "id": "def-server.IncrementCounterParams", + "type": "Type", + "tags": [], + "label": "IncrementCounterParams", + "description": [], + "path": "src/plugins/usage_collection/server/usage_counters/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "usageCollection", "id": "def-server.MakeSchemaFrom", diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx index c378a7e609215..edf5948e085e8 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'usageCollection'] --- import usageCollectionObj from './usage_collection.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 | |-------------------|-----------|------------------------|-----------------| -| 58 | 0 | 15 | 1 | +| 55 | 0 | 16 | 2 | ## Client diff --git a/api_docs/ux.mdx b/api_docs/ux.mdx index 20cc0dc720bd8..8fdc46d3c5e3c 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-03-09 +date: 2023-03-21 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 290dcb5dd6e5f..23853e90de937 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-03-09 +date: 2023-03-21 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 8642cd3628324..38d9cb7d05842 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-03-09 +date: 2023-03-21 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 7076d73d94b27..34847a2ec553f 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-03-09 +date: 2023-03-21 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 4e144af35077a..69799fc6383eb 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-03-09 +date: 2023-03-21 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 f68cd179dc365..4293834a35115 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-03-09 +date: 2023-03-21 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 03eef9d5bea57..70920f3e82aa4 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-03-09 +date: 2023-03-21 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 fd8d512b5d66b..cd826a82be4b6 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-03-09 +date: 2023-03-21 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 13c79d84a5563..04f6fdb82c198 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-03-09 +date: 2023-03-21 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 b38bf91be2d4e..12158c63d458e 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-03-09 +date: 2023-03-21 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 5308bf58d21c7..91b7094dced4a 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] --- import visTypeXyObj from './vis_type_xy.devdocs.json'; diff --git a/api_docs/visualizations.devdocs.json b/api_docs/visualizations.devdocs.json index 06dd95c48d277..91f6ff2cb98a6 100644 --- a/api_docs/visualizations.devdocs.json +++ b/api_docs/visualizations.devdocs.json @@ -12503,7 +12503,7 @@ "label": "yLeftScale", "description": [], "signature": [ - "\"log\" | \"time\" | \"sqrt\" | \"linear\" | undefined" + "\"log\" | \"time\" | \"linear\" | \"sqrt\" | undefined" ], "path": "src/plugins/visualizations/common/convert_to_lens/types/configurations.ts", "deprecated": false, @@ -12517,7 +12517,7 @@ "label": "yRightScale", "description": [], "signature": [ - "\"log\" | \"time\" | \"sqrt\" | \"linear\" | undefined" + "\"log\" | \"time\" | \"linear\" | \"sqrt\" | undefined" ], "path": "src/plugins/visualizations/common/convert_to_lens/types/configurations.ts", "deprecated": false, @@ -14529,7 +14529,7 @@ "label": "Operation", "description": [], "signature": [ - "\"min\" | \"max\" | \"sum\" | \"median\" | \"count\" | \"range\" | \"cumulative_sum\" | \"date_histogram\" | \"filters\" | \"terms\" | \"percentile\" | \"average\" | \"moving_average\" | \"unique_count\" | \"standard_deviation\" | \"percentile_rank\" | \"last_value\" | \"counter_rate\" | \"differences\" | \"formula\" | \"static_value\" | \"normalize_by_unit\"" + "\"min\" | \"max\" | \"sum\" | \"median\" | \"count\" | \"range\" | \"filters\" | \"date_histogram\" | \"percentile\" | \"average\" | \"terms\" | \"cumulative_sum\" | \"moving_average\" | \"unique_count\" | \"standard_deviation\" | \"percentile_rank\" | \"last_value\" | \"counter_rate\" | \"differences\" | \"formula\" | \"static_value\" | \"normalize_by_unit\"" ], "path": "src/plugins/visualizations/common/convert_to_lens/types/operations.ts", "deprecated": false, @@ -14559,7 +14559,7 @@ "label": "OperationWithSourceField", "description": [], "signature": [ - "\"min\" | \"max\" | \"sum\" | \"median\" | \"count\" | \"range\" | \"date_histogram\" | \"filters\" | \"terms\" | \"percentile\" | \"average\" | \"unique_count\" | \"standard_deviation\" | \"percentile_rank\" | \"last_value\"" + "\"min\" | \"max\" | \"sum\" | \"median\" | \"count\" | \"range\" | \"filters\" | \"date_histogram\" | \"percentile\" | \"average\" | \"terms\" | \"unique_count\" | \"standard_deviation\" | \"percentile_rank\" | \"last_value\"" ], "path": "src/plugins/visualizations/common/convert_to_lens/types/operations.ts", "deprecated": false, diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index b887f601043d1..56493abfa2122 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-03-09 +date: 2023-03-21 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] --- import visualizationsObj from './visualizations.devdocs.json'; diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index f420afb81624d..c3bef9fe0016f 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -434,6 +434,11 @@ The plugin exposes the static DefaultEditorController class to consume. |undefined +|{kib-repo}blob/{branch}/x-pack/plugins/asset_manager/README.md[assetManager] +|This plugin provides access to the asset data stored in assets-* indices, primarily +for inventory and topology purposes. + + |{kib-repo}blob/{branch}/x-pack/plugins/banners/README.md[banners] |Allow to add a header banner that will be displayed on every page of the Kibana application @@ -488,7 +493,7 @@ The plugin exposes the static DefaultEditorController class to consume. |{kib-repo}blob/{branch}/x-pack/plugins/custom_branding/README.md[customBranding] |This is a plugin to configure custom branding. -This plugin is currently under active development; do not use. +Plugin server-side only. Plugin has three main functions: |<> diff --git a/docs/user/security/session-management.asciidoc b/docs/user/security/session-management.asciidoc index 01b5693d1b0b3..d5edf66523668 100644 --- a/docs/user/security/session-management.asciidoc +++ b/docs/user/security/session-management.asciidoc @@ -57,10 +57,13 @@ To add a limit, use the `xpack.security.session.сoncurrentSessions.maxSessions` If set, the value of this option should be an integer between `1` and `1000`. When the limit is exceeded, the oldest session is automatically invalidated. +NOTE: Due to the rate at which session information is refreshed, there might be a few seconds where the concurrent session limit is not enforced. +This is something to consider for use cases where it is common to create multiple sessions simultaneously. + -- [source,yaml] -------------------------------------------------------------------------------- -xpack.security.session.сoncurrentSessions: +xpack.security.session.concurrentSessions: maxSessions: 3 -------------------------------------------------------------------------------- -- diff --git a/examples/content_management_examples/public/examples/todos/stories/todo.stories.tsx b/examples/content_management_examples/public/examples/todos/stories/todo.stories.tsx index 5b7b8f1e23823..9a37ac2816f6c 100644 --- a/examples/content_management_examples/public/examples/todos/stories/todo.stories.tsx +++ b/examples/content_management_examples/public/examples/todos/stories/todo.stories.tsx @@ -8,6 +8,7 @@ import * as React from 'react'; import { ContentClientProvider, ContentClient } from '@kbn/content-management-plugin/public'; +import { ContentTypeRegistry } from '@kbn/content-management-plugin/public/registry'; import { Todos } from '../todos'; import { TodosClient } from './todos_client'; @@ -19,6 +20,10 @@ export default { }; const todosClient = new TodosClient(); + +const contentTypeRegistry = new ContentTypeRegistry(); +contentTypeRegistry.register({ id: 'todos', version: { latest: 1 } }); + const contentClient = new ContentClient((contentType: string) => { switch (contentType) { case 'todos': @@ -27,7 +32,7 @@ const contentClient = new ContentClient((contentType: string) => { default: throw new Error(`Unknown content type: ${contentType}`); } -}); +}, contentTypeRegistry); export const SimpleTodoApp = () => ( diff --git a/examples/content_management_examples/public/examples/todos/todos.tsx b/examples/content_management_examples/public/examples/todos/todos.tsx index 84c48aa24c88b..5c3bcfd4880e9 100644 --- a/examples/content_management_examples/public/examples/todos/todos.tsx +++ b/examples/content_management_examples/public/examples/todos/todos.tsx @@ -6,7 +6,14 @@ * Side Public License, v 1. */ import React from 'react'; -import { EuiButtonGroup, EuiButtonIcon, EuiCheckbox, EuiFieldText, EuiSpacer } from '@elastic/eui'; +import { + EuiButtonGroup, + EuiButtonIcon, + EuiCheckbox, + EuiFieldText, + EuiSpacer, + EuiLoadingSpinner, +} from '@elastic/eui'; import { useCreateContentMutation, useDeleteContentMutation, @@ -55,7 +62,7 @@ const filters = [ export const Todos = () => { const [filterIdSelected, setFilterIdSelected] = React.useState('all'); - const { data, isLoading, isError, error } = useSearchTodosQuery({ + const { data, isError, error, isFetching, isLoading } = useSearchTodosQuery({ filter: filterIdSelected === 'all' ? undefined : filterIdSelected, }); @@ -63,7 +70,13 @@ export const Todos = () => { const deleteTodoMutation = useDeleteTodoMutation(); const updateTodoMutation = useUpdateTodoMutation(); - if (isLoading) return

Loading...

; + const isPending = + isFetching || + isLoading || + createTodoMutation.isLoading || + deleteTodoMutation.isLoading || + updateTodoMutation.isLoading; + if (isError) return

Error: {error}

; return ( @@ -77,46 +90,50 @@ export const Todos = () => { }} /> -
    - {data.hits.map((todo: Todo) => ( - -
  • - { - updateTodoMutation.mutate({ - contentTypeId: TODO_CONTENT_ID, - id: todo.id, - data: { - completed: e.target.checked, - }, - }); - }} - label={todo.title} - data-test-subj={`todoCheckbox todoCheckbox-${todo.id}`} - /> + {!isLoading && ( +
      + {data.hits.map((todo: Todo) => ( + +
    • + { + updateTodoMutation.mutate({ + contentTypeId: TODO_CONTENT_ID, + id: todo.id, + data: { + completed: e.target.checked, + }, + }); + }} + label={todo.title} + data-test-subj={`todoCheckbox todoCheckbox-${todo.id}`} + /> - { - deleteTodoMutation.mutate({ contentTypeId: TODO_CONTENT_ID, id: todo.id }); - }} - /> -
      • - -       - ))} -
    - + { + deleteTodoMutation.mutate({ contentTypeId: TODO_CONTENT_ID, id: todo.id }); + }} + /> +
    • + +     + ))} +
+ )} +
+ {isPending && } +
{ const inputRef = (e.target as HTMLFormElement).elements.namedItem( diff --git a/examples/content_management_examples/public/plugin.ts b/examples/content_management_examples/public/plugin.ts index 8731ef667650a..fddb1ff657c49 100644 --- a/examples/content_management_examples/public/plugin.ts +++ b/examples/content_management_examples/public/plugin.ts @@ -31,10 +31,17 @@ export class ContentManagementExamplesPlugin }, }); + contentManagement.registry.register({ + id: 'todos', + version: { + latest: 1, + }, + }); + return {}; } - public start(core: CoreStart) { + public start(core: CoreStart, deps: StartDeps) { return {}; } diff --git a/examples/content_management_examples/server/examples/todos/todos.ts b/examples/content_management_examples/server/examples/todos/todos.ts index fe8a7826be655..6addc5ed50148 100644 --- a/examples/content_management_examples/server/examples/todos/todos.ts +++ b/examples/content_management_examples/server/examples/todos/todos.ts @@ -13,20 +13,13 @@ import { } from '@kbn/content-management-plugin/server'; import { v4 } from 'uuid'; import { - createInSchema, - searchInSchema, Todo, TODO_CONTENT_ID, - updateInSchema, TodoSearchOut, TodoCreateOut, TodoUpdateOut, TodoDeleteOut, TodoGetOut, - createOutSchema, - getOutSchema, - updateOutSchema, - searchOutSchema, TodoUpdateIn, TodoSearchIn, TodoCreateIn, @@ -39,40 +32,10 @@ export const registerTodoContentType = ({ }) => { contentManagement.register({ id: TODO_CONTENT_ID, - schemas: { - content: { - create: { - in: { - data: createInSchema, - }, - out: { - result: createOutSchema, - }, - }, - update: { - in: { - data: updateInSchema, - }, - out: { - result: updateOutSchema, - }, - }, - search: { - in: { - query: searchInSchema, - }, - out: { - result: searchOutSchema, - }, - }, - get: { - out: { - result: getOutSchema, - }, - }, - }, - }, storage: new TodosStorage(), + version: { + latest: 1, + }, }); }; diff --git a/examples/controls_example/public/edit_example.tsx b/examples/controls_example/public/edit_example.tsx index d8bfd515ca7da..cf5430cad48f1 100644 --- a/examples/controls_example/public/edit_example.tsx +++ b/examples/controls_example/public/edit_example.tsx @@ -6,10 +6,12 @@ * Side Public License, v 1. */ +import { pickBy } from 'lodash'; import React, { useState } from 'react'; import { EuiButton, EuiButtonEmpty, + EuiButtonGroup, EuiFlexGroup, EuiFlexItem, EuiLoadingContent, @@ -19,8 +21,13 @@ import { EuiTitle, } from '@elastic/eui'; import { ViewMode } from '@kbn/embeddable-plugin/public'; -import { LazyControlGroupRenderer, ControlGroupContainer } from '@kbn/controls-plugin/public'; +import { + LazyControlGroupRenderer, + ControlGroupContainer, + ControlGroupInput, +} from '@kbn/controls-plugin/public'; import { withSuspense } from '@kbn/presentation-util-plugin/public'; +import { ACTION_EDIT_CONTROL, ACTION_DELETE_CONTROL } from '@kbn/controls-plugin/public'; const ControlGroupRenderer = withSuspense(LazyControlGroupRenderer); @@ -30,6 +37,27 @@ export const EditExample = () => { const [isSaving, setIsSaving] = useState(false); const [isLoading, setIsLoading] = useState(false); const [controlGroup, setControlGroup] = useState(); + const [toggleIconIdToSelectedMapIcon, setToggleIconIdToSelectedMapIcon] = useState<{ + [id: string]: boolean; + }>({}); + + function onChangeIconsMultiIcons(optionId: string) { + const newToggleIconIdToSelectedMapIcon = { + ...toggleIconIdToSelectedMapIcon, + ...{ + [optionId]: !toggleIconIdToSelectedMapIcon[optionId], + }, + }; + + if (controlGroup) { + const disabledActions: string[] = Object.keys( + pickBy(newToggleIconIdToSelectedMapIcon, (value) => value) + ); + controlGroup.updateInput({ disabledActions }); + } + + setToggleIconIdToSelectedMapIcon(newToggleIconIdToSelectedMapIcon); + } async function onSave() { setIsSaving(true); @@ -48,16 +76,20 @@ export const EditExample = () => { // simulated async load await await new Promise((resolve) => setTimeout(resolve, 1000)); - let input = {}; + let input: Partial = {}; const inputAsString = localStorage.getItem(INPUT_KEY); if (inputAsString) { try { input = JSON.parse(inputAsString); + const disabledActions = input.disabledActions ?? []; + setToggleIconIdToSelectedMapIcon({ + [ACTION_EDIT_CONTROL]: disabledActions.includes(ACTION_EDIT_CONTROL), + [ACTION_DELETE_CONTROL]: disabledActions.includes(ACTION_DELETE_CONTROL), + }); } catch (e) { // ignore parse errors } } - setIsLoading(false); return input; } @@ -72,7 +104,7 @@ export const EditExample = () => { - + { Add control + + onChangeIconsMultiIcons(id)} + /> + diff --git a/examples/files_example/public/components/app.tsx b/examples/files_example/public/components/app.tsx index dff0c5d1c9028..db0968d7b43f2 100644 --- a/examples/files_example/public/components/app.tsx +++ b/examples/files_example/public/components/app.tsx @@ -87,7 +87,7 @@ export const FilesExampleApp = ({ files, notifications }: FilesExampleAppDeps) = ) : status === 'AWAITING_UPLOAD' ? ( ) : ( - + ), }, { diff --git a/examples/files_example/public/components/confirm_button.tsx b/examples/files_example/public/components/confirm_button.tsx index b60f84b3369d0..8c328e9bb432b 100644 --- a/examples/files_example/public/components/confirm_button.tsx +++ b/examples/files_example/public/components/confirm_button.tsx @@ -30,7 +30,7 @@ export const ConfirmButtonIcon: FunctionComponent = ({ disabled={disabled} aria-label={confirmationText} color="warning" - iconType="alert" + iconType="warning" onClick={onConfirm} /> diff --git a/examples/response_stream/public/containers/app/pages/page_simple_string_stream/index.tsx b/examples/response_stream/public/containers/app/pages/page_simple_string_stream/index.tsx index a305e907cfb45..35b1cf07ed63b 100644 --- a/examples/response_stream/public/containers/app/pages/page_simple_string_stream/index.tsx +++ b/examples/response_stream/public/containers/app/pages/page_simple_string_stream/index.tsx @@ -83,7 +83,7 @@ export const PageSimpleStringStream: FC = () => {

{data}

{errors.length > 0 && ( - + {errors.length === 1 ? (

{errors[0]}

) : ( diff --git a/examples/routing_example/public/get_message_example.tsx b/examples/routing_example/public/get_message_example.tsx index 677d4cd44a7b6..47d12a6fed491 100644 --- a/examples/routing_example/public/get_message_example.tsx +++ b/examples/routing_example/public/get_message_example.tsx @@ -70,7 +70,7 @@ export function GetMessageRouteExample({ getMessageById }: Props) { {error !== undefined ? ( - + {error.message} ) : null} diff --git a/examples/routing_example/public/post_message_example.tsx b/examples/routing_example/public/post_message_example.tsx index f25ff5c369077..c60a41ca6fe81 100644 --- a/examples/routing_example/public/post_message_example.tsx +++ b/examples/routing_example/public/post_message_example.tsx @@ -82,7 +82,7 @@ export function PostMessageRouteExample({ postMessage, addSuccessToast }: Props) {error !== undefined ? ( - + {error.message} ) : null} diff --git a/examples/routing_example/public/random_number_between_example.tsx b/examples/routing_example/public/random_number_between_example.tsx index bb6f1eac20131..68bea90fd88ff 100644 --- a/examples/routing_example/public/random_number_between_example.tsx +++ b/examples/routing_example/public/random_number_between_example.tsx @@ -71,7 +71,7 @@ export function RandomNumberBetweenRouteExample({ fetchRandomNumberBetween }: Pr {error !== undefined ? ( - + {error.message} ) : null} diff --git a/examples/routing_example/public/random_number_example.tsx b/examples/routing_example/public/random_number_example.tsx index 7a2a3bf608e4b..8ae118a722b99 100644 --- a/examples/routing_example/public/random_number_example.tsx +++ b/examples/routing_example/public/random_number_example.tsx @@ -52,7 +52,7 @@ export function RandomNumberRouteExample({ fetchRandomNumber }: Props) { {error !== undefined ? ( - + {error} ) : null} diff --git a/examples/search_examples/public/search/app.tsx b/examples/search_examples/public/search/app.tsx index 01ebd4433af10..65f653f39122a 100644 --- a/examples/search_examples/public/search/app.tsx +++ b/examples/search_examples/public/search/app.tsx @@ -784,7 +784,7 @@ export const SearchExamplesApp = ({ data.search.session.start()} - iconType="alert" + iconType="warning" data-test-subj="searchExamplesStartSession" > data.search.session.clear()} - iconType="alert" + iconType="warning" data-test-subj="searchExamplesClearSession" > =2.0.0 <4.0.0", - "@types/selenium-webdriver": "^4.1.12", + "@types/selenium-webdriver": "^4.1.13", "@types/semver": "^7", "@types/set-value": "^2.0.0", "@types/sharp": "^0.30.4", diff --git a/packages/content-management/table_list/src/table_list_view.tsx b/packages/content-management/table_list/src/table_list_view.tsx index 5aa2d6e0f6e82..f397b8f2d999c 100644 --- a/packages/content-management/table_list/src/table_list_view.tsx +++ b/packages/content-management/table_list/src/table_list_view.tsx @@ -724,7 +724,7 @@ function TableListViewComp({ /> } color="danger" - iconType="alert" + iconType="warning" >

( diff --git a/packages/core/apps/core-apps-browser-internal/src/errors/error_application.tsx b/packages/core/apps/core-apps-browser-internal/src/errors/error_application.tsx index 69c257e84e1a5..32a3d83d40413 100644 --- a/packages/core/apps/core-apps-browser-internal/src/errors/error_application.tsx +++ b/packages/core/apps/core-apps-browser-internal/src/errors/error_application.tsx @@ -40,7 +40,7 @@ const ErrorPage: React.FC = ({ title, children }) => { {title}} body={children} diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/index.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/index.ts index 9f50cdee84e3f..d9b92518a39dd 100644 --- a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/index.ts +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/index.ts @@ -10,7 +10,11 @@ export { ScopedClusterClient } from './src/scoped_cluster_client'; export { ClusterClient } from './src/cluster_client'; export { configureClient } from './src/configure_client'; export { type AgentStatsProvider, AgentManager, type NetworkAgent } from './src/agent_manager'; -export { getRequestDebugMeta, getErrorMessage } from './src/log_query_and_deprecation'; +export { + type RequestDebugMeta, + getRequestDebugMeta, + getErrorMessage, +} from './src/log_query_and_deprecation'; export { PRODUCT_RESPONSE_HEADER, DEFAULT_HEADERS, diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.test.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.test.ts index 1784fa7a08662..ad86ffb10ebfd 100644 --- a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.test.ts +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.test.ts @@ -212,6 +212,7 @@ describe('configureClient', () => { logger, client, type: 'test', + apisToRedactInLogs: [], }); }); }); diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.ts index 2fd7a4d4a74bb..5f8d793b0a426 100644 --- a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.ts +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.ts @@ -45,7 +45,8 @@ export const configureClient = ( ConnectionPool: ClusterConnectionPool, }); - instrumentEsQueryAndDeprecationLogger({ logger, client, type }); + const { apisToRedactInLogs = [] } = config; + instrumentEsQueryAndDeprecationLogger({ logger, client, type, apisToRedactInLogs }); return client; }; diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.test.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.test.ts index 3b5a28eb1e016..0bf8d61e8f465 100644 --- a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.test.ts +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.test.ts @@ -96,13 +96,23 @@ describe('instrumentQueryAndDeprecationLogger', () => { } it('creates a query logger context based on the `type` parameter', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test123' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test123', + apisToRedactInLogs: [], + }); expect(logger.get).toHaveBeenCalledWith('query', 'test123'); }); describe('logs each query', () => { it('when request body is an object', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createResponseWithBody({ seq_no_primary_term: true, @@ -120,7 +130,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('when request body is a string', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createResponseWithBody( JSON.stringify({ @@ -140,7 +155,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('when request body is a buffer', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createResponseWithBody( Buffer.from( @@ -162,7 +182,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('when request body is a readable stream', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createResponseWithBody( Readable.from( @@ -184,7 +209,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('when request body is not defined', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createResponseWithBody(); @@ -196,7 +226,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('properly encode queries', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createApiResponse({ body: {}, @@ -217,7 +252,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('logs queries even in case of errors', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createApiResponse({ statusCode: 500, @@ -248,7 +288,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('logs debug when the client emits an @elastic/elasticsearch error', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createApiResponse({ body: {} }); client.diagnostic.emit('response', new errors.TimeoutError('message', response), response); @@ -259,7 +304,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('logs debug when the client emits an ResponseError returned by elasticsearch', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createApiResponse({ statusCode: 400, @@ -285,7 +335,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('logs default error info when the error response body is empty', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); let response: DiagnosticResult = createApiResponse({ statusCode: 400, @@ -325,7 +380,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('adds meta information to logs', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); let response = createApiResponse({ statusCode: 400, @@ -407,7 +467,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('logs response size', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createResponseWithBody( { @@ -432,7 +497,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { describe('deprecation warnings from response headers', () => { it('does not log when no deprecation warning header is returned', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createApiResponse({ statusCode: 200, @@ -458,7 +528,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('does not log when warning header comes from a warn-agent that is not elasticsearch', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createApiResponse({ statusCode: 200, @@ -487,7 +562,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('logs error when the client receives an Elasticsearch error response for a deprecated request originating from a user', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createApiResponse({ statusCode: 400, @@ -519,7 +599,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('logs warning when the client receives an Elasticsearch error response for a deprecated request originating from kibana', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createApiResponse({ statusCode: 400, @@ -552,7 +637,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('logs error when the client receives an Elasticsearch success response for a deprecated request originating from a user', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createApiResponse({ statusCode: 200, @@ -584,7 +674,12 @@ describe('instrumentQueryAndDeprecationLogger', () => { }); it('logs warning when the client receives an Elasticsearch success response for a deprecated request originating from kibana', () => { - instrumentEsQueryAndDeprecationLogger({ logger, client, type: 'test type' }); + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); const response = createApiResponse({ statusCode: 200, @@ -616,5 +711,287 @@ describe('instrumentQueryAndDeprecationLogger', () => { /Query:\n.*200\n.*GET \/_path\?hello\=dolly/ ); }); + + describe('Request body redaction on some APIs', () => { + it('redacts for an API in the extended list (path only)', () => { + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [{ path: '/foo' }], + }); + + const response = createApiResponse({ + body: {}, + statusCode: 200, + headers: {}, + params: { + method: 'GET', + path: '/foo', + querystring: { hello: 'dolly' }, + body: { + seq_no_primary_term: true, + query: { + term: { user: 'kimchy' }, + }, + }, + }, + }); + + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + GET /foo?hello=dolly + [redacted]" + `); + }); + + it('redacts for an API that is contained by the declared path (path only)', () => { + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [{ path: '/foo' }], + }); + + const response = createApiResponse({ + body: {}, + statusCode: 200, + headers: {}, + params: { + method: 'GET', + path: '/foo/something/something-else', + querystring: { hello: 'dolly' }, + body: { + seq_no_primary_term: true, + query: { + term: { user: 'kimchy' }, + }, + }, + }, + }); + + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + GET /foo/something/something-else?hello=dolly + [redacted]" + `); + }); + + it('redacts for an API in the extended list (method and path)', () => { + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [{ method: 'GET', path: '/foo' }], + }); + + const response = createApiResponse({ + body: {}, + statusCode: 200, + headers: {}, + params: { + method: 'GET', + path: '/foo', + querystring: { hello: 'dolly' }, + body: { + seq_no_primary_term: true, + query: { + term: { user: 'kimchy' }, + }, + }, + }, + }); + + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + GET /foo?hello=dolly + [redacted]" + `); + }); + + it('does not redact for an API in the extended list when method does not match', () => { + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [{ method: 'PUT', path: '/foo' }], + }); + + const response = createApiResponse({ + body: {}, + statusCode: 200, + headers: {}, + params: { + method: 'GET', + path: '/foo', + querystring: { hello: 'dolly' }, + body: { + seq_no_primary_term: true, + query: { + term: { user: 'kimchy' }, + }, + }, + }, + }); + + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + GET /foo?hello=dolly + {\\"seq_no_primary_term\\":true,\\"query\\":{\\"term\\":{\\"user\\":\\"kimchy\\"}}}" + `); + }); + + it('does not redact for an API in the extended list when path does not match', () => { + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [{ path: '/foo' }], + }); + + const response = createApiResponse({ + body: {}, + statusCode: 200, + headers: {}, + params: { + method: 'GET', + path: '/bar', + querystring: { hello: 'dolly' }, + body: { + seq_no_primary_term: true, + query: { + term: { user: 'kimchy' }, + }, + }, + }, + }); + + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + GET /bar?hello=dolly + {\\"seq_no_primary_term\\":true,\\"query\\":{\\"term\\":{\\"user\\":\\"kimchy\\"}}}" + `); + }); + + describe('Known list', () => { + beforeEach(() => { + instrumentEsQueryAndDeprecationLogger({ + logger, + client, + type: 'test type', + apisToRedactInLogs: [], + }); + }); + + function createResponseWithPath(path: string, method: string = '*') { + return createApiResponse({ + body: {}, + statusCode: 200, + headers: {}, + params: { + method, + path, + querystring: { hello: 'dolly' }, + body: { super_secret: 'stuff' }, + }, + }); + } + + it('[*] /_security/', () => { + const response = createResponseWithPath('/_security/something'); + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + * /_security/something?hello=dolly + [redacted]" + `); + }); + + it('[*] /_xpack/security/', () => { + const response = createResponseWithPath('/_xpack/security/something'); + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + * /_xpack/security/something?hello=dolly + [redacted]" + `); + }); + + it('[POST] /_reindex', () => { + const response = createResponseWithPath('/_reindex', 'POST'); + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + POST /_reindex?hello=dolly + [redacted]" + `); + }); + + it('[PUT] /_watcher/watch', () => { + const response = createResponseWithPath('/_watcher/watch', 'PUT'); + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + PUT /_watcher/watch?hello=dolly + [redacted]" + `); + }); + + it('[PUT] /_xpack/watcher/watch', () => { + const response = createResponseWithPath('/_xpack/watcher/watch', 'PUT'); + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + PUT /_xpack/watcher/watch?hello=dolly + [redacted]" + `); + }); + + it('[PUT] /_snapshot/something', () => { + const response = createResponseWithPath('/_snapshot/something', 'PUT'); + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + PUT /_snapshot/something?hello=dolly + [redacted]" + `); + }); + + it('[PUT] /_logstash/pipeline/something', () => { + const response = createResponseWithPath('/_logstash/pipeline/something', 'PUT'); + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + PUT /_logstash/pipeline/something?hello=dolly + [redacted]" + `); + }); + + it('[POST] /_nodes/reload_secure_settings', () => { + const response = createResponseWithPath('/_nodes/reload_secure_settings', 'POST'); + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + POST /_nodes/reload_secure_settings?hello=dolly + [redacted]" + `); + }); + + it('[POST] /_nodes/*/reload_secure_settings', () => { + const response = createResponseWithPath('/_nodes/node-id/reload_secure_settings', 'POST'); + client.diagnostic.emit('response', null, response); + expect(loggingSystemMock.collect(logger).debug[0][0]).toMatchInlineSnapshot(` + "200 + POST /_nodes/node-id/reload_secure_settings?hello=dolly + [redacted]" + `); + }); + }); + }); }); }); diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.ts index 460ca0446f0fc..954baec201e45 100644 --- a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.ts +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/log_query_and_deprecation.ts @@ -13,8 +13,62 @@ import { errors, DiagnosticResult, RequestBody, Client } from '@elastic/elastics import numeral from '@elastic/numeral'; import type { Logger } from '@kbn/logging'; import type { ElasticsearchErrorDetails } from '@kbn/es-errors'; +import type { ElasticsearchApiToRedactInLogs } from '@kbn/core-elasticsearch-server'; import { getEcsResponseLog } from './get_ecs_response_log'; +/** + * The logger-relevant request meta of an ES request + */ +export interface RequestDebugMeta { + /** + * The requested method + */ + method: string; + /** + * The requested endpoint + querystring + */ + url: string; + /** + * The request body (it may be redacted) + */ + body: string; + /** + * The status code of the response + */ + statusCode: number | null; +} + +/** + * Known list of APIs that should redact the request body in the logs + */ +const APIS_TO_REDACT_IN_LOGS: ElasticsearchApiToRedactInLogs[] = [ + { path: '/_security/' }, + { path: '/_xpack/security/' }, + { method: 'POST', path: '/_reindex' }, + { method: 'PUT', path: '/_watcher/watch' }, + { method: 'PUT', path: '/_xpack/watcher/watch' }, + { method: 'PUT', path: '/_snapshot/' }, + { method: 'PUT', path: '/_logstash/pipeline/' }, + { method: 'POST', path: '/_nodes/reload_secure_settings' }, + { method: 'POST', path: /\/_nodes\/.+\/reload_secure_settings/ }, +]; + +function shouldRedactBodyInLogs( + requestDebugMeta: RequestDebugMeta, + extendedList: ElasticsearchApiToRedactInLogs[] = [] +) { + return [...APIS_TO_REDACT_IN_LOGS, ...extendedList].some(({ path, method }) => { + if (!method || method === requestDebugMeta.method) { + if (typeof path === 'string') { + return requestDebugMeta.url.includes(path); + } else { + return path.test(requestDebugMeta.url); + } + } + return false; + }); +} + const convertQueryString = (qs: string | Record | undefined): string => { if (qs === undefined || typeof qs === 'string') { return qs ?? ''; @@ -58,35 +112,43 @@ function getContentLength(headers?: IncomingHttpHeaders): number | undefined { * * so it could be copy-pasted into the Dev console */ -function getResponseMessage(event: DiagnosticResult, bytesMsg: string): string { - const errorMeta = getRequestDebugMeta(event); - const body = errorMeta.body ? `\n${errorMeta.body}` : ''; - return `${errorMeta.statusCode}${bytesMsg}\n${errorMeta.method} ${errorMeta.url}${body}`; +function getResponseMessage( + event: DiagnosticResult, + bytesMsg: string, + apisToRedactInLogs: ElasticsearchApiToRedactInLogs[] +): string { + const debugMeta = getRequestDebugMeta(event, apisToRedactInLogs); + const body = debugMeta.body ? `\n${debugMeta.body}` : ''; + return `${debugMeta.statusCode}${bytesMsg}\n${debugMeta.method} ${debugMeta.url}${body}`; } /** * Returns stringified debug information from an Elasticsearch request event * useful for logging in case of an unexpected failure. */ -export function getRequestDebugMeta(event: DiagnosticResult): { - url: string; - body: string; - statusCode: number | null; - method: string; -} { +export function getRequestDebugMeta( + event: DiagnosticResult, + apisToRedactInLogs?: ElasticsearchApiToRedactInLogs[] +): RequestDebugMeta { const params = event.meta.request.params; // definition is wrong, `params.querystring` can be either a string or an object const querystring = convertQueryString(params.querystring); - return { + + const debugMeta: RequestDebugMeta = { url: `${params.path}${querystring ? `?${querystring}` : ''}`, body: params.body ? `${ensureString(params.body)}` : '', method: params.method, statusCode: event.statusCode!, }; + + // Some known APIs may contain sensitive information in the request body that we don't want to expose to the logs. + return shouldRedactBodyInLogs(debugMeta, apisToRedactInLogs) + ? { ...debugMeta, body: '[redacted]' } + : debugMeta; } /** HTTP Warning headers have the following syntax: - * (where warn-code is a three digit number) + * (where warn-code is a three-digit number) * This function tests if a warning comes from an Elasticsearch warn-agent * */ const isEsWarning = (warning: string) => /\d\d\d Elasticsearch-/.test(warning); @@ -95,10 +157,12 @@ export const instrumentEsQueryAndDeprecationLogger = ({ logger, client, type, + apisToRedactInLogs, }: { logger: Logger; client: Client; type: string; + apisToRedactInLogs: ElasticsearchApiToRedactInLogs[]; }) => { const queryLogger = logger.get('query', type); const deprecationLogger = logger.get('deprecation'); @@ -111,12 +175,14 @@ export const instrumentEsQueryAndDeprecationLogger = ({ let queryMsg = ''; if (error) { if (error instanceof errors.ResponseError) { - queryMsg = `${getResponseMessage(event, bytesMsg)} ${getErrorMessage(error)}`; + queryMsg = `${getResponseMessage(event, bytesMsg, apisToRedactInLogs)} ${getErrorMessage( + error + )}`; } else { queryMsg = getErrorMessage(error); } } else { - queryMsg = getResponseMessage(event, bytesMsg); + queryMsg = getResponseMessage(event, bytesMsg, apisToRedactInLogs); } queryLogger.debug(queryMsg, meta); @@ -137,7 +203,7 @@ export const instrumentEsQueryAndDeprecationLogger = ({ ? 'kibana' : 'user'; - // Strip the first 5 stack trace lines as these are irrelavent to finding the call site + // Strip the first 5 stack trace lines as these are irrelevant to finding the call site const stackTrace = new Error().stack?.split('\n').slice(5).join('\n'); deprecationLogger.debug( diff --git a/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_config.test.ts b/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_config.test.ts index b81683d1cc11f..45d88445df419 100644 --- a/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_config.test.ts +++ b/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_config.test.ts @@ -30,6 +30,7 @@ test('set correct defaults', () => { expect(configValue).toMatchInlineSnapshot(` ElasticsearchConfig { "apiVersion": "master", + "apisToRedactInLogs": Array [], "compression": false, "customHeaders": Object {}, "healthCheckDelay": "PT2.5S", diff --git a/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_config.ts b/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_config.ts index bc2ec78acac06..bb022a22a63e8 100644 --- a/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_config.ts +++ b/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_config.ts @@ -13,7 +13,11 @@ import { Duration } from 'moment'; import { readFileSync } from 'fs'; import type { ServiceConfigDescriptor } from '@kbn/core-base-server-internal'; import type { ConfigDeprecationProvider } from '@kbn/config'; -import type { IElasticsearchConfig, ElasticsearchSslConfig } from '@kbn/core-elasticsearch-server'; +import type { + IElasticsearchConfig, + ElasticsearchSslConfig, + ElasticsearchApiToRedactInLogs, +} from '@kbn/core-elasticsearch-server'; import { getReservedHeaders } from './default_headers'; const hostURISchema = schema.uri({ scheme: ['http', 'https'] }); @@ -169,6 +173,13 @@ export const configSchema = schema.object({ }), schema.boolean({ defaultValue: false }) ), + apisToRedactInLogs: schema.arrayOf( + schema.object({ + path: schema.string(), + method: schema.maybe(schema.string()), + }), + { defaultValue: [] } + ), }); const deprecations: ConfigDeprecationProvider = () => [ @@ -402,6 +413,11 @@ export class ElasticsearchConfig implements IElasticsearchConfig { */ public readonly customHeaders: ElasticsearchConfigType['customHeaders']; + /** + * Extends the list of APIs that should be redacted in logs. + */ + public readonly apisToRedactInLogs: ElasticsearchApiToRedactInLogs[]; + constructor(rawConfig: ElasticsearchConfigType) { this.ignoreVersionMismatch = rawConfig.ignoreVersionMismatch; this.apiVersion = rawConfig.apiVersion; @@ -425,6 +441,7 @@ export class ElasticsearchConfig implements IElasticsearchConfig { this.idleSocketTimeout = rawConfig.idleSocketTimeout; this.compression = rawConfig.compression; this.skipStartupConnectionCheck = rawConfig.skipStartupConnectionCheck; + this.apisToRedactInLogs = rawConfig.apisToRedactInLogs; const { alwaysPresentCertificate, verificationMode } = rawConfig.ssl; const { key, keyPassphrase, certificate, certificateAuthorities } = readKeyAndCerts(rawConfig); diff --git a/packages/core/elasticsearch/core-elasticsearch-server/index.ts b/packages/core/elasticsearch/core-elasticsearch-server/index.ts index 0a810a0b65895..da71ac13c8ac0 100644 --- a/packages/core/elasticsearch/core-elasticsearch-server/index.ts +++ b/packages/core/elasticsearch/core-elasticsearch-server/index.ts @@ -22,6 +22,7 @@ export type { FakeRequest, ElasticsearchClientSslConfig, ElasticsearchClientConfig, + ElasticsearchApiToRedactInLogs, } from './src/client'; export type { diff --git a/packages/core/elasticsearch/core-elasticsearch-server/src/client/client_config.ts b/packages/core/elasticsearch/core-elasticsearch-server/src/client/client_config.ts index 8bd5003e903a6..4f61e4b07a864 100644 --- a/packages/core/elasticsearch/core-elasticsearch-server/src/client/client_config.ts +++ b/packages/core/elasticsearch/core-elasticsearch-server/src/client/client_config.ts @@ -8,6 +8,23 @@ import type { Duration } from 'moment'; +/** + * Definition of an API that should redact the requested body in the logs + */ +export interface ElasticsearchApiToRedactInLogs { + /** + * The ES path. + * - If specified as a string, it'll be checked as `contains`. + * - If specified as a RegExp, it'll be tested against the path. + */ + path: string | RegExp; + /** + * HTTP method. + * If not provided, the path will be checked for all methods. + */ + method?: string; +} + /** * Configuration options to be used to create a {@link IClusterClient | cluster client} * @@ -32,6 +49,7 @@ export interface ElasticsearchClientConfig { requestTimeout?: Duration | number; caFingerprint?: string; ssl?: ElasticsearchClientSslConfig; + apisToRedactInLogs?: ElasticsearchApiToRedactInLogs[]; } /** diff --git a/packages/core/elasticsearch/core-elasticsearch-server/src/client/index.ts b/packages/core/elasticsearch/core-elasticsearch-server/src/client/index.ts index 377d836508989..b7901645a9d9b 100644 --- a/packages/core/elasticsearch/core-elasticsearch-server/src/client/index.ts +++ b/packages/core/elasticsearch/core-elasticsearch-server/src/client/index.ts @@ -19,4 +19,8 @@ export type { UnauthorizedErrorHandlerRetryResult, UnauthorizedErrorHandlerNotHandledResult, } from './unauthorized_error_handler'; -export type { ElasticsearchClientConfig, ElasticsearchClientSslConfig } from './client_config'; +export type { + ElasticsearchClientConfig, + ElasticsearchClientSslConfig, + ElasticsearchApiToRedactInLogs, +} from './client_config'; diff --git a/packages/core/elasticsearch/core-elasticsearch-server/src/elasticsearch_config.ts b/packages/core/elasticsearch/core-elasticsearch-server/src/elasticsearch_config.ts index ae1dc281b29fb..8ad2faff90249 100644 --- a/packages/core/elasticsearch/core-elasticsearch-server/src/elasticsearch_config.ts +++ b/packages/core/elasticsearch/core-elasticsearch-server/src/elasticsearch_config.ts @@ -7,6 +7,7 @@ */ import type { Duration } from 'moment'; +import type { ElasticsearchApiToRedactInLogs } from './client'; /** * @public @@ -139,6 +140,11 @@ export interface IElasticsearchConfig { * either `certificate` or `full`. */ readonly ssl: ElasticsearchSslConfig; + + /** + * Extends the list of APIs that should be redacted in logs. + */ + readonly apisToRedactInLogs: ElasticsearchApiToRedactInLogs[]; } /** diff --git a/packages/core/fatal-errors/core-fatal-errors-browser-internal/src/__snapshots__/fatal_errors_screen.test.tsx.snap b/packages/core/fatal-errors/core-fatal-errors-browser-internal/src/__snapshots__/fatal_errors_screen.test.tsx.snap index 1b9baa09b0e2b..a2163e2b4c4e9 100644 --- a/packages/core/fatal-errors/core-fatal-errors-browser-internal/src/__snapshots__/fatal_errors_screen.test.tsx.snap +++ b/packages/core/fatal-errors/core-fatal-errors-browser-internal/src/__snapshots__/fatal_errors_screen.test.tsx.snap @@ -51,7 +51,7 @@ exports[`FatalErrorsScreen rendering render matches snapshot 1`] = `

} iconColor="danger" - iconType="alert" + iconType="warning" title={

@@ -80,7 +80,7 @@ Error: foo diff --git a/packages/core/fatal-errors/core-fatal-errors-browser-internal/src/fatal_errors_screen.tsx b/packages/core/fatal-errors/core-fatal-errors-browser-internal/src/fatal_errors_screen.tsx index bdcb6334eb48e..a7f274920694f 100644 --- a/packages/core/fatal-errors/core-fatal-errors-browser-internal/src/fatal_errors_screen.tsx +++ b/packages/core/fatal-errors/core-fatal-errors-browser-internal/src/fatal_errors_screen.tsx @@ -79,7 +79,7 @@ export class FatalErrorsScreen extends React.Component { @@ -119,7 +119,7 @@ export class FatalErrorsScreen extends React.Component { ]} /> {this.state.errors.map((error, i) => ( - + {`Version: ${this.props.kibanaVersion}` + '\n' + diff --git a/packages/core/http/core-http-server/src/router/response.ts b/packages/core/http/core-http-server/src/router/response.ts index 41f7d84f6b5d1..07ec226e8c3a9 100644 --- a/packages/core/http/core-http-server/src/router/response.ts +++ b/packages/core/http/core-http-server/src/router/response.ts @@ -13,9 +13,9 @@ import type { ResponseHeaders } from './headers'; * HTTP response parameters * @public */ -export interface HttpResponseOptions { +export interface HttpResponseOptions { /** HTTP message to send to the client */ - body?: HttpResponsePayload; + body?: T; /** HTTP Headers with additional information about response */ headers?: ResponseHeaders; /** Bypass the default error formatting */ diff --git a/packages/core/http/core-http-server/src/router/response_factory.ts b/packages/core/http/core-http-server/src/router/response_factory.ts index 9f9be08dc2cb7..34303103732a2 100644 --- a/packages/core/http/core-http-server/src/router/response_factory.ts +++ b/packages/core/http/core-http-server/src/router/response_factory.ts @@ -27,14 +27,18 @@ export interface KibanaSuccessResponseFactory { * Status code: `200`. * @param options - {@link HttpResponseOptions} configures HTTP response body & headers. */ - ok(options?: HttpResponseOptions): IKibanaResponse; + ok( + options?: HttpResponseOptions + ): IKibanaResponse; /** * The request has been accepted for processing. * Status code: `202`. * @param options - {@link HttpResponseOptions} configures HTTP response body & headers. */ - accepted(options?: HttpResponseOptions): IKibanaResponse; + accepted( + options?: HttpResponseOptions + ): IKibanaResponse; /** * The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. diff --git a/packages/core/notifications/core-notifications-browser-internal/src/notifications_service.ts b/packages/core/notifications/core-notifications-browser-internal/src/notifications_service.ts index 01d23f13784d4..942fe03447d1e 100644 --- a/packages/core/notifications/core-notifications-browser-internal/src/notifications_service.ts +++ b/packages/core/notifications/core-notifications-browser-internal/src/notifications_service.ts @@ -15,7 +15,7 @@ import type { IUiSettingsClient } from '@kbn/core-ui-settings-browser'; import type { OverlayStart } from '@kbn/core-overlays-browser'; import type { NotificationsSetup, NotificationsStart } from '@kbn/core-notifications-browser'; import type { PublicMethodsOf } from '@kbn/utility-types'; -import { ToastsService } from './toasts'; +import { showErrorDialog, ToastsService } from './toasts'; export interface SetupDeps { uiSettings: IUiSettingsClient; @@ -70,6 +70,13 @@ export class NotificationsService { theme, targetDomElement: toastsContainer, }), + showErrorDialog: ({ title, error }) => + showErrorDialog({ + title, + error, + openModal: overlays.openModal, + i18nContext: () => i18nDep.Context, + }), }; } diff --git a/packages/core/notifications/core-notifications-browser-internal/src/toasts/error_toast.tsx b/packages/core/notifications/core-notifications-browser-internal/src/toasts/error_toast.tsx index b1c21064d3c91..5cdcf84ccb4ad 100644 --- a/packages/core/notifications/core-notifications-browser-internal/src/toasts/error_toast.tsx +++ b/packages/core/notifications/core-notifications-browser-internal/src/toasts/error_toast.tsx @@ -48,7 +48,7 @@ const isRequestError = (e: Error | RequestError): e is RequestError => { * does not disappear. NOTE: this should use a global modal in the overlay service * in the future. */ -function showErrorDialog({ +export function showErrorDialog({ title, error, openModal, diff --git a/packages/core/notifications/core-notifications-browser-internal/src/toasts/index.ts b/packages/core/notifications/core-notifications-browser-internal/src/toasts/index.ts index 1d4dd09e67899..af00d72e762ed 100644 --- a/packages/core/notifications/core-notifications-browser-internal/src/toasts/index.ts +++ b/packages/core/notifications/core-notifications-browser-internal/src/toasts/index.ts @@ -8,3 +8,4 @@ export { ToastsService } from './toasts_service'; export type { ToastsApi } from './toasts_api'; +export { showErrorDialog } from './error_toast'; diff --git a/packages/core/notifications/core-notifications-browser-mocks/src/notifications_service.mock.ts b/packages/core/notifications/core-notifications-browser-mocks/src/notifications_service.mock.ts index 93520e227778a..7bce7ff85f85d 100644 --- a/packages/core/notifications/core-notifications-browser-mocks/src/notifications_service.mock.ts +++ b/packages/core/notifications/core-notifications-browser-mocks/src/notifications_service.mock.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import type { MockedKeys } from '@kbn/utility-types-jest'; +import type { DeeplyMockedKeys, MockedKeys } from '@kbn/utility-types-jest'; import type { NotificationsSetup, NotificationsStart } from '@kbn/core-notifications-browser'; import type { NotificationsServiceContract } from '@kbn/core-notifications-browser-internal'; import { toastsServiceMock } from './toasts_service.mock'; @@ -20,9 +20,10 @@ const createSetupContractMock = () => { }; const createStartContractMock = () => { - const startContract: MockedKeys = { + const startContract: DeeplyMockedKeys = { // we have to suppress type errors until decide how to mock es6 class toasts: toastsServiceMock.createStartContract(), + showErrorDialog: jest.fn(), }; return startContract; }; diff --git a/packages/core/notifications/core-notifications-browser/src/contracts.ts b/packages/core/notifications/core-notifications-browser/src/contracts.ts index c89b4dc226e2b..cf882b2ae64de 100644 --- a/packages/core/notifications/core-notifications-browser/src/contracts.ts +++ b/packages/core/notifications/core-notifications-browser/src/contracts.ts @@ -30,4 +30,5 @@ export interface NotificationsSetup { export interface NotificationsStart { /** {@link ToastsStart} */ toasts: ToastsStart; + showErrorDialog: (options: { title: string; error: Error }) => void; } diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/README.md b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/README.md index 6dfc468b2a985..10cfdf437ef58 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/README.md +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/README.md @@ -27,57 +27,60 @@ - [WAIT_FOR_YELLOW_SOURCE](#wait_for_yellow_source) - [Next action](#next-action-8) - [New control state](#new-control-state-8) - - [SET_SOURCE_WRITE_BLOCK](#set_source_write_block) + - [UPDATE_SOURCE_MAPPINGS_PROPERTIES](#update_source_mappings_properties) - [Next action](#next-action-9) - [New control state](#new-control-state-9) - - [CREATE_REINDEX_TEMP](#create_reindex_temp) + - [SET_SOURCE_WRITE_BLOCK](#set_source_write_block) - [Next action](#next-action-10) - [New control state](#new-control-state-10) - - [REINDEX_SOURCE_TO_TEMP_OPEN_PIT](#reindex_source_to_temp_open_pit) + - [CREATE_REINDEX_TEMP](#create_reindex_temp) - [Next action](#next-action-11) - [New control state](#new-control-state-11) - - [REINDEX_SOURCE_TO_TEMP_READ](#reindex_source_to_temp_read) + - [REINDEX_SOURCE_TO_TEMP_OPEN_PIT](#reindex_source_to_temp_open_pit) - [Next action](#next-action-12) - [New control state](#new-control-state-12) - - [REINDEX_SOURCE_TO_TEMP_TRANSFORM](#reindex_source_to_temp_transform) + - [REINDEX_SOURCE_TO_TEMP_READ](#reindex_source_to_temp_read) - [Next action](#next-action-13) - [New control state](#new-control-state-13) - - [REINDEX_SOURCE_TO_TEMP_INDEX_BULK](#reindex_source_to_temp_index_bulk) + - [REINDEX_SOURCE_TO_TEMP_TRANSFORM](#reindex_source_to_temp_transform) - [Next action](#next-action-14) - [New control state](#new-control-state-14) - - [REINDEX_SOURCE_TO_TEMP_CLOSE_PIT](#reindex_source_to_temp_close_pit) + - [REINDEX_SOURCE_TO_TEMP_INDEX_BULK](#reindex_source_to_temp_index_bulk) - [Next action](#next-action-15) - [New control state](#new-control-state-15) - - [SET_TEMP_WRITE_BLOCK](#set_temp_write_block) + - [REINDEX_SOURCE_TO_TEMP_CLOSE_PIT](#reindex_source_to_temp_close_pit) - [Next action](#next-action-16) - [New control state](#new-control-state-16) - - [CLONE_TEMP_TO_TARGET](#clone_temp_to_target) + - [SET_TEMP_WRITE_BLOCK](#set_temp_write_block) - [Next action](#next-action-17) - [New control state](#new-control-state-17) - - [OUTDATED_DOCUMENTS_SEARCH](#outdated_documents_search) + - [CLONE_TEMP_TO_TARGET](#clone_temp_to_target) - [Next action](#next-action-18) - [New control state](#new-control-state-18) - - [OUTDATED_DOCUMENTS_TRANSFORM](#outdated_documents_transform) + - [OUTDATED_DOCUMENTS_SEARCH](#outdated_documents_search) - [Next action](#next-action-19) - [New control state](#new-control-state-19) - - [CHECK_TARGET_MAPPINGS](#check_target_mappings) + - [OUTDATED_DOCUMENTS_TRANSFORM](#outdated_documents_transform) - [Next action](#next-action-20) - [New control state](#new-control-state-20) - - [UPDATE_TARGET_MAPPINGS_PROPERTIES](#update_target_mappings_properties) + - [CHECK_TARGET_MAPPINGS](#check_target_mappings) - [Next action](#next-action-21) - [New control state](#new-control-state-21) - - [UPDATE_TARGET_MAPPINGS_PROPERTIES_WAIT_FOR_TASK](#update_target_mappings_properties_wait_for_task) + - [UPDATE_TARGET_MAPPINGS_PROPERTIES](#update_target_mappings_properties) - [Next action](#next-action-22) - [New control state](#new-control-state-22) - - [CHECK_VERSION_INDEX_READY_ACTIONS](#check_version_index_ready_actions) + - [UPDATE_TARGET_MAPPINGS_PROPERTIES_WAIT_FOR_TASK](#update_target_mappings_properties_wait_for_task) - [Next action](#next-action-23) - [New control state](#new-control-state-23) - - [MARK_VERSION_INDEX_READY](#mark_version_index_ready) + - [CHECK_VERSION_INDEX_READY_ACTIONS](#check_version_index_ready_actions) - [Next action](#next-action-24) - [New control state](#new-control-state-24) - - [MARK_VERSION_INDEX_READY_CONFLICT](#mark_version_index_ready_conflict) + - [MARK_VERSION_INDEX_READY](#mark_version_index_ready) - [Next action](#next-action-25) - [New control state](#new-control-state-25) + - [MARK_VERSION_INDEX_READY_CONFLICT](#mark_version_index_ready_conflict) + - [Next action](#next-action-26) + - [New control state](#new-control-state-26) - [Manual QA Test Plan](#manual-qa-test-plan) - [1. Legacy pre-migration](#1-legacy-pre-migration) - [2. Plugins enabled/disabled](#2-plugins-enableddisabled) @@ -168,30 +171,27 @@ index. The check only considers persistent and transient settings and does not take static configuration in `elasticsearch.yml` into account since there are no known use cases for doing so. If `cluster.routing.allocation.enable` is configured in `elaticsearch.yml` and not set to the default of 'all', the migration will timeout. Static settings can only be returned from the `nodes/info` API. → `INIT` - 2. If `.kibana` is pointing to an index that belongs to a later version of + 2. If `.kibana` is pointing to more than one index. + → `FATAL` + + 3. If `.kibana` is pointing to an index that belongs to a later version of Kibana .e.g. a 7.11.0 instance found the `.kibana` alias pointing to `.kibana_7.12.0_001` fail the migration → `FATAL` -2. If `.kibana` and the version specific aliases both exists and are pointing -to the same index. This version's migration has already been completed. Since -the same version could have plugins enabled at any time that would introduce -new transforms or mappings. - → `OUTDATED_DOCUMENTS_SEARCH` - -3. If `waitForMigrations` was set we're running on a background-tasks node and +2. If `waitForMigrations` was set we're running on a background-tasks node and we should not participate in the migration but instead wait for the ui node(s) to complete the migration. → `WAIT_FOR_MIGRATION_COMPLETION` -4. If the `.kibana` alias exists we’re migrating from either a v1 or v2 index +3. If the `.kibana` alias exists we’re migrating from either a v1 or v2 index and the migration source index is the index the `.kibana` alias points to. → `WAIT_FOR_YELLOW_SOURCE` -5. If `.kibana` is a concrete index, we’re migrating from a legacy index +4. If `.kibana` is a concrete index, we’re migrating from a legacy index → `LEGACY_SET_WRITE_BLOCK` -6. If there are no `.kibana` indices, this is a fresh deployment. Initialize a +5. If there are no `.kibana` indices, this is a fresh deployment. Initialize a new saved objects index → `CREATE_NEW_TARGET` @@ -293,10 +293,31 @@ Wait for the source index to become yellow. This means the index's primary has b ### New control state 1. If the action succeeds - → `SET_SOURCE_WRITE_BLOCK` + → `UPDATE_SOURCE_MAPPINGS_PROPERTIES` 2. If the action fails with a `index_not_yellow_timeout` → `WAIT_FOR_YELLOW_SOURCE` +## UPDATE_SOURCE_MAPPINGS_PROPERTIES +### Next action +`updateSourceMappingsProperties` + +This action checks for source mappings changes. +And if there are some, it tries to patch the mappings. +- If there were no changes or the patch was successful, that reports either the changes are compatible or the source is already up to date, depending on the version migration completion state. Either way, it does not require a follow-up reindexing. +- If the patch is failed and the version migration is incomplete, it reports an incompatible state that requires reindexing. +- If the patch is failed and the version migration is complete, it reports an error as it means an incompatible mappings change in an already migrated environment. +The latter usually happens when a new plugin is enabled that brings some incompatible changes or when there are incompatible changes in the development environment. + +### New control state +1. If the mappings are updated and the migration is already completed. + → `OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT` +2. If the mappings are updated and the migration is still in progress. + → `CLEANUP_UNKNOWN_AND_EXCLUDED` +3. If the mappings are not updated due to incompatible changes and the migration is still in progress. + → `CHECK_UNKNOWN_DOCUMENTS` +4. If the mappings are not updated due to incompatible changes and the migration is already completed. + → `FATAL` + ## SET_SOURCE_WRITE_BLOCK ### Next action `setWriteBlock` diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/index.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/index.ts index 7aec839dca066..652178fd25919 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/index.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/index.ts @@ -97,6 +97,11 @@ export { updateAndPickupMappings } from './update_and_pickup_mappings'; export { updateMappings, type IncompatibleMappingException } from './update_mappings'; +export { + type UpdateSourceMappingsPropertiesParams, + updateSourceMappingsProperties, +} from './update_source_mappings_properties'; + import type { UnknownDocsFound } from './check_for_unknown_docs'; import type { IncompatibleClusterRoutingAllocation } from './initialize_action'; import { ClusterShardLimitExceeded } from './create_index'; diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/initialize_action.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/initialize_action.test.ts index ebcca7e1bb787..04ddcd3b78ce5 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/initialize_action.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/initialize_action.test.ts @@ -10,13 +10,19 @@ import * as Either from 'fp-ts/lib/Either'; import { catchRetryableEsClientErrors } from './catch_retryable_es_client_errors'; import { errors as EsErrors } from '@elastic/elasticsearch'; import { elasticsearchClientMock } from '@kbn/core-elasticsearch-client-server-mocks'; -import { initAction } from './initialize_action'; +import { initAction, type InitActionParams } from './initialize_action'; jest.mock('./catch_retryable_es_client_errors'); describe('initAction', () => { + let initActionParams: Omit; + beforeEach(() => { jest.clearAllMocks(); + + initActionParams = { + indices: ['.kibana', '.kibana_8.8.0'], + }; }); it('calls catchRetryableEsClientErrors when the promise rejects', async () => { const retryableError = new EsErrors.ResponseError( @@ -28,7 +34,7 @@ describe('initAction', () => { const client = elasticsearchClientMock.createInternalClient( elasticsearchClientMock.createErrorTransportRequestPromise(retryableError) ); - const task = initAction({ client, indices: ['my_index'] }); + const task = initAction({ ...initActionParams, client }); try { await task(); } catch (e) { @@ -36,88 +42,73 @@ describe('initAction', () => { } expect(catchRetryableEsClientErrors).toHaveBeenCalledWith(retryableError); }); - it('resolves right when persistent and transient cluster settings are compatible', async () => { - const clusterSettingsResponse = { - transient: { 'cluster.routing.allocation.enable': 'all' }, - persistent: { 'cluster.routing.allocation.enable': 'all' }, - }; - const client = elasticsearchClientMock.createInternalClient( - new Promise((res) => res(clusterSettingsResponse)) - ); - const task = initAction({ client, indices: ['my_index'] }); - const result = await task(); - expect(Either.isRight(result)).toEqual(true); - }); - it('resolves right when persistent and transient cluster settings are undefined', async () => { - const clusterSettingsResponse = { - transient: {}, - persistent: {}, - }; - const client = elasticsearchClientMock.createInternalClient( - new Promise((res) => res(clusterSettingsResponse)) - ); - const task = initAction({ client, indices: ['my_index'] }); - const result = await task(); - expect(Either.isRight(result)).toEqual(true); - }); - it('resolves right when persistent cluster settings are compatible', async () => { - const clusterSettingsResponse = { - transient: {}, - persistent: { 'cluster.routing.allocation.enable': 'all' }, - }; - const client = elasticsearchClientMock.createInternalClient( - new Promise((res) => res(clusterSettingsResponse)) - ); - const task = initAction({ client, indices: ['my_index'] }); - const result = await task(); - expect(Either.isRight(result)).toEqual(true); - }); - it('resolves right when transient cluster settings are compatible', async () => { - const clusterSettingsResponse = { - transient: { 'cluster.routing.allocation.enable': 'all' }, - persistent: {}, - }; - const client = elasticsearchClientMock.createInternalClient( - new Promise((res) => res(clusterSettingsResponse)) - ); - const task = initAction({ client, indices: ['my_index'] }); - const result = await task(); - expect(Either.isRight(result)).toEqual(true); - }); - it('resolves right when valid transient settings, incompatible persistent settings', async () => { - const clusterSettingsResponse = { - transient: { 'cluster.routing.allocation.enable': 'all' }, - persistent: { 'cluster.routing.allocation.enable': 'primaries' }, - }; - const client = elasticsearchClientMock.createInternalClient( - new Promise((res) => res(clusterSettingsResponse)) - ); - const task = initAction({ client, indices: ['my_index'] }); - const result = await task(); - expect(Either.isRight(result)).toEqual(true); - }); - it('resolves left when valid persistent settings, incompatible transient settings', async () => { - const clusterSettingsResponse = { - transient: { 'cluster.routing.allocation.enable': 'primaries' }, - persistent: { 'cluster.routing.allocation.enable': 'alls' }, - }; + + it.each([ + { + clusterSettingsResponse: { + transient: { 'cluster.routing.allocation.enable': 'primaries' }, + persistent: { 'cluster.routing.allocation.enable': 'alls' }, + }, + case: 'resolves left when valid persistent settings, incompatible transient settings', + }, + { + clusterSettingsResponse: { + transient: { 'cluster.routing.allocation.enable': 'none' }, + persistent: { 'cluster.routing.allocation.enable': 'all' }, + }, + case: 'resolves left when transient cluster settings are incompatible', + }, + ])('$case', async ({ clusterSettingsResponse }) => { const client = elasticsearchClientMock.createInternalClient( - new Promise((res) => res(clusterSettingsResponse)) + Promise.resolve(clusterSettingsResponse) ); - const task = initAction({ client, indices: ['my_index'] }); + const task = initAction({ ...initActionParams, client }); const result = await task(); expect(Either.isLeft(result)).toEqual(true); }); - it('resolves left when transient cluster settings are incompatible', async () => { - const clusterSettingsResponse = { - transient: { 'cluster.routing.allocation.enable': 'none' }, - persistent: { 'cluster.routing.allocation.enable': 'all' }, - }; + + it.each([ + { + clusterSettingsResponse: { + transient: { 'cluster.routing.allocation.enable': 'all' }, + persistent: { 'cluster.routing.allocation.enable': 'all' }, + }, + case: 'resolves right when persistent and transient cluster settings are compatible', + }, + { + clusterSettingsResponse: { + transient: {}, + persistent: {}, + }, + case: 'resolves right when persistent and transient cluster settings are undefined', + }, + { + clusterSettingsResponse: { + transient: {}, + persistent: { 'cluster.routing.allocation.enable': 'all' }, + }, + case: 'resolves right when persistent cluster settings are compatible', + }, + { + clusterSettingsResponse: { + transient: { 'cluster.routing.allocation.enable': 'all' }, + persistent: {}, + }, + case: 'resolves right when transient cluster settings are compatible', + }, + { + clusterSettingsResponse: { + transient: { 'cluster.routing.allocation.enable': 'all' }, + persistent: { 'cluster.routing.allocation.enable': 'primaries' }, + }, + case: 'resolves right when valid transient settings, incompatible persistent settings', + }, + ])('$case', async ({ clusterSettingsResponse }) => { const client = elasticsearchClientMock.createInternalClient( - new Promise((res) => res(clusterSettingsResponse)) + Promise.resolve(clusterSettingsResponse) ); - const task = initAction({ client, indices: ['my_index'] }); + const task = initAction({ ...initActionParams, client }); const result = await task(); - expect(Either.isLeft(result)).toEqual(true); + expect(Either.isRight(result)).toEqual(true); }); }); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/update_source_mappings_properties.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/update_source_mappings_properties.test.ts new file mode 100644 index 0000000000000..54814693d599f --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/update_source_mappings_properties.test.ts @@ -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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { chain } from 'lodash'; +import * as Either from 'fp-ts/lib/Either'; +import { elasticsearchClientMock } from '@kbn/core-elasticsearch-client-server-mocks'; +import { + updateSourceMappingsProperties, + type UpdateSourceMappingsPropertiesParams, +} from './update_source_mappings_properties'; + +describe('updateSourceMappingsProperties', () => { + let client: ReturnType; + let params: UpdateSourceMappingsPropertiesParams; + + beforeEach(() => { + client = elasticsearchClientMock.createInternalClient(); + params = { + client, + sourceIndex: '.kibana_8.7.0_001', + sourceMappings: { + properties: { + a: { type: 'keyword' }, + b: { type: 'long' }, + }, + _meta: { + migrationMappingPropertyHashes: { + a: '000', + b: '111', + }, + }, + }, + targetMappings: { + properties: { + a: { type: 'keyword' }, + c: { type: 'long' }, + }, + _meta: { + migrationMappingPropertyHashes: { + a: '000', + c: '222', + }, + }, + }, + }; + }); + + it('should not update mappings when there are no changes', async () => { + const sameMappingsParams = chain(params).set('targetMappings', params.sourceMappings).value(); + const result = await updateSourceMappingsProperties(sameMappingsParams)(); + + expect(client.indices.putMapping).not.toHaveBeenCalled(); + expect(Either.isRight(result)).toEqual(true); + expect(result).toHaveProperty('right', 'update_mappings_succeeded'); + }); + + it('should return that mappings are updated when changes are compatible', async () => { + const result = await updateSourceMappingsProperties(params)(); + + expect(client.indices.putMapping).toHaveBeenCalledWith( + expect.not.objectContaining({ + _meta: expect.anything(), + }) + ); + expect(Either.isRight(result)).toEqual(true); + expect(result).toHaveProperty('right', 'update_mappings_succeeded'); + }); + + it('should report that changes are incompatible', async () => { + client.indices.putMapping.mockRejectedValueOnce( + elasticsearchClientMock.createApiResponse({ + statusCode: 400, + body: { + error: { + type: 'strict_dynamic_mapping_exception', + }, + }, + }) + ); + const result = await updateSourceMappingsProperties(params)(); + + expect(Either.isLeft(result)).toEqual(true); + expect(result).toHaveProperty( + 'left', + expect.objectContaining({ + type: 'incompatible_mapping_exception', + }) + ); + }); +}); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/update_source_mappings_properties.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/update_source_mappings_properties.ts new file mode 100644 index 0000000000000..51113f2892095 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/update_source_mappings_properties.ts @@ -0,0 +1,55 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { omit } from 'lodash'; +import * as TaskEither from 'fp-ts/lib/TaskEither'; +import { pipe } from 'fp-ts/lib/pipeable'; +import type { ElasticsearchClient } from '@kbn/core-elasticsearch-server'; +import type { IndexMapping } from '@kbn/core-saved-objects-base-server-internal'; +import { diffMappings } from '../core/build_active_mappings'; +import type { RetryableEsClientError } from './catch_retryable_es_client_errors'; +import { updateMappings } from './update_mappings'; +import type { IncompatibleMappingException } from './update_mappings'; + +/** @internal */ +export interface UpdateSourceMappingsPropertiesParams { + client: ElasticsearchClient; + sourceIndex: string; + sourceMappings: IndexMapping; + targetMappings: IndexMapping; +} + +/** + * This action tries to update the source mappings properties if there are any changes. + * @internal + */ +export const updateSourceMappingsProperties = ({ + client, + sourceIndex, + sourceMappings, + targetMappings, +}: UpdateSourceMappingsPropertiesParams): TaskEither.TaskEither< + RetryableEsClientError | IncompatibleMappingException, + 'update_mappings_succeeded' +> => { + return pipe( + diffMappings(sourceMappings, targetMappings), + TaskEither.fromPredicate( + (changes) => !!changes, + () => 'update_mappings_succeeded' as const + ), + TaskEither.swap, + TaskEither.orElse(() => + updateMappings({ + client, + index: sourceIndex, + mappings: omit(targetMappings, ['_meta']), // ._meta property will be updated on a later step + }) + ) + ); +}; diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/build_active_mappings.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/build_active_mappings.ts index 3d8648ae33274..808055b846842 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/build_active_mappings.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/build_active_mappings.ts @@ -51,7 +51,7 @@ export function diffMappings(actual: IndexMapping, expected: IndexMapping) { return { changedProp: 'dynamic' }; } - if (!actual._meta || !actual._meta.migrationMappingPropertyHashes) { + if (!actual._meta?.migrationMappingPropertyHashes) { return { changedProp: '_meta' }; } diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/helpers.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/helpers.test.ts index 5cfd4bc04c465..291f865f8c100 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/helpers.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/helpers.test.ts @@ -12,8 +12,10 @@ import { addMustClausesToBoolQuery, addMustNotClausesToBoolQuery, getAliases, + getMigrationType, buildRemoveAliasActions, versionMigrationCompleted, + MigrationType, } from './helpers'; describe('addExcludedTypesToBoolQuery', () => { @@ -287,3 +289,20 @@ describe('buildRemoveAliasActions', () => { ]); }); }); + +describe('getMigrationType', () => { + it.each` + isMappingsCompatible | isVersionMigrationCompleted | expected + ${true} | ${true} | ${MigrationType.Unnecessary} + ${true} | ${false} | ${MigrationType.Compatible} + ${false} | ${false} | ${MigrationType.Incompatible} + ${false} | ${true} | ${MigrationType.Invalid} + `( + "returns '$expected' migration type", + ({ isMappingsCompatible, isVersionMigrationCompleted, expected }) => { + expect(getMigrationType({ isMappingsCompatible, isVersionMigrationCompleted })).toBe( + expected + ); + } + ); +}); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/helpers.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/helpers.ts index 15691632a4399..9ffdf8508c8f5 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/helpers.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/helpers.ts @@ -18,6 +18,9 @@ import type { IndexMapping } from '@kbn/core-saved-objects-base-server-internal' import type { AliasAction, FetchIndexResponse } from '../actions'; import type { BulkIndexOperationTuple } from './create_batches'; +/** @internal */ +export type Aliases = Partial>; + /** * A helper function/type for ensuring that all control state's are handled. */ @@ -78,12 +81,12 @@ export function mergeMigrationMappingPropertyHashes( export function versionMigrationCompleted( currentAlias: string, versionAlias: string, - aliases: Record + aliases: Aliases ): boolean { return aliases[currentAlias] != null && aliases[currentAlias] === aliases[versionAlias]; } -export function indexBelongsToLaterVersion(indexName: string, kibanaVersion: string): boolean { +export function indexBelongsToLaterVersion(kibanaVersion: string, indexName?: string): boolean { const version = valid(indexVersion(indexName)); return version != null ? gt(version, kibanaVersion) : false; } @@ -165,16 +168,20 @@ export function indexVersion(indexName?: string): string | undefined { return (indexName?.match(/.+_(\d+\.\d+\.\d+)_\d+/) || [])[1]; } +/** @internal */ +export interface MultipleIndicesPerAlias { + type: 'multiple_indices_per_alias'; + alias: string; + indices: string[]; +} + /** * Creates a record of alias -> index name pairs */ export function getAliases( indices: FetchIndexResponse -): Either.Either< - { type: 'multiple_indices_per_alias'; alias: string; indices: string[] }, - Record -> { - const aliases = {} as Record; +): Either.Either { + const aliases = {} as Aliases; for (const index of Object.getOwnPropertyNames(indices)) { for (const alias of Object.getOwnPropertyNames(indices[index].aliases || {})) { const secondIndexThisAliasPointsTo = aliases[alias]; @@ -232,3 +239,35 @@ export const createBulkIndexOperationTuple = (doc: SavedObjectsRawDoc): BulkInde export const createBulkDeleteOperationBody = (_id: string): BulkOperationContainer => ({ delete: { _id }, }); + +/** @internal */ +export enum MigrationType { + Compatible = 'compatible', + Incompatible = 'incompatible', + Unnecessary = 'unnecessary', + Invalid = 'invalid', +} + +interface MigrationTypeParams { + isMappingsCompatible: boolean; + isVersionMigrationCompleted: boolean; +} + +export function getMigrationType({ + isMappingsCompatible, + isVersionMigrationCompleted, +}: MigrationTypeParams): MigrationType { + if (isMappingsCompatible && isVersionMigrationCompleted) { + return MigrationType.Unnecessary; + } + + if (isMappingsCompatible && !isVersionMigrationCompleted) { + return MigrationType.Compatible; + } + + if (!isMappingsCompatible && !isVersionMigrationCompleted) { + return MigrationType.Incompatible; + } + + return MigrationType.Invalid; +} diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/model.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/model.test.ts index 190996dc2f6ee..deba537b3f81e 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/model.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/model.test.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +import { chain } from 'lodash'; import * as Either from 'fp-ts/lib/Either'; import * as Option from 'fp-ts/lib/Option'; import type { SavedObjectsRawDoc } from '@kbn/core-saved-objects-server'; @@ -115,6 +116,14 @@ describe('migrations v2 model', () => { }, waitForMigrationCompletion: false, }; + const postInitState = { + ...baseState, + aliases: {}, + sourceIndex: Option.none, + sourceIndexMappings: Option.none, + versionIndexReadyActions: Option.none, + targetIndex: '.kibana_7.11.0_001', + }; const aProcessedDoc = { _id: 'a:b', @@ -232,9 +241,6 @@ describe('migrations v2 model', () => { const initState: State = { ...baseState, controlState: 'INIT', - currentAlias: '.kibana', - versionAlias: '.kibana_7.11.0', - versionIndex: '.kibana_7.11.0_001', }; const res: ResponseType<'INIT'> = Either.right({ @@ -257,9 +263,6 @@ describe('migrations v2 model', () => { const initBaseState: State = { ...baseState, controlState: 'INIT', - currentAlias: '.kibana', - versionAlias: '.kibana_7.11.0', - versionIndex: '.kibana_7.11.0_001', }; const mappingsWithUnknownType = { @@ -281,63 +284,6 @@ describe('migrations v2 model', () => { const initState = Object.assign({}, initBaseState, { waitForMigrationCompletion: true, }); - test('INIT -> OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT if .kibana is already pointing to the target index', () => { - const res: ResponseType<'INIT'> = Either.right({ - '.kibana_7.11.0_001': { - aliases: { - '.kibana': {}, - '.kibana_7.11.0': {}, - }, - mappings: mappingsWithUnknownType, - settings: {}, - }, - }); - const newState = model(initState, res) as OutdatedDocumentsSearchOpenPit; - - expect(newState.controlState).toEqual('OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT'); - // This snapshot asserts that we merge the - // migrationMappingPropertyHashes of the existing index, but we leave - // the mappings for the disabled_saved_object_type untouched. There - // might be another Kibana instance that knows about this type and - // needs these mappings in place. - expect(newState.targetIndexMappings).toMatchInlineSnapshot(` - Object { - "_meta": Object { - "migrationMappingPropertyHashes": Object { - "disabled_saved_object_type": "7997cf5a56cc02bdc9c93361bde732b0", - "new_saved_object_type": "4a11183eee21e6fbad864f7a30b39ad0", - }, - }, - "properties": Object { - "new_saved_object_type": Object { - "properties": Object { - "value": Object { - "type": "text", - }, - }, - }, - }, - } - `); - expect(newState.targetIndexRawMappings).toEqual({ - _meta: { - migrationMappingPropertyHashes: { - disabled_saved_object_type: '7997cf5a56cc02bdc9c93361bde732b0', - }, - }, - properties: { - disabled_saved_object_type: { - properties: { - value: { - type: 'keyword', - }, - }, - }, - }, - }); - expect(newState.retryCount).toEqual(0); - expect(newState.retryDelay).toEqual(0); - }); test('INIT -> INIT when cluster routing allocation is incompatible', () => { const res: ResponseType<'INIT'> = Either.left({ type: 'incompatible_cluster_routing_allocation', @@ -444,11 +390,9 @@ describe('migrations v2 model', () => { const newState = model( { ...initState, - ...{ - kibanaVersion: '7.12.0', - versionAlias: '.kibana_7.12.0', - versionIndex: '.kibana_7.12.0_001', - }, + kibanaVersion: '7.12.0', + versionAlias: '.kibana_7.12.0', + versionIndex: '.kibana_7.12.0_001', }, res ) as WaitForYellowSourceState; @@ -546,47 +490,6 @@ describe('migrations v2 model', () => { const initState = Object.assign({}, initBaseState, { waitForMigrationCompletion: false, }); - test('INIT -> OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT if .kibana is already pointing to the target index', () => { - const res: ResponseType<'INIT'> = Either.right({ - '.kibana_7.11.0_001': { - aliases: { - '.kibana': {}, - '.kibana_7.11.0': {}, - }, - mappings: mappingsWithUnknownType, - settings: {}, - }, - }); - const newState = model(initState, res); - - expect(newState.controlState).toEqual('OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT'); - // This snapshot asserts that we merge the - // migrationMappingPropertyHashes of the existing index, but we leave - // the mappings for the disabled_saved_object_type untouched. There - // might be another Kibana instance that knows about this type and - // needs these mappings in place. - expect(newState.targetIndexMappings).toMatchInlineSnapshot(` - Object { - "_meta": Object { - "migrationMappingPropertyHashes": Object { - "disabled_saved_object_type": "7997cf5a56cc02bdc9c93361bde732b0", - "new_saved_object_type": "4a11183eee21e6fbad864f7a30b39ad0", - }, - }, - "properties": Object { - "new_saved_object_type": Object { - "properties": Object { - "value": Object { - "type": "text", - }, - }, - }, - }, - } - `); - expect(newState.retryCount).toEqual(0); - expect(newState.retryDelay).toEqual(0); - }); test('INIT -> INIT when cluster routing allocation is incompatible', () => { const res: ResponseType<'INIT'> = Either.left({ type: 'incompatible_cluster_routing_allocation', @@ -699,11 +602,9 @@ describe('migrations v2 model', () => { const newState = model( { ...initState, - ...{ - kibanaVersion: '7.12.0', - versionAlias: '.kibana_7.12.0', - versionIndex: '.kibana_7.12.0_001', - }, + kibanaVersion: '7.12.0', + versionAlias: '.kibana_7.12.0', + versionIndex: '.kibana_7.12.0_001', }, res ) as WaitForYellowSourceState; @@ -848,11 +749,10 @@ describe('migrations v2 model', () => { describe('WAIT_FOR_MIGRATION_COMPLETION', () => { const waitForMState: State = { - ...baseState, + ...postInitState, controlState: 'WAIT_FOR_MIGRATION_COMPLETION', - currentAlias: '.kibana', - versionAlias: '.kibana_7.11.0', - versionIndex: '.kibana_7.11.0_001', + sourceIndex: Option.some('.kibana_7.11.0_001'), + sourceIndexMappings: Option.none, }; test('WAIT_FOR_MIGRATION_COMPLETION -> WAIT_FOR_MIGRATION_COMPLETION when .kibana points to an index with an invalid version', () => { @@ -1013,12 +913,10 @@ describe('migrations v2 model', () => { describe('LEGACY_SET_WRITE_BLOCK', () => { const legacySetWriteBlockState: LegacySetWriteBlockState = { - ...baseState, + ...postInitState, controlState: 'LEGACY_SET_WRITE_BLOCK', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, - targetIndex: '.kibana_7.11.0_001', - legacyReindexTargetMappings: { properties: {} }, + sourceIndexMappings: Option.some({ properties: {} }) as Option.Some, legacyPreMigrationDoneActions: [], legacyIndex: '', }; @@ -1055,12 +953,10 @@ describe('migrations v2 model', () => { describe('LEGACY_CREATE_REINDEX_TARGET', () => { const legacyCreateReindexTargetState: LegacyCreateReindexTargetState = { - ...baseState, + ...postInitState, controlState: 'LEGACY_CREATE_REINDEX_TARGET', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, - targetIndex: '.kibana_7.11.0_001', - legacyReindexTargetMappings: { properties: {} }, + sourceIndexMappings: Option.some({ properties: {} }) as Option.Some, legacyPreMigrationDoneActions: [], legacyIndex: '', }; @@ -1115,12 +1011,10 @@ describe('migrations v2 model', () => { describe('LEGACY_REINDEX', () => { const legacyReindexState: LegacyReindexState = { - ...baseState, + ...postInitState, controlState: 'LEGACY_REINDEX', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, - targetIndex: '.kibana_7.11.0_001', - legacyReindexTargetMappings: { properties: {} }, + sourceIndexMappings: Option.some({ properties: {} }) as Option.Some, legacyPreMigrationDoneActions: [], legacyIndex: '', }; @@ -1135,12 +1029,10 @@ describe('migrations v2 model', () => { describe('LEGACY_REINDEX_WAIT_FOR_TASK', () => { const legacyReindexWaitForTaskState: LegacyReindexWaitForTaskState = { - ...baseState, + ...postInitState, controlState: 'LEGACY_REINDEX_WAIT_FOR_TASK', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('source_index_name') as Option.Some, - targetIndex: '.kibana_7.11.0_001', - legacyReindexTargetMappings: { properties: {} }, + sourceIndexMappings: Option.some({ properties: {} }) as Option.Some, legacyPreMigrationDoneActions: [], legacyIndex: 'legacy_index_name', legacyReindexTaskId: 'test_task_id', @@ -1196,12 +1088,10 @@ describe('migrations v2 model', () => { describe('LEGACY_DELETE', () => { const legacyDeleteState: LegacyDeleteState = { - ...baseState, + ...postInitState, controlState: 'LEGACY_DELETE', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('source_index_name') as Option.Some, - targetIndex: '.kibana_7.11.0_001', - legacyReindexTargetMappings: { properties: {} }, + sourceIndexMappings: Option.some({ properties: {} }) as Option.Some, legacyPreMigrationDoneActions: [], legacyIndex: 'legacy_index_name', }; @@ -1235,14 +1125,12 @@ describe('migrations v2 model', () => { describe('WAIT_FOR_YELLOW_SOURCE', () => { const waitForYellowSourceState: WaitForYellowSourceState = { - ...baseState, + ...postInitState, controlState: 'WAIT_FOR_YELLOW_SOURCE', sourceIndex: Option.some('.kibana_7.11.0_001') as Option.Some, - sourceIndexMappings: baseState.targetIndexMappings, - aliases: { - '.kibana': '.kibana_7.11.0_001', - '.kibana_7.11.0': '.kibana_7.11.0_001', - }, + sourceIndexMappings: Option.some( + baseState.targetIndexMappings + ) as Option.Some, }; describe('if action succeeds', () => { @@ -1258,56 +1146,12 @@ describe('migrations v2 model', () => { expect(newState.retryDelay).toEqual(0); }); - describe('and mappings match (diffMappings == false)', () => { - test('WAIT_FOR_YELLOW_SOURCE -> CLEANUP_UNKNOWN_AND_EXCLUDED', () => { - const res: ResponseType<'WAIT_FOR_YELLOW_SOURCE'> = Either.right({ - '.kibana_7.11.0_001': { - aliases: { - '.kibana': {}, - '.kibana_7.11.0': {}, - }, - mappings: indexMapping, - settings: {}, - }, - }); - const newState = model(waitForYellowSourceState, res) as CleanupUnknownAndExcluded; - - expect(newState.controlState).toEqual('CLEANUP_UNKNOWN_AND_EXCLUDED'); - expect(newState.targetIndex).toEqual(baseState.versionIndex); - expect(newState.versionIndexReadyActions).toEqual(Option.none); - }); - }); - - describe('and mappings DO NOT match (diffMappings == true)', () => { - const actualMappings: IndexMapping = { - properties: { - new_saved_object_type: { - properties: { - value: { type: 'integer' }, - }, - }, - }, - _meta: { - migrationMappingPropertyHashes: { - new_saved_object_type: '5b11183eee21e6fbad864f7a30b39be1', - }, - }, - }; - - const changedMappingsState: WaitForYellowSourceState = { - ...waitForYellowSourceState, - sourceIndexMappings: actualMappings, - }; - - test('WAIT_FOR_YELLOW_SOURCE -> UPDATE_SOURCE_MAPPINGS_PROPERTIES', () => { - const res: ResponseType<'WAIT_FOR_YELLOW_SOURCE'> = Either.right({}); - const newState = model(changedMappingsState, res); + test('WAIT_FOR_YELLOW_SOURCE -> UPDATE_SOURCE_MAPPINGS_PROPERTIES', () => { + const res: ResponseType<'WAIT_FOR_YELLOW_SOURCE'> = Either.right({}); + const newState = model(waitForYellowSourceState, res); - expect(newState).toMatchObject({ - controlState: 'UPDATE_SOURCE_MAPPINGS_PROPERTIES', - sourceIndex: Option.some('.kibana_7.11.0_001'), - sourceIndexMappings: actualMappings, - }); + expect(newState).toMatchObject({ + controlState: 'UPDATE_SOURCE_MAPPINGS_PROPERTIES', }); }); }); @@ -1331,43 +1175,85 @@ describe('migrations v2 model', () => { }); describe('UPDATE_SOURCE_MAPPINGS_PROPERTIES', () => { - const checkCompatibleMappingsState: UpdateSourceMappingsPropertiesState = { - ...baseState, - controlState: 'UPDATE_SOURCE_MAPPINGS_PROPERTIES', - sourceIndex: Option.some('.kibana_7.11.0_001') as Option.Some, - sourceIndexMappings: baseState.targetIndexMappings, + const updateSourceMappingsPropertiesState: UpdateSourceMappingsPropertiesState = { + ...postInitState, aliases: { - '.kibana': '.kibana_7.11.0_001', '.kibana_7.11.0': '.kibana_7.11.0_001', }, + controlState: 'UPDATE_SOURCE_MAPPINGS_PROPERTIES', + sourceIndex: Option.some('.kibana_7.11.0_001') as Option.Some, + sourceIndexMappings: Option.some( + chain(baseState.targetIndexMappings) + .cloneDeep() + .set('_meta.migrationMappingPropertyHashes.something', 'some-hash') + .value() + ) as Option.Some, }; describe('if action succeeds', () => { - test('UPDATE_SOURCE_MAPPINGS_PROPERTIES -> CLEANUP_UNKNOWN_AND_EXCLUDED', () => { + test('UPDATE_SOURCE_MAPPINGS_PROPERTIES -> CLEANUP_UNKNOWN_AND_EXCLUDED if mappings changes are compatible and index is not migrated yet', () => { const res: ResponseType<'UPDATE_SOURCE_MAPPINGS_PROPERTIES'> = Either.right( - 'update_mappings_succeeded' as const + 'update_mappings_succeeded' ); - const newState = model(checkCompatibleMappingsState, res); + const newState = model(updateSourceMappingsPropertiesState, res); expect(newState).toMatchObject({ controlState: 'CLEANUP_UNKNOWN_AND_EXCLUDED', - targetIndex: '.kibana_7.11.0_001', - versionIndexReadyActions: Option.none, }); }); + + test('UPDATE_SOURCE_MAPPINGS_PROPERTIES -> OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT if mappings changes are compatible and index is already migrated', () => { + const res: ResponseType<'UPDATE_SOURCE_MAPPINGS_PROPERTIES'> = Either.right( + 'update_mappings_succeeded' + ); + const newState = model( + chain(updateSourceMappingsPropertiesState) + .cloneDeep() + .set(['aliases', '.kibana'], '.kibana_7.11.0_001') + .value(), + res + ); + + expect(newState).toEqual( + expect.objectContaining({ + controlState: 'OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT', + sourceIndex: Option.none, + targetIndex: '.kibana_7.11.0_001', + targetIndexMappings: chain(indexMapping) + .cloneDeep() + .set('_meta.migrationMappingPropertyHashes.something', 'some-hash') + .value(), + }) + ); + }); }); describe('if action fails', () => { - test('UPDATE_SOURCE_MAPPINGS_PROPERTIES -> CHECK_UNKNOWN_DOCUMENTS', () => { + test('UPDATE_SOURCE_MAPPINGS_PROPERTIES -> CHECK_UNKNOWN_DOCUMENTS if mappings changes are incompatible', () => { const res: ResponseType<'UPDATE_SOURCE_MAPPINGS_PROPERTIES'> = Either.left({ type: 'incompatible_mapping_exception', }); - const newState = model(checkCompatibleMappingsState, res); + const newState = model(updateSourceMappingsPropertiesState, res); expect(newState).toMatchObject({ controlState: 'CHECK_UNKNOWN_DOCUMENTS', - sourceIndex: Option.some('.kibana_7.11.0_001'), - sourceIndexMappings: baseState.targetIndexMappings, + }); + }); + + test('UPDATE_SOURCE_MAPPINGS_PROPERTIES -> FATAL', () => { + const res: ResponseType<'UPDATE_SOURCE_MAPPINGS_PROPERTIES'> = Either.left({ + type: 'incompatible_mapping_exception', + }); + const newState = model( + chain(updateSourceMappingsPropertiesState) + .cloneDeep() + .set(['aliases', '.kibana'], '.kibana_7.11.0_001') + .value(), + res + ); + + expect(newState).toMatchObject({ + controlState: 'FATAL', }); }); }); @@ -1375,19 +1261,16 @@ describe('migrations v2 model', () => { describe('CLEANUP_UNKNOWN_AND_EXCLUDED', () => { const cleanupUnknownAndExcluded: CleanupUnknownAndExcluded = { - ...baseState, + ...postInitState, controlState: 'CLEANUP_UNKNOWN_AND_EXCLUDED', sourceIndex: Option.some('.kibana_7.11.0_001') as Option.Some, - sourceIndexMappings: baseState.targetIndexMappings, + sourceIndexMappings: Option.some( + baseState.targetIndexMappings + ) as Option.Some, targetIndex: baseState.versionIndex, kibanaVersion: '7.12.0', // new version! currentAlias: '.kibana', versionAlias: '.kibana_7.12.0', - aliases: { - '.kibana': '.kibana_7.11.0_001', - '.kibana_7.11.0': '.kibana_7.11.0_001', - }, - versionIndexReadyActions: Option.none, }; describe('if action succeeds', () => { @@ -1401,24 +1284,6 @@ describe('migrations v2 model', () => { const newState = model(cleanupUnknownAndExcluded, res) as PrepareCompatibleMigration; expect(newState.controlState).toEqual('CLEANUP_UNKNOWN_AND_EXCLUDED_WAIT_FOR_TASK'); - // expect(newState.targetIndexRawMappings).toEqual(indexMapping); - // expect(newState.targetIndexMappings).toEqual(indexMapping); - // expect(newState.targetIndex).toEqual('.kibana_7.11.0_001'); - // expect(newState.preTransformDocsActions).toEqual([ - // { - // add: { - // alias: '.kibana_7.12.0', - // index: '.kibana_7.11.0_001', - // }, - // }, - // { - // remove: { - // alias: '.kibana_7.11.0', - // index: '.kibana_7.11.0_001', - // must_exist: true, - // }, - // }, - // ]); }); }); @@ -1444,11 +1309,13 @@ describe('migrations v2 model', () => { describe('CLEANUP_UNKNOWN_AND_EXCLUDED_WAIT_FOR_TASK', () => { const cleanupUnknownAndExcludedWaitForTask: CleanupUnknownAndExcludedWaitForTaskState = { - ...baseState, + ...postInitState, controlState: 'CLEANUP_UNKNOWN_AND_EXCLUDED_WAIT_FOR_TASK', deleteByQueryTaskId: '1234', sourceIndex: Option.some('.kibana_7.11.0_001') as Option.Some, - sourceIndexMappings: baseState.targetIndexMappings, + sourceIndexMappings: Option.some( + baseState.targetIndexMappings + ) as Option.Some, targetIndex: baseState.versionIndex, kibanaVersion: '7.12.0', // new version! currentAlias: '.kibana', @@ -1457,7 +1324,6 @@ describe('migrations v2 model', () => { '.kibana': '.kibana_7.11.0_001', '.kibana_7.11.0': '.kibana_7.11.0_001', }, - versionIndexReadyActions: Option.none, }; test('CLEANUP_UNKNOWN_AND_EXCLUDED_WAIT_FOR_TASK -> CLEANUP_UNKNOWN_AND_EXCLUDED_WAIT_FOR_TASK when response is left wait_for_task_completion_timeout', () => { @@ -1481,9 +1347,7 @@ describe('migrations v2 model', () => { ) as PrepareCompatibleMigration; expect(newState.controlState).toEqual('PREPARE_COMPATIBLE_MIGRATION'); - expect(newState.targetIndexRawMappings).toEqual(indexMapping); expect(newState.targetIndexMappings).toEqual(indexMapping); - expect(newState.targetIndex).toEqual('.kibana_7.11.0_001'); expect(newState.preTransformDocsActions).toEqual([ { add: { @@ -1563,10 +1427,10 @@ describe('migrations v2 model', () => { test('CHECK_UNKNOWN_DOCUMENTS -> SET_SOURCE_WRITE_BLOCK if action succeeds and no unknown docs are found', () => { const checkUnknownDocumentsSourceState: CheckUnknownDocumentsState = { - ...baseState, + ...postInitState, controlState: 'CHECK_UNKNOWN_DOCUMENTS', sourceIndex: Option.some('.kibana_3') as Option.Some, - sourceIndexMappings: mappingsWithUnknownType, + sourceIndexMappings: Option.some(mappingsWithUnknownType) as Option.Some, }; const res: ResponseType<'CHECK_UNKNOWN_DOCUMENTS'> = Either.right({}); @@ -1608,11 +1472,11 @@ describe('migrations v2 model', () => { describe('when unknown docs are found', () => { test('CHECK_UNKNOWN_DOCUMENTS -> SET_SOURCE_WRITE_BLOCK if discardUnknownObjects=true', () => { const checkUnknownDocumentsSourceState: CheckUnknownDocumentsState = { - ...baseState, + ...postInitState, discardUnknownObjects: true, controlState: 'CHECK_UNKNOWN_DOCUMENTS', sourceIndex: Option.some('.kibana_3') as Option.Some, - sourceIndexMappings: mappingsWithUnknownType, + sourceIndexMappings: Option.some(mappingsWithUnknownType) as Option.Some, }; const res: ResponseType<'CHECK_UNKNOWN_DOCUMENTS'> = Either.right({ @@ -1653,10 +1517,10 @@ describe('migrations v2 model', () => { test('CHECK_UNKNOWN_DOCUMENTS -> FATAL if discardUnknownObjects=false', () => { const checkUnknownDocumentsSourceState: CheckUnknownDocumentsState = { - ...baseState, + ...postInitState, controlState: 'CHECK_UNKNOWN_DOCUMENTS', sourceIndex: Option.some('.kibana_3') as Option.Some, - sourceIndexMappings: mappingsWithUnknownType, + sourceIndexMappings: Option.some(mappingsWithUnknownType) as Option.Some, }; const res: ResponseType<'CHECK_UNKNOWN_DOCUMENTS'> = Either.right({ @@ -1681,11 +1545,10 @@ describe('migrations v2 model', () => { describe('SET_SOURCE_WRITE_BLOCK', () => { const setWriteBlockState: SetSourceWriteBlockState = { - ...baseState, + ...postInitState, controlState: 'SET_SOURCE_WRITE_BLOCK', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, - targetIndex: '.kibana_7.11.0_001', + sourceIndexMappings: Option.some({}) as Option.Some, }; test('SET_SOURCE_WRITE_BLOCK -> SET_SOURCE_WRITE_BLOCK if action fails with set_write_block_failed', () => { const res: ResponseType<'SET_SOURCE_WRITE_BLOCK'> = Either.left({ @@ -1710,11 +1573,10 @@ describe('migrations v2 model', () => { describe('CALCULATE_EXCLUDE_FILTERS', () => { const state: CalculateExcludeFiltersState = { - ...baseState, + ...postInitState, controlState: 'CALCULATE_EXCLUDE_FILTERS', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, - targetIndex: '.kibana_7.11.0_001', + sourceIndexMappings: Option.some({}) as Option.Some, tempIndexMappings: { properties: {} }, }; test('CALCULATE_EXCLUDE_FILTERS -> CALCULATE_EXCLUDE_FILTERS if action fails with retryable error', () => { @@ -1762,11 +1624,10 @@ describe('migrations v2 model', () => { describe('CREATE_REINDEX_TEMP', () => { const state: CreateReindexTempState = { - ...baseState, + ...postInitState, controlState: 'CREATE_REINDEX_TEMP', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, - targetIndex: '.kibana_7.11.0_001', + sourceIndexMappings: Option.some({}) as Option.Some, tempIndexMappings: { properties: {} }, }; it('CREATE_REINDEX_TEMP -> REINDEX_SOURCE_TO_TEMP_OPEN_PIT if action succeeds', () => { @@ -1818,11 +1679,10 @@ describe('migrations v2 model', () => { describe('REINDEX_SOURCE_TO_TEMP_OPEN_PIT', () => { const state: ReindexSourceToTempOpenPit = { - ...baseState, + ...postInitState, controlState: 'REINDEX_SOURCE_TO_TEMP_OPEN_PIT', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, - targetIndex: '.kibana_7.11.0_001', + sourceIndexMappings: Option.some({}) as Option.Some, tempIndexMappings: { properties: {} }, }; it('REINDEX_SOURCE_TO_TEMP_OPEN_PIT -> REINDEX_SOURCE_TO_TEMP_READ if action succeeds', () => { @@ -1840,10 +1700,10 @@ describe('migrations v2 model', () => { describe('REINDEX_SOURCE_TO_TEMP_READ', () => { const state: ReindexSourceToTempRead = { - ...baseState, + ...postInitState, controlState: 'REINDEX_SOURCE_TO_TEMP_READ', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, + sourceIndexMappings: Option.some({}) as Option.Some, sourceIndexPitId: 'pit_id', targetIndex: '.kibana_7.11.0_001', tempIndexMappings: { properties: {} }, @@ -1944,12 +1804,11 @@ describe('migrations v2 model', () => { describe('REINDEX_SOURCE_TO_TEMP_CLOSE_PIT', () => { const state: ReindexSourceToTempClosePit = { - ...baseState, + ...postInitState, controlState: 'REINDEX_SOURCE_TO_TEMP_CLOSE_PIT', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, + sourceIndexMappings: Option.some({}) as Option.Some, sourceIndexPitId: 'pit_id', - targetIndex: '.kibana_7.11.0_001', tempIndexMappings: { properties: {} }, }; @@ -1963,11 +1822,11 @@ describe('migrations v2 model', () => { describe('REINDEX_SOURCE_TO_TEMP_TRANSFORM', () => { const state: ReindexSourceToTempTransform = { - ...baseState, + ...postInitState, controlState: 'REINDEX_SOURCE_TO_TEMP_TRANSFORM', outdatedDocuments: [], - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, + sourceIndexMappings: Option.some({}) as Option.Some, sourceIndexPitId: 'pit_id', targetIndex: '.kibana_7.11.0_001', lastHitSortValue: undefined, @@ -2040,14 +1899,13 @@ describe('migrations v2 model', () => { describe('REINDEX_SOURCE_TO_TEMP_INDEX_BULK', () => { const reindexSourceToTempIndexBulkState: ReindexSourceToTempIndexBulk = { - ...baseState, + ...postInitState, controlState: 'REINDEX_SOURCE_TO_TEMP_INDEX_BULK', bulkOperationBatches, currentBatch: 0, - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, + sourceIndexMappings: Option.some({}) as Option.Some, sourceIndexPitId: 'pit_id', - targetIndex: '.kibana_7.11.0_001', lastHitSortValue: undefined, transformErrors: [], corruptDocumentIds: [], @@ -2104,11 +1962,10 @@ describe('migrations v2 model', () => { describe('SET_TEMP_WRITE_BLOCK', () => { const state: SetTempWriteBlock = { - ...baseState, + ...postInitState, controlState: 'SET_TEMP_WRITE_BLOCK', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, - targetIndex: '.kibana_7.11.0_001', + sourceIndexMappings: Option.some({}) as Option.Some, }; test('SET_TEMP_WRITE_BLOCK -> CLONE_TEMP_TO_TARGET when response is right', () => { const res: ResponseType<'SET_TEMP_WRITE_BLOCK'> = Either.right('set_write_block_succeeded'); @@ -2121,11 +1978,9 @@ describe('migrations v2 model', () => { describe('CLONE_TEMP_TO_TARGET', () => { const state: CloneTempToSource = { - ...baseState, + ...postInitState, controlState: 'CLONE_TEMP_TO_TARGET', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, - targetIndex: '.kibana_7.11.0_001', }; it('CLONE_TEMP_TO_TARGET -> REFRESH_TARGET if response is right', () => { const res: ResponseType<'CLONE_TEMP_TO_TARGET'> = Either.right({ @@ -2193,11 +2048,10 @@ describe('migrations v2 model', () => { describe('PREPARE_COMPATIBLE_MIGRATIONS', () => { const someAliasAction: AliasAction = { add: { index: '.kibana', alias: '.kibana_8.7.0' } }; const state: PrepareCompatibleMigration = { - ...baseState, + ...postInitState, controlState: 'PREPARE_COMPATIBLE_MIGRATION', - versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, - targetIndex: '.kibana_7.11.0_001', + sourceIndexMappings: Option.some({}) as Option.Some, preTransformDocsActions: [someAliasAction], }; @@ -2258,7 +2112,7 @@ describe('migrations v2 model', () => { describe('OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT', () => { const state: OutdatedDocumentsSearchOpenPit = { - ...baseState, + ...postInitState, controlState: 'OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT', versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, @@ -2279,7 +2133,7 @@ describe('migrations v2 model', () => { describe('OUTDATED_DOCUMENTS_SEARCH_READ', () => { const state: OutdatedDocumentsSearchRead = { - ...baseState, + ...postInitState, controlState: 'OUTDATED_DOCUMENTS_SEARCH_READ', versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, @@ -2391,7 +2245,7 @@ describe('migrations v2 model', () => { describe('OUTDATED_DOCUMENTS_SEARCH_CLOSE_PIT', () => { const state: OutdatedDocumentsSearchClosePit = { - ...baseState, + ...postInitState, controlState: 'OUTDATED_DOCUMENTS_SEARCH_CLOSE_PIT', versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, @@ -2411,7 +2265,7 @@ describe('migrations v2 model', () => { describe('CHECK_TARGET_MAPPINGS', () => { const checkTargetMappingsState: CheckTargetMappingsState = { - ...baseState, + ...postInitState, controlState: 'CHECK_TARGET_MAPPINGS', versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, @@ -2436,7 +2290,7 @@ describe('migrations v2 model', () => { describe('REFRESH_TARGET', () => { const state: RefreshTarget = { - ...baseState, + ...postInitState, controlState: 'REFRESH_TARGET', versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, @@ -2460,6 +2314,8 @@ describe('migrations v2 model', () => { ] as TransformErrorObjects[]; const outdatedDocumentsTransformState: OutdatedDocumentsTransform = { ...baseState, + aliases: {}, + sourceIndexMappings: Option.none, controlState: 'OUTDATED_DOCUMENTS_TRANSFORM', versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, @@ -2585,7 +2441,7 @@ describe('migrations v2 model', () => { ['a:d'].map(idToIndexOperation), ]; const transformedDocumentsBulkIndexState: TransformedDocumentsBulkIndex = { - ...baseState, + ...postInitState, controlState: 'TRANSFORMED_DOCUMENTS_BULK_INDEX', bulkOperationBatches: customBulkOperationBatches, currentBatch: 0, @@ -2656,7 +2512,7 @@ describe('migrations v2 model', () => { describe('UPDATE_TARGET_MAPPINGS_PROPERTIES', () => { const updateTargetMappingsState: UpdateTargetMappingsPropertiesState = { - ...baseState, + ...postInitState, controlState: 'UPDATE_TARGET_MAPPINGS_PROPERTIES', versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, @@ -2679,7 +2535,7 @@ describe('migrations v2 model', () => { describe('UPDATE_TARGET_MAPPINGS_PROPERTIES_WAIT_FOR_TASK', () => { const updateTargetMappingsWaitForTaskState: UpdateTargetMappingsPropertiesWaitForTaskState = { - ...baseState, + ...postInitState, controlState: 'UPDATE_TARGET_MAPPINGS_PROPERTIES_WAIT_FOR_TASK', versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, @@ -2730,7 +2586,7 @@ describe('migrations v2 model', () => { describe('UPDATE_TARGET_MAPPINGS_META', () => { const updateTargetMappingsMetaState: UpdateTargetMappingsMeta = { - ...baseState, + ...postInitState, controlState: 'UPDATE_TARGET_MAPPINGS_META', versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, @@ -2749,8 +2605,8 @@ describe('migrations v2 model', () => { describe('CHECK_VERSION_INDEX_READY_ACTIONS', () => { const res: ResponseType<'CHECK_VERSION_INDEX_READY_ACTIONS'> = Either.right('noop'); - const postInitState: CheckVersionIndexReadyActions = { - ...baseState, + const сheckVersionIndexReadyActionsState: CheckVersionIndexReadyActions = { + ...postInitState, controlState: 'CHECK_VERSION_INDEX_READY_ACTIONS', versionIndexReadyActions: Option.none, sourceIndex: Option.some('.kibana') as Option.Some, @@ -2764,7 +2620,7 @@ describe('migrations v2 model', () => { const newState = model( { - ...postInitState, + ...сheckVersionIndexReadyActionsState, versionIndexReadyActions, }, res @@ -2775,7 +2631,7 @@ describe('migrations v2 model', () => { }); test('CHECK_VERSION_INDEX_READY_ACTIONS -> DONE if none versionIndexReadyActions', () => { - const newState = model(postInitState, res) as PostInitState; + const newState = model(сheckVersionIndexReadyActionsState, res) as PostInitState; expect(newState.controlState).toEqual('DONE'); expect(newState.retryCount).toEqual(0); expect(newState.retryDelay).toEqual(0); @@ -2787,7 +2643,7 @@ describe('migrations v2 model', () => { AliasAction[] >; const createNewTargetState: CreateNewTargetState = { - ...baseState, + ...postInitState, controlState: 'CREATE_NEW_TARGET', versionIndexReadyActions: aliasActions, sourceIndex: Option.none as Option.None, @@ -2840,10 +2696,9 @@ describe('migrations v2 model', () => { AliasAction[] >; const markVersionIndexReadyState: MarkVersionIndexReady = { - ...baseState, + ...postInitState, controlState: 'MARK_VERSION_INDEX_READY', versionIndexReadyActions: aliasActions, - sourceIndex: Option.none as Option.None, targetIndex: '.kibana_7.11.0_001', }; test('MARK_VERSION_INDEX_READY -> DONE if the action succeeded', () => { @@ -2881,10 +2736,9 @@ describe('migrations v2 model', () => { AliasAction[] >; const markVersionIndexConflictState: MarkVersionIndexReadyConflict = { - ...baseState, + ...postInitState, controlState: 'MARK_VERSION_INDEX_READY_CONFLICT', versionIndexReadyActions: aliasActions, - sourceIndex: Option.none as Option.None, targetIndex: '.kibana_7.11.0_001', }; test('MARK_VERSION_INDEX_CONFLICT -> DONE if the current alias is pointing to the version alias', () => { diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/model.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/model.ts index 45dbcc877bbdb..2f78d8745e55a 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/model.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/model/model.ts @@ -8,6 +8,7 @@ import * as Either from 'fp-ts/lib/Either'; import * as Option from 'fp-ts/lib/Option'; +import type { IndexMapping } from '@kbn/core-saved-objects-base-server-internal'; import { isTypeof } from '../actions'; import type { AliasAction } from '../actions'; @@ -33,6 +34,7 @@ import { addMustClausesToBoolQuery, addMustNotClausesToBoolQuery, getAliases, + getMigrationType, indexBelongsToLaterVersion, indexVersion, mergeMigrationMappingPropertyHashes, @@ -40,10 +42,10 @@ import { throwBadResponse, versionMigrationCompleted, buildRemoveAliasActions, + MigrationType, } from './helpers'; import { createBatches } from './create_batches'; import type { MigrationLog } from '../types'; -import { diffMappings } from '../core/build_active_mappings'; import { CLUSTER_SHARD_LIMIT_EXCEEDED_REASON } from '../common/constants'; export const FATAL_REASON_REQUEST_ENTITY_TOO_LARGE = `While indexing a batch of saved objects, Elasticsearch returned a 413 Request Entity Too Large exception. Ensure that the Kibana configuration option 'migrations.maxBatchSizeBytes' is set to a value that is lower than or equal to the Elasticsearch 'http.max_content_length' configuration option.`; @@ -99,39 +101,11 @@ export const model = (currentState: State, resW: ResponseType): const aliases = aliasesRes.right; - // The source index .kibana is pointing to. E.g: ".kibana_8.7.0_001" - const source = aliases[stateP.currentAlias]; - if ( - // This version's migration has already been completed. - versionMigrationCompleted(stateP.currentAlias, stateP.versionAlias, aliases) - ) { - return { - ...stateP, - // Skip to 'OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT' so that if a new plugin was - // installed / enabled we can transform any old documents and update - // the mappings for this plugin's types. - controlState: 'OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT', - // Source is a none because we didn't do any migration from a source - // index - sourceIndex: Option.none, - targetIndex: source!, - sourceIndexMappings: indices[source!].mappings, - // in this scenario, a .kibana_X.Y.Z_001 index exists that matches the current kibana version - // aka we are NOT upgrading to a newer version - // we inject the target index's current mappings in the state, to check them later - targetIndexRawMappings: indices[source!].mappings, - targetIndexMappings: mergeMigrationMappingPropertyHashes( - stateP.targetIndexMappings, - indices[source!].mappings - ), - versionIndexReadyActions: Option.none, - }; - } else if ( // `.kibana` is pointing to an index that belongs to a later // version of Kibana .e.g. a 7.11.0 instance found the `.kibana` alias // pointing to `.kibana_7.12.0_001` - indexBelongsToLaterVersion(aliases[stateP.currentAlias]!, stateP.kibanaVersion) + indexBelongsToLaterVersion(stateP.kibanaVersion, aliases[stateP.currentAlias]) ) { return { ...stateP, @@ -142,12 +116,27 @@ export const model = (currentState: State, resW: ResponseType): aliases[stateP.currentAlias] )}`, }; - } else if ( + } + + // The source index .kibana is pointing to. E.g: ".kibana_8.7.0_001" + const source = aliases[stateP.currentAlias]; + + const postInitState = { + aliases, + sourceIndex: Option.fromNullable(source), + sourceIndexMappings: Option.fromNullable(source ? indices[source]?.mappings : undefined), + versionIndexReadyActions: Option.none, + }; + + if ( // Don't actively participate in this migration but wait for another instance to complete it stateP.waitForMigrationCompletion === true ) { return { ...stateP, + ...postInitState, + sourceIndex: Option.none, + targetIndex: `${stateP.indexPrefix}_${stateP.kibanaVersion}_001`, controlState: 'WAIT_FOR_MIGRATION_COMPLETION', // Wait for 2s before checking again if the migration has completed retryDelay: 2000, @@ -161,15 +150,16 @@ export const model = (currentState: State, resW: ResponseType): }; } else if ( // If the `.kibana` alias exists - source != null + Option.isSome(postInitState.sourceIndex) ) { // CHECKPOINT here we decide to go for yellow source return { ...stateP, - aliases, + ...postInitState, controlState: 'WAIT_FOR_YELLOW_SOURCE', - sourceIndex: Option.some(source!) as Option.Some, - sourceIndexMappings: indices[source!].mappings, + sourceIndex: postInitState.sourceIndex, + sourceIndexMappings: postInitState.sourceIndexMappings as Option.Some, + targetIndex: postInitState.sourceIndex.value, // We preserve the same index, source == target (E.g: ".xx8.7.0_001") }; } else if (indices[stateP.legacyIndex] != null) { // Migrate from a legacy index @@ -194,10 +184,13 @@ export const model = (currentState: State, resW: ResponseType): const target = stateP.versionIndex; return { ...stateP, + ...postInitState, controlState: 'LEGACY_SET_WRITE_BLOCK', sourceIndex: Option.some(legacyReindexTarget) as Option.Some, + sourceIndexMappings: Option.some( + indices[stateP.legacyIndex].mappings + ) as Option.Some, targetIndex: target, - legacyReindexTargetMappings: indices[stateP.legacyIndex].mappings, legacyPreMigrationDoneActions: [ { remove_index: { index: stateP.legacyIndex } }, { @@ -226,6 +219,7 @@ export const model = (currentState: State, resW: ResponseType): const target = stateP.versionIndex; return { ...stateP, + ...postInitState, controlState: 'CREATE_NEW_TARGET', sourceIndex: Option.none as Option.None, targetIndex: target, @@ -256,11 +250,6 @@ export const model = (currentState: State, resW: ResponseType): // migration. So we won't need to transform any old documents or update // the mappings. controlState: 'DONE', - // Source is a none because we didn't do any migration from a source - // index - sourceIndex: Option.none, - targetIndex: `${stateP.indexPrefix}_${stateP.kibanaVersion}_001`, - versionIndexReadyActions: Option.none, }; } else { // When getAliases returns a left 'multiple_indices_per_alias' error or @@ -424,30 +413,10 @@ export const model = (currentState: State, resW: ResponseType): } else if (stateP.controlState === 'WAIT_FOR_YELLOW_SOURCE') { const res = resW as ExcludeRetryableEsError>; if (Either.isRight(res)) { - if ( - // source exists - Boolean(stateP.sourceIndexMappings._meta?.migrationMappingPropertyHashes) && - // ...and mappings are unchanged - !diffMappings( - /* actual */ - stateP.sourceIndexMappings, - /* expected */ - stateP.targetIndexMappings - ) - ) { - // the existing mappings match, we can avoid reindexing - return { - ...stateP, - controlState: 'CLEANUP_UNKNOWN_AND_EXCLUDED', - targetIndex: stateP.sourceIndex.value!, // We preserve the same index, source == target (E.g: ".xx8.7.0_001") - versionIndexReadyActions: Option.none, - }; - } else { - return { - ...stateP, - controlState: 'UPDATE_SOURCE_MAPPINGS_PROPERTIES', - }; - } + return { + ...stateP, + controlState: 'UPDATE_SOURCE_MAPPINGS_PROPERTIES', + }; } else if (Either.isLeft(res)) { const left = res.left; if (isTypeof(left, 'index_not_yellow_timeout')) { @@ -466,25 +435,50 @@ export const model = (currentState: State, resW: ResponseType): } } else if (stateP.controlState === 'UPDATE_SOURCE_MAPPINGS_PROPERTIES') { const res = resW as ExcludeRetryableEsError>; - if (Either.isRight(res)) { - return { - ...stateP, - controlState: 'CLEANUP_UNKNOWN_AND_EXCLUDED', - targetIndex: stateP.sourceIndex.value!, // We preserve the same index, source == target (E.g: ".xx8.7.0_001") - versionIndexReadyActions: Option.none, - }; - } else if (Either.isLeft(res)) { - const left = res.left; - if (isTypeof(left, 'incompatible_mapping_exception')) { + const migrationType = getMigrationType({ + isMappingsCompatible: Either.isRight(res), + isVersionMigrationCompleted: versionMigrationCompleted( + stateP.currentAlias, + stateP.versionAlias, + stateP.aliases + ), + }); + + switch (migrationType) { + case MigrationType.Compatible: + return { + ...stateP, + controlState: 'CLEANUP_UNKNOWN_AND_EXCLUDED', + }; + case MigrationType.Incompatible: return { ...stateP, controlState: 'CHECK_UNKNOWN_DOCUMENTS', }; - } else { - return throwBadResponse(stateP, left as never); - } - } else { - return throwBadResponse(stateP, res); + case MigrationType.Unnecessary: + return { + ...stateP, + // Skip to 'OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT' so that if a new plugin was + // installed / enabled we can transform any old documents and update + // the mappings for this plugin's types. + controlState: 'OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT', + // Source is a none because we didn't do any migration from a source index + sourceIndex: Option.none, + targetIndex: stateP.sourceIndex.value, + // in this scenario, a .kibana_X.Y.Z_001 index exists that matches the current kibana version + // aka we are NOT upgrading to a newer version + // we inject the source index's current mappings in the state, to check them later + targetIndexMappings: mergeMigrationMappingPropertyHashes( + stateP.targetIndexMappings, + stateP.sourceIndexMappings.value + ), + }; + case MigrationType.Invalid: + return { + ...stateP, + controlState: 'FATAL', + reason: 'Incompatible mappings change on already migrated Kibana instance.', + }; } } else if (stateP.controlState === 'CLEANUP_UNKNOWN_AND_EXCLUDED') { const res = resW as ExcludeRetryableEsError>; @@ -530,10 +524,9 @@ export const model = (currentState: State, resW: ResponseType): controlState: 'PREPARE_COMPATIBLE_MIGRATION', mustRefresh: stateP.mustRefresh || typeof res.right.deleted === 'undefined' || res.right.deleted > 0, - targetIndexRawMappings: stateP.sourceIndexMappings, targetIndexMappings: mergeMigrationMappingPropertyHashes( stateP.targetIndexMappings, - stateP.sourceIndexMappings + stateP.sourceIndexMappings.value ), preTransformDocsActions: [ // Point the version alias to the source index. This let's other Kibana @@ -826,6 +819,7 @@ export const model = (currentState: State, resW: ResponseType): ...state, controlState: 'SET_TEMP_WRITE_BLOCK', sourceIndex: stateP.sourceIndex as Option.Some, + sourceIndexMappings: Option.none, }; } else { throwBadResponse(stateP, res); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/next.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/next.ts index 1109d52039d3e..cc26bb543ef5e 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/next.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/next.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +import * as Option from 'fp-ts/lib/Option'; import type { ElasticsearchClient } from '@kbn/core-elasticsearch-server'; import { omit } from 'lodash'; import type { @@ -75,11 +76,16 @@ export const nextActionMap = (client: ElasticsearchClient, transformRawDocs: Tra Actions.fetchIndices({ client, indices: [state.currentAlias, state.versionAlias] }), WAIT_FOR_YELLOW_SOURCE: (state: WaitForYellowSourceState) => Actions.waitForIndexStatus({ client, index: state.sourceIndex.value, status: 'yellow' }), - UPDATE_SOURCE_MAPPINGS_PROPERTIES: (state: UpdateSourceMappingsPropertiesState) => - Actions.updateMappings({ + UPDATE_SOURCE_MAPPINGS_PROPERTIES: ({ + sourceIndex, + sourceIndexMappings, + targetIndexMappings, + }: UpdateSourceMappingsPropertiesState) => + Actions.updateSourceMappingsProperties({ client, - index: state.sourceIndex.value, // attempt to update source mappings in-place - mappings: omit(state.targetIndexMappings, ['_meta']), // ._meta property will be updated on a later step + sourceIndex: sourceIndex.value, + sourceMappings: sourceIndexMappings.value, + targetMappings: targetIndexMappings, }), CLEANUP_UNKNOWN_AND_EXCLUDED: (state: CleanupUnknownAndExcluded) => Actions.cleanupUnknownAndExcluded({ @@ -169,7 +175,7 @@ export const nextActionMap = (client: ElasticsearchClient, transformRawDocs: Tra Actions.refreshIndex({ client, index: state.targetIndex }), CHECK_TARGET_MAPPINGS: (state: CheckTargetMappingsState) => Actions.checkTargetMappings({ - actualMappings: state.targetIndexRawMappings, + actualMappings: Option.toUndefined(state.sourceIndexMappings), expectedMappings: state.targetIndexMappings, }), UPDATE_TARGET_MAPPINGS_PROPERTIES: (state: UpdateTargetMappingsPropertiesState) => @@ -233,7 +239,7 @@ export const nextActionMap = (client: ElasticsearchClient, transformRawDocs: Tra Actions.createIndex({ client, indexName: state.sourceIndex.value, - mappings: state.legacyReindexTargetMappings, + mappings: state.sourceIndexMappings.value, }), LEGACY_REINDEX: (state: LegacyReindexState) => Actions.reindex({ diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/state.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/state.ts index 475598345e92e..5dd135d4b32fe 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/state.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/state.ts @@ -19,6 +19,7 @@ import type { AliasAction } from './actions'; import type { TransformErrorObjects } from './core'; import type { MigrationLog, Progress } from './types'; import type { BulkOperation } from './model/create_batches'; +import type { Aliases } from './model/helpers'; export interface BaseState extends ControlState { /** The first part of the index name such as `.kibana` or `.kibana_task_manager` */ @@ -157,12 +158,8 @@ export interface InitState extends BaseState { readonly controlState: 'INIT'; } -export interface WaitForMigrationCompletionState extends BaseState { - /** Wait until another instance completes the migration */ - readonly controlState: 'WAIT_FOR_MIGRATION_COMPLETION'; -} - export interface PostInitState extends BaseState { + readonly aliases: Aliases; /** * The source index is the index from which the migration reads. If the * Option is a none, we didn't do any migration from a source index, either: @@ -172,42 +169,37 @@ export interface PostInitState extends BaseState { * the MARK_VERSION_INDEX_READY step */ readonly sourceIndex: Option.Option; + readonly sourceIndexMappings: Option.Option; /** The target index is the index to which the migration writes */ readonly targetIndex: string; - /** - * Unaltered mappings retrieved from the current target index. - * - * See also {@link BaseState['targetIndexMappings']}. - */ - readonly targetIndexRawMappings?: IndexMapping; readonly versionIndexReadyActions: Option.Option; } -export interface SourceExistsState { +export interface SourceExistsState extends PostInitState { readonly sourceIndex: Option.Some; + readonly sourceIndexMappings: Option.Some; +} + +export interface WaitForMigrationCompletionState extends PostInitState { + /** Wait until another instance completes the migration */ + readonly controlState: 'WAIT_FOR_MIGRATION_COMPLETION'; } -export type BaseWithSource = BaseState & SourceExistsState; -export type PostInitWithSource = PostInitState & SourceExistsState; export interface DoneState extends PostInitState { /** Migration completed successfully */ readonly controlState: 'DONE'; } -export interface CleanupUnknownAndExcluded extends PostInitWithSource { +export interface CleanupUnknownAndExcluded extends SourceExistsState { /** Clean the source index, removing SOs with unknown and excluded types */ readonly controlState: 'CLEANUP_UNKNOWN_AND_EXCLUDED'; - readonly sourceIndexMappings: IndexMapping; - readonly aliases: Record; /** The cleanup operation has deleted one or more documents, we gotta refresh the index */ readonly mustRefresh?: boolean; } -export interface CleanupUnknownAndExcludedWaitForTaskState extends PostInitWithSource { +export interface CleanupUnknownAndExcludedWaitForTaskState extends SourceExistsState { readonly controlState: 'CLEANUP_UNKNOWN_AND_EXCLUDED_WAIT_FOR_TASK'; readonly deleteByQueryTaskId: string; - readonly sourceIndexMappings: IndexMapping; - readonly aliases: Record; /** The cleanup operation has deleted one or more documents, we gotta refresh the index */ readonly mustRefresh?: boolean; } @@ -220,7 +212,7 @@ export interface CleanupUnknownAndExcludedWaitForTaskState extends PostInitWithS * need to make sure that no older Kibana versions are still writing to target * index. */ -export interface PrepareCompatibleMigration extends PostInitWithSource { +export interface PrepareCompatibleMigration extends SourceExistsState { /** We have found a schema-compatible migration, this means we can optimise our migration steps */ readonly controlState: 'PREPARE_COMPATIBLE_MIGRATION'; /** Alias-level actions that prepare for this migration */ @@ -229,7 +221,7 @@ export interface PrepareCompatibleMigration extends PostInitWithSource { readonly mustRefresh?: boolean; } -export interface RefreshSource extends PostInitWithSource { +export interface RefreshSource extends SourceExistsState { /** Refresh source index before searching for outdated docs */ readonly controlState: 'REFRESH_SOURCE'; } @@ -241,32 +233,26 @@ export interface FatalState extends BaseState { readonly reason: string; } -export interface WaitForYellowSourceState extends BaseWithSource { +export interface WaitForYellowSourceState extends SourceExistsState { /** Wait for the source index to be yellow before reading from it. */ readonly controlState: 'WAIT_FOR_YELLOW_SOURCE'; - readonly sourceIndexMappings: IndexMapping; - readonly aliases: Record; } -export interface UpdateSourceMappingsPropertiesState extends BaseState { +export interface UpdateSourceMappingsPropertiesState extends SourceExistsState { readonly controlState: 'UPDATE_SOURCE_MAPPINGS_PROPERTIES'; - readonly sourceIndex: Option.Some; - readonly sourceIndexMappings: IndexMapping; - readonly aliases: Record; } -export interface CheckUnknownDocumentsState extends BaseWithSource { +export interface CheckUnknownDocumentsState extends SourceExistsState { /** Check if any unknown document is present in the source index */ readonly controlState: 'CHECK_UNKNOWN_DOCUMENTS'; - readonly sourceIndexMappings: IndexMapping; } -export interface SetSourceWriteBlockState extends PostInitWithSource { +export interface SetSourceWriteBlockState extends SourceExistsState { /** Set a write block on the source index to prevent any further writes */ readonly controlState: 'SET_SOURCE_WRITE_BLOCK'; } -export interface CalculateExcludeFiltersState extends PostInitWithSource { +export interface CalculateExcludeFiltersState extends SourceExistsState { readonly controlState: 'CALCULATE_EXCLUDE_FILTERS'; } @@ -277,7 +263,7 @@ export interface CreateNewTargetState extends PostInitState { readonly versionIndexReadyActions: Option.Some; } -export interface CreateReindexTempState extends PostInitWithSource { +export interface CreateReindexTempState extends SourceExistsState { /** * Create a target index with mappings from the source index and registered * plugins @@ -285,12 +271,12 @@ export interface CreateReindexTempState extends PostInitWithSource { readonly controlState: 'CREATE_REINDEX_TEMP'; } -export interface ReindexSourceToTempOpenPit extends PostInitWithSource { +export interface ReindexSourceToTempOpenPit extends SourceExistsState { /** Open PIT to the source index */ readonly controlState: 'REINDEX_SOURCE_TO_TEMP_OPEN_PIT'; } -interface ReindexSourceToTempBatch extends PostInitState { +interface ReindexSourceToTempBatch extends SourceExistsState { readonly sourceIndexPitId: string; readonly lastHitSortValue: number[] | undefined; readonly corruptDocumentIds: string[]; @@ -302,7 +288,7 @@ export interface ReindexSourceToTempRead extends ReindexSourceToTempBatch { readonly controlState: 'REINDEX_SOURCE_TO_TEMP_READ'; } -export interface ReindexSourceToTempClosePit extends PostInitState { +export interface ReindexSourceToTempClosePit extends SourceExistsState { readonly controlState: 'REINDEX_SOURCE_TO_TEMP_CLOSE_PIT'; readonly sourceIndexPitId: string; } @@ -318,11 +304,11 @@ export interface ReindexSourceToTempIndexBulk extends ReindexSourceToTempBatch { readonly currentBatch: number; } -export interface SetTempWriteBlock extends PostInitWithSource { +export interface SetTempWriteBlock extends PostInitState { readonly controlState: 'SET_TEMP_WRITE_BLOCK'; } -export interface CloneTempToSource extends PostInitWithSource { +export interface CloneTempToSource extends PostInitState { /** * Clone the temporary reindex index into */ @@ -337,7 +323,6 @@ export interface RefreshTarget extends PostInitState { export interface CheckTargetMappingsState extends PostInitState { readonly controlState: 'CHECK_TARGET_MAPPINGS'; - readonly sourceIndexMappings?: IndexMapping; } export interface UpdateTargetMappingsPropertiesState extends PostInitState { @@ -363,7 +348,6 @@ export interface CheckVersionIndexReadyActions extends PostInitState { export interface OutdatedDocumentsSearchOpenPit extends PostInitState { /** Open PiT for target index to search for outdated documents */ readonly controlState: 'OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT'; - readonly sourceIndexMappings?: IndexMapping; } export interface OutdatedDocumentsSearchRead extends PostInitState { @@ -450,13 +434,8 @@ export interface MarkVersionIndexReadyConflict extends PostInitState { * If we're migrating from a legacy index we need to perform some additional * steps to prepare this index so that it can be used as a migration 'source'. */ -export interface LegacyBaseState extends PostInitWithSource { +export interface LegacyBaseState extends SourceExistsState { readonly legacyPreMigrationDoneActions: AliasAction[]; - /** - * The mappings read from the legacy index, used to create a new reindex - * target index. - */ - readonly legacyReindexTargetMappings: IndexMapping; } export interface LegacySetWriteBlockState extends LegacyBaseState { diff --git a/packages/core/versioning/core-version-http-server/src/example.ts b/packages/core/versioning/core-version-http-server/src/example.ts index b63c75e86a562..fc0a9b3e39aec 100644 --- a/packages/core/versioning/core-version-http-server/src/example.ts +++ b/packages/core/versioning/core-version-http-server/src/example.ts @@ -28,13 +28,18 @@ const versionedRoute = versionedRouter { version: '1', validate: { - query: schema.object({ - name: schema.maybe(schema.string({ minLength: 2, maxLength: 50 })), - }), - params: schema.object({ - id: schema.maybe(schema.string({ minLength: 10, maxLength: 13 })), - }), - body: schema.object({ foo: schema.string() }), + request: { + query: schema.object({ + name: schema.maybe(schema.string({ minLength: 2, maxLength: 50 })), + }), + params: schema.object({ + id: schema.maybe(schema.string({ minLength: 10, maxLength: 13 })), + }), + body: schema.object({ foo: schema.string() }), + }, + response: { + body: schema.object({ foo: schema.string() }), + }, }, }, async (ctx, req, res) => { @@ -47,13 +52,18 @@ const versionedRoute = versionedRouter { version: '2', validate: { - query: schema.object({ - name: schema.maybe(schema.string({ minLength: 2, maxLength: 50 })), - }), - params: schema.object({ - id: schema.maybe(schema.string({ minLength: 10, maxLength: 13 })), - }), - body: schema.object({ fooString: schema.string() }), + request: { + query: schema.object({ + name: schema.maybe(schema.string({ minLength: 2, maxLength: 50 })), + }), + params: schema.object({ + id: schema.maybe(schema.string({ minLength: 10, maxLength: 13 })), + }), + body: schema.object({ fooString: schema.string() }), + }, + response: { + body: schema.object({ fooName: schema.string() }), + }, }, }, async (ctx, req, res) => { @@ -66,13 +76,18 @@ const versionedRoute = versionedRouter { version: '3', validate: { - query: schema.object({ - name: schema.maybe(schema.string({ minLength: 2, maxLength: 50 })), - }), - params: schema.object({ - id: schema.maybe(schema.string({ minLength: 10, maxLength: 13 })), - }), - body: schema.object({ fooString: schema.string({ minLength: 0, maxLength: 1000 }) }), + request: { + query: schema.object({ + name: schema.maybe(schema.string({ minLength: 2, maxLength: 50 })), + }), + params: schema.object({ + id: schema.maybe(schema.string({ minLength: 10, maxLength: 13 })), + }), + body: schema.object({ fooString: schema.string({ minLength: 0, maxLength: 1000 }) }), + }, + response: { + body: schema.object({ fooName: schema.string() }), + }, }, }, async (ctx, req, res) => { diff --git a/packages/core/versioning/core-version-http-server/src/version_http_toolkit.ts b/packages/core/versioning/core-version-http-server/src/version_http_toolkit.ts index 7d8dd7765e476..1488184aea7e0 100644 --- a/packages/core/versioning/core-version-http-server/src/version_http_toolkit.ts +++ b/packages/core/versioning/core-version-http-server/src/version_http_toolkit.ts @@ -6,14 +6,18 @@ * Side Public License, v 1. */ +import { Type } from '@kbn/config-schema'; +import type { WithRequiredProperty } from '@kbn/utility-types'; import type { IRouter, RouteConfig, RouteMethod, RequestHandler, + IKibanaResponse, + RouteConfigOptions, RouteValidatorFullConfig, RequestHandlerContextBase, - RouteConfigOptions, + RouteValidationFunction, } from '@kbn/core-http-server'; type RqCtx = RequestHandlerContextBase; @@ -39,53 +43,8 @@ export interface CreateVersionedRouterArgs { /** * This interface is the starting point for creating versioned routers and routes * - * @example - * const versionedRouter = vtk.createVersionedRouter({ router }); + * @example see ./example.ts * - * ```ts - * const versionedRoute = versionedRouter - * .post({ - * path: '/api/my-app/foo/{id?}', - * options: { timeout: { payload: 60000 }, access: 'public' }, - * }) - * .addVersion( - * { - * version: '1', - * validate: { - * query: schema.object({ - * name: schema.maybe(schema.string({ minLength: 2, maxLength: 50 })), - * }), - * params: schema.object({ - * id: schema.maybe(schema.string({ minLength: 10, maxLength: 13 })), - * }), - * body: schema.object({ foo: schema.string() }), - * }, - * }, - * async (ctx, req, res) => { - * await ctx.fooService.create(req.body.foo, req.params.id, req.query.name); - * return res.ok({ body: { foo: req.body.foo } }); - * } - * ) - * // BREAKING CHANGE: { foo: string } => { fooString: string } in body - * .addVersion( - * { - * version: '2', - * validate: { - * query: schema.object({ - * name: schema.maybe(schema.string({ minLength: 2, maxLength: 50 })), - * }), - * params: schema.object({ - * id: schema.maybe(schema.string({ minLength: 10, maxLength: 13 })), - * }), - * body: schema.object({ fooString: schema.string() }), - * }, - * }, - * async (ctx, req, res) => { - * await ctx.fooService.create(req.body.fooString, req.params.id, req.query.name); - * return res.ok({ body: { fooName: req.body.fooString } }); - * } - * ) - * ``` * @experimental */ export interface VersionHTTPToolkit { @@ -100,13 +59,6 @@ export interface VersionHTTPToolkit { ): VersionedRouter; } -/** - * Converts an input property from optional to required. Needed for making RouteConfigOptions['access'] required. - */ -type WithRequiredProperty = Type & { - [Property in Key]-?: Type[Property]; -}; - /** * Versioned route access flag, required * - '/api/foo' is 'public' @@ -154,12 +106,39 @@ export interface VersionedRouter { options: VersionedRouteRegistrar<'options', Ctx>; } +/** @experimental */ +export type RequestValidation = RouteValidatorFullConfig; + +/** @experimental */ +export interface ResponseValidation { + body: RouteValidationFunction | Type; +} + +/** + * Versioned route validation + * @experimental + */ +interface FullValidationConfig { + /** + * Validation to run against route inputs: params, query and body + * @experimental + */ + request?: RequestValidation; + /** + * Validation to run against route output + * @note This validation is only intended to run in development. Do not use this + * for setting default values! + * @experimental + */ + response?: ResponseValidation; +} + /** * Options for a versioned route. Probably needs a lot more options like sunsetting * of an endpoint etc. * @experimental */ -export interface AddVersionOpts { +export interface AddVersionOpts { /** * Version to assign to this route * @experimental @@ -169,7 +148,7 @@ export interface AddVersionOpts; + validate: false | FullValidationConfig; } /** @@ -187,8 +166,8 @@ export interface VersionedRoute< * @returns A versioned route, allows for fluent chaining of version declarations * @experimental */ - addVersion( - opts: AddVersionOpts, - handler: RequestHandler + addVersion( + options: AddVersionOpts, + handler: (...params: Parameters>) => Promise> ): VersionedRoute; } diff --git a/packages/core/versioning/core-version-http-server/tsconfig.json b/packages/core/versioning/core-version-http-server/tsconfig.json index fa73dc9c397bf..d0ff9556e176f 100644 --- a/packages/core/versioning/core-version-http-server/tsconfig.json +++ b/packages/core/versioning/core-version-http-server/tsconfig.json @@ -13,6 +13,7 @@ "kbn_references": [ "@kbn/config-schema", "@kbn/core-http-server", + "@kbn/utility-types", ], "exclude": [ "target/**/*", diff --git a/packages/kbn-apm-synthtrace-client/src/lib/apm/apm_fields.ts b/packages/kbn-apm-synthtrace-client/src/lib/apm/apm_fields.ts index abc916668299c..df780671d35ce 100644 --- a/packages/kbn-apm-synthtrace-client/src/lib/apm/apm_fields.ts +++ b/packages/kbn-apm-synthtrace-client/src/lib/apm/apm_fields.ts @@ -116,6 +116,7 @@ export type ApmFields = Fields<{ 'kubernetes.pod.name': string; 'kubernetes.pod.uid': string; 'labels.name': string; + 'labels.telemetry_auto_version': string; 'metricset.name': string; 'network.carrier.icc': string; 'network.carrier.mcc': string; diff --git a/packages/kbn-apm-synthtrace-client/src/lib/apm/processors/get_breakdown_metrics.ts b/packages/kbn-apm-synthtrace-client/src/lib/apm/processors/get_breakdown_metrics.ts index fe1779c3cace9..b33b8d6953a73 100644 --- a/packages/kbn-apm-synthtrace-client/src/lib/apm/processors/get_breakdown_metrics.ts +++ b/packages/kbn-apm-synthtrace-client/src/lib/apm/processors/get_breakdown_metrics.ts @@ -41,6 +41,7 @@ const KEY_FIELDS: Array = [ 'transaction.name', 'span.type', 'span.subtype', + 'labels.telemetry_auto_version', ]; export function getBreakdownMetrics(events: ApmFields[]): ApmFields[] { diff --git a/packages/kbn-apm-synthtrace/src/test/scenarios/__snapshots__/01_simple_trace.test.ts.snap b/packages/kbn-apm-synthtrace/src/test/scenarios/__snapshots__/01_simple_trace.test.ts.snap index c16486fe50da6..15883c2711f43 100644 --- a/packages/kbn-apm-synthtrace/src/test/scenarios/__snapshots__/01_simple_trace.test.ts.snap +++ b/packages/kbn-apm-synthtrace/src/test/scenarios/__snapshots__/01_simple_trace.test.ts.snap @@ -48,7 +48,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -68,7 +68,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -129,7 +129,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -149,7 +149,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -210,7 +210,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -230,7 +230,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -291,7 +291,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -311,7 +311,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -372,7 +372,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -392,7 +392,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -453,7 +453,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -473,7 +473,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -534,7 +534,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -554,7 +554,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -615,7 +615,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -635,7 +635,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -696,7 +696,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -716,7 +716,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -777,7 +777,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -797,7 +797,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -858,7 +858,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -878,7 +878,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -939,7 +939,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -959,7 +959,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -1020,7 +1020,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -1040,7 +1040,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -1101,7 +1101,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -1121,7 +1121,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -1182,7 +1182,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "256555875", + "metricset.id": "1946223711", }, "metricset.name": "span_breakdown", "processor.event": "metric", @@ -1202,7 +1202,7 @@ Array [ "container.id": "instance-1", "host.name": "instance-1", "meta": Object { - "metricset.id": "290461557", + "metricset.id": "3995767080", }, "metricset.name": "span_breakdown", "processor.event": "metric", diff --git a/packages/kbn-eslint-config/.eslintrc.js b/packages/kbn-eslint-config/.eslintrc.js index 79369e3ed2cae..36504cb8b8355 100644 --- a/packages/kbn-eslint-config/.eslintrc.js +++ b/packages/kbn-eslint-config/.eslintrc.js @@ -1,22 +1,18 @@ const { USES_STYLED_COMPONENTS } = require('@kbn/babel-preset/styled_components_files'); module.exports = { - extends: [ - './javascript.js', - './typescript.js', - './jest.js', - './react.js', - ], + extends: ['./javascript.js', './typescript.js', './jest.js', './react.js'], plugins: [ '@kbn/eslint-plugin-disable', '@kbn/eslint-plugin-eslint', '@kbn/eslint-plugin-imports', + '@kbn/eslint-plugin-telemetry', 'prettier', ], parserOptions: { - ecmaVersion: 2018 + ecmaVersion: 2018, }, env: { @@ -41,7 +37,7 @@ module.exports = { { from: 'mkdirp', to: false, - disallowedMessage: `Don't use 'mkdirp', use the new { recursive: true } option of Fs.mkdir instead` + disallowedMessage: `Don't use 'mkdirp', use the new { recursive: true } option of Fs.mkdir instead`, }, { from: 'numeral', @@ -50,7 +46,7 @@ module.exports = { { from: '@kbn/elastic-idx', to: false, - disallowedMessage: `Don't use idx(), use optional chaining syntax instead https://ela.st/optchain` + disallowedMessage: `Don't use idx(), use optional chaining syntax instead https://ela.st/optchain`, }, { from: 'x-pack', @@ -67,46 +63,45 @@ module.exports = { { from: 'monaco-editor', to: false, - disallowedMessage: `Don't import monaco directly, use or add exports to @kbn/monaco` + disallowedMessage: `Don't import monaco directly, use or add exports to @kbn/monaco`, }, { from: 'tinymath', to: '@kbn/tinymath', - disallowedMessage: `Don't use 'tinymath', use '@kbn/tinymath'` + disallowedMessage: `Don't use 'tinymath', use '@kbn/tinymath'`, }, { from: '@kbn/test/types/ftr', to: '@kbn/test', - disallowedMessage: `import from the root of @kbn/test instead` + disallowedMessage: `import from the root of @kbn/test instead`, }, { from: 'react-intl', to: '@kbn/i18n-react', - disallowedMessage: `import from @kbn/i18n-react instead` + disallowedMessage: `import from @kbn/i18n-react instead`, }, { from: 'styled-components', to: false, exclude: USES_STYLED_COMPONENTS, - disallowedMessage: `Prefer using @emotion/react instead. To use styled-components, ensure you plugin is enabled in packages/kbn-babel-preset/styled_components_files.js.` + disallowedMessage: `Prefer using @emotion/react instead. To use styled-components, ensure you plugin is enabled in packages/kbn-babel-preset/styled_components_files.js.`, }, - ...[ - '@elastic/eui/dist/eui_theme_light.json', - '@elastic/eui/dist/eui_theme_dark.json', - ].map(from => ({ - from, - to: false, - disallowedMessage: `Use "@kbn/ui-theme" to access theme vars.` - })), + ...['@elastic/eui/dist/eui_theme_light.json', '@elastic/eui/dist/eui_theme_dark.json'].map( + (from) => ({ + from, + to: false, + disallowedMessage: `Use "@kbn/ui-theme" to access theme vars.`, + }) + ), { from: '@kbn/test/jest', to: '@kbn/test-jest-helpers', - disallowedMessage: `import from @kbn/test-jest-helpers instead` + disallowedMessage: `import from @kbn/test-jest-helpers instead`, }, { from: '@kbn/utility-types/jest', to: '@kbn/utility-types-jest', - disallowedMessage: `import from @kbn/utility-types-jest instead` + disallowedMessage: `import from @kbn/utility-types-jest instead`, }, { from: '@kbn/inspector-plugin', @@ -149,142 +144,126 @@ module.exports = { * of the file being linted so that we could re-route imports from `plugin-client` types to a different package * than `plugin-server` types. */ - '@kbn/imports/exports_moved_packages': ['error', [ - { - from: '@kbn/dev-utils', - to: '@kbn/tooling-log', - exportNames: [ - 'DEFAULT_LOG_LEVEL', - 'getLogLevelFlagsHelp', - 'LOG_LEVEL_FLAGS', - 'LogLevel', - 'Message', - 'ParsedLogLevel', - 'parseLogLevel', - 'pickLevelFromFlags', - 'ToolingLog', - 'ToolingLogCollectingWriter', - 'ToolingLogOptions', - 'ToolingLogTextWriter', - 'ToolingLogTextWriterConfig', - 'Writer', - ] - }, - { - from: '@kbn/dev-utils', - to: '@kbn/ci-stats-reporter', - exportNames: [ - 'CiStatsMetric', - 'CiStatsReporter', - 'CiStatsReportTestsOptions', - 'CiStatsTestGroupInfo', - 'CiStatsTestResult', - 'CiStatsTestRun', - 'CiStatsTestType', - 'CiStatsTiming', - 'getTimeReporter', - 'MetricsOptions', - 'TimingsOptions', - ] - }, - { - from: '@kbn/dev-utils', - to: '@kbn/ci-stats-core', - exportNames: [ - 'Config', - ] - }, - { - from: '@kbn/dev-utils', - to: '@kbn/jest-serializers', - exportNames: [ - 'createAbsolutePathSerializer', - 'createStripAnsiSerializer', - 'createRecursiveSerializer', - 'createAnyInstanceSerializer', - 'createReplaceSerializer', - ] - }, - { - from: '@kbn/dev-utils', - to: '@kbn/stdio-dev-helpers', - exportNames: [ - 'observeReadable', - 'observeLines', - ] - }, - { - from: '@kbn/dev-utils', - to: '@kbn/sort-package-json', - exportNames: [ - 'sortPackageJson', - ] - }, - { - from: '@kbn/dev-utils', - to: '@kbn/dev-cli-runner', - exportNames: [ - 'run', - 'Command', - 'RunWithCommands', - 'CleanupTask', - 'Command', - 'CommandRunFn', - 'FlagOptions', - 'Flags', - 'RunContext', - 'RunFn', - 'RunOptions', - 'RunWithCommands', - 'RunWithCommandsOptions', - 'getFlags', - 'mergeFlagOptions' - ] - }, - { - from: '@kbn/dev-utils', - to: '@kbn/dev-cli-errors', - exportNames: [ - 'createFailError', - 'createFlagError', - 'isFailError', - ] - }, - { - from: '@kbn/dev-utils', - to: '@kbn/dev-proc-runner', - exportNames: [ - 'withProcRunner', - 'ProcRunner', - ] - }, - { - from: '@kbn/utils', - to: '@kbn/repo-info', - exportNames: [ - 'REPO_ROOT', - 'UPSTREAM_BRANCH', - 'kibanaPackageJson', - 'isKibanaDistributable', - 'fromRoot', - ] - }, - { - from: '@kbn/presentation-util-plugin/common', - to: '@kbn/presentation-util-plugin/test_helpers', - exportNames: [ - 'functionWrapper', - 'fontStyle' - ] - }, - { - from: '@kbn/fleet-plugin/common', - to: '@kbn/fleet-plugin/common/mocks', - exportNames: [ - 'createFleetAuthzMock' - ] - } - ]], + '@kbn/imports/exports_moved_packages': [ + 'error', + [ + { + from: '@kbn/dev-utils', + to: '@kbn/tooling-log', + exportNames: [ + 'DEFAULT_LOG_LEVEL', + 'getLogLevelFlagsHelp', + 'LOG_LEVEL_FLAGS', + 'LogLevel', + 'Message', + 'ParsedLogLevel', + 'parseLogLevel', + 'pickLevelFromFlags', + 'ToolingLog', + 'ToolingLogCollectingWriter', + 'ToolingLogOptions', + 'ToolingLogTextWriter', + 'ToolingLogTextWriterConfig', + 'Writer', + ], + }, + { + from: '@kbn/dev-utils', + to: '@kbn/ci-stats-reporter', + exportNames: [ + 'CiStatsMetric', + 'CiStatsReporter', + 'CiStatsReportTestsOptions', + 'CiStatsTestGroupInfo', + 'CiStatsTestResult', + 'CiStatsTestRun', + 'CiStatsTestType', + 'CiStatsTiming', + 'getTimeReporter', + 'MetricsOptions', + 'TimingsOptions', + ], + }, + { + from: '@kbn/dev-utils', + to: '@kbn/ci-stats-core', + exportNames: ['Config'], + }, + { + from: '@kbn/dev-utils', + to: '@kbn/jest-serializers', + exportNames: [ + 'createAbsolutePathSerializer', + 'createStripAnsiSerializer', + 'createRecursiveSerializer', + 'createAnyInstanceSerializer', + 'createReplaceSerializer', + ], + }, + { + from: '@kbn/dev-utils', + to: '@kbn/stdio-dev-helpers', + exportNames: ['observeReadable', 'observeLines'], + }, + { + from: '@kbn/dev-utils', + to: '@kbn/sort-package-json', + exportNames: ['sortPackageJson'], + }, + { + from: '@kbn/dev-utils', + to: '@kbn/dev-cli-runner', + exportNames: [ + 'run', + 'Command', + 'RunWithCommands', + 'CleanupTask', + 'Command', + 'CommandRunFn', + 'FlagOptions', + 'Flags', + 'RunContext', + 'RunFn', + 'RunOptions', + 'RunWithCommands', + 'RunWithCommandsOptions', + 'getFlags', + 'mergeFlagOptions', + ], + }, + { + from: '@kbn/dev-utils', + to: '@kbn/dev-cli-errors', + exportNames: ['createFailError', 'createFlagError', 'isFailError'], + }, + { + from: '@kbn/dev-utils', + to: '@kbn/dev-proc-runner', + exportNames: ['withProcRunner', 'ProcRunner'], + }, + { + from: '@kbn/utils', + to: '@kbn/repo-info', + exportNames: [ + 'REPO_ROOT', + 'UPSTREAM_BRANCH', + 'kibanaPackageJson', + 'isKibanaDistributable', + 'fromRoot', + ], + }, + { + from: '@kbn/presentation-util-plugin/common', + to: '@kbn/presentation-util-plugin/test_helpers', + exportNames: ['functionWrapper', 'fontStyle'], + }, + { + from: '@kbn/fleet-plugin/common', + to: '@kbn/fleet-plugin/common/mocks', + exportNames: ['createFleetAuthzMock'], + }, + ], + ], '@kbn/disable/no_protected_eslint_disable': 'error', '@kbn/disable/no_naked_eslint_disable': 'error', diff --git a/packages/kbn-eslint-plugin-telemetry/README.mdx b/packages/kbn-eslint-plugin-telemetry/README.mdx new file mode 100644 index 0000000000000..11127b2492a57 --- /dev/null +++ b/packages/kbn-eslint-plugin-telemetry/README.mdx @@ -0,0 +1,13 @@ +--- +id: kibDevDocsOpsEslintPluginTelemetry +slug: /kibana-dev-docs/ops/kbn-eslint-plugin-telemetry +title: '@kbn/eslint-plugin-telemetry' +description: Custom ESLint rules to support telemetry in the Kibana repository +tags: ['kibana', 'dev', 'contributor', 'operations', 'eslint', 'telemetry'] +--- + +`@kbn/eslint-plugin-telemetry` is an ESLint plugin providing custom rules for validating JSXCode in the Kibana repo to make sure it can be instrumented for the purposes of telemetry. + +## `@kbn/telemetry/instrumentable_elements_should_be_instrumented` + +This rule warns engineers to add `data-test-subj` to instrumentable components. It currently suggests the most widely used EUI components (`EuiButton`, `EuiFieldText`, etc), but can be expanded with often-used specific components used in the Kibana repo. diff --git a/packages/kbn-eslint-plugin-telemetry/helpers/check_node_for_existing_data_test_subj_prop.ts b/packages/kbn-eslint-plugin-telemetry/helpers/check_node_for_existing_data_test_subj_prop.ts new file mode 100644 index 0000000000000..b739dc5116c1c --- /dev/null +++ b/packages/kbn-eslint-plugin-telemetry/helpers/check_node_for_existing_data_test_subj_prop.ts @@ -0,0 +1,47 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +import type { Scope } from 'eslint'; +import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/typescript-estree'; + +export function checkNodeForExistingDataTestSubjProp( + node: TSESTree.JSXOpeningElement, + getScope: () => Scope.Scope +): boolean { + const hasJsxDataTestSubjProp = node.attributes.find( + (attr) => attr.type === AST_NODE_TYPES.JSXAttribute && attr.name.name === 'data-test-subj' + ); + + if (hasJsxDataTestSubjProp) { + return true; + } + + const spreadedVariable = node.attributes.find( + (attr) => attr.type === AST_NODE_TYPES.JSXSpreadAttribute + ); + + if ( + !spreadedVariable || + !('argument' in spreadedVariable) || + !('name' in spreadedVariable.argument) + ) { + return false; + } + + const { name } = spreadedVariable.argument; // The name of the spreaded variable + + const variable = getScope().variables.find((v) => v.name === name); // the variable definition of the spreaded variable + + return variable && variable.defs.length > 0 + ? variable.defs[0].node.init.properties.find((property: TSESTree.Property) => { + if ('value' in property.key) { + return property.key.value === 'data-test-subj'; + } + return false; + }) + : false; +} diff --git a/packages/kbn-eslint-plugin-telemetry/helpers/get_app_name.test.ts b/packages/kbn-eslint-plugin-telemetry/helpers/get_app_name.test.ts new file mode 100644 index 0000000000000..36790e883cce1 --- /dev/null +++ b/packages/kbn-eslint-plugin-telemetry/helpers/get_app_name.test.ts @@ -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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { getAppName } from './get_app_name'; + +const SYSTEMPATH = 'systemPath'; + +const testMap = [ + ['x-pack/plugins/observability/foo/bar/baz/header_actions.tsx', 'o11y'], + ['x-pack/plugins/apm/public/components/app/correlations/correlations_table.tsx', 'apm'], + ['x-pack/plugins/cases/public/components/foo.tsx', 'cases'], + ['packages/kbn-alerts-ui-shared/src/alert_lifecycle_status_badge/index.tsx', 'kbnAlertsUiShared'], +]; + +describe('Get App Name', () => { + test.each(testMap)( + 'should get the responsible app name from a file path', + (path, expectedValue) => { + const appName = getAppName(`${SYSTEMPATH}/${path}`, SYSTEMPATH); + expect(appName).toBe(expectedValue); + } + ); +}); diff --git a/packages/kbn-eslint-plugin-telemetry/helpers/get_app_name.ts b/packages/kbn-eslint-plugin-telemetry/helpers/get_app_name.ts new file mode 100644 index 0000000000000..e483a572be892 --- /dev/null +++ b/packages/kbn-eslint-plugin-telemetry/helpers/get_app_name.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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { camelCase } from 'lodash'; +import path from 'path'; +import { getPkgDirMap } from '@kbn/repo-packages'; +import { REPO_ROOT } from '@kbn/repo-info'; + +export function getAppName(fileName: string, cwd: string) { + const { dir } = path.parse(fileName); + const relativePathToFile = dir.replace(cwd, ''); + + const packageDirs = Array.from( + Array.from(getPkgDirMap(REPO_ROOT).values()).reduce((acc, currentDir) => { + const topDirectory = currentDir.normalizedRepoRelativeDir.split('/')[0]; + + if (topDirectory) { + acc.add(topDirectory); + } + + return acc; + }, new Set()) + ); + + const relativePathArray = relativePathToFile.split('/'); + + const appName = camelCase( + packageDirs.reduce((acc, repoPath) => { + if (!relativePathArray[1]) return ''; + + if (relativePathArray[1] === 'x-pack') { + return relativePathArray[3]; + } + + if (relativePathArray[1].includes(repoPath)) { + return relativePathArray[2]; + } + + return acc; + }, '') + ); + + return appName === 'observability' ? 'o11y' : appName; +} diff --git a/packages/kbn-eslint-plugin-telemetry/helpers/get_function_name.ts b/packages/kbn-eslint-plugin-telemetry/helpers/get_function_name.ts new file mode 100644 index 0000000000000..40bb3e8a17e93 --- /dev/null +++ b/packages/kbn-eslint-plugin-telemetry/helpers/get_function_name.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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/typescript-estree'; + +export function getFunctionName(func: TSESTree.FunctionDeclaration | TSESTree.Node): string { + if ( + 'id' in func && + func.id && + func.type === AST_NODE_TYPES.FunctionDeclaration && + func.id.type === AST_NODE_TYPES.Identifier + ) { + return func.id.name; + } + + if ( + func.parent && + (func.parent.type !== AST_NODE_TYPES.VariableDeclarator || + func.parent.id.type !== AST_NODE_TYPES.Identifier) + ) { + return getFunctionName(func.parent); + } + + if (func.parent?.id && 'name' in func.parent.id) { + return func.parent.id.name; + } + + return ''; +} diff --git a/packages/kbn-eslint-plugin-telemetry/helpers/get_intent_from_node.ts b/packages/kbn-eslint-plugin-telemetry/helpers/get_intent_from_node.ts new file mode 100644 index 0000000000000..5df44e5dd0f75 --- /dev/null +++ b/packages/kbn-eslint-plugin-telemetry/helpers/get_intent_from_node.ts @@ -0,0 +1,133 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +import { TSESTree } from '@typescript-eslint/typescript-estree'; +import camelCase from 'lodash/camelCase'; + +/* + Attempts to get a string representation of the intent + out of an array of nodes. + + Currently supported node types in the array: + * String literal text (JSXText) + * Translated text via component -> uses prop `defaultMessage` + * Translated text via {i18n.translate} call -> uses passed options object key `defaultMessage` +*/ +export function getIntentFromNode(originalNode: TSESTree.JSXOpeningElement): string { + const parent = originalNode.parent as TSESTree.JSXElement; + + const node = Array.isArray(parent.children) ? parent.children : []; + + if (node.length === 0) { + return ''; + } + + /* + In order to satisfy TS we need to do quite a bit of defensive programming. + This is my best attempt at providing the minimum amount of typeguards and + keeping the code readable. In the cases where types are explicitly set to + variables, it was done to help the compiler when it couldn't infer the type. + */ + return node.reduce((acc: string, currentNode) => { + switch (currentNode.type) { + case 'JSXText': + // When node is a string primitive + return `${acc}${strip(currentNode.value)}`; + + case 'JSXElement': + // Determining whether node is of form `` + const name: TSESTree.JSXTagNameExpression = currentNode.openingElement.name; + const attributes: Array = + currentNode.openingElement.attributes; + + if (!('name' in name) || name.name !== 'FormattedMessage') { + return ''; + } + + const defaultMessageProp = attributes.find( + (attribute) => 'name' in attribute && attribute.name.name === 'defaultMessage' + ); + + if ( + !defaultMessageProp || + !('value' in defaultMessageProp) || + !('type' in defaultMessageProp.value!) || + defaultMessageProp.value.type !== 'Literal' || + typeof defaultMessageProp.value.value !== 'string' + ) { + return ''; + } + + return `${acc}${strip(defaultMessageProp.value.value)}`; + + case 'JSXExpressionContainer': + // Determining whether node is of form `{i18n.translate('foo', { defaultMessage: 'message'})}` + const expression: TSESTree.JSXEmptyExpression | TSESTree.Expression = + currentNode.expression; + + if (!('arguments' in expression)) { + return ''; + } + + const args: TSESTree.CallExpressionArgument[] = expression.arguments; + const callee: TSESTree.LeftHandSideExpression = expression.callee; + + if (!('object' in callee)) { + return ''; + } + + const object: TSESTree.LeftHandSideExpression = callee.object; + const property: TSESTree.Expression | TSESTree.PrivateIdentifier = callee.property; + + if (!('name' in object) || !('name' in property)) { + return ''; + } + + if (object.name !== 'i18n' || property.name !== 'translate') { + return ''; + } + + const callExpressionArgument: TSESTree.CallExpressionArgument | undefined = args.find( + (arg) => arg.type === 'ObjectExpression' + ); + + if (!callExpressionArgument || callExpressionArgument.type !== 'ObjectExpression') { + return ''; + } + + const defaultMessageValue: TSESTree.ObjectLiteralElement | undefined = + callExpressionArgument.properties.find( + (prop) => + prop.type === 'Property' && 'name' in prop.key && prop.key.name === 'defaultMessage' + ); + + if ( + !defaultMessageValue || + !('value' in defaultMessageValue) || + defaultMessageValue.value.type !== 'Literal' || + typeof defaultMessageValue.value.value !== 'string' + ) { + return ''; + } + + return `${acc}${strip(defaultMessageValue.value.value)}`; + + default: + break; + } + + return acc; + }, ''); +} + +function strip(input: string): string { + if (!input) return ''; + + const cleanedString = camelCase(input); + + return `${cleanedString.charAt(0).toUpperCase()}${cleanedString.slice(1)}`; +} diff --git a/packages/kbn-eslint-plugin-telemetry/index.ts b/packages/kbn-eslint-plugin-telemetry/index.ts new file mode 100644 index 0000000000000..ea68eae7fdfa1 --- /dev/null +++ b/packages/kbn-eslint-plugin-telemetry/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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { EventGeneratingElementsShouldBeInstrumented } from './rules/event_generating_elements_should_be_instrumented'; + +/** + * Custom ESLint rules, add `'@kbn/eslint-plugin-telemetry'` to your eslint config to use them + * @internal + */ +export const rules = { + event_generating_elements_should_be_instrumented: EventGeneratingElementsShouldBeInstrumented, +}; diff --git a/packages/kbn-eslint-plugin-telemetry/jest.config.js b/packages/kbn-eslint-plugin-telemetry/jest.config.js new file mode 100644 index 0000000000000..f2778eaf7ddae --- /dev/null +++ b/packages/kbn-eslint-plugin-telemetry/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../..', + roots: ['/packages/kbn-eslint-plugin-telemetry'], +}; diff --git a/packages/kbn-eslint-plugin-telemetry/kibana.jsonc b/packages/kbn-eslint-plugin-telemetry/kibana.jsonc new file mode 100644 index 0000000000000..79c8fbf8adb2b --- /dev/null +++ b/packages/kbn-eslint-plugin-telemetry/kibana.jsonc @@ -0,0 +1,6 @@ +{ + "type": "shared-common", + "id": "@kbn/eslint-plugin-telemetry", + "owner": "@elastic/actionable-observability", + "devOnly": true +} diff --git a/packages/kbn-eslint-plugin-telemetry/package.json b/packages/kbn-eslint-plugin-telemetry/package.json new file mode 100644 index 0000000000000..9632bf6d0f5c1 --- /dev/null +++ b/packages/kbn-eslint-plugin-telemetry/package.json @@ -0,0 +1,6 @@ +{ + "name": "@kbn/eslint-plugin-telemetry", + "private": true, + "version": "1.0.0", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/kbn-eslint-plugin-telemetry/rules/event_generating_elements_should_be_instrumented.test.ts b/packages/kbn-eslint-plugin-telemetry/rules/event_generating_elements_should_be_instrumented.test.ts new file mode 100644 index 0000000000000..c8829f05efd21 --- /dev/null +++ b/packages/kbn-eslint-plugin-telemetry/rules/event_generating_elements_should_be_instrumented.test.ts @@ -0,0 +1,71 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { RuleTester } from 'eslint'; +import { + EventGeneratingElementsShouldBeInstrumented, + EVENT_GENERATING_ELEMENTS, +} from './event_generating_elements_should_be_instrumented'; + +const tsTester = [ + '@typescript-eslint/parser', + new RuleTester({ + parser: require.resolve('@typescript-eslint/parser'), + parserOptions: { + sourceType: 'module', + ecmaVersion: 2018, + ecmaFeatures: { + jsx: true, + }, + }, + }), +] as const; + +const babelTester = [ + '@babel/eslint-parser', + new RuleTester({ + parser: require.resolve('@babel/eslint-parser'), + parserOptions: { + sourceType: 'module', + ecmaVersion: 2018, + requireConfigFile: false, + babelOptions: { + presets: ['@kbn/babel-preset/node_preset'], + }, + }, + }), +] as const; + +for (const [name, tester] of [tsTester, babelTester]) { + describe(name, () => { + tester.run( + '@kbn/event_generating_elements_should_be_instrumented', + EventGeneratingElementsShouldBeInstrumented, + { + valid: EVENT_GENERATING_ELEMENTS.map((element) => ({ + filename: 'foo.tsx', + code: `<${element} data-test-subj="foo" />`, + })), + + invalid: EVENT_GENERATING_ELEMENTS.map((element) => ({ + filename: 'foo.tsx', + code: `<${element}>Value`, + errors: [ + { + line: 1, + message: `<${element}> should have a \`data-test-subj\` for telemetry purposes. Use the autofix suggestion or add your own.`, + }, + ], + output: `<${element} data-test-subj="Value${element + .replace('Eui', '') + .replace('Empty', '')}">Value`, + })), + } + ); + }); +} diff --git a/packages/kbn-eslint-plugin-telemetry/rules/event_generating_elements_should_be_instrumented.ts b/packages/kbn-eslint-plugin-telemetry/rules/event_generating_elements_should_be_instrumented.ts new file mode 100644 index 0000000000000..d2069d2845e59 --- /dev/null +++ b/packages/kbn-eslint-plugin-telemetry/rules/event_generating_elements_should_be_instrumented.ts @@ -0,0 +1,92 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { Rule } from 'eslint'; +import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/typescript-estree'; + +import { checkNodeForExistingDataTestSubjProp } from '../helpers/check_node_for_existing_data_test_subj_prop'; +import { getIntentFromNode } from '../helpers/get_intent_from_node'; +import { getAppName } from '../helpers/get_app_name'; +import { getFunctionName } from '../helpers/get_function_name'; + +export const EVENT_GENERATING_ELEMENTS = [ + 'EuiButton', + 'EuiButtonEmpty', + 'EuiLink', + 'EuiFieldText', + 'EuiFieldSearch', + 'EuiFieldNumber', + 'EuiSelect', + 'EuiRadioGroup', + 'EuiTextArea', +]; + +export const EventGeneratingElementsShouldBeInstrumented: Rule.RuleModule = { + meta: { + type: 'suggestion', + fixable: 'code', + }, + create(context) { + const { getCwd, getFilename, getScope, report } = context; + + return { + JSXIdentifier: (node: TSESTree.Node) => { + if (!('name' in node)) { + return; + } + + const name = String(node.name); + const range = node.range; + const parent = node.parent; + + if ( + parent?.type !== AST_NODE_TYPES.JSXOpeningElement || + !EVENT_GENERATING_ELEMENTS.includes(name) + ) { + return; + } + + const hasDataTestSubjProp = checkNodeForExistingDataTestSubjProp(parent, getScope); + + if (hasDataTestSubjProp) { + // JSXOpeningElement already has a prop for data-test-subj. Bail. + return; + } + + // Start building the suggestion. + + // 1. The app name + const cwd = getCwd(); + const fileName = getFilename(); + const appName = getAppName(fileName, cwd); + + // 2. Component name + const functionDeclaration = getScope().block as TSESTree.FunctionDeclaration; + const functionName = getFunctionName(functionDeclaration); + const componentName = `${functionName.charAt(0).toUpperCase()}${functionName.slice(1)}`; + + // 3. The intention of the element (i.e. "Select date", "Submit", "Cancel") + const intent = getIntentFromNode(parent); + + // 4. The element name that generates the events + const element = name.replace('Eui', '').replace('Empty', ''); + + const suggestion = `${appName}${componentName}${intent}${element}`; // 'o11yHeaderActionsSubmitButton' + + // 6. Report feedback to engineer + report({ + node: node as any, + message: `<${name}> should have a \`data-test-subj\` for telemetry purposes. Use the autofix suggestion or add your own.`, + fix(fixer) { + return fixer.insertTextAfterRange(range, ` data-test-subj="${suggestion}"`); + }, + }); + }, + } as Rule.RuleListener; + }, +}; diff --git a/packages/kbn-eslint-plugin-telemetry/tsconfig.json b/packages/kbn-eslint-plugin-telemetry/tsconfig.json new file mode 100644 index 0000000000000..75014884aa312 --- /dev/null +++ b/packages/kbn-eslint-plugin-telemetry/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "outDir": "target/types", + "types": ["jest", "node"], + "lib": ["es2021"] + }, + "include": ["**/*.ts"], + "exclude": ["target/**/*"], + "kbn_references": ["@kbn/repo-packages", "@kbn/repo-info"] +} diff --git a/packages/kbn-guided-onboarding/src/components/landing_page/__snapshots__/guide_cards.test.tsx.snap b/packages/kbn-guided-onboarding/src/components/landing_page/__snapshots__/guide_cards.test.tsx.snap index 2b9c99e546957..31294c58f1908 100644 --- a/packages/kbn-guided-onboarding/src/components/landing_page/__snapshots__/guide_cards.test.tsx.snap +++ b/packages/kbn-guided-onboarding/src/components/landing_page/__snapshots__/guide_cards.test.tsx.snap @@ -253,7 +253,7 @@ exports[`guide cards snapshots should render all cards 1`] = ` Object { "navigateTo": Object { "appId": "integrations", - "path": "/detail/cloud_security_posture/overview", + "path": "/detail/cloud_security_posture/overview?integration=cspm", }, "order": 9, "solution": "security", diff --git a/packages/kbn-guided-onboarding/src/components/landing_page/guide_cards.constants.tsx b/packages/kbn-guided-onboarding/src/components/landing_page/guide_cards.constants.tsx index 0952a8d044b6b..75437cf9d17f3 100644 --- a/packages/kbn-guided-onboarding/src/components/landing_page/guide_cards.constants.tsx +++ b/packages/kbn-guided-onboarding/src/components/landing_page/guide_cards.constants.tsx @@ -169,7 +169,7 @@ export const guideCards: GuideCardConstants[] = [ ), navigateTo: { appId: 'integrations', - path: '/detail/cloud_security_posture/overview', + path: '/detail/cloud_security_posture/overview?integration=cspm', }, telemetryId: 'onboarding--security--cloud', order: 9, diff --git a/packages/kbn-object-versioning/README.md b/packages/kbn-object-versioning/README.md new file mode 100644 index 0000000000000..37db4dc7e5f5a --- /dev/null +++ b/packages/kbn-object-versioning/README.md @@ -0,0 +1,3 @@ +# @kbn/object-versioning + +Empty package generated by @kbn/generate diff --git a/packages/kbn-object-versioning/index.ts b/packages/kbn-object-versioning/index.ts new file mode 100644 index 0000000000000..c66f324ae4920 --- /dev/null +++ b/packages/kbn-object-versioning/index.ts @@ -0,0 +1,26 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { + initTransform, + getContentManagmentServicesTransforms, + compileServiceDefinitions, +} from './lib'; + +export type { + Version, + VersionableObject, + ObjectMigrationDefinition, + ObjectTransform, + ObjectTransforms, + TransformReturn, + ContentManagementServiceDefinitionVersioned, + ContentManagementServiceTransforms, + ContentManagementServicesDefinition, + ContentManagementGetTransformsFn, +} from './lib'; diff --git a/packages/kbn-object-versioning/jest.config.js b/packages/kbn-object-versioning/jest.config.js new file mode 100644 index 0000000000000..59a91127b7d05 --- /dev/null +++ b/packages/kbn-object-versioning/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../..', + roots: ['/packages/kbn-object-versioning'], +}; diff --git a/packages/kbn-object-versioning/kibana.jsonc b/packages/kbn-object-versioning/kibana.jsonc new file mode 100644 index 0000000000000..c79023fdec49d --- /dev/null +++ b/packages/kbn-object-versioning/kibana.jsonc @@ -0,0 +1,5 @@ +{ + "type": "shared-common", + "id": "@kbn/object-versioning", + "owner": "@elastic/appex-sharedux" +} diff --git a/packages/kbn-object-versioning/lib/content_management_services_schemas.ts b/packages/kbn-object-versioning/lib/content_management_services_schemas.ts new file mode 100644 index 0000000000000..4b87cc458b16a --- /dev/null +++ b/packages/kbn-object-versioning/lib/content_management_services_schemas.ts @@ -0,0 +1,117 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { isConfigSchema, schema } from '@kbn/config-schema'; +import type { Type } from '@kbn/config-schema'; + +// Validate that the value is a function +const functionSchema = schema.any({ + validate: (value) => { + if (typeof value !== 'function') { + return 'Must be a function'; + } + }, +}); + +// Validate that the value is a kbn config Schema (Type) +const kbnConfigSchema = schema.any({ + validate: (value) => { + if (!isConfigSchema(value)) { + return 'Invalid schema type.'; + } + }, +}); + +// VersionableObject schema +const versionableObjectSchema = schema.object( + { + schema: schema.maybe(kbnConfigSchema), + down: schema.maybe(functionSchema), + up: schema.maybe(functionSchema), + }, + { unknowns: 'forbid' } +); + +const getOptionalInOutSchemas = (props: { in: Type; out: Type }) => + schema.maybe(schema.object(props, { unknowns: 'forbid' })); + +// Schema to validate the "get" service objects +// Note: the "bulkGet" and "delete" services also use this schema as they allow the same IN/OUT objects +const getSchemas = getOptionalInOutSchemas({ + in: schema.maybe( + schema.object( + { + options: schema.maybe(versionableObjectSchema), + }, + { unknowns: 'forbid' } + ) + ), + out: schema.maybe( + schema.object( + { + result: schema.maybe(versionableObjectSchema), + }, + { unknowns: 'forbid' } + ) + ), +}); + +// Schema to validate the "create" service objects +// Note: the "update" service also uses this schema as they allow the same IN/OUT objects +const createSchemas = getOptionalInOutSchemas({ + in: schema.maybe( + schema.object( + { + data: schema.maybe(versionableObjectSchema), + options: schema.maybe(versionableObjectSchema), + }, + { unknowns: 'forbid' } + ) + ), + out: schema.maybe( + schema.object( + { + result: schema.maybe(versionableObjectSchema), + }, + { unknowns: 'forbid' } + ) + ), +}); + +// Schema to validate the "search" service objects +const searchSchemas = getOptionalInOutSchemas({ + in: schema.maybe( + schema.object( + { + query: schema.maybe(versionableObjectSchema), + options: schema.maybe(versionableObjectSchema), + }, + { unknowns: 'forbid' } + ) + ), + out: schema.maybe( + schema.object( + { + result: schema.maybe(versionableObjectSchema), + }, + { unknowns: 'forbid' } + ) + ), +}); + +export const serviceDefinitionSchema = schema.object( + { + get: getSchemas, + bulkGet: getSchemas, + create: createSchemas, + update: createSchemas, + delete: getSchemas, + search: searchSchemas, + }, + { unknowns: 'forbid' } +); diff --git a/packages/kbn-object-versioning/lib/content_management_services_versioning.test.ts b/packages/kbn-object-versioning/lib/content_management_services_versioning.test.ts new file mode 100644 index 0000000000000..1470dd70a765a --- /dev/null +++ b/packages/kbn-object-versioning/lib/content_management_services_versioning.test.ts @@ -0,0 +1,403 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { schema } from '@kbn/config-schema'; +import { set } from '@kbn/safer-lodash-set'; +import { get } from 'lodash'; +import { getTransforms } from './content_management_services_versioning'; +import type { ServiceDefinitionVersioned } from './content_management_types'; + +/** + * Wrap the key with [] if it is a key from an Array + * @param key The object key + * @param isArrayItem Flag to indicate if it is the key of an Array + */ +const renderKey = (key: string, isArrayItem: boolean): string => (isArrayItem ? `[${key}]` : key); + +const flattenObject = ( + obj: Record, + prefix: string[] = [], + isArrayItem = false +): Record => + Object.keys(obj).reduce>((acc, k) => { + const nextValue = obj[k]; + + if (typeof nextValue === 'object' && nextValue !== null) { + const isNextValueArray = Array.isArray(nextValue); + const dotSuffix = isNextValueArray ? '' : '.'; + + if (Object.keys(nextValue).length > 0) { + return { + ...acc, + ...flattenObject( + nextValue, + [...prefix, `${renderKey(k, isArrayItem)}${dotSuffix}`], + isNextValueArray + ), + }; + } + } + + const fullPath = `${prefix.join('')}${renderKey(k, isArrayItem)}`; + acc[fullPath] = nextValue; + + return acc; + }, {}); + +/** + * Create an object and set a value at the specific path + * + * @param path The path where to create the object + * @param value The value to set at the path + * @returns An object with a value at the provided path + */ +const setObjectValue = (path: string, value: unknown) => { + const obj = {}; + set(obj, path, value); + return obj; +}; + +const wrapVersion = (obj: object, version = 1): object => ({ + [version]: obj, +}); + +/** + * Get all the test cases for a versionable object at a specific path + * + * @param path The versionable object path (e.g. "get.in.options") + * @returns A veresioned service definition + */ +const getVersionnableObjectTests = (path: string) => { + return [ + { + definitions: wrapVersion(setObjectValue(path, 123)), + expected: false, + ref: 'versionable object is not an object', + }, + { + definitions: wrapVersion( + setObjectValue(path, { + up: 123, + }) + ), + expected: false, + ref: '"up" transform is not a function', + }, + { + definitions: wrapVersion( + setObjectValue(path, { + down: 123, + }) + ), + expected: false, + ref: '"down" transform is not a function', + }, + { + definitions: wrapVersion( + setObjectValue(path, { + schema: 123, + }) + ), + expected: false, + ref: '"schema" is not a valid validation Type', + }, + { + definitions: wrapVersion( + setObjectValue(path, { + schema: schema.object({ + foo: schema.string(), + }), + up: () => ({}), + down: () => ({}), + }) + ), + expected: true, + ref: `valid versionable object [${path}]`, + }, + ]; +}; + +// Get the tests to validate the services props +const getInvalidServiceObjectTests = () => + ['get', 'bulkGet', 'create', 'update', 'delete', 'search'].map((service) => ({ + definitions: { + 1: { + [service]: { + unknown: {}, + }, + }, + }, + expected: false, + ref: `invalid ${service}: unknown prop`, + })); + +describe('CM services getTransforms()', () => { + describe('validation', () => { + [ + { + definitions: 123, + expected: false, + ref: 'definition is not an object', + error: 'Invalid service definition. Must be an object.', + }, + // Test that each version is an integer + { + definitions: { a: {} }, + expected: false, + ref: 'invalid version', + error: 'Invalid version [a]. Must be an integer.', + }, + { + definitions: { '123a': {} }, + expected: false, + ref: 'invalid version (2)', + error: 'Invalid version [123a]. Must be an integer.', + }, + { + definitions: wrapVersion({ foo: 'bar', get: { in: { options: { up: () => ({}) } } } }), + expected: false, + ref: 'invalid root prop', + }, + // Test that each service only accepts an "in" and "out" prop + ...getInvalidServiceObjectTests(), + // Test that each versionable object has a valid definition + ...getVersionnableObjectTests('get.in.options'), + ...getVersionnableObjectTests('get.out.result'), + ...getVersionnableObjectTests('bulkGet.in.options'), + ...getVersionnableObjectTests('bulkGet.out.result'), + ...getVersionnableObjectTests('create.in.options'), + ...getVersionnableObjectTests('create.in.data'), + ...getVersionnableObjectTests('create.out.result'), + ...getVersionnableObjectTests('update.in.options'), + ...getVersionnableObjectTests('update.in.data'), + ...getVersionnableObjectTests('update.out.result'), + ...getVersionnableObjectTests('delete.in.options'), + ...getVersionnableObjectTests('delete.out.result'), + ...getVersionnableObjectTests('search.in.options'), + ...getVersionnableObjectTests('search.in.query'), + ...getVersionnableObjectTests('search.out.result'), + ].forEach(({ definitions, expected, ref, error = 'Invalid services definition.' }: any) => { + test(`validate: ${ref}`, () => { + if (expected === false) { + expect(() => { + getTransforms(definitions, 1); + }).toThrowError(error); + } else { + expect(() => { + getTransforms(definitions, 1); + }).not.toThrow(); + } + }); + }); + }); + + describe('transforms', () => { + describe('validate objects', () => { + const setup = (definitions: ServiceDefinitionVersioned) => { + const transforms = getTransforms(definitions, 1); + + // We flatten the object and extract the paths so we can later make sure that + // each of them have "up()" and "down()" that are callable. Even if they simply proxy + // the data that we send them in. + const flattened = flattenObject(transforms); + const paths = Object.keys(flattened); + + // Remove the last section of the path as that's where our ServiceObject is + // e.g. path === "get.in.options.up" --> the versionable object is at "get.in.options" + const serviceObjectPaths = paths.map((path) => { + const index = path.lastIndexOf('.'); + if (index < 0) { + throw new Error(`Invalid transforms [${JSON.stringify(transforms)}]`); + } + return path.substring(0, index); + }); + + return { + transforms, + serviceObjectPaths: [...new Set(serviceObjectPaths)], + }; + }; + + test('should return a ServiceObject for each of the CM services objects', () => { + const { serviceObjectPaths } = setup({ 1: {} }); + expect(serviceObjectPaths.sort()).toEqual( + [ + 'get.in.options', + 'get.out.result', + 'bulkGet.in.options', + 'bulkGet.out.result', + 'create.in.options', + 'create.in.data', + 'create.out.result', + 'update.in.options', + 'update.in.data', + 'update.out.result', + 'delete.in.options', + 'delete.out.result', + 'search.in.query', + 'search.in.options', + 'search.out.result', + ].sort() + ); + }); + + test('each of the services objects must have a up, down and validate method', () => { + const { transforms, serviceObjectPaths } = setup({ 1: {} }); + + // Test every service object... + serviceObjectPaths.forEach((path) => { + const serviceObject = get(transforms, path); + + // We haven't passed any definition for any object. We still expect the + // up(), down() methods to exist and to be callable + const data = { foo: 'bar' }; + expect(serviceObject.up(data).value).toBe(data); + expect(serviceObject.down(data).value).toBe(data); + }); + }); + }); + + describe('up/down transform & validation', () => { + const definitions: ServiceDefinitionVersioned = { + 1: { + get: { + in: { + options: { + schema: schema.object({ + version1: schema.string(), + }), + up: (pre: object) => ({ ...pre, version2: 'added' }), + }, + }, + out: { + result: { + schema: schema.object({ + version1: schema.string(), + }), + }, + }, + }, + }, + 2: { + get: { + in: { + options: { + schema: schema.object({ + version1: schema.string(), + version2: schema.string(), + }), + up: (pre: object) => ({ ...pre, version3: 'added' }), + }, + }, + out: { + result: { + schema: schema.object({ + version1: schema.string(), + version2: schema.string(), + }), + down: (pre: any) => { + const { version1 } = pre; + return { version1 }; + }, + }, + }, + }, + }, + 3: { + get: { + out: { + result: { + schema: schema.object({ + version1: schema.string(), + version2: schema.string(), + version3: schema.string(), + }), + down: (pre: any) => { + const { version1, version2 } = pre; + return { version1, version2 }; + }, + }, + }, + }, + }, + }; + + test('should up transform an object', () => { + const requestVersion = 1; + const transforms = getTransforms(definitions, requestVersion); + const initial = { version1: 'option version 1' }; + const upTransform = transforms.get.in.options.up(initial); + expect(upTransform.value).toEqual({ ...initial, version2: 'added', version3: 'added' }); + }); + + test('should validate object *before* up transform', () => { + const requestVersion = 1; + const transforms = getTransforms(definitions, requestVersion); + const upTransform = transforms.get.in.options.up({ unknown: 'foo' }); + expect(upTransform.error?.message).toBe( + '[version1]: expected value of type [string] but got [undefined]' + ); + }); + + test('should down transform an object', () => { + const requestVersion = 1; + const transforms = getTransforms(definitions, requestVersion); + const downTransform = transforms.get.out.result.down({ + version1: 'foo', + version2: 'bar', + version3: 'superBar', + }); + expect(downTransform.value).toEqual({ version1: 'foo' }); + }); + + test('should validate object *before* down transform', () => { + const requestVersion = 1; + const transforms = getTransforms(definitions, requestVersion); + + // Implicitly down transform from "latest" version (which is version 3 in our case) + const downTransform = transforms.get.out.result.down({ + version1: 'foo', + version2: 'bar', + version3: 123, + }); + expect(downTransform.error?.message).toBe( + '[version3]: expected value of type [string] but got [number]' + ); + }); + + test('should validate object *before* down transform (2)', () => { + const requestVersion = 1; + const transforms = getTransforms(definitions, requestVersion); + + // Explicitly down transform from version 1 + const downTransformFrom = 1; + const downTransform = transforms.get.out.result.down({ version1: 123 }, downTransformFrom); + expect(downTransform.error?.message).toBe( + '[version1]: expected value of type [string] but got [number]' + ); + }); + + test('should expose a method to validate at the specific version', () => { + const requestVersion = 1; + const transforms = getTransforms(definitions, requestVersion); + + // Validate request version (1) + expect(transforms.get.in.options.validate({ version1: 123 })?.message).toBe( + '[version1]: expected value of type [string] but got [number]' + ); + + expect(transforms.get.in.options.validate({ version1: 'foo' })).toBe(null); + + // Validate version 2 schema + expect(transforms.get.in.options.validate({ version1: 'foo' }, 2)?.message).toBe( + '[version2]: expected value of type [string] but got [undefined]' + ); + }); + }); + }); +}); diff --git a/packages/kbn-object-versioning/lib/content_management_services_versioning.ts b/packages/kbn-object-versioning/lib/content_management_services_versioning.ts new file mode 100644 index 0000000000000..72016a34684db --- /dev/null +++ b/packages/kbn-object-versioning/lib/content_management_services_versioning.ts @@ -0,0 +1,201 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { get } from 'lodash'; +import { set } from '@kbn/safer-lodash-set'; + +import { ObjectMigrationDefinition, Version, VersionableObject } from './types'; +import type { + ServiceDefinitionVersioned, + ServicesDefinition, + ServiceTransforms, +} from './content_management_types'; +import { serviceDefinitionSchema } from './content_management_services_schemas'; +import { validateObj, validateVersion } from './utils'; +import { initTransform } from './object_transform'; + +const serviceObjectPaths = [ + 'get.in.options', + 'get.out.result', + 'bulkGet.in.options', + 'bulkGet.out.result', + 'create.in.options', + 'create.in.data', + 'create.out.result', + 'update.in.options', + 'update.in.data', + 'update.out.result', + 'delete.in.options', + 'delete.out.result', + 'search.in.query', + 'search.in.options', + 'search.out.result', +]; + +const validateServiceDefinitions = (definitions: ServiceDefinitionVersioned) => { + if (definitions === null || Array.isArray(definitions) || typeof definitions !== 'object') { + throw new Error('Invalid service definition. Must be an object.'); + } + + if (Object.keys(definitions).length === 0) { + throw new Error('At least one version must be defined.'); + } + + Object.entries(definitions).forEach(([version, definition]) => { + const { result: isVersionValid } = validateVersion(version); + + if (!isVersionValid) { + throw new Error(`Invalid version [${version}]. Must be an integer.`); + } + + const error = validateObj(definition, serviceDefinitionSchema); + if (error !== null) { + throw new Error(`Invalid services definition. [${error}]`); + } + }); +}; + +/** + * Convert a versionned service definition to a flattened service definition + * where _each object_ is versioned (at the leaf). + * + * @example + * + * ```ts + * From this + * { + * 1: { + * get: { + * in: { + * options: { up: () => {} } // 1 + * } + * }, + * ... + * }, + * 2: { + * get: { + * in: { + * options: { up: () => {} } // 2 + * } + * }, + * } + * } + * + * To this + * + * { + * 'get.in.options': { // Flattend path + * 1: { up: () => {} }, // 1 + * 2: { up: () => {} } // 2 + * } + * } + * ``` + */ +export const compile = ( + definitions: ServiceDefinitionVersioned +): { [path: string]: ObjectMigrationDefinition } => { + validateServiceDefinitions(definitions); + + const flattened: { [path: string]: ObjectMigrationDefinition } = {}; + + Object.entries(definitions).forEach(([version, definition]: [string, ServicesDefinition]) => { + serviceObjectPaths.forEach((path) => { + const versionableObject: VersionableObject = get(definition, path) ?? {}; + + const objectMigrationDefinition: ObjectMigrationDefinition = { + ...(get(flattened, path) ?? {}), + [version]: versionableObject, + }; + + flattened[path] = objectMigrationDefinition; + }); + }); + + return flattened; +}; + +const getDefaultTransforms = () => ({ + up: (input: any) => input, + down: (input: any) => input, + validate: () => null, +}); + +const getDefaultServiceTransforms = (): ServiceTransforms => ({ + get: { + in: { + options: getDefaultTransforms(), + }, + out: { + result: getDefaultTransforms(), + }, + }, + bulkGet: { + in: { + options: getDefaultTransforms(), + }, + out: { + result: getDefaultTransforms(), + }, + }, + create: { + in: { + options: getDefaultTransforms(), + data: getDefaultTransforms(), + }, + out: { + result: getDefaultTransforms(), + }, + }, + update: { + in: { + options: getDefaultTransforms(), + data: getDefaultTransforms(), + }, + out: { + result: getDefaultTransforms(), + }, + }, + delete: { + in: { + options: getDefaultTransforms(), + }, + out: { + result: getDefaultTransforms(), + }, + }, + search: { + in: { + options: getDefaultTransforms(), + query: getDefaultTransforms(), + }, + out: { + result: getDefaultTransforms(), + }, + }, +}); + +export const getTransforms = ( + definitions: ServiceDefinitionVersioned, + requestVersion: Version, + _compiled?: { [path: string]: ObjectMigrationDefinition } +): ServiceTransforms => { + // Compile the definition into a flattened object with ObjectMigrationDefinition + const compiled = _compiled ?? compile(definitions); + + // Initiate transform for specific request version + const transformsForRequest = getDefaultServiceTransforms(); + + Object.entries(compiled).forEach(([path, objectMigrationDefinition]) => { + const objectTransforms = initTransform(requestVersion)(objectMigrationDefinition); + set(transformsForRequest, path, objectTransforms); + }); + + return transformsForRequest; +}; + +export type GetTransformsFn = typeof getTransforms; diff --git a/packages/kbn-object-versioning/lib/content_management_types.ts b/packages/kbn-object-versioning/lib/content_management_types.ts new file mode 100644 index 0000000000000..004c77f8ff605 --- /dev/null +++ b/packages/kbn-object-versioning/lib/content_management_types.ts @@ -0,0 +1,121 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { ObjectTransforms, Version, VersionableObject } from './types'; + +export interface ServicesDefinition { + get?: { + in?: { + options?: VersionableObject; + }; + out?: { + result?: VersionableObject; + }; + }; + bulkGet?: { + in?: { + options?: VersionableObject; + }; + out?: { + result?: VersionableObject; + }; + }; + create?: { + in?: { + data?: VersionableObject; + options?: VersionableObject; + }; + out?: { + result?: VersionableObject; + }; + }; + update?: { + in?: { + data?: VersionableObject; + options?: VersionableObject; + }; + out?: { + result?: VersionableObject; + }; + }; + delete?: { + in?: { + options?: VersionableObject; + }; + out?: { + result?: VersionableObject; + }; + }; + search?: { + in?: { + query?: VersionableObject; + options?: VersionableObject; + }; + out?: { + result?: VersionableObject; + }; + }; +} + +export interface ServiceTransforms { + get: { + in: { + options: ObjectTransforms; + }; + out: { + result: ObjectTransforms; + }; + }; + bulkGet: { + in: { + options: ObjectTransforms; + }; + out: { + result: ObjectTransforms; + }; + }; + create: { + in: { + data: ObjectTransforms; + options: ObjectTransforms; + }; + out: { + result: ObjectTransforms; + }; + }; + update: { + in: { + data: ObjectTransforms; + options: ObjectTransforms; + }; + out: { + result: ObjectTransforms; + }; + }; + delete: { + in: { + options: ObjectTransforms; + }; + out: { + result: ObjectTransforms; + }; + }; + search: { + in: { + query: ObjectTransforms; + options: ObjectTransforms; + }; + out: { + result: ObjectTransforms; + }; + }; +} + +export interface ServiceDefinitionVersioned { + [version: Version]: ServicesDefinition; +} diff --git a/packages/kbn-object-versioning/lib/index.ts b/packages/kbn-object-versioning/lib/index.ts new file mode 100644 index 0000000000000..9e5c1c3cdbf12 --- /dev/null +++ b/packages/kbn-object-versioning/lib/index.ts @@ -0,0 +1,31 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { initTransform } from './object_transform'; + +export { + getTransforms as getContentManagmentServicesTransforms, + compile as compileServiceDefinitions, +} from './content_management_services_versioning'; + +export type { GetTransformsFn as ContentManagementGetTransformsFn } from './content_management_services_versioning'; + +export type { + Version, + VersionableObject, + ObjectMigrationDefinition, + ObjectTransform, + ObjectTransforms, + TransformReturn, +} from './types'; + +export type { + ServiceTransforms as ContentManagementServiceTransforms, + ServicesDefinition as ContentManagementServicesDefinition, + ServiceDefinitionVersioned as ContentManagementServiceDefinitionVersioned, +} from './content_management_types'; diff --git a/packages/kbn-object-versioning/lib/object_transform.test.ts b/packages/kbn-object-versioning/lib/object_transform.test.ts new file mode 100644 index 0000000000000..ee1880313b2b7 --- /dev/null +++ b/packages/kbn-object-versioning/lib/object_transform.test.ts @@ -0,0 +1,220 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { schema } from '@kbn/config-schema'; +import { initTransform } from './object_transform'; + +import type { + ObjectMigrationDefinition, + ObjectTransforms, + Version, + VersionableObject, +} from './types'; + +interface FooV1 { + fullName: string; +} + +const v1Tv2Transform = jest.fn((v1: FooV1): FooV2 => { + const [firstName, lastName] = v1.fullName.split(' '); + return { firstName, lastName }; +}); + +const fooDefV1: VersionableObject = { + schema: schema.object({ + fullName: schema.string({ minLength: 1 }), + }), + up: v1Tv2Transform, +}; + +interface FooV2 { + firstName: string; + lastName: string; +} + +const v2Tv1Transform = jest.fn((v2: FooV2): FooV1 => { + return { + fullName: `${v2.firstName} ${v2.lastName}`, + }; +}); + +const fooDefV2: VersionableObject = { + schema: schema.object({ + firstName: schema.string(), + lastName: schema.string(), + }), + down: v2Tv1Transform, +}; + +const fooMigrationDef: ObjectMigrationDefinition = { + 1: fooDefV1, + 2: fooDefV2, +}; + +const setup = (browserVersion: Version): ObjectTransforms => { + const transformsFactory = initTransform(browserVersion); + return transformsFactory(fooMigrationDef); +}; + +describe('object transform', () => { + describe('initTransform()', () => { + test('it should validate that version numbers are valid', () => { + expect(() => { + initTransform(2)({ + // @ts-expect-error + abc: { up: () => undefined }, + }); + }).toThrowError('Invalid version number [abc].'); + }); + }); + + describe('up()', () => { + test('it should up transform to the latest version', () => { + const fooTransforms = setup(1); + const { value } = fooTransforms.up({ fullName: 'John Snow' }); + const expected = { firstName: 'John', lastName: 'Snow' }; + expect(value).toEqual(expected); + }); + + test('it should forward object if on same version', () => { + const fooTransforms = setup(2); + const obj = { firstName: 'John', lastName: 'Snow' }; + const { value } = fooTransforms.up(obj); + expect(value).toBe(obj); + }); + + describe('validation', () => { + test('it should validate the object before up transform', () => { + const fooTransforms = setup(1); + const { error } = fooTransforms.up({ unknown: 'John Snow' }); + expect(error!.message).toBe( + '[fullName]: expected value of type [string] but got [undefined]' + ); + }); + + test('it should validate that the version to up transform to exists', () => { + const fooTransforms = setup(1); + const { error } = fooTransforms.up({ fullName: 'John Snow' }, 3); + expect(error!.message).toBe('Unvalid version to up transform to [3].'); + }); + + test('it should validate that the version to up transform from exists', () => { + const fooTransforms = setup(0); + const { error } = fooTransforms.up({ fullName: 'John Snow' }); + expect(error!.message).toBe('Unvalid version to up transform from [0].'); + }); + + test('it should handle errors while up transforming', () => { + const fooTransforms = setup(1); + + v1Tv2Transform.mockImplementation((v1) => { + return (v1 as any).unknown.split(''); + }); + + const { error } = fooTransforms.up({ fullName: 'John Snow' }); + + expect(error!.message).toBe( + `[Transform error] Cannot read properties of undefined (reading 'split').` + ); + }); + }); + }); + + describe('down()', () => { + test('it should down transform to a previous version', () => { + const fooTransforms = setup(1); + const { value } = fooTransforms.down({ firstName: 'John', lastName: 'Snow' }); + const expected = { fullName: 'John Snow' }; + expect(value).toEqual(expected); + }); + + test('it should forward object if on same version', () => { + const fooTransforms = setup(1); + const obj = { fullName: 'John Snow' }; + const { value } = fooTransforms.down(obj, 1); + expect(value).toBe(obj); + }); + + describe('validation', () => { + test('it should validate the object before down transform', () => { + const fooTransforms = setup(1); + + const { error } = fooTransforms.down({ bad: 'Unknown' }); + expect(error).not.toBe(null); + expect(error!.message).toBe( + '[firstName]: expected value of type [string] but got [undefined]' + ); + }); + + test('it should validate that the version to down transform from exists', () => { + const fooTransforms = setup(1); + const { error } = fooTransforms.down({ fullName: 'John Snow' }, 3); + expect(error!.message).toBe('Unvalid version to down transform from [3].'); + }); + + test('it should validate that the version to down transform to exists', () => { + const fooTransforms = setup(0); + const { error } = fooTransforms.down({ firstName: 'John', lastName: 'Snow' }); + expect(error!.message).toBe('Unvalid version to down transform to [0].'); + }); + + test('it should handle errors while down transforming', () => { + const fooTransforms = setup(1); + + v2Tv1Transform.mockImplementation((v2) => { + return (v2 as any).unknown.split(''); + }); + + const { error } = fooTransforms.down({ firstName: 'John', lastName: 'Snow' }); + + expect(error!.message).toBe( + `[Transform error] Cannot read properties of undefined (reading 'split').` + ); + }); + }); + }); + + describe('validate()', () => { + test('it should validate the object at the specific version', () => { + const def: ObjectMigrationDefinition = { + 1: { + schema: schema.string(), + }, + 2: { + schema: schema.number(), + }, + }; + + // Init transforms for version 1 + let transformsFactory = initTransform(1); + expect(transformsFactory(def).validate(123)?.message).toBe( + 'expected value of type [string] but got [number]' + ); + expect(transformsFactory(def).validate('foo')).toBe(null); + + // Can validate another version than the requested one + expect(transformsFactory(def).validate('foo', 2)?.message).toBe( + 'expected value of type [number] but got [string]' + ); + expect(transformsFactory(def).validate(123, 2)).toBe(null); + + // Init transform for version 2 + transformsFactory = initTransform(2); + expect(transformsFactory(def).validate('foo')?.message).toBe( + 'expected value of type [number] but got [string]' + ); + expect(transformsFactory(def).validate(123)).toBe(null); + + // Init transform for version 7 (invalid) + transformsFactory = initTransform(7); + expect(() => { + transformsFactory(def).validate(123); + }).toThrowError('Invalid version number [7].'); + }); + }); +}); diff --git a/packages/kbn-object-versioning/lib/object_transform.ts b/packages/kbn-object-versioning/lib/object_transform.ts new file mode 100644 index 0000000000000..266906a352a6f --- /dev/null +++ b/packages/kbn-object-versioning/lib/object_transform.ts @@ -0,0 +1,195 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { ObjectMigrationDefinition, ObjectTransform, ObjectTransforms, Version } from './types'; +import { validateObj, validateVersion } from './utils'; + +/** + * Extract versions metadata from an object migration definition + * + * @param migrationDefinition The object migration definition + * @returns Metadata about the versions (list of available, last supported, latest) + */ +const getVersionsMeta = (migrationDefinition: ObjectMigrationDefinition) => { + const versions = Object.keys(migrationDefinition) + .map((version) => { + const { result, value } = validateVersion(version); + if (!result) { + throw new Error(`Invalid version number [${version}].`); + } + return value as number; + }) + .sort((a, b) => a - b); + + const latestVersion = versions[versions.length - 1]; + const lastSupportedVersion = versions[0]; + + return { + versions, + lastSupportedVersion, + latestVersion, + }; +}; + +/** + * Get a list of pure functions to transform an object from one version + * to another. Either "up" or "down" according if the "to" is > than the "from" + * + * @param from The version to start from + * @param to The version to end to + * @param migrationDefinition The object migration definition + * @returns An array of transform functions + */ +const getTransformFns = ( + from: Version, + to: Version, + migrationDefinition: ObjectMigrationDefinition +): ObjectTransform[] => { + const fns: ObjectTransform[] = []; + + let i = from; + let fn: ObjectTransform | undefined; + if (to > from) { + while (i <= to) { + fn = migrationDefinition[i].up; + if (fn) { + fns.push(fn); + } + i++; + } + } else if (to < from) { + while (i >= to) { + fn = migrationDefinition[i].down; + if (fn) { + fns.push(fn); + } + i--; + } + } + + return fns; +}; + +/** + * Initiate a transform for a specific request version. After we initiate the transforms + * for a specific version we can then pass different `ObjectMigrationDefinition` to the provided + * handler to start up/down transforming different object based on this request version. + * + * @example + * + * ```ts + * const transforms = initTransform(2); // start from version "2" + * const fooTransforms = transforms(fooMigrationDefinition); + * const barTransforms = transforms(barMigrationDefinition); + * + * // Up transform the objects to the latest, starting from version "2" + * const { value: fooOnLatest } = foo.up(); + * const { value: barOnLatest } = bar.up(); + * ``` + * + * @param requestVersion The starting version before up/down transforming + * @returns A handler to pass an object migration definition + */ +export const initTransform = + (requestVersion: Version) => + (migrationDefinition: ObjectMigrationDefinition): ObjectTransforms => { + const { latestVersion } = getVersionsMeta(migrationDefinition); + + const getVersion = (v: Version | 'latest'): Version => (v === 'latest' ? latestVersion : v); + + const validateFn = (value: unknown, version: number = requestVersion) => { + const def = migrationDefinition[version]; + + if (!def) { + throw new Error(`Invalid version number [${version}].`); + } + + const { schema } = def; + + if (schema) { + return validateObj(value, schema); + } + return null; + }; + + return { + up: (obj, to = 'latest', { validate = true }: { validate?: boolean } = {}) => { + try { + if (!migrationDefinition[requestVersion]) { + return { + error: new Error(`Unvalid version to up transform from [${requestVersion}].`), + value: null, + }; + } + + if (validate) { + const error = validateFn(obj, requestVersion); + if (error) { + return { error, value: null }; + } + } + + const targetVersion = getVersion(to); + + if (!migrationDefinition[targetVersion]) { + return { + error: new Error(`Unvalid version to up transform to [${to}].`), + value: null, + }; + } + + const fns = getTransformFns(requestVersion, targetVersion, migrationDefinition); + + const value = fns.reduce((acc, fn) => fn(acc), obj); + return { value, error: null }; + } catch (e) { + return { + value: null, + error: new Error(`[Transform error] ${e.message ?? 'could not transform object'}.`), + }; + } + }, + down: (obj, from = 'latest', { validate = true }: { validate?: boolean } = {}) => { + try { + if (!migrationDefinition[requestVersion]) { + return { + error: new Error(`Unvalid version to down transform to [${requestVersion}].`), + value: null, + }; + } + + const fromVersion = getVersion(from); + + if (!migrationDefinition[fromVersion]) { + return { + error: new Error(`Unvalid version to down transform from [${from}].`), + value: null, + }; + } + + if (validate) { + const error = validateFn(obj, fromVersion); + if (error) { + return { error, value: null }; + } + } + + const fns = getTransformFns(fromVersion, requestVersion, migrationDefinition); + const value = fns.reduce((acc, fn) => fn(acc), obj); + + return { value, error: null }; + } catch (e) { + return { + value: null, + error: new Error(`[Transform error] ${e.message ?? 'could not transform object'}.`), + }; + } + }, + validate: validateFn, + }; + }; diff --git a/packages/kbn-object-versioning/lib/types.ts b/packages/kbn-object-versioning/lib/types.ts new file mode 100644 index 0000000000000..f177c3a282167 --- /dev/null +++ b/packages/kbn-object-versioning/lib/types.ts @@ -0,0 +1,52 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +import type { Type, ValidationError } from '@kbn/config-schema'; + +export type Version = number; + +export type ObjectTransform = (input: I) => O; + +export interface VersionableObject { + schema?: Type; + down?: ObjectTransform; + up?: ObjectTransform; +} + +export interface ObjectMigrationDefinition { + [version: Version]: VersionableObject; +} + +export type TransformReturn = + | { + value: T; + error: null; + } + | { + value: null; + error: ValidationError | Error; + }; + +export interface ObjectTransforms { + up: ( + obj: Current, + version?: Version | 'latest', + options?: { + /** Validate the object _before_ up transform */ + validate?: boolean; + } + ) => TransformReturn; + down: ( + obj: Current, + version?: Version | 'latest', + options?: { + /** Validate the object _before_ down transform */ + validate?: boolean; + } + ) => TransformReturn; + validate: (obj: any, version?: Version) => ValidationError | null; +} diff --git a/packages/kbn-object-versioning/lib/utils.test.ts b/packages/kbn-object-versioning/lib/utils.test.ts new file mode 100644 index 0000000000000..a10bc8e84a7dd --- /dev/null +++ b/packages/kbn-object-versioning/lib/utils.test.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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { validateVersion } from './utils'; + +describe('utils', () => { + describe('validateVersion()', () => { + [ + { input: '123', isValid: true, expected: 123 }, + { input: '1111111111111111111111111', isValid: true, expected: 1111111111111111111111111 }, + { input: '111111111111.1111111111111', isValid: false, expected: null }, + { input: 123, isValid: true, expected: 123 }, + { input: 1.23, isValid: false, expected: null }, + { input: '123a', isValid: false, expected: null }, + { input: 'abc', isValid: false, expected: null }, + { input: undefined, isValid: false, expected: null }, + { input: null, isValid: false, expected: null }, + { input: [123], isValid: false, expected: null }, + { input: { 123: true }, isValid: false, expected: null }, + { input: () => 123, isValid: false, expected: null }, + ].forEach(({ input, expected, isValid }) => { + test(`validate: [${input}]`, () => { + const { result, value } = validateVersion(input); + expect(result).toBe(isValid); + expect(value).toBe(expected); + }); + }); + }); +}); diff --git a/packages/kbn-object-versioning/lib/utils.ts b/packages/kbn-object-versioning/lib/utils.ts new file mode 100644 index 0000000000000..e5531578c55bb --- /dev/null +++ b/packages/kbn-object-versioning/lib/utils.ts @@ -0,0 +1,58 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { Type, ValidationError } from '@kbn/config-schema'; +import { Version } from './types'; + +/** + * Validate an object based on a schema. + * + * @param obj The object to validate + * @param objSchema The schema to validate the object against + * @returns null or ValidationError + */ +export const validateObj = (obj: unknown, objSchema?: Type): ValidationError | null => { + if (objSchema === undefined) { + return null; + } + + try { + objSchema.validate(obj); + return null; + } catch (e: any) { + return e as ValidationError; + } +}; + +export const validateVersion = ( + version: unknown +): { result: true; value: Version } | { result: false; value: null } => { + if (typeof version === 'string') { + const isValid = /^\d+$/.test(version); + if (isValid) { + const parsed = parseInt(version, 10); + if (Number.isNaN(parsed)) { + return { result: false, value: null }; + } + return { result: true, value: parsed }; + } + return { result: false, value: null }; + } else { + const isValid = Number.isInteger(version); + if (isValid) { + return { + result: true, + value: version as Version, + }; + } + return { + result: false, + value: null, + }; + } +}; diff --git a/packages/kbn-object-versioning/package.json b/packages/kbn-object-versioning/package.json new file mode 100644 index 0000000000000..0c5ed9b109702 --- /dev/null +++ b/packages/kbn-object-versioning/package.json @@ -0,0 +1,6 @@ +{ + "name": "@kbn/object-versioning", + "private": true, + "version": "1.0.0", + "license": "SSPL-1.0 OR Elastic License 2.0" +} \ No newline at end of file diff --git a/packages/kbn-object-versioning/tsconfig.json b/packages/kbn-object-versioning/tsconfig.json new file mode 100644 index 0000000000000..35c4b501af791 --- /dev/null +++ b/packages/kbn-object-versioning/tsconfig.json @@ -0,0 +1,22 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "outDir": "target/types", + "types": [ + "jest", + "node", + "react" + ] + }, + "include": [ + "**/*.ts", + "**/*.tsx", + ], + "exclude": [ + "target/**/*" + ], + "kbn_references": [ + "@kbn/config-schema", + "@kbn/safer-lodash-set", + ] +} diff --git a/packages/kbn-optimizer/src/worker/webpack.config.ts b/packages/kbn-optimizer/src/worker/webpack.config.ts index 83b9882118b1c..986ec051637e4 100644 --- a/packages/kbn-optimizer/src/worker/webpack.config.ts +++ b/packages/kbn-optimizer/src/worker/webpack.config.ts @@ -91,7 +91,7 @@ export function getWebpackConfig( // already bundled with all its necessary dependencies noParse: [ /[\/\\]node_modules[\/\\]lodash[\/\\]index\.js$/, - /[\/\\]node_modules[\/\\]vega[\/\\]build[\/\\]vega\.js$/, + /[\/\\]node_modules[\/\\]vega[\/\\]build-es5[\/\\]vega\.js$/, ], rules: [ diff --git a/packages/kbn-react-field/src/field_icon/__snapshots__/field_icon.test.tsx.snap b/packages/kbn-react-field/src/field_icon/__snapshots__/field_icon.test.tsx.snap index 67ea69a8c269c..ada9724ca04e5 100644 --- a/packages/kbn-react-field/src/field_icon/__snapshots__/field_icon.test.tsx.snap +++ b/packages/kbn-react-field/src/field_icon/__snapshots__/field_icon.test.tsx.snap @@ -58,7 +58,7 @@ exports[`FieldIcon renders known field types conflict is rendered 1`] = ` aria-label="conflict" className="kbnFieldIcon" color="euiColorVis9" - iconType="alert" + iconType="warning" shape="square" size="s" title="conflict" diff --git a/packages/kbn-react-field/src/field_icon/field_icon.tsx b/packages/kbn-react-field/src/field_icon/field_icon.tsx index fb282688a4d0b..c0f39ec12dbb6 100644 --- a/packages/kbn-react-field/src/field_icon/field_icon.tsx +++ b/packages/kbn-react-field/src/field_icon/field_icon.tsx @@ -49,7 +49,7 @@ export const typeToEuiIconMap: Partial> = { binary: { iconType: 'tokenBinary' }, boolean: { iconType: 'tokenBoolean' }, // icon for an index pattern mapping conflict in discover - conflict: { iconType: 'alert', color: 'euiColorVis9', shape: 'square' }, + conflict: { iconType: 'warning', color: 'euiColorVis9', shape: 'square' }, date: { iconType: 'tokenDate' }, date_range: { iconType: 'tokenDate' }, dense_vector: { iconType: 'tokenDenseVector' }, diff --git a/packages/kbn-securitysolution-autocomplete/src/field/use_field.tsx b/packages/kbn-securitysolution-autocomplete/src/field/use_field.tsx index ad4e8d42d20fa..0e9e01bbec315 100644 --- a/packages/kbn-securitysolution-autocomplete/src/field/use_field.tsx +++ b/packages/kbn-securitysolution-autocomplete/src/field/use_field.tsx @@ -236,7 +236,7 @@ export const useField = ({ = ({ case ViewerStatus.ERROR: { return { color: 'danger' as ExpressionColor, - iconType: 'alert', + iconType: 'error', title: (

{title || i18n.EMPTY_VIEWER_STATE_ERROR_TITLE}

), diff --git a/packages/kbn-securitysolution-grouping/src/components/group_selector/index.test.tsx b/packages/kbn-securitysolution-grouping/src/components/group_selector/index.test.tsx index 4706247f2f0a7..daa58396df70b 100644 --- a/packages/kbn-securitysolution-grouping/src/components/group_selector/index.test.tsx +++ b/packages/kbn-securitysolution-grouping/src/components/group_selector/index.test.tsx @@ -12,6 +12,7 @@ import React from 'react'; const onGroupChange = jest.fn(); const testProps = { + groupingId: 'test-grouping-id', fields: [ { name: 'kibana.alert.rule.name', diff --git a/packages/kbn-securitysolution-grouping/src/components/group_selector/index.tsx b/packages/kbn-securitysolution-grouping/src/components/group_selector/index.tsx index 210ffef50e381..f0274f7c73ab7 100644 --- a/packages/kbn-securitysolution-grouping/src/components/group_selector/index.tsx +++ b/packages/kbn-securitysolution-grouping/src/components/group_selector/index.tsx @@ -20,6 +20,7 @@ import { StyledContextMenu, StyledEuiButtonEmpty } from '../styles'; export interface GroupSelectorProps { 'data-test-subj'?: string; fields: FieldSpec[]; + groupingId: string; groupSelected: string; onGroupChange: (groupSelection: string) => void; options: Array<{ key: string; label: string }>; diff --git a/packages/kbn-securitysolution-grouping/src/components/grouping.test.tsx b/packages/kbn-securitysolution-grouping/src/components/grouping.test.tsx index 6b1d360e50468..ff5a7d66a6042 100644 --- a/packages/kbn-securitysolution-grouping/src/components/grouping.test.tsx +++ b/packages/kbn-securitysolution-grouping/src/components/grouping.test.tsx @@ -11,9 +11,12 @@ import React from 'react'; import { I18nProvider } from '@kbn/i18n-react'; import { Grouping } from './grouping'; import { createGroupFilter } from './accordion_panel/helpers'; +import { METRIC_TYPE } from '@kbn/analytics'; +import { getTelemetryEvent } from '../telemetry/const'; const renderChildComponent = jest.fn(); const takeActionItems = jest.fn(); +const mockTracker = jest.fn(); const rule1Name = 'Rule 1 name'; const rule1Desc = 'Rule 1 description'; const rule2Name = 'Rule 2 name'; @@ -21,10 +24,10 @@ const rule2Desc = 'Rule 2 description'; const testProps = { data: { - groupCount0: { + groupsCount: { value: 2, }, - stackByMultipleFields0: { + groupByFields: { doc_count_error_upper_bound: 0, sum_other_doc_count: 0, buckets: [ @@ -72,7 +75,7 @@ const testProps = { sum_other_doc_count: 0, buckets: [], }, - unitCount0: { + unitsCount: { value: 1, }, severitiesSubAggregation: { @@ -94,10 +97,11 @@ const testProps = { }, ], }, - unitCount0: { + unitsCount: { value: 2, }, }, + groupingId: 'test-grouping-id', isLoading: false, pagination: { pageIndex: 0, @@ -109,13 +113,14 @@ const testProps = { renderChildComponent, selectedGroup: 'kibana.alert.rule.name', takeActionItems, + tracker: mockTracker, }; describe('grouping container', () => { beforeEach(() => { jest.clearAllMocks(); }); - it('Renders group counts when groupCount0 > 0', () => { + it('Renders groups count when groupsCount > 0', () => { const { getByTestId, getAllByTestId, queryByTestId } = render( @@ -127,17 +132,17 @@ describe('grouping container', () => { expect(queryByTestId('empty-results-panel')).not.toBeInTheDocument(); }); - it('Does not render group counts when groupCount0 = 0', () => { + it('Does not render group counts when groupsCount = 0', () => { const data = { - groupCount0: { + groupsCount: { value: 0, }, - stackByMultipleFields0: { + groupByFields: { doc_count_error_upper_bound: 0, sum_other_doc_count: 0, buckets: [], }, - unitCount0: { + unitsCount: { value: 0, }, }; @@ -171,4 +176,33 @@ describe('grouping container', () => { createGroupFilter(testProps.selectedGroup, rule2Name) ); }); + + it('Send Telemetry when each group is clicked', () => { + const { getAllByTestId } = render( + + + + ); + const group1 = within(getAllByTestId('grouping-accordion')[0]).getAllByRole('button')[0]; + fireEvent.click(group1); + expect(mockTracker).toHaveBeenNthCalledWith( + 1, + METRIC_TYPE.CLICK, + getTelemetryEvent.groupToggled({ + isOpen: true, + groupingId: testProps.groupingId, + groupNumber: 0, + }) + ); + fireEvent.click(group1); + expect(mockTracker).toHaveBeenNthCalledWith( + 2, + METRIC_TYPE.CLICK, + getTelemetryEvent.groupToggled({ + isOpen: false, + groupingId: testProps.groupingId, + groupNumber: 0, + }) + ); + }); }); diff --git a/packages/kbn-securitysolution-grouping/src/components/grouping.tsx b/packages/kbn-securitysolution-grouping/src/components/grouping.tsx index 420656c69db41..bb390ab7dc355 100644 --- a/packages/kbn-securitysolution-grouping/src/components/grouping.tsx +++ b/packages/kbn-securitysolution-grouping/src/components/grouping.tsx @@ -15,6 +15,7 @@ import { } from '@elastic/eui'; import type { Filter } from '@kbn/es-query'; import React, { useMemo, useState } from 'react'; +import { METRIC_TYPE, UiCounterMetricType } from '@kbn/analytics'; import { defaultUnit, firstNonNullValue } from '../helpers'; import { createGroupFilter } from './accordion_panel/helpers'; import type { BadgeMetric, CustomMetric } from './accordion_panel'; @@ -24,15 +25,23 @@ import { EmptyGroupingComponent } from './empty_results_panel'; import { groupingContainerCss, countCss } from './styles'; import { GROUPS_UNIT } from './translations'; import type { GroupingAggregation, GroupingFieldTotalAggregation, RawBucket } from './types'; +import { getTelemetryEvent } from '../telemetry/const'; export interface GroupingProps { badgeMetricStats?: (fieldBucket: RawBucket) => BadgeMetric[]; customMetricStats?: (fieldBucket: RawBucket) => CustomMetric[]; data?: GroupingAggregation & GroupingFieldTotalAggregation; + groupingId: string; groupPanelRenderer?: (fieldBucket: RawBucket) => JSX.Element | undefined; groupSelector?: JSX.Element; inspectButton?: JSX.Element; isLoading: boolean; + onToggleCallback?: (params: { + isOpen: boolean; + groupName?: string | undefined; + groupNumber: number; + groupingId: string; + }) => void; pagination: { pageIndex: number; pageSize: number; @@ -42,7 +51,12 @@ export interface GroupingProps { }; renderChildComponent: (groupFilter: Filter[]) => React.ReactNode; selectedGroup: string; - takeActionItems: (groupFilters: Filter[]) => JSX.Element[]; + takeActionItems: (groupFilters: Filter[], groupNumber: number) => JSX.Element[]; + tracker?: ( + type: UiCounterMetricType, + event: string | string[], + count?: number | undefined + ) => void; unit?: (n: number) => string; } @@ -50,26 +64,29 @@ const GroupingComponent = ({ badgeMetricStats, customMetricStats, data, + groupingId, groupPanelRenderer, groupSelector, inspectButton, isLoading, + onToggleCallback, pagination, renderChildComponent, selectedGroup, takeActionItems, + tracker, unit = defaultUnit, }: GroupingProps) => { const [trigger, setTrigger] = useState< Record }> >({}); - const unitCount = data?.unitCount0?.value ?? 0; + const unitCount = data?.unitsCount?.value ?? 0; const unitCountText = useMemo(() => { return `${unitCount.toLocaleString()} ${unit && unit(unitCount)}`; }, [unitCount, unit]); - const groupCount = data?.groupCount0?.value ?? 0; + const groupCount = data?.groupsCount?.value ?? 0; const groupCountText = useMemo( () => `${groupCount.toLocaleString()} ${GROUPS_UNIT(groupCount)}`, [groupCount] @@ -77,9 +94,9 @@ const GroupingComponent = ({ const groupPanels = useMemo( () => - data?.stackByMultipleFields0?.buckets?.map((groupBucket) => { + data?.groupByFields?.buckets?.map((groupBucket, groupNumber) => { const group = firstNonNullValue(groupBucket.key); - const groupKey = `group0-${group}`; + const groupKey = `group-${groupNumber}-${group}`; return ( @@ -87,7 +104,10 @@ const GroupingComponent = ({ extraAction={ @@ -97,6 +117,11 @@ const GroupingComponent = ({ groupPanelRenderer={groupPanelRenderer && groupPanelRenderer(groupBucket)} isLoading={isLoading} onToggleGroup={(isOpen) => { + // built-in telemetry: UI-counter + tracker?.( + METRIC_TYPE.CLICK, + getTelemetryEvent.groupToggled({ isOpen, groupingId, groupNumber }) + ); setTrigger({ // ...trigger, -> this change will keep only one group at a time expanded and one table displayed [groupKey]: { @@ -104,6 +129,7 @@ const GroupingComponent = ({ selectedBucket: groupBucket, }, }); + onToggleCallback?.({ isOpen, groupName: group, groupNumber, groupingId }); }} renderChildComponent={ trigger[groupKey] && trigger[groupKey].state === 'open' @@ -119,12 +145,15 @@ const GroupingComponent = ({ [ badgeMetricStats, customMetricStats, - data?.stackByMultipleFields0?.buckets, + data?.groupByFields?.buckets, groupPanelRenderer, + groupingId, isLoading, + onToggleCallback, renderChildComponent, selectedGroup, takeActionItems, + tracker, trigger, ] ); diff --git a/packages/kbn-securitysolution-grouping/src/components/types.ts b/packages/kbn-securitysolution-grouping/src/components/types.ts index df978d99eba59..23f48ab29b160 100644 --- a/packages/kbn-securitysolution-grouping/src/components/types.ts +++ b/packages/kbn-securitysolution-grouping/src/components/types.ts @@ -20,13 +20,13 @@ export type RawBucket = GenericBuckets & T; /** Defines the shape of the aggregation returned by Elasticsearch */ // TODO: write developer docs for these fields export interface GroupingAggregation { - stackByMultipleFields0?: { + groupByFields?: { buckets?: Array>; }; - groupCount0?: { + groupsCount?: { value?: number | null; }; - unitCount0?: { + unitsCount?: { value?: number | null; }; } diff --git a/packages/kbn-securitysolution-grouping/src/containers/query/index.test.ts b/packages/kbn-securitysolution-grouping/src/containers/query/index.test.ts index 432f3e645ef2b..72a93b5fa853f 100644 --- a/packages/kbn-securitysolution-grouping/src/containers/query/index.test.ts +++ b/packages/kbn-securitysolution-grouping/src/containers/query/index.test.ts @@ -11,8 +11,9 @@ import { getGroupingQuery, MAX_QUERY_SIZE } from '.'; const testProps: GroupingQueryArgs = { additionalFilters: [], - additionalAggregationsRoot: [], - additionalStatsAggregationsFields0: [ + from: '2022-12-28T15:35:32.871Z', + groupByFields: ['host.name'], + metricsAggregations: [ { alertsCount: { cardinality: { @@ -49,14 +50,10 @@ const testProps: GroupingQueryArgs = { }, }, ], - additionalStatsAggregationsFields1: [], - from: '2022-12-28T15:35:32.871Z', + pageNumber: 0, + rootAggregations: [], runtimeMappings: {}, - stackByMultipleFields0: ['host.name'], - stackByMultipleFields0Size: 25, - stackByMultipleFields0From: 0, - stackByMultipleFields1: [], - stackByMultipleFields1Size: 10, + size: 25, to: '2023-02-23T06:59:59.999Z', }; describe('group selector', () => { @@ -65,12 +62,12 @@ describe('group selector', () => { }); it('Sets terms query when single stackBy field requested', () => { const result = getGroupingQuery(testProps); - expect(result.aggs.stackByMultipleFields0.multi_terms).toBeUndefined(); - expect(result.aggs.stackByMultipleFields0.terms).toEqual({ + expect(result.aggs.groupByFields.multi_terms).toBeUndefined(); + expect(result.aggs.groupByFields.terms).toEqual({ field: 'host.name', size: MAX_QUERY_SIZE, }); - expect(result.aggs.stackByMultipleFields0.aggs).toEqual({ + expect(result.aggs.groupByFields.aggs).toEqual({ bucket_truncate: { bucket_sort: { from: 0, size: 25 } }, alertsCount: { cardinality: { field: 'kibana.alert.uuid' } }, rulesCountAggregation: { cardinality: { field: 'kibana.alert.rule.rule_id' } }, @@ -85,7 +82,7 @@ describe('group selector', () => { it('Sets terms query when single stackBy field requested additionalAggregationsRoot', () => { const result = getGroupingQuery({ ...testProps, - additionalAggregationsRoot: [ + rootAggregations: [ { alertsCount: { terms: { @@ -111,10 +108,10 @@ describe('group selector', () => { it('Sets terms query when multiple stackBy fields requested', () => { const result = getGroupingQuery({ ...testProps, - stackByMultipleFields0: ['kibana.alert.rule.name', 'kibana.alert.rule.description'], + groupByFields: ['kibana.alert.rule.name', 'kibana.alert.rule.description'], }); - expect(result.aggs.stackByMultipleFields0.terms).toBeUndefined(); - expect(result.aggs.stackByMultipleFields0.multi_terms).toEqual({ + expect(result.aggs.groupByFields.terms).toBeUndefined(); + expect(result.aggs.groupByFields.multi_terms).toEqual({ terms: [{ field: 'kibana.alert.rule.name' }, { field: 'kibana.alert.rule.description' }], size: MAX_QUERY_SIZE, }); diff --git a/packages/kbn-securitysolution-grouping/src/containers/query/index.ts b/packages/kbn-securitysolution-grouping/src/containers/query/index.ts index ab40ac554931a..4a2bc38ad4686 100644 --- a/packages/kbn-securitysolution-grouping/src/containers/query/index.ts +++ b/packages/kbn-securitysolution-grouping/src/containers/query/index.ts @@ -6,111 +6,58 @@ * Side Public License, v 1. */ -import { isEmpty } from 'lodash/fp'; -import type { GroupingQueryArgs, GroupingQuery, NamedAggregation } from './types'; -/** The maximum number of items to render */ -export const DEFAULT_STACK_BY_FIELD0_SIZE = 10; -export const DEFAULT_STACK_BY_FIELD1_SIZE = 10; - -const getOptionalSubAggregation = ({ - stackByMultipleFields1, - stackByMultipleFields1Size, - stackByMultipleFields1From = 0, - stackByMultipleFields1Sort, - additionalStatsAggregationsFields1, -}: { - stackByMultipleFields1: string[] | undefined; - stackByMultipleFields1Size: number; - stackByMultipleFields1From?: number; - stackByMultipleFields1Sort?: Array<{ [category: string]: { order: 'asc' | 'desc' } }>; - additionalStatsAggregationsFields1: NamedAggregation[]; -}): NamedAggregation | {} => - stackByMultipleFields1 != null && !isEmpty(stackByMultipleFields1) - ? { - stackByMultipleFields1: { - multi_terms: { - terms: stackByMultipleFields1.map((stackByMultipleField1) => ({ - field: stackByMultipleField1, - })), - }, - aggs: { - bucket_truncate: { - bucket_sort: { - sort: stackByMultipleFields1Sort, - from: stackByMultipleFields1From, - size: stackByMultipleFields1Size, - }, - }, - ...additionalStatsAggregationsFields1.reduce( - (aggObj, subAgg) => Object.assign(aggObj, subAgg), - {} - ), - }, - }, - } - : {}; +import type { GroupingQueryArgs, GroupingQuery } from './types'; +/** The maximum number of groups to render */ +export const DEFAULT_GROUP_BY_FIELD_SIZE = 10; // our pagination will be broken if the stackBy field cardinality exceeds 10,000 // https://github.com/elastic/kibana/issues/151913 export const MAX_QUERY_SIZE = 10000; export const getGroupingQuery = ({ additionalFilters = [], - additionalAggregationsRoot, - additionalStatsAggregationsFields0, - additionalStatsAggregationsFields1, from, + groupByFields, + metricsAggregations, + pageNumber, + rootAggregations, runtimeMappings, - stackByMultipleFields0, - stackByMultipleFields0Size = DEFAULT_STACK_BY_FIELD0_SIZE, - stackByMultipleFields0From, - stackByMultipleFields0Sort, - stackByMultipleFields1, - stackByMultipleFields1Size = DEFAULT_STACK_BY_FIELD1_SIZE, - stackByMultipleFields1From, - stackByMultipleFields1Sort, + size = DEFAULT_GROUP_BY_FIELD_SIZE, + sort, to, }: GroupingQueryArgs): GroupingQuery => ({ size: 0, aggs: { - stackByMultipleFields0: { - ...(stackByMultipleFields0.length > 1 + groupByFields: { + ...(groupByFields.length > 1 ? { multi_terms: { - terms: stackByMultipleFields0.map((stackByMultipleField0) => ({ - field: stackByMultipleField0, + terms: groupByFields.map((groupByField) => ({ + field: groupByField, })), size: MAX_QUERY_SIZE, }, } : { terms: { - field: stackByMultipleFields0[0], + field: groupByFields[0], size: MAX_QUERY_SIZE, }, }), aggs: { - ...getOptionalSubAggregation({ - stackByMultipleFields1, - stackByMultipleFields1Size, - stackByMultipleFields1From, - stackByMultipleFields1Sort, - additionalStatsAggregationsFields1, - }), bucket_truncate: { bucket_sort: { - sort: stackByMultipleFields0Sort, - from: stackByMultipleFields0From, - size: stackByMultipleFields0Size, + sort, + from: pageNumber, + size, }, }, - ...additionalStatsAggregationsFields0.reduce( - (aggObj, subAgg) => Object.assign(aggObj, subAgg), - {} - ), + ...(metricsAggregations + ? metricsAggregations.reduce((aggObj, subAgg) => Object.assign(aggObj, subAgg), {}) + : {}), }, }, - ...(additionalAggregationsRoot - ? additionalAggregationsRoot.reduce((aggObj, subAgg) => Object.assign(aggObj, subAgg), {}) + ...(rootAggregations + ? rootAggregations.reduce((aggObj, subAgg) => Object.assign(aggObj, subAgg), {}) : {}), }, query: { diff --git a/packages/kbn-securitysolution-grouping/src/containers/query/types.ts b/packages/kbn-securitysolution-grouping/src/containers/query/types.ts index d6c08c2d12514..4066fd5ae7d3c 100644 --- a/packages/kbn-securitysolution-grouping/src/containers/query/types.ts +++ b/packages/kbn-securitysolution-grouping/src/containers/query/types.ts @@ -23,37 +23,32 @@ export type NamedAggregation = Record; - additionalStatsAggregationsFields0: NamedAggregation[]; - stackByMultipleFields1: string[] | undefined; - stackByMultipleFields1Size?: number; - stackByMultipleFields1From?: number; - stackByMultipleFields1Sort?: Array<{ [category: string]: { order: estypes.SortOrder } }>; - additionalStatsAggregationsFields1: NamedAggregation[]; + size?: number; + sort?: Array<{ [category: string]: { order: 'asc' | 'desc' } }>; to: string; } export interface MainAggregation extends NamedAggregation { - stackByMultipleFields0: { - terms?: estypes.AggregationsAggregationContainer['terms']; - multi_terms?: estypes.AggregationsAggregationContainer['multi_terms']; + groupByFields: { aggs: NamedAggregation; + multi_terms?: estypes.AggregationsAggregationContainer['multi_terms']; + terms?: estypes.AggregationsAggregationContainer['terms']; }; } export interface GroupingQuery extends estypes.QueryDslQueryContainer { - size: number; - runtime_mappings: MappingRuntimeFields | undefined; + aggs: MainAggregation; query: { bool: { filter: Array; }; }; + runtime_mappings: MappingRuntimeFields | undefined; + size: number; _source: boolean; - aggs: MainAggregation; } diff --git a/packages/kbn-securitysolution-grouping/src/hooks/use_get_group_selector.test.tsx b/packages/kbn-securitysolution-grouping/src/hooks/use_get_group_selector.test.tsx index 2a3e6d39d7a41..7a659a55eba08 100644 --- a/packages/kbn-securitysolution-grouping/src/hooks/use_get_group_selector.test.tsx +++ b/packages/kbn-securitysolution-grouping/src/hooks/use_get_group_selector.test.tsx @@ -10,6 +10,7 @@ import { act, renderHook } from '@testing-library/react-hooks'; import { useGetGroupSelector } from './use_get_group_selector'; import { initialState } from './state'; import { ActionType, defaultGroup } from '..'; +import { METRIC_TYPE } from '@kbn/analytics'; const defaultGroupingOptions = [ { label: 'ruleName', key: 'kibana.alert.rule.name' }, @@ -25,6 +26,8 @@ const defaultArgs = { fields: [], groupingId, groupingState: initialState, + tracker: jest.fn(), + onGroupChangeCallback: jest.fn(), }; const customField = 'custom.field'; describe('useGetGroupSelector', () => { @@ -123,6 +126,54 @@ describe('useGetGroupSelector', () => { expect(dispatch).toHaveBeenCalledTimes(2); }); + it('On group change, sends telemetry', () => { + const testGroup = { + [groupingId]: { + ...defaultGroup, + options: defaultGroupingOptions, + activeGroup: 'host.name', + }, + }; + const { result } = renderHook((props) => useGetGroupSelector(props), { + initialProps: { + ...defaultArgs, + groupingState: { + groupById: testGroup, + }, + }, + }); + act(() => result.current.props.onGroupChange(customField)); + expect(defaultArgs.tracker).toHaveBeenCalledTimes(1); + expect(defaultArgs.tracker).toHaveBeenCalledWith( + METRIC_TYPE.CLICK, + `alerts_table_group_by_test-table_${customField}` + ); + }); + + it('On group change, executes callback', () => { + const testGroup = { + [groupingId]: { + ...defaultGroup, + options: defaultGroupingOptions, + activeGroup: 'host.name', + }, + }; + const { result } = renderHook((props) => useGetGroupSelector(props), { + initialProps: { + ...defaultArgs, + groupingState: { + groupById: testGroup, + }, + }, + }); + act(() => result.current.props.onGroupChange(customField)); + expect(defaultArgs.onGroupChangeCallback).toHaveBeenCalledTimes(1); + expect(defaultArgs.onGroupChangeCallback).toHaveBeenCalledWith({ + tableId: groupingId, + groupByField: customField, + }); + }); + it('On group change to custom field, updates options', () => { const testGroup = { [groupingId]: { diff --git a/packages/kbn-securitysolution-grouping/src/hooks/use_get_group_selector.tsx b/packages/kbn-securitysolution-grouping/src/hooks/use_get_group_selector.tsx index 3509e095e6cc8..2b52ca141b55f 100644 --- a/packages/kbn-securitysolution-grouping/src/hooks/use_get_group_selector.tsx +++ b/packages/kbn-securitysolution-grouping/src/hooks/use_get_group_selector.tsx @@ -9,10 +9,12 @@ import type { FieldSpec } from '@kbn/data-views-plugin/common'; import { useCallback, useEffect } from 'react'; +import { METRIC_TYPE, UiCounterMetricType } from '@kbn/analytics'; import { getGroupSelector, isNoneGroup } from '../..'; import { groupActions, groupByIdSelector } from './state'; import type { GroupOption } from './types'; import { Action, defaultGroup, GroupMap } from './types'; +import { getTelemetryEvent } from '../telemetry/const'; export interface UseGetGroupSelectorArgs { defaultGroupingOptions: GroupOption[]; @@ -20,6 +22,12 @@ export interface UseGetGroupSelectorArgs { fields: FieldSpec[]; groupingId: string; groupingState: GroupMap; + onGroupChangeCallback?: (param: { groupByField: string; tableId: string }) => void; + tracker: ( + type: UiCounterMetricType, + event: string | string[], + count?: number | undefined + ) => void; } export const useGetGroupSelector = ({ @@ -28,6 +36,8 @@ export const useGetGroupSelector = ({ fields, groupingId, groupingState, + onGroupChangeCallback, + tracker, }: UseGetGroupSelectorArgs) => { const { activeGroup: selectedGroup, options } = groupByIdSelector({ groups: groupingState }, groupingId) ?? defaultGroup; @@ -61,6 +71,14 @@ export const useGetGroupSelector = ({ setGroupsActivePage(0); setSelectedGroup(groupSelection); + // built-in telemetry: UI-counter + tracker?.( + METRIC_TYPE.CLICK, + getTelemetryEvent.groupChanged({ groupingId, selected: groupSelection }) + ); + + onGroupChangeCallback?.({ tableId: groupingId, groupByField: groupSelection }); + // only update options if the new selection is a custom field if ( !isNoneGroup(groupSelection) && @@ -77,11 +95,14 @@ export const useGetGroupSelector = ({ }, [ defaultGroupingOptions, + groupingId, + onGroupChangeCallback, options, selectedGroup, setGroupsActivePage, setOptions, setSelectedGroup, + tracker, ] ); @@ -106,6 +127,7 @@ export const useGetGroupSelector = ({ }, [defaultGroupingOptions, options.length, selectedGroup, setOptions]); return getGroupSelector({ + groupingId, groupSelected: selectedGroup, 'data-test-subj': 'alerts-table-group-selector', onGroupChange, diff --git a/packages/kbn-securitysolution-grouping/src/hooks/use_grouping.test.tsx b/packages/kbn-securitysolution-grouping/src/hooks/use_grouping.test.tsx index 9d585ce4fc454..c1e1839754869 100644 --- a/packages/kbn-securitysolution-grouping/src/hooks/use_grouping.test.tsx +++ b/packages/kbn-securitysolution-grouping/src/hooks/use_grouping.test.tsx @@ -21,6 +21,7 @@ const defaultArgs = { defaultGroupingOptions, fields: [], groupingId, + tracker: jest.fn(), }; const groupingArgs = { @@ -36,7 +37,7 @@ const groupingArgs = { renderChildComponent: jest.fn(), runtimeMappings: {}, signalIndexName: 'test', - tableId: groupingId, + groupingId, takeActionItems: jest.fn(), to: '2020-07-08T08:20:18.966Z', }; diff --git a/packages/kbn-securitysolution-grouping/src/hooks/use_grouping.tsx b/packages/kbn-securitysolution-grouping/src/hooks/use_grouping.tsx index d81c19cafda91..c621695d6b17c 100644 --- a/packages/kbn-securitysolution-grouping/src/hooks/use_grouping.tsx +++ b/packages/kbn-securitysolution-grouping/src/hooks/use_grouping.tsx @@ -8,6 +8,7 @@ import { FieldSpec } from '@kbn/data-views-plugin/common'; import React, { useCallback, useMemo, useReducer } from 'react'; +import { UiCounterMetricType } from '@kbn/analytics'; import { groupsReducerWithStorage, initialState } from './state/reducer'; import { GroupingProps, GroupSelectorProps } from '..'; import { useGroupingPagination } from './use_grouping_pagination'; @@ -31,14 +32,21 @@ interface Grouping { interface GroupingArgs { defaultGroupingOptions: GroupOption[]; - fields: FieldSpec[]; groupingId: string; + onGroupChangeCallback?: (param: { groupByField: string; tableId: string }) => void; + tracker: ( + type: UiCounterMetricType, + event: string | string[], + count?: number | undefined + ) => void; } export const useGrouping = ({ defaultGroupingOptions, fields, groupingId, + onGroupChangeCallback, + tracker, }: GroupingArgs): Grouping => { const [groupingState, dispatch] = useReducer(groupsReducerWithStorage, initialState); @@ -53,6 +61,8 @@ export const useGrouping = ({ fields, groupingId, groupingState, + onGroupChangeCallback, + tracker, }); const pagination = useGroupingPagination({ groupingId, groupingState, dispatch }); diff --git a/packages/kbn-securitysolution-grouping/src/telemetry/const.ts b/packages/kbn-securitysolution-grouping/src/telemetry/const.ts new file mode 100644 index 0000000000000..5397d98514901 --- /dev/null +++ b/packages/kbn-securitysolution-grouping/src/telemetry/const.ts @@ -0,0 +1,26 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +enum TELEMETRY_EVENT { + GROUP_TOGGLED = 'alerts_table_toggled_', + GROUPED_ALERTS = 'alerts_table_group_by_', +} + +export const getTelemetryEvent = { + groupToggled: ({ + isOpen, + groupingId, + groupNumber, + }: { + isOpen: boolean; + groupingId: string; + groupNumber: number; + }) => + `${TELEMETRY_EVENT.GROUP_TOGGLED}${isOpen ? 'on' : 'off'}_${groupingId}_group-${groupNumber}`, + groupChanged: ({ groupingId, selected }: { groupingId: string; selected: string }) => + `${TELEMETRY_EVENT.GROUPED_ALERTS}${groupingId}_${selected}`, +}; diff --git a/packages/kbn-securitysolution-grouping/tsconfig.json b/packages/kbn-securitysolution-grouping/tsconfig.json index 5767aafe7051a..ab98ec47e3c93 100644 --- a/packages/kbn-securitysolution-grouping/tsconfig.json +++ b/packages/kbn-securitysolution-grouping/tsconfig.json @@ -24,5 +24,6 @@ "@kbn/kibana-react-plugin", "@kbn/shared-svg", "@kbn/ui-theme", + "@kbn/analytics" ] } diff --git a/packages/kbn-slo-schema/src/rest_specs/slo.ts b/packages/kbn-slo-schema/src/rest_specs/slo.ts index 8fd6e757c6ffb..6d1ef3692f5ad 100644 --- a/packages/kbn-slo-schema/src/rest_specs/slo.ts +++ b/packages/kbn-slo-schema/src/rest_specs/slo.ts @@ -17,7 +17,9 @@ import { objectiveSchema, optionalSettingsSchema, settingsSchema, + sloIdSchema, summarySchema, + tagsSchema, timeWindowSchema, } from '../schema'; @@ -31,23 +33,23 @@ const createSLOParamsSchema = t.type({ budgetingMethod: budgetingMethodSchema, objective: objectiveSchema, }), - t.partial({ settings: optionalSettingsSchema }), + t.partial({ settings: optionalSettingsSchema, tags: tagsSchema }), ]), }); const createSLOResponseSchema = t.type({ - id: t.string, + id: sloIdSchema, }); const deleteSLOParamsSchema = t.type({ path: t.type({ - id: t.string, + id: sloIdSchema, }), }); const getSLOParamsSchema = t.type({ path: t.type({ - id: t.string, + id: sloIdSchema, }), }); @@ -66,7 +68,7 @@ const findSLOParamsSchema = t.partial({ }); const sloResponseSchema = t.type({ - id: t.string, + id: sloIdSchema, name: t.string, description: t.string, indicator: indicatorSchema, @@ -76,6 +78,7 @@ const sloResponseSchema = t.type({ revision: t.number, settings: settingsSchema, enabled: t.boolean, + tags: tagsSchema, createdAt: dateType, updatedAt: dateType, }); @@ -89,7 +92,7 @@ const getSLOResponseSchema = sloWithSummaryResponseSchema; const updateSLOParamsSchema = t.type({ path: t.type({ - id: t.string, + id: sloIdSchema, }), body: t.partial({ name: t.string, @@ -99,11 +102,12 @@ const updateSLOParamsSchema = t.type({ budgetingMethod: budgetingMethodSchema, objective: objectiveSchema, settings: optionalSettingsSchema, + tags: tagsSchema, }), }); const manageSLOParamsSchema = t.type({ - path: t.type({ id: t.string }), + path: t.type({ id: sloIdSchema }), }); const updateSLOResponseSchema = sloResponseSchema; @@ -115,8 +119,17 @@ const findSLOResponseSchema = t.type({ results: t.array(sloWithSummaryResponseSchema), }); -const fetchHistoricalSummaryParamsSchema = t.type({ body: t.type({ sloIds: t.array(t.string) }) }); -const fetchHistoricalSummaryResponseSchema = t.record(t.string, t.array(historicalSummarySchema)); +const fetchHistoricalSummaryParamsSchema = t.type({ + body: t.type({ sloIds: t.array(sloIdSchema) }), +}); +const fetchHistoricalSummaryResponseSchema = t.record( + sloIdSchema, + t.array(historicalSummarySchema) +); + +const getSLODiagnosisParamsSchema = t.type({ + path: t.type({ id: t.string }), +}); type SLOResponse = t.OutputOf; type SLOWithSummaryResponse = t.OutputOf; @@ -147,6 +160,7 @@ export { deleteSLOParamsSchema, findSLOParamsSchema, findSLOResponseSchema, + getSLODiagnosisParamsSchema, getSLOParamsSchema, getSLOResponseSchema, fetchHistoricalSummaryParamsSchema, diff --git a/packages/kbn-slo-schema/src/schema/indicators.ts b/packages/kbn-slo-schema/src/schema/indicators.ts index 045d267b04d42..55b5e31af5da0 100644 --- a/packages/kbn-slo-schema/src/schema/indicators.ts +++ b/packages/kbn-slo-schema/src/schema/indicators.ts @@ -19,9 +19,9 @@ const apmTransactionDurationIndicatorSchema = t.type({ transactionType: allOrAnyString, transactionName: allOrAnyString, threshold: t.number, + index: t.string, }), t.partial({ - index: t.string, filter: t.string, }), ]), @@ -36,12 +36,12 @@ const apmTransactionErrorRateIndicatorSchema = t.type({ service: allOrAnyString, transactionType: allOrAnyString, transactionName: allOrAnyString, + index: t.string, }), t.partial({ goodStatusCodes: t.array( t.union([t.literal('2xx'), t.literal('3xx'), t.literal('4xx'), t.literal('5xx')]) ), - index: t.string, filter: t.string, }), ]), diff --git a/packages/kbn-slo-schema/src/schema/slo.ts b/packages/kbn-slo-schema/src/schema/slo.ts index 1e2e1ec810389..dceb68c2b7d25 100644 --- a/packages/kbn-slo-schema/src/schema/slo.ts +++ b/packages/kbn-slo-schema/src/schema/slo.ts @@ -33,8 +33,12 @@ const settingsSchema = t.type({ const optionalSettingsSchema = t.partial({ ...settingsSchema.props }); +const tagsSchema = t.array(t.string); + +const sloIdSchema = t.string; + const sloSchema = t.type({ - id: t.string, + id: sloIdSchema, name: t.string, description: t.string, indicator: indicatorSchema, @@ -44,6 +48,7 @@ const sloSchema = t.type({ settings: settingsSchema, revision: t.number, enabled: t.boolean, + tags: tagsSchema, createdAt: dateType, updatedAt: dateType, }); @@ -56,7 +61,9 @@ export { occurrencesBudgetingMethodSchema, optionalSettingsSchema, settingsSchema, + sloIdSchema, sloSchema, sloWithSummarySchema, + tagsSchema, timeslicesBudgetingMethodSchema, }; diff --git a/packages/kbn-ts-projects/ts_projects.ts b/packages/kbn-ts-projects/ts_projects.ts index 9a218fbabe816..38573bf4ca9d3 100644 --- a/packages/kbn-ts-projects/ts_projects.ts +++ b/packages/kbn-ts-projects/ts_projects.ts @@ -10,7 +10,7 @@ import { TsProject } from './ts_project'; export const TS_PROJECTS = TsProject.loadAll({ /** Array of repo-relative paths to projects which should be ignored and not treated as a TS project in the repo */ - ignore: ['x-pack/plugins/apm/scripts/optimize_tsconfig/tsconfig.json', '**/__fixtures__/**/*'], + ignore: ['**/__fixtures__/**/*'], /** Array of repo-relative paths to projects which should have their type-check disabled */ disableTypeCheck: [ diff --git a/packages/kbn-utility-types/index.ts b/packages/kbn-utility-types/index.ts index 52f707f2bc0d4..3aeaf04083c66 100644 --- a/packages/kbn-utility-types/index.ts +++ b/packages/kbn-utility-types/index.ts @@ -140,3 +140,14 @@ export type DeepPartialObject = { [P in keyof T]+?: DeepPartial }; export type { DotObject, DedotObject } from './src/dot'; export type ArrayElement = A extends ReadonlyArray ? T : never; + +/** + * Takes a type and makes selected properties required. + * + * @example + * interface Foo { bar?: string } + * const foo: WithRequiredProperty = { bar: 'baz' } + */ +export type WithRequiredProperty = Omit & { + [Property in Key]-?: Type[Property]; +}; diff --git a/packages/security-solution/README.mdx b/packages/security-solution/README.mdx new file mode 100644 index 0000000000000..8f46e37529f9d --- /dev/null +++ b/packages/security-solution/README.mdx @@ -0,0 +1,10 @@ +## Security Solution package + +This package compiles components used by Security Solution + +### Lazy by default + +All components are exported to be lazily-loaded with a default `React.Suspense` default most appropriate to its nature. + +If a page needs to alter the `React.Suspense` behavior, (e.g. a different "loading" component), one can import the `Lazy[ComponentName]` version and surround it with a custom `React.Suspense` component. + diff --git a/packages/security-solution/side_nav/README.mdx b/packages/security-solution/side_nav/README.mdx new file mode 100644 index 0000000000000..598696e94cef8 --- /dev/null +++ b/packages/security-solution/side_nav/README.mdx @@ -0,0 +1,50 @@ +## Security Solution Side Nav + +This package provides a component to render a two-level side navigation for Security. + +It uses `EuiPortal` to render the secondary panel. + +> This package is being considered for adoption by Shared UX so it can be reused by other solutions. + +## Example + +Using the `SecurityNav` wrapper provided by `@kbn/shared-ux-page-solution-nav` is recommended in order to display the proper layout. + +```JSX + + } +/> +``` + +Both `items` and `footerItems` props are arrays of `SolutionSideNavItem` type. The definition of this type is the following: + +| Prop | Type | Description | +| ------------- | ------------- |------------- | +| `id` (required) | `string` | The identifier of the link | +| `label` (required) | `string` | The label that will be displayed for the link | +| `href` (required) | `string` | The path to be used in the link anchor | +| `onClick` | `React.MouseEventHandler` | The handler for the click event | +| `items` | `SolutionSideNavItem[]` | The sub-items that will be displayed in the panel | +| `categories` | `Category[]` | The categories to display in the panel for sub-items | +| `iconType` | `IconType` | The EUI IconType to be pre-pended to the label | +| `labelSize` | `string` | The custom size for the label (`xs` \| `s` \| `m` \| `l`), default: `s` | +| `description` | `string` | The description displayed in the panel. Only for sub-items | +| `appendSeparator` | `boolean` | The flag to display an horizontal line separator after the item link | +| `isBeta` | `boolean` | The flag to display "beta" badge next to the item link | +| `betaOptions` | `Object` | The beta badge option only `text` is supported to define a custom badge label | + + +The `Category` object consists of: + +| Prop | Type | Description | +| ------------- | ------------- |------------- | +| `label` (required) | `string` | The label displayed for the category | +| `linkIds` (required) | `string[]` | The list of links that the category include, in order | \ No newline at end of file diff --git a/packages/security-solution/side_nav/index.ts b/packages/security-solution/side_nav/index.ts new file mode 100644 index 0000000000000..d35fa8578831b --- /dev/null +++ b/packages/security-solution/side_nav/index.ts @@ -0,0 +1,10 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { SolutionSideNav, type SolutionSideNavProps } from './src'; +export type { SolutionSideNavItem, LinkCategory, LinkCategories, Tracker } from './src/types'; diff --git a/packages/security-solution/side_nav/jest.config.js b/packages/security-solution/side_nav/jest.config.js new file mode 100644 index 0000000000000..84ffd6a1f7720 --- /dev/null +++ b/packages/security-solution/side_nav/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../..', + roots: ['/packages/security-solution/side_nav'], +}; diff --git a/packages/security-solution/side_nav/kibana.jsonc b/packages/security-solution/side_nav/kibana.jsonc new file mode 100644 index 0000000000000..88e34019f44bd --- /dev/null +++ b/packages/security-solution/side_nav/kibana.jsonc @@ -0,0 +1,5 @@ +{ + "type": "shared-common", + "id": "@kbn/security-solution-side-nav", + "owner": "@elastic/security-threat-hunting-explore" +} diff --git a/packages/security-solution/side_nav/package.json b/packages/security-solution/side_nav/package.json new file mode 100644 index 0000000000000..d34551f751046 --- /dev/null +++ b/packages/security-solution/side_nav/package.json @@ -0,0 +1,6 @@ +{ + "name": "@kbn/security-solution-side-nav", + "private": true, + "version": "1.0.0", + "license": "SSPL-1.0 OR Elastic License 2.0" +} \ No newline at end of file diff --git a/packages/security-solution/side_nav/src/beta_badge.tsx b/packages/security-solution/side_nav/src/beta_badge.tsx new file mode 100644 index 0000000000000..75696cd3bad32 --- /dev/null +++ b/packages/security-solution/side_nav/src/beta_badge.tsx @@ -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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import { i18n } from '@kbn/i18n'; +import { css } from '@emotion/react'; +import { EuiBetaBadge, useEuiTheme } from '@elastic/eui'; + +export const BETA_LABEL = i18n.translate('securitySolutionPackages.sideNav.betaBadge.label', { + defaultMessage: 'Beta', +}); + +export const BetaBadge = ({ text, className }: { text?: string; className?: string }) => { + const { euiTheme } = useEuiTheme(); + + return ( + + ); +}; diff --git a/packages/security-solution/side_nav/src/index.tsx b/packages/security-solution/side_nav/src/index.tsx new file mode 100644 index 0000000000000..09d37a0b0cdff --- /dev/null +++ b/packages/security-solution/side_nav/src/index.tsx @@ -0,0 +1,21 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React, { lazy, Suspense } from 'react'; +import { EuiLoadingSpinner } from '@elastic/eui'; +import type { SolutionSideNavProps } from './solution_side_nav'; + +export type { SolutionSideNavProps }; + +const SolutionSideNavLazy = lazy(() => import('./solution_side_nav')); + +export const SolutionSideNav = (props: SolutionSideNavProps) => ( + }> + + +); diff --git a/packages/security-solution/side_nav/src/solution_side_nav.stories.tsx b/packages/security-solution/side_nav/src/solution_side_nav.stories.tsx new file mode 100644 index 0000000000000..e8b82c01a62e8 --- /dev/null +++ b/packages/security-solution/side_nav/src/solution_side_nav.stories.tsx @@ -0,0 +1,186 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import { SolutionNav } from '@kbn/shared-ux-page-solution-nav'; +import readme from '../../README.mdx'; +import { + SolutionSideNav as SolutionSideNavComponent, + type SolutionSideNavProps, + type SolutionSideNavItem, +} from '..'; + +const items: SolutionSideNavItem[] = [ + { + id: 'simpleLink', + label: 'I am a simple link', + href: '#', + }, + { + id: 'panelLink', + label: 'I have a simple panel', + href: '#', + items: [ + { + id: 'panelLink1', + label: 'I am the first nested', + href: '#', + description: + 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed dignissim, velit ac dignissim maximus, orci justo mattis neque, non eleifend lectus velit sit amet dolor', + }, + { + id: 'panelLink2', + label: 'I am the second nested', + href: '#', + description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', + }, + { + id: 'linkBeta', + label: 'I am beta', + href: '#', + description: 'This is a beta project', + isBeta: true, + }, + { + id: 'linkTechnicalPreview', + label: 'I am preview', + href: '#', + description: 'This is a technical preview functionality', + isBeta: true, + betaOptions: { + text: 'Technical Preview', + }, + }, + ], + }, + { + id: 'categoriesPanelLink', + label: 'I have categories', + href: '#', + categories: [ + { label: 'First Category', linkIds: ['panelCatLink1', 'panelCatLink2'] }, + { label: 'Second Category', linkIds: ['panelCatLink3', 'panelCatLink4'] }, + ], + items: [ + { + id: 'panelCatLink1', + label: 'I am the first nested', + href: '#', + description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', + }, + { + id: 'panelCatLink2', + label: 'I am the second nested', + href: '#', + description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', + }, + { + id: 'panelCatLink3', + label: 'I am the third nested', + href: '#', + description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', + }, + { + id: 'panelCatLink4', + label: 'I am the fourth nested', + href: '#', + description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', + }, + ], + }, + { id: 'linkTruncated', href: '#', label: 'I have truncated text because I am too long' }, + { id: 'linkSmall', href: '#', label: 'I am smaller', labelSize: 'xs' }, +]; +const footerItems: SolutionSideNavItem[] = [ + { id: 'footerLink', href: '#', label: 'I am a footer link' }, + { + id: 'footerLinkPanel', + href: '#', + label: 'I also have panel', + items: [ + { + id: 'footerLinkPanel1', + label: 'I am a footer nested link', + href: '#', + description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', + }, + ], + }, + { id: 'footerLinkSeparator', href: '#', label: 'I have a separator', appendSeparator: true }, + { id: 'footerLinkIcon', href: '#', label: 'I have an icon', iconType: 'heart' }, +]; + +export default { + title: 'SolutionSideNav', + description: 'An panel oriented component that renders a nested array of navigation items.', + parameters: { + docs: { + page: readme, + }, + }, + decorators: [ + (storyFn: Function) => ( +
+ {storyFn()} +
+ ), + ], +}; + +type Params = Pick; + +export const SolutionSideNav = (params: Params) => ( + <> + + } + /> +
+ +); + +SolutionSideNav.argTypes = { + selectedId: { + control: { type: 'radio' }, + options: [...items, ...footerItems].map(({ id }) => id), + defaultValue: 'simpleLink', + }, + panelTopOffset: { + control: 'text', + defaultValue: '0px', + }, + panelBottomOffset: { + control: 'text', + defaultValue: '0px', + }, +}; + +SolutionSideNav.parameters = { + layout: 'fullscreen', +}; diff --git a/packages/security-solution/side_nav/src/solution_side_nav.styles.ts b/packages/security-solution/side_nav/src/solution_side_nav.styles.ts new file mode 100644 index 0000000000000..258b6fad72db0 --- /dev/null +++ b/packages/security-solution/side_nav/src/solution_side_nav.styles.ts @@ -0,0 +1,29 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { transparentize, type EuiThemeComputed } from '@elastic/eui'; +import { css } from '@emotion/css'; + +export const SolutionSideNavItemStyles = (euiTheme: EuiThemeComputed<{}>) => css` + font-weight: ${euiTheme.font.weight.regular}; + &.solutionSideNavItem--isPrimary * { + font-weight: ${euiTheme.font.weight.bold}; + } + &:focus, + &:focus-within, + &:hover, + &.solutionSideNavItem--isActive { + background-color: ${transparentize(euiTheme.colors.primary, 0.1)}; + } + .solutionSideNavItemButton:focus, + .solutionSideNavItemButton:focus-within, + .solutionSideNavItemButton:hover { + transform: none; /* prevent translationY transform that causes misalignment within the list item */ + background-color: ${transparentize(euiTheme.colors.primary, 0.2)}; + } +`; diff --git a/packages/security-solution/side_nav/src/solution_side_nav.test.tsx b/packages/security-solution/side_nav/src/solution_side_nav.test.tsx new file mode 100644 index 0000000000000..44befe4fb7653 --- /dev/null +++ b/packages/security-solution/side_nav/src/solution_side_nav.test.tsx @@ -0,0 +1,171 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import { render, waitFor } from '@testing-library/react'; +import { SolutionSideNav, type SolutionSideNavProps } from './solution_side_nav'; +import type { SolutionSideNavItem } from './types'; +import { METRIC_TYPE } from '@kbn/analytics'; +import { TELEMETRY_EVENT } from './telemetry/const'; + +const mockTrack = jest.fn(); + +const mockItems: SolutionSideNavItem[] = [ + { + id: 'dashboardsLanding', + label: 'Dashboards', + href: '/dashboards', + items: [ + { + id: 'overview', + label: 'Overview', + href: '/overview', + description: 'Overview description', + }, + ], + }, + { + id: 'alerts', + label: 'Alerts', + href: '/alerts', + }, +]; + +const renderNav = (props: Partial = {}) => + render( + + ); + +describe('SolutionSideNav', () => { + beforeEach(() => { + jest.clearAllMocks(); + }); + + it('should render all main items', () => { + const result = renderNav(); + expect(result.getByText('Dashboards')).toBeInTheDocument(); + expect(result.getByText('Alerts')).toBeInTheDocument(); + }); + + describe('links', () => { + it('should contain correct href in links', () => { + const result = renderNav(); + expect( + result.getByTestId(`solutionSideNavItemLink-${'dashboardsLanding'}`).getAttribute('href') + ).toBe('/dashboards'); + expect(result.getByTestId(`solutionSideNavItemLink-${'alerts'}`).getAttribute('href')).toBe( + '/alerts' + ); + }); + + it('should call onClick callback if link clicked', () => { + const mockOnClick = jest.fn((ev) => { + ev.preventDefault(); + }); + const items = [ + ...mockItems, + { + id: 'exploreLanding', + label: 'Explore', + href: '/explore', + onClick: mockOnClick, + }, + ]; + const result = renderNav({ items }); + result.getByTestId(`solutionSideNavItemLink-${'exploreLanding'}`).click(); + expect(mockOnClick).toHaveBeenCalled(); + }); + + it('should send telemetry if link clicked', () => { + const items = [ + ...mockItems, + { + id: 'exploreLanding', + label: 'Explore', + href: '/explore', + }, + ]; + const result = renderNav({ items }); + result.getByTestId(`solutionSideNavItemLink-${'exploreLanding'}`).click(); + expect(mockTrack).toHaveBeenCalledWith( + METRIC_TYPE.CLICK, + `${TELEMETRY_EVENT.NAVIGATION}${'exploreLanding'}` + ); + }); + }); + + describe('panel button toggle', () => { + it('should render the panel button only for nav items', () => { + const result = renderNav(); + expect( + result.getByTestId(`solutionSideNavItemButton-${'dashboardsLanding'}`) + ).toBeInTheDocument(); + expect(result.queryByTestId(`solutionSideNavItemButton-${'alerts'}`)).not.toBeInTheDocument(); + }); + + it('should render the panel when button is clicked', () => { + const result = renderNav(); + expect(result.queryByTestId('solutionSideNavPanel')).not.toBeInTheDocument(); + + result.getByTestId(`solutionSideNavItemButton-${'dashboardsLanding'}`).click(); + expect(result.getByTestId('solutionSideNavPanel')).toBeInTheDocument(); + expect(result.getByText('Overview')).toBeInTheDocument(); + }); + + it('should telemetry when button is clicked', () => { + const result = renderNav(); + expect(result.queryByTestId('solutionSideNavPanel')).not.toBeInTheDocument(); + + result.getByTestId(`solutionSideNavItemButton-${'dashboardsLanding'}`).click(); + expect(mockTrack).toHaveBeenCalledWith( + METRIC_TYPE.CLICK, + `${TELEMETRY_EVENT.PANEL_NAVIGATION_TOGGLE}${'dashboardsLanding'}` + ); + }); + + it('should close the panel when the same button is clicked', () => { + const result = renderNav(); + result.getByTestId(`solutionSideNavItemButton-${'dashboardsLanding'}`).click(); + expect(result.getByTestId('solutionSideNavPanel')).toBeInTheDocument(); + + result.getByTestId(`solutionSideNavItemButton-${'dashboardsLanding'}`).click(); + + waitFor(() => { + expect(result.queryByTestId('solutionSideNavPanel')).not.toBeInTheDocument(); + }); + }); + + it('should open other panel when other button is clicked while open', () => { + const items = [ + ...mockItems, + { + id: 'exploreLanding', + label: 'Explore', + href: '/explore', + items: [ + { + id: 'users', + label: 'Users', + href: '/users', + description: 'Users description', + }, + ], + }, + ]; + const result = renderNav({ items }); + + result.getByTestId(`solutionSideNavItemButton-${'dashboardsLanding'}`).click(); + expect(result.getByTestId('solutionSideNavPanel')).toBeInTheDocument(); + expect(result.getByText('Overview')).toBeInTheDocument(); + + result.getByTestId(`solutionSideNavItemButton-${'exploreLanding'}`).click(); + expect(result.queryByTestId('solutionSideNavPanel')).toBeInTheDocument(); + expect(result.getByText('Users')).toBeInTheDocument(); + }); + }); +}); diff --git a/packages/security-solution/side_nav/src/solution_side_nav.tsx b/packages/security-solution/side_nav/src/solution_side_nav.tsx new file mode 100644 index 0000000000000..d1d4f95f2613a --- /dev/null +++ b/packages/security-solution/side_nav/src/solution_side_nav.tsx @@ -0,0 +1,265 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +/* eslint-disable @elastic/eui/href-or-on-click */ + +import React, { useCallback, useMemo, useRef, useState } from 'react'; +import { + EuiListGroup, + EuiFlexGroup, + EuiFlexItem, + EuiLink, + useIsWithinBreakpoints, + useEuiTheme, + EuiListGroupItem, + EuiHorizontalRule, +} from '@elastic/eui'; + +import classNames from 'classnames'; +import { METRIC_TYPE } from '@kbn/analytics'; +import { SolutionSideNavPanel } from './solution_side_nav_panel'; +import type { LinkCategories, SolutionSideNavItem, Tracker } from './types'; +import { TELEMETRY_EVENT } from './telemetry/const'; +import { TelemetryContextProvider, useTelemetryContext } from './telemetry/telemetry_context'; +import { SolutionSideNavItemStyles } from './solution_side_nav.styles'; + +export interface SolutionSideNavProps { + items: SolutionSideNavItem[]; + selectedId: string; + footerItems?: SolutionSideNavItem[]; + panelBottomOffset?: string; + panelTopOffset?: string; + // This enables Telemetry tracking inside side navigation, this has to be bound with the plugin appId + // e.g.: usageCollection?.reportUiCounter?.bind(null, appId) + tracker?: Tracker; +} +export interface SolutionSideNavItemsProps { + items: SolutionSideNavItem[]; + selectedId: string; + activePanelNavId: ActivePanelNav; + isMobileSize: boolean; + navItemsById: NavItemsById; + onOpenPanelNav: (id: string) => void; +} +export interface SolutionSideNavItemProps { + item: SolutionSideNavItem; + isSelected: boolean; + isActive: boolean; + hasPanelNav: boolean; + onOpenPanelNav: (id: string) => void; +} + +type ActivePanelNav = string | null; +type NavItemsById = Record< + string, + { title: string; panelItems: SolutionSideNavItem[]; categories?: LinkCategories } +>; + +export const SolutionSideNav: React.FC = React.memo( + ({ items, selectedId, footerItems = [], panelBottomOffset, panelTopOffset, tracker }) => { + const isMobileSize = useIsWithinBreakpoints(['xs', 's']); + + const [activePanelNavId, setActivePanelNavId] = useState(null); + const activePanelNavIdRef = useRef(null); + + const openPanelNav = (id: string) => { + activePanelNavIdRef.current = id; + setActivePanelNavId(id); + }; + + const onClosePanelNav = useCallback(() => { + activePanelNavIdRef.current = null; + setActivePanelNavId(null); + }, []); + + const onOutsidePanelClick = useCallback(() => { + const currentPanelNavId = activePanelNavIdRef.current; + setTimeout(() => { + // This event is triggered on outside click. + // Closing the side nav at the end of event loop to make sure it + // closes also if the active panel button has been clicked (toggle), + // but it does not close if any any other panel open button has been clicked. + if (activePanelNavIdRef.current === currentPanelNavId) { + onClosePanelNav(); + } + }); + }, [onClosePanelNav]); + + const navItemsById = useMemo( + () => + [...items, ...footerItems].reduce((acc, navItem) => { + if (navItem.items?.length) { + acc[navItem.id] = { + title: navItem.label, + panelItems: navItem.items, + categories: navItem.categories, + }; + } + return acc; + }, {}), + [items, footerItems] + ); + + const panelNav = useMemo(() => { + if (activePanelNavId == null || !navItemsById[activePanelNavId]) { + return null; + } + const { panelItems, title, categories } = navItemsById[activePanelNavId]; + return ( + + ); + }, [ + activePanelNavId, + navItemsById, + onClosePanelNav, + onOutsidePanelClick, + panelBottomOffset, + panelTopOffset, + ]); + + return ( + + + + + + + + + + + + + + + + + + + {panelNav} + + ); + } +); + +const SolutionSideNavItems: React.FC = ({ + items, + selectedId, + activePanelNavId, + isMobileSize, + navItemsById, + onOpenPanelNav, +}) => ( + <> + {items.map((item) => ( + + ))} + +); + +const SolutionSideNavItem: React.FC = React.memo( + ({ item, isSelected, isActive, hasPanelNav, onOpenPanelNav }) => { + const { euiTheme } = useEuiTheme(); + const { tracker } = useTelemetryContext(); + + const { id, href, label, onClick, labelSize, iconType, appendSeparator } = item; + + const onLinkClicked: React.MouseEventHandler = (ev) => { + tracker?.(METRIC_TYPE.CLICK, `${TELEMETRY_EVENT.NAVIGATION}${id}`); + onClick?.(ev); + }; + + const solutionSideNavItemStyles = SolutionSideNavItemStyles(euiTheme); + const itemClassNames = classNames( + 'solutionSideNavItem', + { + 'solutionSideNavItem--isActive': isActive, + 'solutionSideNavItem--isPrimary': isSelected, + }, + solutionSideNavItemStyles + ); + const buttonClassNames = classNames('solutionSideNavItemButton'); + + const onButtonClick: React.MouseEventHandler = (ev) => { + ev.preventDefault(); + ev.stopPropagation(); + tracker?.(METRIC_TYPE.CLICK, `${TELEMETRY_EVENT.PANEL_NAVIGATION_TOGGLE}${id}`); + onOpenPanelNav(id); + }; + + return ( + <> + + + + {appendSeparator && } + + ); + } +); + +// eslint-disable-next-line import/no-default-export +export default SolutionSideNav; diff --git a/packages/security-solution/side_nav/src/solution_side_nav_panel.styles.ts b/packages/security-solution/side_nav/src/solution_side_nav_panel.styles.ts new file mode 100644 index 0000000000000..574310923c357 --- /dev/null +++ b/packages/security-solution/side_nav/src/solution_side_nav_panel.styles.ts @@ -0,0 +1,74 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { transparentize, type EuiThemeComputed } from '@elastic/eui'; +import { css, injectGlobal } from '@emotion/css'; + +const EUI_HEADER_HEIGHT = '93px'; +const PANEL_LEFT_OFFSET = '248px'; +const PANEL_WIDTH = '340px'; + +export const panelClass = 'solutionSideNavPanel'; + +export const SolutionSideNavPanelStyles = ( + euiTheme: EuiThemeComputed<{}>, + { $bottomOffset, $topOffset }: { $bottomOffset?: string; $topOffset?: string } = {} +) => { + // We need to add the banner height to the top space when the header banner is present + injectGlobal(` + body.kbnBody--hasHeaderBanner .${panelClass} { + top: calc(${EUI_HEADER_HEIGHT} + ${euiTheme.size.xl}); + } + `); + + return css` + position: fixed; + top: ${$topOffset ?? EUI_HEADER_HEIGHT}; + left: ${PANEL_LEFT_OFFSET}; + bottom: 0; + width: ${PANEL_WIDTH}; + height: inherit; + + // If the bottom bar is visible add padding to the navigation + ${$bottomOffset != null && + ` + height: inherit; + bottom: ${$bottomOffset}; + box-shadow: + // left + -${euiTheme.size.s} 0 ${euiTheme.size.s} -${euiTheme.size.s} rgb(0 0 0 / 15%), + // right + ${euiTheme.size.s} 0 ${euiTheme.size.s} -${euiTheme.size.s} rgb(0 0 0 / 15%), + // bottom inset to match timeline bar top shadow + inset 0 -6px ${euiTheme.size.xs} -${euiTheme.size.xs} rgb(0 0 0 / 15%); + `} + + .solutionSideNavPanelLink { + .solutionSideNavPanelLinkItem { + background-color: transparent; /* originally white, it prevents panel to remove the bottom inset box shadow */ + &:hover { + background-color: ${transparentize(euiTheme.colors.primary, 0.1)}; + } + dt { + color: ${euiTheme.colors.primaryText}; + } + dd { + color: ${euiTheme.colors.darkestShade}; + } + } + } + `; +}; + +export const SolutionSideNavTitleStyles = ( + euiTheme: EuiThemeComputed<{}>, + { $paddingTop = false }: { $paddingTop?: boolean } = {} +) => css` + padding-left: ${euiTheme.size.s}; + ${$paddingTop && `padding-top: ${euiTheme.size.s};`} +`; diff --git a/x-pack/plugins/security_solution/public/common/components/navigation/solution_grouped_nav/solution_grouped_nav_panel.test.tsx b/packages/security-solution/side_nav/src/solution_side_nav_panel.test.tsx similarity index 69% rename from x-pack/plugins/security_solution/public/common/components/navigation/solution_grouped_nav/solution_grouped_nav_panel.test.tsx rename to packages/security-solution/side_nav/src/solution_side_nav_panel.test.tsx index aeb7e21f21bab..eb0f887eab96c 100644 --- a/x-pack/plugins/security_solution/public/common/components/navigation/solution_grouped_nav/solution_grouped_nav_panel.test.tsx +++ b/packages/security-solution/side_nav/src/solution_side_nav_panel.test.tsx @@ -1,23 +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. + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. */ -import type { LinkCategories } from '../../../links'; import React from 'react'; import { render, waitFor } from '@testing-library/react'; -import { SecurityPageName } from '../../../../app/types'; -import { TestProviders } from '../../../mock'; -import type { SolutionNavPanelProps } from './solution_grouped_nav_panel'; -import { SolutionNavPanel } from './solution_grouped_nav_panel'; -import type { DefaultSideNavItem } from './types'; -import { bottomNavOffset } from '../../../lib/helpers'; -import { BETA } from '@kbn/kubernetes-security-plugin/common/translations'; +import { SolutionSideNavPanel, type SolutionSideNavPanelProps } from './solution_side_nav_panel'; +import type { SolutionSideNavItem } from './types'; +import { BETA_LABEL } from './beta_badge'; import { TELEMETRY_EVENT } from './telemetry/const'; import { METRIC_TYPE } from '@kbn/analytics'; import { TelemetryContextProvider } from './telemetry/telemetry_context'; +import type { LinkCategories } from './types'; const mockUseIsWithinMinBreakpoint = jest.fn(() => true); jest.mock('@elastic/eui', () => { @@ -30,21 +27,21 @@ jest.mock('@elastic/eui', () => { const mockTrack = jest.fn(); -const mockItems: DefaultSideNavItem[] = [ +const mockItems: SolutionSideNavItem[] = [ { - id: SecurityPageName.hosts, + id: 'hosts', label: 'Hosts', href: '/hosts', description: 'Hosts description', }, { - id: SecurityPageName.network, + id: 'network', label: 'Network', href: '/network', description: 'Network description', }, { - id: SecurityPageName.kubernetes, + id: 'kubernetes', label: 'Kubernetes', href: '/kubernetes', description: 'Kubernetes description', @@ -57,7 +54,7 @@ const betaMockItemsCount = mockItems.filter((item) => item.isBeta).length; const mockCategories: LinkCategories = [ { label: 'HOSTS CATEGORY', - linkIds: [SecurityPageName.hosts], + linkIds: ['hosts'], }, { label: 'Empty category', @@ -65,15 +62,16 @@ const mockCategories: LinkCategories = [ }, ]; +const bottomNavOffset = '10px'; const PANEL_TITLE = 'test title'; const mockOnClose = jest.fn(); const mockOnOutsideClick = jest.fn(); -const renderNavPanel = (props: Partial = {}) => +const renderNavPanel = (props: Partial = {}) => render( <>
- = {}) => {...props} /> - , - { - wrapper: TestProviders, - } + ); -describe('SolutionGroupedNav', () => { +describe('SolutionSideNavPanel', () => { beforeEach(() => { jest.clearAllMocks(); }); @@ -103,7 +98,7 @@ describe('SolutionGroupedNav', () => { expect(result.getByText(item.description)).toBeInTheDocument(); } }); - expect(result.queryAllByText(BETA).length).toBe(betaMockItemsCount); + expect(result.queryAllByText(BETA_LABEL).length).toBe(betaMockItemsCount); }); it('should only render categories with items', () => { @@ -121,12 +116,12 @@ describe('SolutionGroupedNav', () => { describe('links', () => { it('should contain correct href in links', () => { const result = renderNavPanel(); - expect( - result.getByTestId(`groupedNavPanelLink-${SecurityPageName.hosts}`).getAttribute('href') - ).toBe('/hosts'); - expect( - result.getByTestId(`groupedNavPanelLink-${SecurityPageName.network}`).getAttribute('href') - ).toBe('/network'); + expect(result.getByTestId(`solutionSideNavPanelLink-${'hosts'}`).getAttribute('href')).toBe( + '/hosts' + ); + expect(result.getByTestId(`solutionSideNavPanelLink-${'network'}`).getAttribute('href')).toBe( + '/network' + ); }); it('should call onClick callback if link clicked', () => { @@ -136,14 +131,14 @@ describe('SolutionGroupedNav', () => { const items = [ ...mockItems, { - id: SecurityPageName.users, + id: 'users', label: 'Users', href: '/users', onClick: mockOnClick, }, ]; const result = renderNavPanel({ items }); - result.getByTestId(`groupedNavPanelLink-${SecurityPageName.users}`).click(); + result.getByTestId(`solutionSideNavPanelLink-${'users'}`).click(); expect(mockOnClick).toHaveBeenCalled(); }); @@ -154,17 +149,17 @@ describe('SolutionGroupedNav', () => { const items = [ ...mockItems, { - id: SecurityPageName.users, + id: 'users', label: 'Users', href: '/users', onClick: mockOnClick, }, ]; const result = renderNavPanel({ items }); - result.getByTestId(`groupedNavPanelLink-${SecurityPageName.users}`).click(); + result.getByTestId(`solutionSideNavPanelLink-${'users'}`).click(); expect(mockTrack).toHaveBeenCalledWith( METRIC_TYPE.CLICK, - `${TELEMETRY_EVENT.GROUPED_NAVIGATION}${SecurityPageName.users}` + `${TELEMETRY_EVENT.PANEL_NAVIGATION}${'users'}` ); }); }); @@ -174,21 +169,23 @@ describe('SolutionGroupedNav', () => { mockUseIsWithinMinBreakpoint.mockReturnValueOnce(true); const result = renderNavPanel({ bottomOffset: bottomNavOffset }); - expect(result.getByTestId('groupedNavPanel')).toHaveStyle({ bottom: bottomNavOffset }); + expect(result.getByTestId('solutionSideNavPanel')).toHaveStyle({ bottom: bottomNavOffset }); }); it('should not add bottom offset if not large screen', () => { mockUseIsWithinMinBreakpoint.mockReturnValueOnce(false); const result = renderNavPanel({ bottomOffset: bottomNavOffset }); - expect(result.getByTestId('groupedNavPanel')).not.toHaveStyle({ bottom: bottomNavOffset }); + expect(result.getByTestId('solutionSideNavPanel')).not.toHaveStyle({ + bottom: bottomNavOffset, + }); }); }); describe('close', () => { it('should call onClose callback if link clicked', () => { const result = renderNavPanel(); - result.getByTestId(`groupedNavPanelLink-${SecurityPageName.hosts}`).click(); + result.getByTestId(`solutionSideNavPanelLink-${'hosts'}`).click(); expect(mockOnClose).toHaveBeenCalled(); }); diff --git a/packages/security-solution/side_nav/src/solution_side_nav_panel.tsx b/packages/security-solution/side_nav/src/solution_side_nav_panel.tsx new file mode 100644 index 0000000000000..f884bfce5fac7 --- /dev/null +++ b/packages/security-solution/side_nav/src/solution_side_nav_panel.tsx @@ -0,0 +1,203 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React, { Fragment, useCallback } from 'react'; +import { + EuiDescriptionList, + EuiDescriptionListDescription, + EuiDescriptionListTitle, + EuiFlexGroup, + EuiFlexItem, + EuiFocusTrap, + EuiHorizontalRule, + EuiOutsideClickDetector, + EuiPanel, + EuiPortal, + EuiSpacer, + EuiTitle, + EuiWindowEvent, + keys, + useEuiTheme, + useIsWithinMinBreakpoint, +} from '@elastic/eui'; +import classNames from 'classnames'; +import { METRIC_TYPE } from '@kbn/analytics'; +import type { SolutionSideNavItem, LinkCategories } from './types'; +import { BetaBadge } from './beta_badge'; +import { TELEMETRY_EVENT } from './telemetry/const'; +import { useTelemetryContext } from './telemetry/telemetry_context'; +import { + SolutionSideNavPanelStyles, + panelClass, + SolutionSideNavTitleStyles, +} from './solution_side_nav_panel.styles'; + +export interface SolutionSideNavPanelProps { + onClose: () => void; + onOutsideClick: () => void; + title: string; + items: SolutionSideNavItem[]; + categories?: LinkCategories; + bottomOffset?: string; + topOffset?: string; +} +export interface SolutionSideNavPanelCategoriesProps { + categories: LinkCategories; + items: SolutionSideNavItem[]; + onClose: () => void; +} +export interface SolutionSideNavPanelItemsProps { + items: SolutionSideNavItem[]; + onClose: () => void; +} + +/** + * Renders the side navigation panel for secondary links + */ +export const SolutionSideNavPanel: React.FC = React.memo( + ({ onClose, onOutsideClick, title, categories, items, bottomOffset, topOffset }) => { + const { euiTheme } = useEuiTheme(); + const isLargerBreakpoint = useIsWithinMinBreakpoint('l'); + + // Only larger breakpoint needs to add bottom offset, other sizes should have full height + const $bottomOffset = isLargerBreakpoint ? bottomOffset : undefined; + const $topOffset = isLargerBreakpoint ? topOffset : undefined; + const hasShadow = !$bottomOffset; + + const solutionSideNavPanelStyles = SolutionSideNavPanelStyles(euiTheme, { + $bottomOffset, + $topOffset, + }); + const solutionSideNavTitleStyles = SolutionSideNavTitleStyles(euiTheme, { $paddingTop: true }); + const panelClasses = classNames(panelClass, 'eui-yScroll', solutionSideNavPanelStyles); + const titleClasses = classNames(solutionSideNavTitleStyles); + + // ESC key closes PanelNav + const onKeyDown = useCallback( + (ev: KeyboardEvent) => { + if (ev.key === keys.ESCAPE) { + onClose(); + } + }, + [onClose] + ); + + return ( + <> + {/* */} + + + + + + + + + {title} + + + + + + {categories ? ( + + ) : ( + + )} + + + + + + + + + ); + } +); + +const SolutionSideNavPanelCategories: React.FC = React.memo( + ({ categories, items, onClose }) => { + const { euiTheme } = useEuiTheme(); + const sideNavTitleStyles = SolutionSideNavTitleStyles(euiTheme); + const titleClasses = classNames(sideNavTitleStyles); + + return ( + <> + {categories.map(({ label, linkIds }) => { + const links = linkIds.reduce((acc, linkId) => { + const link = items.find((item) => item.id === linkId); + if (link) { + acc.push(link); + } + return acc; + }, []); + + if (!links.length) { + return null; + } + + return ( + + +

{label}

+ + + + + + ); + })} + + ); + } +); + +const SolutionSideNavPanelItems: React.FC = React.memo( + ({ items, onClose }) => { + const panelLinkClassNames = classNames('solutionSideNavPanelLink'); + const panelLinkItemClassNames = classNames('solutionSideNavPanelLinkItem'); + const { tracker } = useTelemetryContext(); + return ( + <> + {items.map(({ id, href, onClick, label, description, isBeta, betaOptions }) => ( + { + tracker?.(METRIC_TYPE.CLICK, `${TELEMETRY_EVENT.PANEL_NAVIGATION}${id}`); + onClose(); + onClick?.(ev); + }} + > + + + {label} + {isBeta && } + + {description} + + + ))} + + ); + } +); diff --git a/packages/security-solution/side_nav/src/telemetry/const.ts b/packages/security-solution/side_nav/src/telemetry/const.ts new file mode 100644 index 0000000000000..84628ee341ba9 --- /dev/null +++ b/packages/security-solution/side_nav/src/telemetry/const.ts @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export enum TELEMETRY_EVENT { + PANEL_NAVIGATION = 'panel_navigation_', + PANEL_NAVIGATION_TOGGLE = 'panel_navigation_toggle_', + NAVIGATION = 'navigation_', +} diff --git a/x-pack/plugins/security_solution/public/common/components/navigation/solution_grouped_nav/telemetry/telemetry_context.tsx b/packages/security-solution/side_nav/src/telemetry/telemetry_context.tsx similarity index 81% rename from x-pack/plugins/security_solution/public/common/components/navigation/solution_grouped_nav/telemetry/telemetry_context.tsx rename to packages/security-solution/side_nav/src/telemetry/telemetry_context.tsx index c7e97969ad31c..53a4b355dcb45 100644 --- a/x-pack/plugins/security_solution/public/common/components/navigation/solution_grouped_nav/telemetry/telemetry_context.tsx +++ b/packages/security-solution/side_nav/src/telemetry/telemetry_context.tsx @@ -1,8 +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. + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. */ import type { FC } from 'react'; diff --git a/packages/security-solution/side_nav/src/types.ts b/packages/security-solution/side_nav/src/types.ts new file mode 100644 index 0000000000000..c67647f12fa73 --- /dev/null +++ b/packages/security-solution/side_nav/src/types.ts @@ -0,0 +1,41 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type React from 'react'; +import type { UiCounterMetricType } from '@kbn/analytics'; +import type { EuiListGroupItemProps, IconType } from '@elastic/eui'; + +export interface SolutionSideNavItem { + id: T; + label: string; + href: string; + onClick?: React.MouseEventHandler; + description?: string; + items?: Array>; + categories?: LinkCategories; + iconType?: IconType; + labelSize?: EuiListGroupItemProps['size']; + appendSeparator?: boolean; + isBeta?: boolean; + betaOptions?: { + text: string; + }; +} + +export interface LinkCategory { + label: string; + linkIds: readonly T[]; +} + +export type LinkCategories = Readonly>>; + +export type Tracker = ( + type: UiCounterMetricType, + event: string | string[], + count?: number | undefined +) => void; diff --git a/packages/security-solution/side_nav/tsconfig.json b/packages/security-solution/side_nav/tsconfig.json new file mode 100644 index 0000000000000..e19419203ab79 --- /dev/null +++ b/packages/security-solution/side_nav/tsconfig.json @@ -0,0 +1,22 @@ +{ + "extends": "../../../tsconfig.base.json", + "compilerOptions": { + "outDir": "target/types", + "types": [ + "jest", + "node", + "react", + "@emotion/react/types/css-prop", + "@testing-library/jest-dom", + "@testing-library/react", + "@kbn/ambient-ui-types" + ] + }, + "include": ["**/*.ts", "**/*.tsx"], + "kbn_references": [ + "@kbn/i18n", + "@kbn/analytics", + "@kbn/shared-ux-page-solution-nav", + ], + "exclude": ["target/**/*"] +} diff --git a/packages/security-solution/storybook/config/README.mdx b/packages/security-solution/storybook/config/README.mdx new file mode 100644 index 0000000000000..2bcc29367c77a --- /dev/null +++ b/packages/security-solution/storybook/config/README.mdx @@ -0,0 +1,3 @@ +# @kbn/security-solution-storybook-config + +Storybook configuration used by `yarn storybook`. Refer to `@kbn/storybook` for more information. diff --git a/packages/security-solution/storybook/config/constants.ts b/packages/security-solution/storybook/config/constants.ts new file mode 100644 index 0000000000000..216e3822a2943 --- /dev/null +++ b/packages/security-solution/storybook/config/constants.ts @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +/** The title of the Storybook. */ +export const TITLE = 'Security Solution Storybook'; + +/** The remote URL of the root from which Storybook loads stories for Security Solution. */ +export const URL = 'https://github.com/elastic/kibana/tree/main/packages/security_solution'; diff --git a/packages/security-solution/storybook/config/index.ts b/packages/security-solution/storybook/config/index.ts new file mode 100755 index 0000000000000..5a73da614bf27 --- /dev/null +++ b/packages/security-solution/storybook/config/index.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { TITLE, URL } from './constants'; diff --git a/packages/security-solution/storybook/config/kibana.jsonc b/packages/security-solution/storybook/config/kibana.jsonc new file mode 100644 index 0000000000000..cc52a3074f250 --- /dev/null +++ b/packages/security-solution/storybook/config/kibana.jsonc @@ -0,0 +1,5 @@ +{ + "type": "shared-common", + "id": "@kbn/security-solution-storybook-config", + "owner": "@elastic/security-threat-hunting-explore" +} diff --git a/packages/security-solution/storybook/config/main.ts b/packages/security-solution/storybook/config/main.ts new file mode 100644 index 0000000000000..47a47a5a802b3 --- /dev/null +++ b/packages/security-solution/storybook/config/main.ts @@ -0,0 +1,17 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { defaultConfig } from '@kbn/storybook'; + +module.exports = { + ...defaultConfig, + stories: ['../../**/*.stories.+(tsx|mdx)'], + reactOptions: { + strictMode: true, + }, +}; diff --git a/packages/security-solution/storybook/config/manager.ts b/packages/security-solution/storybook/config/manager.ts new file mode 100644 index 0000000000000..fb973258b9053 --- /dev/null +++ b/packages/security-solution/storybook/config/manager.ts @@ -0,0 +1,23 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { addons } from '@storybook/addons'; +import { create } from '@storybook/theming'; +import { PANEL_ID as selectedPanel } from '@storybook/addon-actions'; + +import { TITLE as brandTitle, URL as brandUrl } from './constants'; + +addons.setConfig({ + theme: create({ + base: 'light', + brandTitle, + brandUrl, + }), + selectedPanel, + showPanel: true.valueOf, +}); diff --git a/packages/security-solution/storybook/config/package.json b/packages/security-solution/storybook/config/package.json new file mode 100644 index 0000000000000..27d92c5c0ed1a --- /dev/null +++ b/packages/security-solution/storybook/config/package.json @@ -0,0 +1,6 @@ +{ + "name": "@kbn/security-solution-storybook-config", + "private": true, + "version": "1.0.0", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/security-solution/storybook/config/preview.ts b/packages/security-solution/storybook/config/preview.ts new file mode 100644 index 0000000000000..5a53e48a916d8 --- /dev/null +++ b/packages/security-solution/storybook/config/preview.ts @@ -0,0 +1,21 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +/* eslint-disable @typescript-eslint/no-namespace,@typescript-eslint/no-empty-interface */ +declare global { + namespace NodeJS { + interface Global {} + interface InspectOptions {} + type ConsoleConstructor = console.ConsoleConstructor; + } +} +/* eslint-enable */ + +import jest from 'jest-mock'; +/* @ts-expect-error TS doesn't see jest as a property of window, and I don't want to edit our global config. */ +window.jest = jest; diff --git a/packages/security-solution/storybook/config/tsconfig.json b/packages/security-solution/storybook/config/tsconfig.json new file mode 100644 index 0000000000000..7b41c512d4ef0 --- /dev/null +++ b/packages/security-solution/storybook/config/tsconfig.json @@ -0,0 +1,20 @@ +{ + "extends": "../../../../tsconfig.base.json", + "compilerOptions": { + "outDir": "target/types", + "types": [ + "jest", + "node", + "@kbn/ambient-storybook-types", + ] + }, + "include": [ + "**/*.ts" + ], + "kbn_references": [ + "@kbn/storybook", + ], + "exclude": [ + "target/**/*", + ] +} diff --git a/packages/shared-ux/file/file_picker/impl/src/components/error_content.tsx b/packages/shared-ux/file/file_picker/impl/src/components/error_content.tsx index 2c65619a7e2ed..edfabb109144a 100644 --- a/packages/shared-ux/file/file_picker/impl/src/components/error_content.tsx +++ b/packages/shared-ux/file/file_picker/impl/src/components/error_content.tsx @@ -23,7 +23,7 @@ export const ErrorContent: FunctionComponent = ({ error }) => { return ( {i18nTexts.loadingFilesErrorTitle}

} diff --git a/src/core/public/styles/_base.scss b/src/core/public/styles/_base.scss index de138cdf402e6..1e8e6c7411e4d 100644 --- a/src/core/public/styles/_base.scss +++ b/src/core/public/styles/_base.scss @@ -34,3 +34,12 @@ .euiPageHeader--bottomBorder:not(.euiPageHeader--tabsAtBottom):not([class*='euiPageHeader--padding']) { padding-bottom: $euiSizeL; } + +// Kibana's body ignores the `margin-right !important` set by react-remove-scroll-bar +// (used by EUI's focus trap component & prevents page width jumps on full-screen overlays) +// due to the 100% width/min-width CSS set by Kibana in other places. To work around this, we +// grab the `--removed-body-scroll-bar-size` var added by the library & manually set `padding` +// TODO: Use `gapMode` instead once https://github.com/theKashey/react-focus-on/issues/65 is fixed +.kbnBody { + padding-right: var(--removed-body-scroll-bar-size, 0); +} diff --git a/src/core/server/integration_tests/saved_objects/migrations/group2/check_registered_types.test.ts b/src/core/server/integration_tests/saved_objects/migrations/group2/check_registered_types.test.ts index fbc82719bd381..b919bac313c8f 100644 --- a/src/core/server/integration_tests/saved_objects/migrations/group2/check_registered_types.test.ts +++ b/src/core/server/integration_tests/saved_objects/migrations/group2/check_registered_types.test.ts @@ -57,7 +57,7 @@ describe('checking migration metadata changes on all registered SO types', () => Object { "action": "6cfc277ed3211639e37546ac625f4a68f2494215", "action_task_params": "5f419caba96dd8c77d0f94013e71d43890e3d5d6", - "alert": "785240e3137f5eb1a0f8986e5b8eff99780fc04f", + "alert": "1e4cd6941f1eb39c729c646e91fbfb9700de84b9", "api_key_pending_invalidation": "16e7bcf8e78764102d7f525542d5b616809a21ee", "apm-indices": "d19dd7fb51f2d2cbc1f8769481721e0953f9a6d2", "apm-server-schema": "1d42f17eff9ec6c16d3a9324d9539e2d123d0a9a", @@ -122,7 +122,7 @@ describe('checking migration metadata changes on all registered SO types', () => "osquery-pack": "edd84b2c59ef36214ece0676706da8f22175c660", "osquery-pack-asset": "18e08979d46ee7e5538f54c080aec4d8c58516ca", "osquery-saved-query": "f5e4e303f65c7607248ea8b2672f1ee30e4fb15e", - "query": "f94de164936da788e9215c0e9b824f8b948ea859", + "query": "ec6000b775f06f81470df42d23f7a88cb31d64ba", "rules-settings": "9854495c3b54b16a6625fb250c35e5504da72266", "sample-data-telemetry": "c38daf1a49ed24f2a4fb091e6e1e833fccf19935", "search": "01bc42d635e9ea0588741c4c7a2bbd3feb3ac5dc", @@ -134,7 +134,7 @@ describe('checking migration metadata changes on all registered SO types', () => "siem-ui-timeline": "e9d6b3a9fd7af6dc502293c21cbdb309409f3996", "siem-ui-timeline-note": "13c9d4c142f96624a93a623c6d7cba7e1ae9b5a6", "siem-ui-timeline-pinned-event": "96a43d59b9e2fc11f12255a0cb47ef0a3d83af4c", - "slo": "9a138b459c7efef7fecfda91f22db8b7655d0e61", + "slo": "06733daaa5fbe331fdf3b515171978aff483ccf2", "space": "9542afcd6fd71558623c09151e453c5e84b4e5e1", "spaces-usage-stats": "084bd0f080f94fb5735d7f3cf12f13ec92f36bad", "synthetics-monitor": "96cc312bfa597022f83dfb3b5d1501e27a73e8d5", diff --git a/src/core/server/integration_tests/saved_objects/migrations/group3/active_delete.test.ts b/src/core/server/integration_tests/saved_objects/migrations/group3/active_delete.test.ts index 233cac9a0e83e..37bd9f49a6cd1 100644 --- a/src/core/server/integration_tests/saved_objects/migrations/group3/active_delete.test.ts +++ b/src/core/server/integration_tests/saved_objects/migrations/group3/active_delete.test.ts @@ -66,7 +66,8 @@ describe('when upgrading to a new stack version', () => { it('the migrator is skipping reindex operation and executing CLEANUP_UNKNOWN_AND_EXCLUDED step', async () => { const logs = await readLog(); expect(logs).toMatch('INIT -> WAIT_FOR_YELLOW_SOURCE'); - expect(logs).toMatch('WAIT_FOR_YELLOW_SOURCE -> CLEANUP_UNKNOWN_AND_EXCLUDED'); + expect(logs).toMatch('WAIT_FOR_YELLOW_SOURCE -> UPDATE_SOURCE_MAPPINGS_PROPERTIES.'); + expect(logs).toMatch('UPDATE_SOURCE_MAPPINGS_PROPERTIES -> CLEANUP_UNKNOWN_AND_EXCLUDED.'); // we gotta inform that we are deleting unknown documents too (discardUnknownObjects: true) expect(logs).toMatch( 'Kibana has been configured to discard unknown documents for this migration.' @@ -157,7 +158,8 @@ describe('when upgrading to a new stack version', () => { const logs = await readLog(); expect(logs).toMatch('INIT -> WAIT_FOR_YELLOW_SOURCE.'); - expect(logs).toMatch('WAIT_FOR_YELLOW_SOURCE -> CLEANUP_UNKNOWN_AND_EXCLUDED.'); + expect(logs).toMatch('WAIT_FOR_YELLOW_SOURCE -> UPDATE_SOURCE_MAPPINGS_PROPERTIES.'); + expect(logs).toMatch('UPDATE_SOURCE_MAPPINGS_PROPERTIES -> CLEANUP_UNKNOWN_AND_EXCLUDED.'); expect(logs).toMatch('CLEANUP_UNKNOWN_AND_EXCLUDED -> FATAL.'); }); @@ -168,7 +170,8 @@ describe('when upgrading to a new stack version', () => { const logs = await readLog(); expect(logs).toMatch('INIT -> WAIT_FOR_YELLOW_SOURCE.'); - expect(logs).toMatch('WAIT_FOR_YELLOW_SOURCE -> CLEANUP_UNKNOWN_AND_EXCLUDED.'); + expect(logs).toMatch('WAIT_FOR_YELLOW_SOURCE -> UPDATE_SOURCE_MAPPINGS_PROPERTIES.'); + expect(logs).toMatch('UPDATE_SOURCE_MAPPINGS_PROPERTIES -> CLEANUP_UNKNOWN_AND_EXCLUDED.'); expect(logs).toMatch( 'CLEANUP_UNKNOWN_AND_EXCLUDED -> CLEANUP_UNKNOWN_AND_EXCLUDED_WAIT_FOR_TASK.' ); diff --git a/src/core/server/integration_tests/saved_objects/migrations/group3/skip_reindex.test.ts b/src/core/server/integration_tests/saved_objects/migrations/group3/skip_reindex.test.ts index 0276a5a03bd5c..797f482b3e568 100644 --- a/src/core/server/integration_tests/saved_objects/migrations/group3/skip_reindex.test.ts +++ b/src/core/server/integration_tests/saved_objects/migrations/group3/skip_reindex.test.ts @@ -45,7 +45,8 @@ describe('when migrating to a new version', () => { const logs = await readLog(); expect(logs).toMatch('INIT -> WAIT_FOR_YELLOW_SOURCE.'); - expect(logs).toMatch('WAIT_FOR_YELLOW_SOURCE -> CLEANUP_UNKNOWN_AND_EXCLUDED.'); + expect(logs).toMatch('WAIT_FOR_YELLOW_SOURCE -> UPDATE_SOURCE_MAPPINGS_PROPERTIES.'); + expect(logs).toMatch('UPDATE_SOURCE_MAPPINGS_PROPERTIES -> CLEANUP_UNKNOWN_AND_EXCLUDED.'); expect(logs).toMatch( 'CLEANUP_UNKNOWN_AND_EXCLUDED -> CLEANUP_UNKNOWN_AND_EXCLUDED_WAIT_FOR_TASK.' ); @@ -121,10 +122,13 @@ describe('when migrating to a new version', () => { await migrator.runMigrations({ rerun: true }); const logs = await readLog(); - expect(logs).toMatch('INIT -> OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT.'); + expect(logs).toMatch('INIT -> WAIT_FOR_YELLOW_SOURCE.'); + expect(logs).toMatch('WAIT_FOR_YELLOW_SOURCE -> UPDATE_SOURCE_MAPPINGS_PROPERTIES.'); + expect(logs).toMatch( + 'UPDATE_SOURCE_MAPPINGS_PROPERTIES -> OUTDATED_DOCUMENTS_SEARCH_OPEN_PIT.' + ); expect(logs).toMatch('CHECK_VERSION_INDEX_READY_ACTIONS -> DONE.'); - expect(logs).not.toMatch('WAIT_FOR_YELLOW_SOURCE'); expect(logs).not.toMatch('CLEANUP_UNKNOWN_AND_EXCLUCED'); expect(logs).not.toMatch('CREATE_NEW_TARGET'); expect(logs).not.toMatch('PREPARE_COMPATIBLE_MIGRATION'); diff --git a/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker b/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker index 5dc79eefe2229..f095589e3c204 100755 --- a/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker +++ b/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker @@ -300,7 +300,6 @@ kibana_vars=( xpack.ingestManager.fleet.tlsCheckDisabled xpack.ingestManager.registryUrl xpack.observability.annotations.index - xpack.observability.unsafe.alertDetails.apm.enabled xpack.observability.unsafe.alertDetails.metrics.enabled xpack.observability.unsafe.alertDetails.logs.enabled xpack.observability.unsafe.alertDetails.uptime.enabled diff --git a/src/dev/license_checker/config.ts b/src/dev/license_checker/config.ts index e45c89bf69b7a..dff28e30ae76b 100644 --- a/src/dev/license_checker/config.ts +++ b/src/dev/license_checker/config.ts @@ -84,6 +84,6 @@ export const LICENSE_OVERRIDES = { 'jsts@1.6.2': ['Eclipse Distribution License - v 1.0'], // cf. https://github.com/bjornharrtell/jsts '@mapbox/jsonlint-lines-primitives@2.0.2': ['MIT'], // license in readme https://github.com/tmcw/jsonlint '@elastic/ems-client@8.4.0': ['Elastic License 2.0'], - '@elastic/eui@75.1.2': ['SSPL-1.0 OR Elastic License 2.0'], + '@elastic/eui@76.0.2': ['SSPL-1.0 OR Elastic License 2.0'], 'language-subtag-registry@0.3.21': ['CC-BY-4.0'], // retired ODC‑By license https://github.com/mattcg/language-subtag-registry }; diff --git a/src/dev/storybook/aliases.ts b/src/dev/storybook/aliases.ts index 47ebefcc9c8c7..76a0c23992d7a 100644 --- a/src/dev/storybook/aliases.ts +++ b/src/dev/storybook/aliases.ts @@ -44,6 +44,7 @@ export const storybookAliases = { observability: 'x-pack/plugins/observability/.storybook', presentation: 'src/plugins/presentation_util/storybook', security_solution: 'x-pack/plugins/security_solution/.storybook', + security_solution_packages: 'packages/security-solution/storybook/config', shared_ux: 'packages/shared-ux/storybook/config', threat_intelligence: 'x-pack/plugins/threat_intelligence/.storybook', triggers_actions_ui: 'x-pack/plugins/triggers_actions_ui/.storybook', diff --git a/src/plugins/advanced_settings/public/management_app/advanced_settings.tsx b/src/plugins/advanced_settings/public/management_app/advanced_settings.tsx index 99f5f031ad4b1..a61b87ac79c28 100644 --- a/src/plugins/advanced_settings/public/management_app/advanced_settings.tsx +++ b/src/plugins/advanced_settings/public/management_app/advanced_settings.tsx @@ -61,7 +61,7 @@ export class AdvancedSettings extends Component { return (
- +

{this.props.callOutSubtitle}

 diff --git a/src/plugins/advanced_settings/public/management_app/components/field/field.tsx b/src/plugins/advanced_settings/public/management_app/components/field/field.tsx index 8d45aba74de95..21d31b53600a0 100644 --- a/src/plugins/advanced_settings/public/management_app/components/field/field.tsx +++ b/src/plugins/advanced_settings/public/management_app/components/field/field.tsx @@ -449,7 +449,7 @@ export class Field extends PureComponent { {unsavedChanges ? ( = ({ return ( MAX_TAG_COUNT && (
= ({ error, onB return ( { contentTypeId: T; ids: string[]; + version?: Version; options?: Options; } diff --git a/src/plugins/content_management/common/rpc/constants.ts b/src/plugins/content_management/common/rpc/constants.ts index a0f00a600eef6..e88ab0f6df689 100644 --- a/src/plugins/content_management/common/rpc/constants.ts +++ b/src/plugins/content_management/common/rpc/constants.ts @@ -5,7 +5,18 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ +import { schema } from '@kbn/config-schema'; +import { validateVersion } from '@kbn/object-versioning/lib/utils'; export const procedureNames = ['get', 'bulkGet', 'create', 'update', 'delete', 'search'] as const; export type ProcedureName = typeof procedureNames[number]; + +export const versionSchema = schema.number({ + validate: (value) => { + const { result } = validateVersion(value); + if (!result) { + return 'must be an integer'; + } + }, +}); diff --git a/src/plugins/content_management/common/rpc/create.ts b/src/plugins/content_management/common/rpc/create.ts index b5a7cfa7cd0e8..90d797603d16d 100644 --- a/src/plugins/content_management/common/rpc/create.ts +++ b/src/plugins/content_management/common/rpc/create.ts @@ -6,6 +6,8 @@ * Side Public License, v 1. */ import { schema } from '@kbn/config-schema'; +import type { Version } from '@kbn/object-versioning'; +import { versionSchema } from './constants'; import type { ProcedureSchemas } from './types'; @@ -13,6 +15,7 @@ export const createSchemas: ProcedureSchemas = { in: schema.object( { contentTypeId: schema.string(), + version: versionSchema, // --> "data" to create a content will be defined by each content type data: schema.recordOf(schema.string(), schema.any()), options: schema.maybe(schema.object({}, { unknowns: 'allow' })), @@ -29,5 +32,6 @@ export interface CreateIn< > { contentTypeId: T; data: Data; + version?: Version; options?: Options; } diff --git a/src/plugins/content_management/common/rpc/delete.ts b/src/plugins/content_management/common/rpc/delete.ts index 261c6397ab578..83f72b7e541c2 100644 --- a/src/plugins/content_management/common/rpc/delete.ts +++ b/src/plugins/content_management/common/rpc/delete.ts @@ -6,6 +6,8 @@ * Side Public License, v 1. */ import { schema } from '@kbn/config-schema'; +import type { Version } from '@kbn/object-versioning'; +import { versionSchema } from './constants'; import type { ProcedureSchemas } from './types'; @@ -14,6 +16,7 @@ export const deleteSchemas: ProcedureSchemas = { { contentTypeId: schema.string(), id: schema.string({ minLength: 1 }), + version: versionSchema, options: schema.maybe(schema.object({}, { unknowns: 'allow' })), }, { unknowns: 'forbid' } @@ -24,5 +27,6 @@ export const deleteSchemas: ProcedureSchemas = { export interface DeleteIn { contentTypeId: T; id: string; + version?: Version; options?: Options; } diff --git a/src/plugins/content_management/common/rpc/get.ts b/src/plugins/content_management/common/rpc/get.ts index a408a5f1afe83..895e4a25de792 100644 --- a/src/plugins/content_management/common/rpc/get.ts +++ b/src/plugins/content_management/common/rpc/get.ts @@ -6,6 +6,8 @@ * Side Public License, v 1. */ import { schema } from '@kbn/config-schema'; +import type { Version } from '@kbn/object-versioning'; +import { versionSchema } from './constants'; import type { ProcedureSchemas } from './types'; @@ -14,6 +16,7 @@ export const getSchemas: ProcedureSchemas = { { contentTypeId: schema.string(), id: schema.string({ minLength: 1 }), + version: versionSchema, options: schema.maybe(schema.object({}, { unknowns: 'allow' })), }, { unknowns: 'forbid' } @@ -25,5 +28,6 @@ export const getSchemas: ProcedureSchemas = { export interface GetIn { id: string; contentTypeId: T; + version?: Version; options?: Options; } diff --git a/src/plugins/content_management/common/rpc/search.ts b/src/plugins/content_management/common/rpc/search.ts index 9e86b2e8a0fa2..05305b092f0ae 100644 --- a/src/plugins/content_management/common/rpc/search.ts +++ b/src/plugins/content_management/common/rpc/search.ts @@ -6,6 +6,8 @@ * Side Public License, v 1. */ import { schema } from '@kbn/config-schema'; +import type { Version } from '@kbn/object-versioning'; +import { versionSchema } from './constants'; import type { ProcedureSchemas } from './types'; @@ -13,6 +15,7 @@ export const searchSchemas: ProcedureSchemas = { in: schema.object( { contentTypeId: schema.string(), + version: versionSchema, // --> "query" that can be executed will be defined by each content type query: schema.recordOf(schema.string(), schema.any()), options: schema.maybe(schema.object({}, { unknowns: 'allow' })), @@ -32,5 +35,6 @@ export interface SearchIn< > { contentTypeId: T; query: Query; + version?: Version; options?: Options; } diff --git a/src/plugins/content_management/common/rpc/types.ts b/src/plugins/content_management/common/rpc/types.ts index 6a19a80956708..7c6ad6672dbcf 100644 --- a/src/plugins/content_management/common/rpc/types.ts +++ b/src/plugins/content_management/common/rpc/types.ts @@ -9,5 +9,5 @@ import type { Type } from '@kbn/config-schema'; export interface ProcedureSchemas { in: Type | false; - out: Type | false; + out?: Type | false; } diff --git a/src/plugins/content_management/common/rpc/update.ts b/src/plugins/content_management/common/rpc/update.ts index a523822377eb3..8d1c74cf706f3 100644 --- a/src/plugins/content_management/common/rpc/update.ts +++ b/src/plugins/content_management/common/rpc/update.ts @@ -6,6 +6,8 @@ * Side Public License, v 1. */ import { schema } from '@kbn/config-schema'; +import type { Version } from '@kbn/object-versioning'; +import { versionSchema } from './constants'; import type { ProcedureSchemas } from './types'; @@ -14,6 +16,7 @@ export const updateSchemas: ProcedureSchemas = { { contentTypeId: schema.string(), id: schema.string({ minLength: 1 }), + version: versionSchema, // --> "data" to update a content will be defined by each content type data: schema.recordOf(schema.string(), schema.any()), options: schema.maybe(schema.object({}, { unknowns: 'allow' })), @@ -31,5 +34,6 @@ export interface UpdateIn< contentTypeId: T; id: string; data: Data; + version?: Version; options?: Options; } diff --git a/src/plugins/content_management/public/content_client/content_client.test.ts b/src/plugins/content_management/public/content_client/content_client.test.ts index 238570aeb3f49..a654314fd1533 100644 --- a/src/plugins/content_management/public/content_client/content_client.test.ts +++ b/src/plugins/content_management/public/content_client/content_client.test.ts @@ -11,11 +11,17 @@ import { takeWhile, toArray } from 'rxjs/operators'; import { createCrudClientMock } from '../crud_client/crud_client.mock'; import { ContentClient } from './content_client'; import type { GetIn, CreateIn, UpdateIn, DeleteIn, SearchIn } from '../../common'; +import { ContentTypeRegistry } from '../registry'; const setup = () => { const crudClient = createCrudClientMock(); - const contentClient = new ContentClient(() => crudClient); - return { crudClient, contentClient }; + const contentTypeRegistry = new ContentTypeRegistry(); + contentTypeRegistry.register({ + id: 'testType', + version: { latest: 3 }, + }); + const contentClient = new ContentClient(() => crudClient, contentTypeRegistry); + return { crudClient, contentClient, contentTypeRegistry }; }; describe('#get', () => { @@ -25,9 +31,30 @@ describe('#get', () => { const output = { test: 'test' }; crudClient.get.mockResolvedValueOnce(output); expect(await contentClient.get(input)).toEqual(output); + expect(crudClient.get).toBeCalledWith({ ...input, version: 3 }); // latest version added + }); + + it('does not add the latest version if one is passed', async () => { + const { crudClient, contentClient } = setup(); + const input: GetIn = { id: 'test', contentTypeId: 'testType', version: 1 }; + await contentClient.get(input); expect(crudClient.get).toBeCalledWith(input); }); + it('throws if version is not valid', async () => { + const { contentClient } = setup(); + let input = { id: 'test', contentTypeId: 'testType', version: 'foo' }; // Invalid format + await expect(async () => { + contentClient.get(input as any); + }).rejects.toThrowError('Invalid version [foo]. Must be an integer.'); + + // @ts-expect-error + input = { id: 'test', contentTypeId: 'testType', version: 4 }; // Latest version is 3 + await expect(async () => { + contentClient.get(input as any); + }).rejects.toThrowError('Invalid version [4]. Latest version is [3]'); + }); + it('calls rpcClient.get$ with input and returns output', async () => { const { crudClient, contentClient } = setup(); const input: GetIn = { id: 'test', contentTypeId: 'testType' }; @@ -58,6 +85,13 @@ describe('#create', () => { crudClient.create.mockResolvedValueOnce(output); expect(await contentClient.create(input)).toEqual(output); + expect(crudClient.create).toBeCalledWith({ ...input, version: 3 }); // latest version added + }); + + it('does not add the latest version if one is passed', async () => { + const { crudClient, contentClient } = setup(); + const input: CreateIn = { contentTypeId: 'testType', data: { foo: 'bar' }, version: 1 }; + await contentClient.create(input); expect(crudClient.create).toBeCalledWith(input); }); }); @@ -65,11 +99,28 @@ describe('#create', () => { describe('#update', () => { it('calls rpcClient.update with input and returns output', async () => { const { crudClient, contentClient } = setup(); - const input: UpdateIn = { contentTypeId: 'testType', id: 'test', data: { foo: 'bar' } }; + const input: UpdateIn = { + contentTypeId: 'testType', + id: 'test', + data: { foo: 'bar' }, + }; const output = { test: 'test' }; crudClient.update.mockResolvedValueOnce(output); expect(await contentClient.update(input)).toEqual(output); + expect(crudClient.update).toBeCalledWith({ ...input, version: 3 }); // latest version added + }); + + it('does not add the latest version if one is passed', async () => { + const { crudClient, contentClient } = setup(); + + const input: UpdateIn = { + contentTypeId: 'testType', + id: 'test', + data: { foo: 'bar' }, + version: 1, + }; + await contentClient.update(input); expect(crudClient.update).toBeCalledWith(input); }); }); @@ -82,6 +133,13 @@ describe('#delete', () => { crudClient.delete.mockResolvedValueOnce(output); expect(await contentClient.delete(input)).toEqual(output); + expect(crudClient.delete).toBeCalledWith({ ...input, version: 3 }); // latest version added + }); + + it('does not add the latest version if one is passed', async () => { + const { crudClient, contentClient } = setup(); + const input: DeleteIn = { contentTypeId: 'testType', id: 'test', version: 1 }; + await contentClient.delete(input); expect(crudClient.delete).toBeCalledWith(input); }); }); @@ -93,6 +151,13 @@ describe('#search', () => { const output = { hits: [{ id: 'test' }] }; crudClient.search.mockResolvedValueOnce(output); expect(await contentClient.search(input)).toEqual(output); + expect(crudClient.search).toBeCalledWith({ ...input, version: 3 }); // latest version added + }); + + it('does not add the latest version if one is passed', async () => { + const { crudClient, contentClient } = setup(); + const input: SearchIn = { contentTypeId: 'testType', query: {}, version: 1 }; + await contentClient.search(input); expect(crudClient.search).toBeCalledWith(input); }); diff --git a/src/plugins/content_management/public/content_client/content_client.tsx b/src/plugins/content_management/public/content_client/content_client.tsx index 8dfb13223735e..ae8240ccf5562 100644 --- a/src/plugins/content_management/public/content_client/content_client.tsx +++ b/src/plugins/content_management/public/content_client/content_client.tsx @@ -7,9 +7,12 @@ */ import { QueryClient } from '@tanstack/react-query'; +import { validateVersion } from '@kbn/object-versioning/lib/utils'; +import type { Version } from '@kbn/object-versioning'; import { createQueryObservable } from './query_observable'; import type { CrudClient } from '../crud_client'; import type { CreateIn, GetIn, UpdateIn, DeleteIn, SearchIn } from '../../common'; +import type { ContentTypeRegistry } from '../registry'; export const queryKeyBuilder = { all: (type: string) => [type] as const, @@ -21,19 +24,54 @@ export const queryKeyBuilder = { }, }; +const addVersion = ( + input: I, + contentTypeRegistry: ContentTypeRegistry +): I & { version: Version } => { + const contentType = contentTypeRegistry.get(input.contentTypeId); + + if (!contentType) { + throw new Error(`Unknown content type [${input.contentTypeId}]`); + } + + const version = input.version ?? contentType.version.latest; + + const { result, value } = validateVersion(version); + + if (!result) { + throw new Error(`Invalid version [${version}]. Must be an integer.`); + } + + if (value > contentType.version.latest) { + throw new Error( + `Invalid version [${version}]. Latest version is [${contentType.version.latest}]` + ); + } + + return { + ...input, + version, + }; +}; + const createQueryOptionBuilder = ({ crudClientProvider, + contentTypeRegistry, }: { crudClientProvider: (contentType: string) => CrudClient; + contentTypeRegistry: ContentTypeRegistry; }) => { return { - get: (input: I) => { + get: (_input: I) => { + const input = addVersion(_input, contentTypeRegistry); return { queryKey: queryKeyBuilder.item(input.contentTypeId, input.id), queryFn: () => crudClientProvider(input.contentTypeId).get(input) as Promise, }; }, - search: (input: I) => { + search: (_input: I) => { + const input = addVersion(_input, contentTypeRegistry); + return { queryKey: queryKeyBuilder.search(input.contentTypeId, input.query), queryFn: () => crudClientProvider(input.contentTypeId).search(input) as Promise, @@ -46,10 +84,14 @@ export class ContentClient { readonly queryClient: QueryClient; readonly queryOptionBuilder: ReturnType; - constructor(private readonly crudClientProvider: (contentType: string) => CrudClient) { + constructor( + private readonly crudClientProvider: (contentType: string) => CrudClient, + private readonly contentTypeRegistry: ContentTypeRegistry + ) { this.queryClient = new QueryClient(); this.queryOptionBuilder = createQueryOptionBuilder({ crudClientProvider: this.crudClientProvider, + contentTypeRegistry: this.contentTypeRegistry, }); } @@ -62,22 +104,33 @@ export class ContentClient { } create(input: I): Promise { - return this.crudClientProvider(input.contentTypeId).create(input) as Promise; + return this.crudClientProvider(input.contentTypeId).create( + addVersion(input, this.contentTypeRegistry) + ) as Promise; } update(input: I): Promise { - return this.crudClientProvider(input.contentTypeId).update(input) as Promise; + return this.crudClientProvider(input.contentTypeId).update( + addVersion(input, this.contentTypeRegistry) + ) as Promise; } delete(input: I): Promise { - return this.crudClientProvider(input.contentTypeId).delete(input) as Promise; + return this.crudClientProvider(input.contentTypeId).delete( + addVersion(input, this.contentTypeRegistry) + ) as Promise; } search(input: I): Promise { - return this.crudClientProvider(input.contentTypeId).search(input) as Promise; + return this.crudClientProvider(input.contentTypeId).search( + addVersion(input, this.contentTypeRegistry) + ) as Promise; } search$(input: I) { - return createQueryObservable(this.queryClient, this.queryOptionBuilder.search(input)); + return createQueryObservable( + this.queryClient, + this.queryOptionBuilder.search(addVersion(input, this.contentTypeRegistry)) + ); } } diff --git a/src/plugins/content_management/public/content_client/content_client_mutation_hooks.test.tsx b/src/plugins/content_management/public/content_client/content_client_mutation_hooks.test.tsx index 7a19cf2dae7a9..6f19801c2c376 100644 --- a/src/plugins/content_management/public/content_client/content_client_mutation_hooks.test.tsx +++ b/src/plugins/content_management/public/content_client/content_client_mutation_hooks.test.tsx @@ -17,10 +17,16 @@ import { useDeleteContentMutation, } from './content_client_mutation_hooks'; import type { CreateIn, UpdateIn, DeleteIn } from '../../common'; +import { ContentTypeRegistry } from '../registry'; const setup = () => { const crudClient = createCrudClientMock(); - const contentClient = new ContentClient(() => crudClient); + const contentTypeRegistry = new ContentTypeRegistry(); + contentTypeRegistry.register({ + id: 'testType', + version: { latest: 3 }, + }); + const contentClient = new ContentClient(() => crudClient, contentTypeRegistry); const Wrapper: React.FC = ({ children }) => ( {children} @@ -36,7 +42,7 @@ const setup = () => { describe('useCreateContentMutation', () => { test('should call rpcClient.create with input and resolve with output', async () => { const { Wrapper, crudClient } = setup(); - const input: CreateIn = { contentTypeId: 'testType', data: { foo: 'bar' } }; + const input: CreateIn = { contentTypeId: 'testType', data: { foo: 'bar' }, version: 2 }; const output = { test: 'test' }; crudClient.create.mockResolvedValueOnce(output); const { result, waitFor } = renderHook(() => useCreateContentMutation(), { wrapper: Wrapper }); @@ -51,7 +57,12 @@ describe('useCreateContentMutation', () => { describe('useUpdateContentMutation', () => { test('should call rpcClient.update with input and resolve with output', async () => { const { Wrapper, crudClient } = setup(); - const input: UpdateIn = { contentTypeId: 'testType', id: 'test', data: { foo: 'bar' } }; + const input: UpdateIn = { + contentTypeId: 'testType', + id: 'test', + data: { foo: 'bar' }, + version: 2, + }; const output = { test: 'test' }; crudClient.update.mockResolvedValueOnce(output); const { result, waitFor } = renderHook(() => useUpdateContentMutation(), { wrapper: Wrapper }); @@ -66,7 +77,7 @@ describe('useUpdateContentMutation', () => { describe('useDeleteContentMutation', () => { test('should call rpcClient.delete with input and resolve with output', async () => { const { Wrapper, crudClient } = setup(); - const input: DeleteIn = { contentTypeId: 'testType', id: 'test' }; + const input: DeleteIn = { contentTypeId: 'testType', id: 'test', version: 2 }; const output = { test: 'test' }; crudClient.delete.mockResolvedValueOnce(output); const { result, waitFor } = renderHook(() => useDeleteContentMutation(), { wrapper: Wrapper }); diff --git a/src/plugins/content_management/public/content_client/content_client_query_hooks.test.tsx b/src/plugins/content_management/public/content_client/content_client_query_hooks.test.tsx index a716831efc3ad..59c04ede3ab42 100644 --- a/src/plugins/content_management/public/content_client/content_client_query_hooks.test.tsx +++ b/src/plugins/content_management/public/content_client/content_client_query_hooks.test.tsx @@ -13,10 +13,16 @@ import { ContentClient } from './content_client'; import { createCrudClientMock } from '../crud_client/crud_client.mock'; import { useGetContentQuery, useSearchContentQuery } from './content_client_query_hooks'; import type { GetIn, SearchIn } from '../../common'; +import { ContentTypeRegistry } from '../registry'; const setup = () => { const crudClient = createCrudClientMock(); - const contentClient = new ContentClient(() => crudClient); + const contentTypeRegistry = new ContentTypeRegistry(); + contentTypeRegistry.register({ + id: 'testType', + version: { latest: 2 }, + }); + const contentClient = new ContentClient(() => crudClient, contentTypeRegistry); const Wrapper: React.FC = ({ children }) => ( {children} @@ -32,7 +38,7 @@ const setup = () => { describe('useGetContentQuery', () => { test('should call rpcClient.get with input and resolve with output', async () => { const { crudClient, Wrapper } = setup(); - const input: GetIn = { id: 'test', contentTypeId: 'testType' }; + const input: GetIn = { id: 'test', contentTypeId: 'testType', version: 2 }; const output = { test: 'test' }; crudClient.get.mockResolvedValueOnce(output); const { result, waitFor } = renderHook(() => useGetContentQuery(input), { wrapper: Wrapper }); @@ -44,7 +50,7 @@ describe('useGetContentQuery', () => { describe('useSearchContentQuery', () => { test('should call rpcClient.search with input and resolve with output', async () => { const { crudClient, Wrapper } = setup(); - const input: SearchIn = { contentTypeId: 'testType', query: {} }; + const input: SearchIn = { contentTypeId: 'testType', query: {}, version: 2 }; const output = { hits: [{ id: 'test' }] }; crudClient.search.mockResolvedValueOnce(output); const { result, waitFor } = renderHook(() => useSearchContentQuery(input), { diff --git a/src/plugins/content_management/public/plugin.ts b/src/plugins/content_management/public/plugin.ts index b2798e4224384..38b5bcb3283f5 100644 --- a/src/plugins/content_management/public/plugin.ts +++ b/src/plugins/content_management/public/plugin.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import type { CoreSetup, CoreStart, Plugin } from '@kbn/core/public'; +import type { CoreStart, Plugin } from '@kbn/core/public'; import { ContentManagementPublicStart, ContentManagementPublicSetup, @@ -26,18 +26,33 @@ export class ContentManagementPlugin StartDependencies > { - public setup(core: CoreSetup, deps: SetupDependencies) { + private contentTypeRegistry: ContentTypeRegistry; + + constructor() { + this.contentTypeRegistry = new ContentTypeRegistry(); + } + + public setup() { return { - registry: {} as ContentTypeRegistry, + registry: { + register: this.contentTypeRegistry.register.bind(this.contentTypeRegistry), + }, }; } public start(core: CoreStart, deps: StartDependencies) { const rpcClient = new RpcClient(core.http); - const contentTypeRegistry = new ContentTypeRegistry(); + const contentClient = new ContentClient( - (contentType) => contentTypeRegistry.get(contentType)?.crud ?? rpcClient + (contentType) => this.contentTypeRegistry.get(contentType)?.crud ?? rpcClient, + this.contentTypeRegistry ); - return { client: contentClient, registry: contentTypeRegistry }; + return { + client: contentClient, + registry: { + get: this.contentTypeRegistry.get.bind(this.contentTypeRegistry), + getAll: this.contentTypeRegistry.getAll.bind(this.contentTypeRegistry), + }, + }; } } diff --git a/src/plugins/content_management/public/registry/content_type.test.ts b/src/plugins/content_management/public/registry/content_type.test.ts index dd06ea658676e..096144319a996 100644 --- a/src/plugins/content_management/public/registry/content_type.test.ts +++ b/src/plugins/content_management/public/registry/content_type.test.ts @@ -10,7 +10,7 @@ import { ContentType } from './content_type'; import type { ContentTypeDefinition } from './content_type_definition'; test('create a content type with just an id', () => { - const type = new ContentType({ id: 'test' }); + const type = new ContentType({ id: 'test', version: { latest: 1 } }); expect(type.id).toBe('test'); expect(type.name).toBe('test'); @@ -24,6 +24,7 @@ test('create a content type with all the full definition', () => { name: 'Test', icon: 'test', description: 'Test description', + version: { latest: 1 }, }; const type = new ContentType(definition); diff --git a/src/plugins/content_management/public/registry/content_type.ts b/src/plugins/content_management/public/registry/content_type.ts index fa55b890689fe..c4dc2c53a31f3 100644 --- a/src/plugins/content_management/public/registry/content_type.ts +++ b/src/plugins/content_management/public/registry/content_type.ts @@ -31,4 +31,8 @@ export class ContentType { public get crud(): CrudClient | undefined { return this.definition.crud; } + + public get version(): ContentTypeDefinition['version'] { + return this.definition.version; + } } diff --git a/src/plugins/content_management/public/registry/content_type_definition.ts b/src/plugins/content_management/public/registry/content_type_definition.ts index 42a60ed4793fd..792cd589f67e2 100644 --- a/src/plugins/content_management/public/registry/content_type_definition.ts +++ b/src/plugins/content_management/public/registry/content_type_definition.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +import type { Version } from '@kbn/object-versioning'; import type { CrudClient } from '../crud_client'; /** @@ -39,4 +40,9 @@ export interface ContentTypeDefinition { * If not provided the default CRUD client is used assuming that this type has a server-side content registry */ crud?: CrudClient; + + version: { + /** The latest version for this content */ + latest: Version; + }; } diff --git a/src/plugins/content_management/public/registry/registry.test.ts b/src/plugins/content_management/public/registry/registry.test.ts index 20c20c161badd..4ac29a2b19486 100644 --- a/src/plugins/content_management/public/registry/registry.test.ts +++ b/src/plugins/content_management/public/registry/registry.test.ts @@ -14,28 +14,72 @@ beforeEach(() => { registry = new ContentTypeRegistry(); }); +const versionInfo = { + latest: 2, +} as const; + test('registering a content type', () => { const type = registry.register({ id: 'test', name: 'Test', icon: 'test', description: 'Test description', + version: versionInfo, }); expect(type.id).toBe('test'); expect(type.name).toBe('Test'); expect(type.icon).toBe('test'); expect(type.description).toBe('Test description'); + expect(type.version).toEqual(versionInfo); }); test('registering already registered content type throws', () => { registry.register({ id: 'test', + version: versionInfo, }); - expect(() => registry.register({ id: 'test' })).toThrowErrorMatchingInlineSnapshot( - `"Content type with id \\"test\\" already registered."` - ); + expect(() => + registry.register({ id: 'test', version: versionInfo }) + ).toThrowErrorMatchingInlineSnapshot(`"Content type with id \\"test\\" already registered."`); +}); + +test('registering string number version converts it to number', () => { + registry.register({ + id: 'test', + version: { latest: '123' }, + } as any); + + expect(registry.get('test')?.version).toEqual({ latest: 123 }); +}); + +test('registering without version throws', () => { + expect(() => { + registry.register({ + id: 'test', + } as any); + }).toThrowError('Invalid version [undefined]. Must be an integer.'); +}); + +test('registering invalid version throws', () => { + expect(() => { + registry.register({ + id: 'test', + version: { + latest: 'bad', + }, + } as any); + }).toThrowError('Invalid version [bad]. Must be an integer.'); + + expect(() => { + registry.register({ + id: 'test', + version: { + latest: 0, + }, + }); + }).toThrowError('Version must be >= 1'); }); test('getting non registered content returns undefined', () => { @@ -45,6 +89,7 @@ test('getting non registered content returns undefined', () => { test('get', () => { const type = registry.register({ id: 'test', + version: versionInfo, }); expect(registry.get('test')).toEqual(type); @@ -53,9 +98,11 @@ test('get', () => { test('getAll', () => { registry.register({ id: 'test1', + version: versionInfo, }); registry.register({ id: 'test2', + version: versionInfo, }); expect(registry.getAll()).toHaveLength(2); diff --git a/src/plugins/content_management/public/registry/registry.ts b/src/plugins/content_management/public/registry/registry.ts index 7c96a0d79b251..97020f205843f 100644 --- a/src/plugins/content_management/public/registry/registry.ts +++ b/src/plugins/content_management/public/registry/registry.ts @@ -6,6 +6,8 @@ * Side Public License, v 1. */ +import { validateVersion } from '@kbn/object-versioning/lib/utils'; + import type { ContentTypeDefinition } from './content_type_definition'; import { ContentType } from './content_type'; @@ -16,7 +18,20 @@ export class ContentTypeRegistry { if (this.types.has(definition.id)) { throw new Error(`Content type with id "${definition.id}" already registered.`); } - const type = new ContentType(definition); + + const { result, value } = validateVersion(definition.version?.latest); + if (!result) { + throw new Error(`Invalid version [${definition.version?.latest}]. Must be an integer.`); + } + + if (value < 1) { + throw new Error(`Version must be >= 1`); + } + + const type = new ContentType({ + ...definition, + version: { ...definition.version, latest: value }, + }); this.types.set(type.id, type); return type; diff --git a/src/plugins/content_management/public/rpc_client/rpc_client.test.ts b/src/plugins/content_management/public/rpc_client/rpc_client.test.ts index 5e75b45be86ec..c0d832919cf03 100644 --- a/src/plugins/content_management/public/rpc_client/rpc_client.test.ts +++ b/src/plugins/content_management/public/rpc_client/rpc_client.test.ts @@ -6,7 +6,8 @@ * Side Public License, v 1. */ -import { API_ENDPOINT, procedureNames } from '../../common'; +import { API_ENDPOINT } from '../../common'; +import { procedureNames } from '../../common/rpc'; import { RpcClient } from './rpc_client'; diff --git a/src/plugins/content_management/server/core/content_type.ts b/src/plugins/content_management/server/core/content_type.ts index 5853cd3e77556..407bb945dd724 100644 --- a/src/plugins/content_management/server/core/content_type.ts +++ b/src/plugins/content_management/server/core/content_type.ts @@ -36,4 +36,8 @@ export class ContentType { public get crud() { return this.contentCrud; } + + public get version() { + return this._definition.version; + } } diff --git a/src/plugins/content_management/server/core/core.test.ts b/src/plugins/content_management/server/core/core.test.ts index 074f62ebc07b3..220f33e009333 100644 --- a/src/plugins/content_management/server/core/core.test.ts +++ b/src/plugins/content_management/server/core/core.test.ts @@ -5,8 +5,6 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ -import { schema } from '@kbn/config-schema'; - import { loggingSystemMock } from '@kbn/core/server/mocks'; import { Core } from './core'; import { createMemoryStorage, FooContent } from './mocks'; @@ -37,11 +35,17 @@ import { ContentTypeDefinition, StorageContext } from './types'; const logger = loggingSystemMock.createLogger(); const FOO_CONTENT_ID = 'foo'; -const fooSchema = schema.object({ title: schema.string() }); const setup = ({ registerFooType = false }: { registerFooType?: boolean } = {}) => { const ctx: StorageContext = { requestHandlerContext: {} as any, + version: { + latest: 1, + request: 1, + }, + utils: { + getTransforms: jest.fn(), + }, }; const core = new Core({ logger }); @@ -49,12 +53,8 @@ const setup = ({ registerFooType = false }: { registerFooType?: boolean } = {}) const contentDefinition: ContentTypeDefinition = { id: FOO_CONTENT_ID, storage: createMemoryStorage(), - schemas: { - content: { - create: { in: { data: fooSchema } }, - update: { in: { data: fooSchema } }, - search: { in: { query: schema.any() } }, - }, + version: { + latest: 2, }, }; const cleanUp = () => { @@ -107,7 +107,45 @@ describe('Content Core', () => { // Make sure the "register" exposed by the api is indeed registring // the content into our "contentRegistry" instance expect(contentRegistry.isContentRegistered(FOO_CONTENT_ID)).toBe(true); - expect(contentRegistry.getDefinition(FOO_CONTENT_ID)).toBe(contentDefinition); + expect(contentRegistry.getDefinition(FOO_CONTENT_ID)).toEqual(contentDefinition); + + cleanUp(); + }); + + test('should convert the latest version to number if string is passed', () => { + const { coreSetup, cleanUp, contentDefinition } = setup(); + + const { + contentRegistry, + api: { register }, + } = coreSetup; + + register({ ...contentDefinition, version: { latest: '123' } } as any); + + expect(contentRegistry.getContentType(contentDefinition.id).version).toEqual({ + latest: 123, + }); + + cleanUp(); + }); + + test('should throw if latest version passed is not valid', () => { + const { coreSetup, cleanUp, contentDefinition } = setup(); + + const { + contentRegistry, + api: { register }, + } = coreSetup; + + expect(contentRegistry.isContentRegistered(FOO_CONTENT_ID)).toBe(false); + + expect(() => { + register({ ...contentDefinition, version: undefined } as any); + }).toThrowError('Invalid version [undefined]. Must be an integer.'); + + expect(() => { + register({ ...contentDefinition, version: { latest: 0 } }); + }).toThrowError('Version must be >= 1'); cleanUp(); }); diff --git a/src/plugins/content_management/server/core/index.ts b/src/plugins/content_management/server/core/index.ts index 8490272e90fb4..0762fb06d5b2e 100644 --- a/src/plugins/content_management/server/core/index.ts +++ b/src/plugins/content_management/server/core/index.ts @@ -12,7 +12,7 @@ export type { CoreApi } from './core'; export type { ContentType } from './content_type'; -export type { ContentStorage, ContentTypeDefinition, StorageContext, RpcSchemas } from './types'; +export type { ContentStorage, ContentTypeDefinition, StorageContext } from './types'; export type { ContentRegistry } from './registry'; diff --git a/src/plugins/content_management/server/core/registry.ts b/src/plugins/content_management/server/core/registry.ts index 2845ab5f742bc..6537dae320455 100644 --- a/src/plugins/content_management/server/core/registry.ts +++ b/src/plugins/content_management/server/core/registry.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +import { validateVersion } from '@kbn/object-versioning/lib/utils'; import { ContentType } from './content_type'; import { EventBus } from './event_bus'; import type { ContentStorage, ContentTypeDefinition } from './types'; @@ -26,7 +27,19 @@ export class ContentRegistry { throw new Error(`Content [${definition.id}] is already registered`); } - const contentType = new ContentType(definition, this.eventBus); + const { result, value } = validateVersion(definition.version?.latest); + if (!result) { + throw new Error(`Invalid version [${definition.version?.latest}]. Must be an integer.`); + } + + if (value < 1) { + throw new Error(`Version must be >= 1`); + } + + const contentType = new ContentType( + { ...definition, version: { ...definition.version, latest: value } }, + this.eventBus + ); this.types.set(contentType.id, contentType); } diff --git a/src/plugins/content_management/server/core/types.ts b/src/plugins/content_management/server/core/types.ts index e3977e75338f4..2489c6f3a3def 100644 --- a/src/plugins/content_management/server/core/types.ts +++ b/src/plugins/content_management/server/core/types.ts @@ -6,12 +6,19 @@ * Side Public License, v 1. */ -import type { Type } from '@kbn/config-schema'; import type { RequestHandlerContext } from '@kbn/core-http-request-handler-context-server'; +import type { ContentManagementGetTransformsFn, Version } from '@kbn/object-versioning'; /** Context that is sent to all storage instance methods */ export interface StorageContext { requestHandlerContext: RequestHandlerContext; + version: { + request: Version; + latest: Version; + }; + utils: { + getTransforms: ContentManagementGetTransformsFn; + }; } export interface ContentStorage { @@ -34,68 +41,12 @@ export interface ContentStorage { search(ctx: StorageContext, query: object, options: unknown): Promise; } -export interface RpcSchemas { - get?: { - in?: { - options?: Type; - }; - out?: { - result: Type; - }; - }; - bulkGet?: { - in?: { - options?: Type; - }; - out?: { - result: Type; - }; - }; - create: { - in: { - data: Type; - options?: Type; - }; - out?: { - result: Type; - }; - }; - update: { - in: { - data: Type; - options?: Type; - }; - out?: { - result: Type; - }; - }; - delete?: { - in?: { - options?: Type; - }; - out?: { - result: Type; - }; - }; - search: { - in: { - query: Type; - options?: Type; - }; - out?: { - result: Type; - }; - }; -} - -export type ContentSchemas = RpcSchemas; - export interface ContentTypeDefinition { /** Unique id for the content type */ id: string; /** The storage layer for the content. It must implment the ContentStorage interface. */ storage: S; - schemas: { - content: ContentSchemas; + version: { + latest: Version; }; } diff --git a/src/plugins/content_management/server/plugin.test.ts b/src/plugins/content_management/server/plugin.test.ts index 4ec92f3bd2283..f67652da6d938 100644 --- a/src/plugins/content_management/server/plugin.test.ts +++ b/src/plugins/content_management/server/plugin.test.ts @@ -9,7 +9,8 @@ import { loggingSystemMock, coreMock } from '@kbn/core/server/mocks'; import { ContentManagementPlugin } from './plugin'; import { IRouter } from '@kbn/core/server'; -import { ProcedureName, procedureNames } from '../common'; +import type { ProcedureName } from '../common'; +import { procedureNames } from '../common/rpc'; jest.mock('./core', () => ({ ...jest.requireActual('./core'), @@ -128,6 +129,7 @@ describe('ContentManagementPlugin', () => { const context = { requestHandlerContext: mockedRequestHandlerContext, contentRegistry: 'mockedContentRegistry', + getTransformsFactory: expect.any(Function), }; expect(mockGet).toHaveBeenCalledWith(context, input); expect(mockCreate).toHaveBeenCalledWith(context, input); diff --git a/src/plugins/content_management/server/plugin.ts b/src/plugins/content_management/server/plugin.ts index e13c5af7b7a6e..56685c0564973 100755 --- a/src/plugins/content_management/server/plugin.ts +++ b/src/plugins/content_management/server/plugin.ts @@ -21,7 +21,7 @@ import { ContentManagementServerStart, SetupDependencies, } from './types'; -import { procedureNames } from '../common'; +import { procedureNames } from '../common/rpc'; type CreateRouterFn = CoreSetup['http']['createRouter']; diff --git a/src/plugins/content_management/server/rpc/procedures/bulk_get.test.ts b/src/plugins/content_management/server/rpc/procedures/bulk_get.test.ts index c5d839b57c0d3..7a525f6bf4a8b 100644 --- a/src/plugins/content_management/server/rpc/procedures/bulk_get.test.ts +++ b/src/plugins/content_management/server/rpc/procedures/bulk_get.test.ts @@ -6,13 +6,15 @@ * Side Public License, v 1. */ -import { schema } from '@kbn/config-schema'; +import { omit } from 'lodash'; +import { schema } from '@kbn/config-schema'; +import { ContentManagementServiceDefinitionVersioned } from '@kbn/object-versioning'; import { validate } from '../../utils'; import { ContentRegistry } from '../../core/registry'; import { createMockedStorage } from '../../core/mocks'; -import type { RpcSchemas } from '../../core'; import { EventBus } from '../../core/event_bus'; +import { getServiceObjectTransformFactory } from '../services_transforms_factory'; import { bulkGet } from './bulk_get'; const { fn, schemas } = bulkGet; @@ -29,41 +31,48 @@ if (!outputSchema) { } const FOO_CONTENT_ID = 'foo'; -const fooDataSchema = schema.object({ title: schema.string() }, { unknowns: 'forbid' }); describe('RPC -> bulkGet()', () => { describe('Input/Output validation', () => { + const ids = ['123', '456']; + const validInput = { contentTypeId: 'foo', ids, version: 1 }; + /** * These tests are for the procedure call itself. Every RPC needs to declare in/out schema * We will test _specific_ validation schema inside the procedure in separate tests. */ test('should validate that a contentTypeId and "ids" array is passed', () => { - const ids = ['123', '456']; - [ - { input: { contentTypeId: 'foo', ids } }, + { input: validInput }, { - input: { ids }, // contentTypeId missing + input: omit(validInput, 'contentTypeId'), expectedError: '[contentTypeId]: expected value of type [string] but got [undefined]', }, { - input: { contentTypeId: 'foo' }, // ids missing + input: omit(validInput, 'version'), + expectedError: '[version]: expected value of type [number] but got [undefined]', + }, + { + input: { ...validInput, version: '1' }, // string number is OK + }, + { + input: omit(validInput, 'ids'), expectedError: '[ids]: expected value of type [array] but got [undefined]', }, { - input: { contentTypeId: 'foo', ids: [] }, // ids array needs at least one value + input: { ...validInput, ids: [] }, // ids array needs at least one value expectedError: '[ids]: array size is [0], but cannot be smaller than [1]', }, { - input: { contentTypeId: 'foo', ids: [''] }, // ids must havr 1 char min + input: { ...validInput, ids: [''] }, // ids must havr 1 char min expectedError: '[ids.0]: value has length [0] but it must have a minimum length of [1].', }, { - input: { contentTypeId: 'foo', ids: 123 }, // ids is not an array of string + input: { ...validInput, ids: 123 }, // ids is not an array of string expectedError: '[ids]: expected value of type [array] but got [number]', }, { - input: { contentTypeId: 'foo', ids, unknown: 'foo' }, + input: { ...validInput, unknown: 'foo' }, expectedError: '[unknown]: definition for this key is missing', }, ].forEach(({ input, expectedError }) => { @@ -86,6 +95,7 @@ describe('RPC -> bulkGet()', () => { { contentTypeId: 'foo', ids: ['123'], + version: 1, options: { any: 'object' }, }, inputSchema @@ -96,6 +106,7 @@ describe('RPC -> bulkGet()', () => { error = validate( { contentTypeId: 'foo', + version: 1, ids: ['123'], options: 123, // Not an object }, @@ -138,29 +149,23 @@ describe('RPC -> bulkGet()', () => { }); describe('procedure', () => { - const createSchemas = (): RpcSchemas => { - return { - bulkGet: { - in: { - query: fooDataSchema, - }, - }, - } as any; - }; - - const setup = ({ contentSchemas = createSchemas() } = {}) => { + const setup = () => { const contentRegistry = new ContentRegistry(new EventBus()); const storage = createMockedStorage(); contentRegistry.register({ id: FOO_CONTENT_ID, storage, - schemas: { - content: contentSchemas, + version: { + latest: 2, }, }); const requestHandlerContext = 'mockedRequestHandlerContext'; - const ctx: any = { contentRegistry, requestHandlerContext }; + const ctx: any = { + contentRegistry, + requestHandlerContext, + getTransformsFactory: getServiceObjectTransformFactory, + }; return { ctx, storage }; }; @@ -171,7 +176,11 @@ describe('RPC -> bulkGet()', () => { const expected = ['Item1', 'Item2']; storage.bulkGet.mockResolvedValueOnce(expected); - const result = await fn(ctx, { contentTypeId: FOO_CONTENT_ID, ids: ['123', '456'] }); + const result = await fn(ctx, { + contentTypeId: FOO_CONTENT_ID, + version: 1, + ids: ['123', '456'], + }); expect(result).toEqual({ contentTypeId: FOO_CONTENT_ID, @@ -179,7 +188,16 @@ describe('RPC -> bulkGet()', () => { }); expect(storage.bulkGet).toHaveBeenCalledWith( - { requestHandlerContext: ctx.requestHandlerContext }, + { + requestHandlerContext: ctx.requestHandlerContext, + version: { + request: 1, + latest: 2, // from the registry + }, + utils: { + getTransforms: expect.any(Function), + }, + }, ['123', '456'], undefined ); @@ -193,53 +211,63 @@ describe('RPC -> bulkGet()', () => { ); }); - test('should enforce a schema for options if options are passed', () => { + test('should throw if the request version is higher than the registered version', () => { const { ctx } = setup(); expect(() => fn(ctx, { contentTypeId: FOO_CONTENT_ID, ids: ['123', '456'], - options: { foo: 'bar' }, + version: 7, }) - ).rejects.toEqual(new Error('Schema missing for rpc procedure [bulkGet.in.options].')); + ).rejects.toEqual(new Error('Invalid version. Latest version is [2].')); }); + }); + + describe('object versioning', () => { + test('should expose a utility to transform and validate services objects', () => { + const { ctx, storage } = setup(); + fn(ctx, { contentTypeId: FOO_CONTENT_ID, ids: ['1234'], version: 1 }); + const [[storageContext]] = storage.bulkGet.mock.calls; + + // getTransforms() utils should be available from context + const { getTransforms } = storageContext.utils ?? {}; + expect(getTransforms).not.toBeUndefined(); - test('should validate the options', () => { - const { ctx } = setup({ - contentSchemas: { + const definitions: ContentManagementServiceDefinitionVersioned = { + 1: { bulkGet: { in: { - query: fooDataSchema, - options: schema.object({ validOption: schema.maybe(schema.boolean()) }), + options: { + schema: schema.object({ + version1: schema.string(), + }), + up: (pre: object) => ({ ...pre, version2: 'added' }), + }, }, }, - } as any, - }); - expect(() => - fn(ctx, { - contentTypeId: FOO_CONTENT_ID, - ids: ['123', '456'], - options: { foo: 'bar' }, - }) - ).rejects.toEqual(new Error('[foo]: definition for this key is missing')); - }); + }, + 2: {}, + }; - test('should validate the result if schema is provided', () => { - const { ctx, storage } = setup({ - contentSchemas: { - bulkGet: { - in: { query: fooDataSchema }, - out: { result: schema.object({ validField: schema.maybe(schema.boolean()) }) }, - }, - } as any, + const transforms = getTransforms(definitions, 1); + + // Some smoke tests for the getTransforms() utils. Complete test suite is inside + // the package @kbn/object-versioning + expect(transforms.bulkGet.in.options.up({ version1: 'foo' }).value).toEqual({ + version1: 'foo', + version2: 'added', }); - const invalidResult = { wrongField: 'bad' }; - storage.bulkGet.mockResolvedValueOnce(invalidResult); + const optionsUpTransform = transforms.bulkGet.in.options.up({ version1: 123 }); - expect(() => - fn(ctx, { contentTypeId: FOO_CONTENT_ID, ids: ['123', '456'] }) - ).rejects.toEqual(new Error('[wrongField]: definition for this key is missing')); + expect(optionsUpTransform.value).toBe(null); + expect(optionsUpTransform.error?.message).toBe( + '[version1]: expected value of type [string] but got [number]' + ); + + expect(transforms.bulkGet.in.options.validate({ version1: 123 })?.message).toBe( + '[version1]: expected value of type [string] but got [number]' + ); }); }); }); diff --git a/src/plugins/content_management/server/rpc/procedures/bulk_get.ts b/src/plugins/content_management/server/rpc/procedures/bulk_get.ts index 83de5d7fcedf4..716a3baca90d5 100644 --- a/src/plugins/content_management/server/rpc/procedures/bulk_get.ts +++ b/src/plugins/content_management/server/rpc/procedures/bulk_get.ts @@ -11,45 +11,29 @@ import type { BulkGetIn } from '../../../common'; import type { StorageContext, ContentCrud } from '../../core'; import type { ProcedureDefinition } from '../rpc_service'; import type { Context } from '../types'; -import { validate } from '../../utils'; import { BulkGetResponse } from '../../core/crud'; +import { validateRequestVersion } from './utils'; export const bulkGet: ProcedureDefinition, BulkGetResponse> = { schemas: rpcSchemas.bulkGet, - fn: async (ctx, { contentTypeId, ids, options }) => { + fn: async (ctx, { contentTypeId, version: _version, ids, options }) => { const contentDefinition = ctx.contentRegistry.getDefinition(contentTypeId); - const { bulkGet: schemas } = contentDefinition.schemas.content; - - // Validate the possible options - if (options) { - if (!schemas?.in?.options) { - // TODO: Improve error handling - throw new Error('Schema missing for rpc procedure [bulkGet.in.options].'); - } - const error = validate(options, schemas.in.options); - if (error) { - // TODO: Improve error handling - throw error; - } - } + const version = validateRequestVersion(_version, contentDefinition.version.latest); // Execute CRUD const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(contentTypeId); const storageContext: StorageContext = { requestHandlerContext: ctx.requestHandlerContext, + version: { + request: version, + latest: contentDefinition.version.latest, + }, + utils: { + getTransforms: ctx.getTransformsFactory(contentTypeId), + }, }; const result = await crudInstance.bulkGet(storageContext, ids, options); - // Validate result - const resultSchema = schemas?.out?.result; - if (resultSchema) { - const error = validate(result.items, resultSchema); - if (error) { - // TODO: Improve error handling - throw error; - } - } - return result; }, }; diff --git a/src/plugins/content_management/server/rpc/procedures/create.test.ts b/src/plugins/content_management/server/rpc/procedures/create.test.ts index cb05786f72d5d..6e92501b70c25 100644 --- a/src/plugins/content_management/server/rpc/procedures/create.test.ts +++ b/src/plugins/content_management/server/rpc/procedures/create.test.ts @@ -6,12 +6,15 @@ * Side Public License, v 1. */ +import { omit } from 'lodash'; + import { schema } from '@kbn/config-schema'; +import { ContentManagementServiceDefinitionVersioned } from '@kbn/object-versioning'; import { validate } from '../../utils'; import { ContentRegistry } from '../../core/registry'; import { createMockedStorage } from '../../core/mocks'; -import type { RpcSchemas } from '../../core'; import { EventBus } from '../../core/event_bus'; +import { getServiceObjectTransformFactory } from '../services_transforms_factory'; import { create } from './create'; const { fn, schemas } = create; @@ -28,31 +31,35 @@ if (!outputSchema) { } const FOO_CONTENT_ID = 'foo'; -const fooDataSchema = schema.object({ title: schema.string() }, { unknowns: 'forbid' }); describe('RPC -> create()', () => { describe('Input/Output validation', () => { - /** - * These tests are for the procedure call itself. Every RPC needs to declare in/out schema - * We will test _specific_ validation schema inside the procedure in separate tests. - */ - test('should validate that a contentTypeId and "data" object is passed', () => { + const validInput = { contentTypeId: 'foo', version: 1, data: { title: 'hello' } }; + + test('should validate the input', () => { [ - { input: { contentTypeId: 'foo', data: { title: 'hello' } } }, + { input: validInput }, { - input: { data: { title: 'hello' } }, // contentTypeId missing + input: omit(validInput, 'contentTypeId'), expectedError: '[contentTypeId]: expected value of type [string] but got [undefined]', }, { - input: { contentTypeId: 'foo' }, // data missing + input: omit(validInput, 'version'), + expectedError: '[version]: expected value of type [number] but got [undefined]', + }, + { + input: { ...validInput, version: '1' }, // string number is OK + }, + { + input: omit(validInput, 'data'), expectedError: '[data]: expected value of type [object] but got [undefined]', }, { - input: { contentTypeId: 'foo', data: 123 }, // data is not an object + input: { ...validInput, data: 123 }, // data is not an object expectedError: '[data]: expected value of type [object] but got [number]', }, { - input: { contentTypeId: 'foo', data: { title: 'hello' }, unknown: 'foo' }, + input: { ...validInput, unknown: 'foo' }, expectedError: '[unknown]: definition for this key is missing', }, ].forEach(({ input, expectedError }) => { @@ -75,6 +82,7 @@ describe('RPC -> create()', () => { { contentTypeId: 'foo', data: { title: 'hello' }, + version: 1, options: { any: 'object' }, }, inputSchema @@ -86,6 +94,7 @@ describe('RPC -> create()', () => { { contentTypeId: 'foo', data: { title: 'hello' }, + version: 1, options: 123, // Not an object }, inputSchema @@ -113,29 +122,23 @@ describe('RPC -> create()', () => { }); describe('procedure', () => { - const createSchemas = (): RpcSchemas => { - return { - create: { - in: { - data: fooDataSchema, - }, - }, - } as any; - }; - - const setup = ({ contentSchemas = createSchemas() } = {}) => { + const setup = () => { const contentRegistry = new ContentRegistry(new EventBus()); const storage = createMockedStorage(); contentRegistry.register({ id: FOO_CONTENT_ID, storage, - schemas: { - content: contentSchemas, + version: { + latest: 2, }, }); const requestHandlerContext = 'mockedRequestHandlerContext'; - const ctx: any = { contentRegistry, requestHandlerContext }; + const ctx: any = { + contentRegistry, + requestHandlerContext, + getTransformsFactory: getServiceObjectTransformFactory, + }; return { ctx, storage }; }; @@ -146,7 +149,11 @@ describe('RPC -> create()', () => { const expected = 'CreateResult'; storage.create.mockResolvedValueOnce(expected); - const result = await fn(ctx, { contentTypeId: FOO_CONTENT_ID, data: { title: 'Hello' } }); + const result = await fn(ctx, { + contentTypeId: FOO_CONTENT_ID, + version: 1, + data: { title: 'Hello' }, + }); expect(result).toEqual({ contentTypeId: FOO_CONTENT_ID, @@ -154,7 +161,16 @@ describe('RPC -> create()', () => { }); expect(storage.create).toHaveBeenCalledWith( - { requestHandlerContext: ctx.requestHandlerContext }, + { + requestHandlerContext: ctx.requestHandlerContext, + version: { + request: 1, + latest: 2, // from the registry + }, + utils: { + getTransforms: expect.any(Function), + }, + }, { title: 'Hello' }, undefined ); @@ -168,77 +184,63 @@ describe('RPC -> create()', () => { ).rejects.toEqual(new Error('Content [unknown] is not registered.')); }); - test('should enforce a schema for the data', () => { - const { ctx } = setup({ contentSchemas: {} as any }); - expect(() => fn(ctx, { contentTypeId: FOO_CONTENT_ID, data: {} })).rejects.toEqual( - new Error('Schema missing for rpc procedure [create.in.data].') - ); - }); - - test('should validate the data sent in input - missing field', () => { - const { ctx } = setup(); - expect(() => fn(ctx, { contentTypeId: FOO_CONTENT_ID, data: {} })).rejects.toEqual( - new Error('[title]: expected value of type [string] but got [undefined]') - ); - }); - - test('should validate the data sent in input - unknown field', () => { - const { ctx } = setup(); - expect(() => - fn(ctx, { - contentTypeId: FOO_CONTENT_ID, - data: { title: 'Hello', unknownField: 'Hello' }, - }) - ).rejects.toEqual(new Error('[unknownField]: definition for this key is missing')); - }); - - test('should enforce a schema for options if options are passed', () => { + test('should throw if the request version is higher than the registered version', () => { const { ctx } = setup(); expect(() => fn(ctx, { contentTypeId: FOO_CONTENT_ID, data: { title: 'Hello' }, - options: { foo: 'bar' }, + version: 7, }) - ).rejects.toEqual(new Error('Schema missing for rpc procedure [create.in.options].')); + ).rejects.toEqual(new Error('Invalid version. Latest version is [2].')); }); + }); + + describe('object versioning', () => { + test('should expose a utility to transform and validate services objects', () => { + const { ctx, storage } = setup(); + fn(ctx, { contentTypeId: FOO_CONTENT_ID, data: { title: 'Hello' }, version: 1 }); + const [[storageContext]] = storage.create.mock.calls; + + // getTransforms() utils should be available from context + const { getTransforms } = storageContext.utils ?? {}; + expect(getTransforms).not.toBeUndefined(); - test('should validate the options', () => { - const { ctx } = setup({ - contentSchemas: { + const definitions: ContentManagementServiceDefinitionVersioned = { + 1: { create: { in: { - data: fooDataSchema, - options: schema.object({ validOption: schema.maybe(schema.boolean()) }), + options: { + schema: schema.object({ + version1: schema.string(), + }), + up: (pre: object) => ({ ...pre, version2: 'added' }), + }, }, }, - } as any, - }); - expect(() => - fn(ctx, { - contentTypeId: FOO_CONTENT_ID, - data: { title: 'Hello' }, - options: { foo: 'bar' }, - }) - ).rejects.toEqual(new Error('[foo]: definition for this key is missing')); - }); + }, + 2: {}, + }; - test('should validate the result if schema is provided', () => { - const { ctx, storage } = setup({ - contentSchemas: { - create: { - in: { data: fooDataSchema }, - out: { result: schema.object({ validField: schema.maybe(schema.boolean()) }) }, - }, - } as any, + const transforms = getTransforms(definitions, 1); + + // Some smoke tests for the getTransforms() utils. Complete test suite is inside + // the package @kbn/object-versioning + expect(transforms.create.in.options.up({ version1: 'foo' }).value).toEqual({ + version1: 'foo', + version2: 'added', }); - const invalidResult = { wrongField: 'bad' }; - storage.create.mockResolvedValueOnce(invalidResult); + const optionsUpTransform = transforms.create.in.options.up({ version1: 123 }); - expect(() => - fn(ctx, { contentTypeId: FOO_CONTENT_ID, data: { title: 'Hello' } }) - ).rejects.toEqual(new Error('[wrongField]: definition for this key is missing')); + expect(optionsUpTransform.value).toBe(null); + expect(optionsUpTransform.error?.message).toBe( + '[version1]: expected value of type [string] but got [number]' + ); + + expect(transforms.create.in.options.validate({ version1: 123 })?.message).toBe( + '[version1]: expected value of type [string] but got [number]' + ); }); }); }); diff --git a/src/plugins/content_management/server/rpc/procedures/create.ts b/src/plugins/content_management/server/rpc/procedures/create.ts index 9ff7a55fe560c..e56b60477ae5a 100644 --- a/src/plugins/content_management/server/rpc/procedures/create.ts +++ b/src/plugins/content_management/server/rpc/procedures/create.ts @@ -11,55 +11,27 @@ import type { CreateIn } from '../../../common'; import type { StorageContext, ContentCrud } from '../../core'; import type { ProcedureDefinition } from '../rpc_service'; import type { Context } from '../types'; -import { validate } from '../../utils'; +import { validateRequestVersion } from './utils'; export const create: ProcedureDefinition> = { schemas: rpcSchemas.create, - fn: async (ctx, input) => { - const contentDefinition = ctx.contentRegistry.getDefinition(input.contentTypeId); - const { create: schemas } = contentDefinition.schemas.content; - - // Validate data to be stored - if (schemas?.in?.data) { - const error = validate(input.data, schemas.in.data); - if (error) { - // TODO: Improve error handling - throw error; - } - } else { - // TODO: Improve error handling - throw new Error('Schema missing for rpc procedure [create.in.data].'); - } - - // Validate the possible options - if (input.options) { - if (!schemas.in?.options) { - // TODO: Improve error handling - throw new Error('Schema missing for rpc procedure [create.in.options].'); - } - const error = validate(input.options, schemas.in.options); - if (error) { - // TODO: Improve error handling - throw error; - } - } + fn: async (ctx, { contentTypeId, version: _version, data, options }) => { + const contentDefinition = ctx.contentRegistry.getDefinition(contentTypeId); + const version = validateRequestVersion(_version, contentDefinition.version.latest); // Execute CRUD - const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(input.contentTypeId); + const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(contentTypeId); const storageContext: StorageContext = { requestHandlerContext: ctx.requestHandlerContext, + version: { + request: version, + latest: contentDefinition.version.latest, + }, + utils: { + getTransforms: ctx.getTransformsFactory(contentTypeId), + }, }; - const result = await crudInstance.create(storageContext, input.data, input.options); - - // Validate result - const resultSchema = schemas.out?.result; - if (resultSchema) { - const error = validate(result.result, resultSchema); - if (error) { - // TODO: Improve error handling - throw error; - } - } + const result = await crudInstance.create(storageContext, data, options); return result; }, diff --git a/src/plugins/content_management/server/rpc/procedures/delete.test.ts b/src/plugins/content_management/server/rpc/procedures/delete.test.ts index 9b89adc790197..0d227be530453 100644 --- a/src/plugins/content_management/server/rpc/procedures/delete.test.ts +++ b/src/plugins/content_management/server/rpc/procedures/delete.test.ts @@ -6,12 +6,15 @@ * Side Public License, v 1. */ +import { omit } from 'lodash'; + +import { ContentManagementServiceDefinitionVersioned } from '@kbn/object-versioning'; import { schema } from '@kbn/config-schema'; import { validate } from '../../utils'; import { ContentRegistry } from '../../core/registry'; import { createMockedStorage } from '../../core/mocks'; -import type { RpcSchemas } from '../../core'; import { EventBus } from '../../core/event_bus'; +import { getServiceObjectTransformFactory } from '../services_transforms_factory'; import { deleteProc } from './delete'; const { fn, schemas } = deleteProc; @@ -31,25 +34,30 @@ const FOO_CONTENT_ID = 'foo'; describe('RPC -> delete()', () => { describe('Input/Output validation', () => { - /** - * These tests are for the procedure call itself. Every RPC needs to declare in/out schema - * We will test _specific_ validation schema inside the procedure in separate tests. - */ + const validInput = { contentTypeId: 'foo', id: '123', version: 1 }; + test('should validate that a contentTypeId and an id is passed', () => { [ - { input: { contentTypeId: 'foo', id: '123' } }, + { input: validInput }, { - input: { id: '777' }, // contentTypeId missing + input: omit(validInput, 'contentTypeId'), expectedError: '[contentTypeId]: expected value of type [string] but got [undefined]', }, { - input: { contentTypeId: 'foo', id: '123', unknown: 'foo' }, + input: { ...validInput, unknown: 'foo' }, expectedError: '[unknown]: definition for this key is missing', }, { - input: { contentTypeId: 'foo', id: '' }, // id must have min 1 char + input: { ...validInput, id: '' }, // id must have min 1 char expectedError: '[id]: value has length [0] but it must have a minimum length of [1].', }, + { + input: omit(validInput, 'version'), + expectedError: '[version]: expected value of type [number] but got [undefined]', + }, + { + input: { ...validInput, version: '1' }, // string number is OK + }, ].forEach(({ input, expectedError }) => { const error = validate(input, inputSchema); @@ -70,6 +78,7 @@ describe('RPC -> delete()', () => { { contentTypeId: 'foo', id: '123', + version: 1, options: { any: 'object' }, }, inputSchema @@ -81,6 +90,7 @@ describe('RPC -> delete()', () => { { contentTypeId: 'foo', id: '123', + version: 1, options: 123, // Not an object }, inputSchema @@ -108,23 +118,23 @@ describe('RPC -> delete()', () => { }); describe('procedure', () => { - const createSchemas = (): RpcSchemas => { - return {} as any; - }; - - const setup = ({ contentSchemas = createSchemas() } = {}) => { + const setup = () => { const contentRegistry = new ContentRegistry(new EventBus()); const storage = createMockedStorage(); contentRegistry.register({ id: FOO_CONTENT_ID, storage, - schemas: { - content: contentSchemas, + version: { + latest: 2, }, }); const requestHandlerContext = 'mockedRequestHandlerContext'; - const ctx: any = { contentRegistry, requestHandlerContext }; + const ctx: any = { + contentRegistry, + requestHandlerContext, + getTransformsFactory: getServiceObjectTransformFactory, + }; return { ctx, storage }; }; @@ -135,7 +145,7 @@ describe('RPC -> delete()', () => { const expected = 'DeleteResult'; storage.delete.mockResolvedValueOnce(expected); - const result = await fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '1234' }); + const result = await fn(ctx, { contentTypeId: FOO_CONTENT_ID, version: 1, id: '1234' }); expect(result).toEqual({ contentTypeId: FOO_CONTENT_ID, @@ -143,7 +153,16 @@ describe('RPC -> delete()', () => { }); expect(storage.delete).toHaveBeenCalledWith( - { requestHandlerContext: ctx.requestHandlerContext }, + { + requestHandlerContext: ctx.requestHandlerContext, + version: { + request: 1, + latest: 2, // from the registry + }, + utils: { + getTransforms: expect.any(Function), + }, + }, '1234', undefined ); @@ -157,42 +176,62 @@ describe('RPC -> delete()', () => { ); }); - test('should enforce a schema for options if options are passed', () => { + test('should throw if the request version is higher than the registered version', () => { const { ctx } = setup(); expect(() => - fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '1234', options: { foo: 'bar' } }) - ).rejects.toEqual(new Error('Schema missing for rpc procedure [delete.in.options].')); + fn(ctx, { + contentTypeId: FOO_CONTENT_ID, + id: '1234', + version: 7, + }) + ).rejects.toEqual(new Error('Invalid version. Latest version is [2].')); }); + }); - test('should validate the options', () => { - const { ctx } = setup({ - contentSchemas: { + describe('object versioning', () => { + test('should expose a utility to transform and validate services objects', () => { + const { ctx, storage } = setup(); + fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '1234', version: 1 }); + const [[storageContext]] = storage.delete.mock.calls; + + // getTransforms() utils should be available from context + const { getTransforms } = storageContext.utils ?? {}; + expect(getTransforms).not.toBeUndefined(); + + const definitions: ContentManagementServiceDefinitionVersioned = { + 1: { delete: { in: { - options: schema.object({ validOption: schema.maybe(schema.boolean()) }), + options: { + schema: schema.object({ + version1: schema.string(), + }), + up: (pre: object) => ({ ...pre, version2: 'added' }), + }, }, }, - } as any, - }); - expect(() => - fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '1234', options: { foo: 'bar' } }) - ).rejects.toEqual(new Error('[foo]: definition for this key is missing')); - }); + }, + 2: {}, + }; - test('should validate the result if schema is provided', () => { - const { ctx, storage } = setup({ - contentSchemas: { - delete: { - out: { result: schema.object({ validField: schema.maybe(schema.boolean()) }) }, - }, - } as any, + const transforms = getTransforms(definitions, 1); + + // Some smoke tests for the getTransforms() utils. Complete test suite is inside + // the package @kbn/object-versioning + expect(transforms.delete.in.options.up({ version1: 'foo' }).value).toEqual({ + version1: 'foo', + version2: 'added', }); - const invalidResult = { wrongField: 'bad' }; - storage.delete.mockResolvedValueOnce(invalidResult); + const optionsUpTransform = transforms.delete.in.options.up({ version1: 123 }); + + expect(optionsUpTransform.value).toBe(null); + expect(optionsUpTransform.error?.message).toBe( + '[version1]: expected value of type [string] but got [number]' + ); - expect(() => fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '1234' })).rejects.toEqual( - new Error('[wrongField]: definition for this key is missing') + expect(transforms.delete.in.options.validate({ version1: 123 })?.message).toBe( + '[version1]: expected value of type [string] but got [number]' ); }); }); diff --git a/src/plugins/content_management/server/rpc/procedures/delete.ts b/src/plugins/content_management/server/rpc/procedures/delete.ts index 6260b54468039..f01b85b51deec 100644 --- a/src/plugins/content_management/server/rpc/procedures/delete.ts +++ b/src/plugins/content_management/server/rpc/procedures/delete.ts @@ -10,43 +10,28 @@ import type { DeleteIn } from '../../../common'; import type { StorageContext, ContentCrud } from '../../core'; import type { ProcedureDefinition } from '../rpc_service'; import type { Context } from '../types'; -import { validate } from '../../utils'; +import { validateRequestVersion } from './utils'; export const deleteProc: ProcedureDefinition> = { schemas: rpcSchemas.delete, - fn: async (ctx, { contentTypeId, id, options }) => { + fn: async (ctx, { contentTypeId, id, version: _version, options }) => { const contentDefinition = ctx.contentRegistry.getDefinition(contentTypeId); - const { delete: schemas } = contentDefinition.schemas.content; - - if (options) { - // Validate the options provided - if (!schemas?.in?.options) { - throw new Error(`Schema missing for rpc procedure [delete.in.options].`); - } - const error = validate(options, schemas.in.options); - if (error) { - // TODO: Improve error handling - throw error; - } - } + const version = validateRequestVersion(_version, contentDefinition.version.latest); // Execute CRUD const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(contentTypeId); const storageContext: StorageContext = { requestHandlerContext: ctx.requestHandlerContext, + version: { + request: version, + latest: contentDefinition.version.latest, + }, + utils: { + getTransforms: ctx.getTransformsFactory(contentTypeId), + }, }; const result = await crudInstance.delete(storageContext, id, options); - // Validate result - const resultSchema = schemas?.out?.result; - if (resultSchema) { - const error = validate(result.result, resultSchema); - if (error) { - // TODO: Improve error handling - throw error; - } - } - return result; }, }; diff --git a/src/plugins/content_management/server/rpc/procedures/get.test.ts b/src/plugins/content_management/server/rpc/procedures/get.test.ts index d3214faaa1e9c..e6934fb7123a0 100644 --- a/src/plugins/content_management/server/rpc/procedures/get.test.ts +++ b/src/plugins/content_management/server/rpc/procedures/get.test.ts @@ -6,12 +6,15 @@ * Side Public License, v 1. */ +import { omit } from 'lodash'; + import { schema } from '@kbn/config-schema'; +import { ContentManagementServiceDefinitionVersioned } from '@kbn/object-versioning'; import { validate } from '../../utils'; import { ContentRegistry } from '../../core/registry'; import { createMockedStorage } from '../../core/mocks'; -import type { RpcSchemas } from '../../core'; import { EventBus } from '../../core/event_bus'; +import { getServiceObjectTransformFactory } from '../services_transforms_factory'; import { get } from './get'; const { fn, schemas } = get; @@ -31,25 +34,30 @@ const FOO_CONTENT_ID = 'foo'; describe('RPC -> get()', () => { describe('Input/Output validation', () => { - /** - * These tests are for the procedure call itself. Every RPC needs to declare in/out schema - * We will test _specific_ validation schema inside the procedure in separate tests. - */ + const validInput = { contentTypeId: 'foo', id: '123', version: 1 }; + test('should validate that a contentTypeId and an id is passed', () => { [ - { input: { contentTypeId: 'foo', id: '123' } }, + { input: validInput }, { - input: { id: '777' }, // contentTypeId missing + input: omit(validInput, 'contentTypeId'), expectedError: '[contentTypeId]: expected value of type [string] but got [undefined]', }, { - input: { contentTypeId: 'foo', id: '123', unknown: 'foo' }, + input: { ...validInput, unknown: 'foo' }, expectedError: '[unknown]: definition for this key is missing', }, { - input: { contentTypeId: 'foo', id: '' }, // id must have min 1 char + input: { ...validInput, id: '' }, // id must have min 1 char expectedError: '[id]: value has length [0] but it must have a minimum length of [1].', }, + { + input: omit(validInput, 'version'), + expectedError: '[version]: expected value of type [number] but got [undefined]', + }, + { + input: { ...validInput, version: '1' }, // string number is OK + }, ].forEach(({ input, expectedError }) => { const error = validate(input, inputSchema); @@ -70,6 +78,7 @@ describe('RPC -> get()', () => { { contentTypeId: 'foo', id: '123', + version: 1, options: { any: 'object' }, }, inputSchema @@ -81,6 +90,7 @@ describe('RPC -> get()', () => { { contentTypeId: 'foo', id: '123', + version: 1, options: 123, // Not an object }, inputSchema @@ -108,23 +118,23 @@ describe('RPC -> get()', () => { }); describe('procedure', () => { - const createSchemas = (): RpcSchemas => { - return {} as any; - }; - - const setup = ({ contentSchemas = createSchemas() } = {}) => { + const setup = () => { const contentRegistry = new ContentRegistry(new EventBus()); const storage = createMockedStorage(); contentRegistry.register({ id: FOO_CONTENT_ID, storage, - schemas: { - content: contentSchemas, + version: { + latest: 2, }, }); const requestHandlerContext = 'mockedRequestHandlerContext'; - const ctx: any = { contentRegistry, requestHandlerContext }; + const ctx: any = { + contentRegistry, + requestHandlerContext, + getTransformsFactory: getServiceObjectTransformFactory, + }; return { ctx, storage }; }; @@ -135,7 +145,7 @@ describe('RPC -> get()', () => { const expected = 'GetResult'; storage.get.mockResolvedValueOnce(expected); - const result = await fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '1234' }); + const result = await fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '1234', version: 1 }); expect(result).toEqual({ contentTypeId: FOO_CONTENT_ID, @@ -143,7 +153,16 @@ describe('RPC -> get()', () => { }); expect(storage.get).toHaveBeenCalledWith( - { requestHandlerContext: ctx.requestHandlerContext }, + { + requestHandlerContext: ctx.requestHandlerContext, + version: { + request: 1, + latest: 2, // from the registry + }, + utils: { + getTransforms: expect.any(Function), + }, + }, '1234', undefined ); @@ -157,42 +176,62 @@ describe('RPC -> get()', () => { ); }); - test('should enforce a schema for options if options are passed', () => { + test('should throw if the request version is higher than the registered version', () => { const { ctx } = setup(); expect(() => - fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '1234', options: { foo: 'bar' } }) - ).rejects.toEqual(new Error('Schema missing for rpc procedure [get.in.options].')); + fn(ctx, { + contentTypeId: FOO_CONTENT_ID, + id: '1234', + version: 7, + }) + ).rejects.toEqual(new Error('Invalid version. Latest version is [2].')); }); + }); - test('should validate the options', () => { - const { ctx } = setup({ - contentSchemas: { + describe('object versioning', () => { + test('should expose a utility to transform and validate services objects', () => { + const { ctx, storage } = setup(); + fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '1234', version: 1 }); + const [[storageContext]] = storage.get.mock.calls; + + // getTransforms() utils should be available from context + const { getTransforms } = storageContext.utils ?? {}; + expect(getTransforms).not.toBeUndefined(); + + const definitions: ContentManagementServiceDefinitionVersioned = { + 1: { get: { in: { - options: schema.object({ validOption: schema.maybe(schema.boolean()) }), + options: { + schema: schema.object({ + version1: schema.string(), + }), + up: (pre: object) => ({ ...pre, version2: 'added' }), + }, }, }, - } as any, - }); - expect(() => - fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '1234', options: { foo: 'bar' } }) - ).rejects.toEqual(new Error('[foo]: definition for this key is missing')); - }); + }, + 2: {}, + }; - test('should validate the result if schema is provided', () => { - const { ctx, storage } = setup({ - contentSchemas: { - get: { - out: { result: schema.object({ validField: schema.maybe(schema.boolean()) }) }, - }, - } as any, + const transforms = getTransforms(definitions, 1); + + // Some smoke tests for the getTransforms() utils. Complete test suite is inside + // the package @kbn/object-versioning + expect(transforms.get.in.options.up({ version1: 'foo' }).value).toEqual({ + version1: 'foo', + version2: 'added', }); - const invalidResult = { wrongField: 'bad' }; - storage.get.mockResolvedValueOnce(invalidResult); + const optionsUpTransform = transforms.get.in.options.up({ version1: 123 }); + + expect(optionsUpTransform.value).toBe(null); + expect(optionsUpTransform.error?.message).toBe( + '[version1]: expected value of type [string] but got [number]' + ); - expect(() => fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '1234' })).rejects.toEqual( - new Error('[wrongField]: definition for this key is missing') + expect(transforms.get.in.options.validate({ version1: 123 })?.message).toBe( + '[version1]: expected value of type [string] but got [number]' ); }); }); diff --git a/src/plugins/content_management/server/rpc/procedures/get.ts b/src/plugins/content_management/server/rpc/procedures/get.ts index 536263b0e9d15..00ac0bf59a627 100644 --- a/src/plugins/content_management/server/rpc/procedures/get.ts +++ b/src/plugins/content_management/server/rpc/procedures/get.ts @@ -9,44 +9,29 @@ import { rpcSchemas } from '../../../common/schemas'; import type { GetIn } from '../../../common'; import type { ContentCrud, StorageContext } from '../../core'; -import { validate } from '../../utils'; import type { ProcedureDefinition } from '../rpc_service'; import type { Context } from '../types'; +import { validateRequestVersion } from './utils'; export const get: ProcedureDefinition> = { schemas: rpcSchemas.get, - fn: async (ctx, input) => { - const contentDefinition = ctx.contentRegistry.getDefinition(input.contentTypeId); - const { get: schemas } = contentDefinition.schemas.content; - - if (input.options) { - // Validate the options provided - if (!schemas?.in?.options) { - throw new Error(`Schema missing for rpc procedure [get.in.options].`); - } - const error = validate(input.options, schemas.in.options); - if (error) { - // TODO: Improve error handling - throw error; - } - } + fn: async (ctx, { contentTypeId, id, version: _version, options }) => { + const contentDefinition = ctx.contentRegistry.getDefinition(contentTypeId); + const version = validateRequestVersion(_version, contentDefinition.version.latest); // Execute CRUD - const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(input.contentTypeId); + const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(contentTypeId); const storageContext: StorageContext = { requestHandlerContext: ctx.requestHandlerContext, + version: { + request: version, + latest: contentDefinition.version.latest, + }, + utils: { + getTransforms: ctx.getTransformsFactory(contentTypeId), + }, }; - const result = await crudInstance.get(storageContext, input.id, input.options); - - // Validate result - const resultSchema = schemas?.out?.result; - if (resultSchema) { - const error = validate(result.item, resultSchema); - if (error) { - // TODO: Improve error handling - throw error; - } - } + const result = await crudInstance.get(storageContext, id, options); return result; }, diff --git a/src/plugins/content_management/server/rpc/procedures/search.test.ts b/src/plugins/content_management/server/rpc/procedures/search.test.ts index 5f5f2e167ac3f..c96a9f304aa55 100644 --- a/src/plugins/content_management/server/rpc/procedures/search.test.ts +++ b/src/plugins/content_management/server/rpc/procedures/search.test.ts @@ -6,13 +6,16 @@ * Side Public License, v 1. */ -import { schema } from '@kbn/config-schema'; +import { omit } from 'lodash'; + import { validate } from '../../utils'; import { ContentRegistry } from '../../core/registry'; import { createMockedStorage } from '../../core/mocks'; -import type { RpcSchemas } from '../../core'; import { EventBus } from '../../core/event_bus'; import { search } from './search'; +import { ContentManagementServiceDefinitionVersioned } from '@kbn/object-versioning'; +import { schema } from '@kbn/config-schema'; +import { getServiceObjectTransformFactory } from '../services_transforms_factory'; const { fn, schemas } = search; @@ -28,33 +31,40 @@ if (!outputSchema) { } const FOO_CONTENT_ID = 'foo'; -const fooDataSchema = schema.object({ title: schema.string() }, { unknowns: 'forbid' }); describe('RPC -> search()', () => { describe('Input/Output validation', () => { - /** - * These tests are for the procedure call itself. Every RPC needs to declare in/out schema - * We will test _specific_ validation schema inside the procedure in separate tests. - */ - test('should validate that a contentTypeId and "query" object is passed', () => { - const query = { title: 'hello' }; + const query = { title: 'hello' }; + const validInput = { contentTypeId: 'foo', version: 1, query }; + test('should validate that a contentTypeId and "query" object is passed', () => { [ - { input: { contentTypeId: 'foo', query } }, + { input: validInput }, { input: { query }, // contentTypeId missing expectedError: '[contentTypeId]: expected value of type [string] but got [undefined]', }, { - input: { contentTypeId: 'foo' }, // query missing + input: omit(validInput, 'version'), + expectedError: '[version]: expected value of type [number] but got [undefined]', + }, + { + input: { ...validInput, version: '1' }, // string number is OK + }, + { + input: { ...validInput, version: 'foo' }, // invalid version format + expectedError: '[version]: expected value of type [number] but got [string]', + }, + { + input: omit(validInput, 'query'), expectedError: '[query]: expected value of type [object] but got [undefined]', }, { - input: { contentTypeId: 'foo', query: 123 }, // query is not an object + input: { ...validInput, query: 123 }, // query is not an object expectedError: '[query]: expected value of type [object] but got [number]', }, { - input: { contentTypeId: 'foo', query, unknown: 'foo' }, + input: { ...validInput, unknown: 'foo' }, expectedError: '[unknown]: definition for this key is missing', }, ].forEach(({ input, expectedError }) => { @@ -77,6 +87,7 @@ describe('RPC -> search()', () => { { contentTypeId: 'foo', query: { title: 'hello' }, + version: 1, options: { any: 'object' }, }, inputSchema @@ -87,6 +98,7 @@ describe('RPC -> search()', () => { error = validate( { contentTypeId: 'foo', + version: 1, query: { title: 'hello' }, options: 123, // Not an object }, @@ -129,29 +141,23 @@ describe('RPC -> search()', () => { }); describe('procedure', () => { - const createSchemas = (): RpcSchemas => { - return { - search: { - in: { - query: fooDataSchema, - }, - }, - } as any; - }; - - const setup = ({ contentSchemas = createSchemas() } = {}) => { + const setup = () => { const contentRegistry = new ContentRegistry(new EventBus()); const storage = createMockedStorage(); contentRegistry.register({ id: FOO_CONTENT_ID, storage, - schemas: { - content: contentSchemas, + version: { + latest: 2, }, }); const requestHandlerContext = 'mockedRequestHandlerContext'; - const ctx: any = { contentRegistry, requestHandlerContext }; + const ctx: any = { + contentRegistry, + requestHandlerContext, + getTransformsFactory: getServiceObjectTransformFactory, + }; return { ctx, storage }; }; @@ -162,7 +168,11 @@ describe('RPC -> search()', () => { const expected = 'SearchResult'; storage.search.mockResolvedValueOnce(expected); - const result = await fn(ctx, { contentTypeId: FOO_CONTENT_ID, query: { title: 'Hello' } }); + const result = await fn(ctx, { + contentTypeId: FOO_CONTENT_ID, + version: 1, // version in request + query: { title: 'Hello' }, + }); expect(result).toEqual({ contentTypeId: FOO_CONTENT_ID, @@ -170,7 +180,16 @@ describe('RPC -> search()', () => { }); expect(storage.search).toHaveBeenCalledWith( - { requestHandlerContext: ctx.requestHandlerContext }, + { + requestHandlerContext: ctx.requestHandlerContext, + version: { + request: 1, + latest: 2, // from the registry + }, + utils: { + getTransforms: expect.any(Function), + }, + }, { title: 'Hello' }, undefined ); @@ -184,77 +203,63 @@ describe('RPC -> search()', () => { ).rejects.toEqual(new Error('Content [unknown] is not registered.')); }); - test('should enforce a schema for the query', () => { - const { ctx } = setup({ contentSchemas: {} as any }); - expect(() => fn(ctx, { contentTypeId: FOO_CONTENT_ID, query: {} })).rejects.toEqual( - new Error('Schema missing for rpc procedure [search.in.query].') - ); - }); - - test('should validate the query sent in input - missing field', () => { - const { ctx } = setup(); - expect(() => fn(ctx, { contentTypeId: FOO_CONTENT_ID, query: {} })).rejects.toEqual( - new Error('[title]: expected value of type [string] but got [undefined]') - ); - }); - - test('should validate the query sent in input - unknown field', () => { - const { ctx } = setup(); - expect(() => - fn(ctx, { - contentTypeId: FOO_CONTENT_ID, - query: { title: 'Hello', unknownField: 'Hello' }, - }) - ).rejects.toEqual(new Error('[unknownField]: definition for this key is missing')); - }); - - test('should enforce a schema for options if options are passed', () => { + test('should throw if the request version is higher than the registered version', () => { const { ctx } = setup(); expect(() => fn(ctx, { contentTypeId: FOO_CONTENT_ID, query: { title: 'Hello' }, - options: { foo: 'bar' }, + version: 7, }) - ).rejects.toEqual(new Error('Schema missing for rpc procedure [search.in.options].')); + ).rejects.toEqual(new Error('Invalid version. Latest version is [2].')); }); + }); + + describe('object versioning', () => { + test('should expose a utility to transform and validate services objects', () => { + const { ctx, storage } = setup(); + fn(ctx, { contentTypeId: FOO_CONTENT_ID, query: { title: 'Hello' }, version: 1 }); + const [[storageContext]] = storage.search.mock.calls; - test('should validate the options', () => { - const { ctx } = setup({ - contentSchemas: { + // getTransforms() utils should be available from context + const { getTransforms } = storageContext.utils ?? {}; + expect(getTransforms).not.toBeUndefined(); + + const definitions: ContentManagementServiceDefinitionVersioned = { + 1: { search: { in: { - query: fooDataSchema, - options: schema.object({ validOption: schema.maybe(schema.boolean()) }), + options: { + schema: schema.object({ + version1: schema.string(), + }), + up: (pre: object) => ({ ...pre, version2: 'added' }), + }, }, }, - } as any, - }); - expect(() => - fn(ctx, { - contentTypeId: FOO_CONTENT_ID, - query: { title: 'Hello' }, - options: { foo: 'bar' }, - }) - ).rejects.toEqual(new Error('[foo]: definition for this key is missing')); - }); + }, + 2: {}, + }; - test('should validate the result if schema is provided', () => { - const { ctx, storage } = setup({ - contentSchemas: { - search: { - in: { query: fooDataSchema }, - out: { result: schema.object({ validField: schema.maybe(schema.boolean()) }) }, - }, - } as any, + const transforms = getTransforms(definitions, 1); + + // Some smoke tests for the getTransforms() utils. Complete test suite is inside + // the package @kbn/object-versioning + expect(transforms.search.in.options.up({ version1: 'foo' }).value).toEqual({ + version1: 'foo', + version2: 'added', }); - const invalidResult = { wrongField: 'bad' }; - storage.search.mockResolvedValueOnce(invalidResult); + const optionsUpTransform = transforms.search.in.options.up({ version1: 123 }); - expect(() => - fn(ctx, { contentTypeId: FOO_CONTENT_ID, query: { title: 'Hello' } }) - ).rejects.toEqual(new Error('[wrongField]: definition for this key is missing')); + expect(optionsUpTransform.value).toBe(null); + expect(optionsUpTransform.error?.message).toBe( + '[version1]: expected value of type [string] but got [number]' + ); + + expect(transforms.search.in.options.validate({ version1: 123 })?.message).toBe( + '[version1]: expected value of type [string] but got [number]' + ); }); }); }); diff --git a/src/plugins/content_management/server/rpc/procedures/search.ts b/src/plugins/content_management/server/rpc/procedures/search.ts index c0fa0b2c807dc..52e971ec041b2 100644 --- a/src/plugins/content_management/server/rpc/procedures/search.ts +++ b/src/plugins/content_management/server/rpc/procedures/search.ts @@ -11,56 +11,28 @@ import type { SearchIn } from '../../../common'; import type { StorageContext, ContentCrud } from '../../core'; import type { ProcedureDefinition } from '../rpc_service'; import type { Context } from '../types'; -import { validate } from '../../utils'; +import { validateRequestVersion } from './utils'; export const search: ProcedureDefinition> = { schemas: rpcSchemas.search, - fn: async (ctx, { contentTypeId, query, options }) => { + fn: async (ctx, { contentTypeId, version: _version, query, options }) => { const contentDefinition = ctx.contentRegistry.getDefinition(contentTypeId); - const { search: schemas } = contentDefinition.schemas.content; - - // Validate query to execute - if (schemas?.in?.query) { - const error = validate(query, schemas.in.query); - if (error) { - // TODO: Improve error handling - throw error; - } - } else { - // TODO: Improve error handling - throw new Error('Schema missing for rpc procedure [search.in.query].'); - } - - // Validate the possible options - if (options) { - if (!schemas.in?.options) { - // TODO: Improve error handling - throw new Error('Schema missing for rpc procedure [search.in.options].'); - } - const error = validate(options, schemas.in.options); - if (error) { - // TODO: Improve error handling - throw error; - } - } + const version = validateRequestVersion(_version, contentDefinition.version.latest); // Execute CRUD const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(contentTypeId); const storageContext: StorageContext = { requestHandlerContext: ctx.requestHandlerContext, + version: { + request: version, + latest: contentDefinition.version.latest, + }, + utils: { + getTransforms: ctx.getTransformsFactory(contentTypeId), + }, }; const result = await crudInstance.search(storageContext, query, options); - // Validate result - const resultSchema = schemas.out?.result; - if (resultSchema) { - const error = validate(result.result, resultSchema); - if (error) { - // TODO: Improve error handling - throw error; - } - } - return result; }, }; diff --git a/src/plugins/content_management/server/rpc/procedures/update.test.ts b/src/plugins/content_management/server/rpc/procedures/update.test.ts index 316456e2dd629..ef00f2bbe1435 100644 --- a/src/plugins/content_management/server/rpc/procedures/update.test.ts +++ b/src/plugins/content_management/server/rpc/procedures/update.test.ts @@ -6,12 +6,15 @@ * Side Public License, v 1. */ +import { omit } from 'lodash'; + import { schema } from '@kbn/config-schema'; +import { ContentManagementServiceDefinitionVersioned } from '@kbn/object-versioning'; import { validate } from '../../utils'; import { ContentRegistry } from '../../core/registry'; import { createMockedStorage } from '../../core/mocks'; -import type { RpcSchemas } from '../../core'; import { EventBus } from '../../core/event_bus'; +import { getServiceObjectTransformFactory } from '../services_transforms_factory'; import { update } from './update'; const { fn, schemas } = update; @@ -28,41 +31,44 @@ if (!outputSchema) { } const FOO_CONTENT_ID = 'foo'; -const fooDataSchema = schema.object({ title: schema.string() }, { unknowns: 'forbid' }); describe('RPC -> update()', () => { describe('Input/Output validation', () => { - /** - * These tests are for the procedure call itself. Every RPC needs to declare in/out schema - * We will test _specific_ validation schema inside the procedure suite below. - */ - test('should validate that a "contentTypeId", an "id" and "data" object is passed', () => { - const data = { title: 'hello' }; + const data = { title: 'hello' }; + const validInput = { contentTypeId: 'foo', id: '123', version: 1, data }; + test('should validate that a "contentTypeId", an "id" and "data" object is passed', () => { [ - { input: { contentTypeId: 'foo', id: '123', data } }, + { input: validInput }, { - input: { id: '123', data }, // contentTypeId missing + input: omit(validInput, 'contentTypeId'), expectedError: '[contentTypeId]: expected value of type [string] but got [undefined]', }, { - input: { contentTypeId: 'foo', data }, // id missing + input: omit(validInput, 'id'), expectedError: '[id]: expected value of type [string] but got [undefined]', }, { - input: { contentTypeId: 'foo', id: '' }, // id must have min 1 char + input: { ...validInput, id: '' }, // id must have min 1 char expectedError: '[id]: value has length [0] but it must have a minimum length of [1].', }, { - input: { contentTypeId: 'foo', id: '123' }, // data missing + input: omit(validInput, 'version'), + expectedError: '[version]: expected value of type [number] but got [undefined]', + }, + { + input: { ...validInput, version: '1' }, // string number is OK + }, + { + input: omit(validInput, 'data'), expectedError: '[data]: expected value of type [object] but got [undefined]', }, { - input: { contentTypeId: 'foo', id: '123', data: 123 }, // data is not an object + input: { ...validInput, data: 123 }, // data is not an object expectedError: '[data]: expected value of type [object] but got [number]', }, { - input: { contentTypeId: 'foo', id: '123', data, unknown: 'foo' }, + input: { ...validInput, unknown: 'foo' }, expectedError: '[unknown]: definition for this key is missing', }, ].forEach(({ input, expectedError }) => { @@ -81,6 +87,7 @@ describe('RPC -> update()', () => { { contentTypeId: 'foo', id: '123', + version: 1, data: { title: 'hello' }, options: { any: 'object' }, }, @@ -94,6 +101,7 @@ describe('RPC -> update()', () => { contentTypeId: 'foo', data: { title: 'hello' }, id: '123', + version: 1, options: 123, // Not an object }, inputSchema @@ -121,29 +129,23 @@ describe('RPC -> update()', () => { }); describe('procedure', () => { - const createSchemas = (): RpcSchemas => { - return { - update: { - in: { - data: fooDataSchema, - }, - }, - } as any; - }; - - const setup = ({ contentSchemas = createSchemas() } = {}) => { + const setup = () => { const contentRegistry = new ContentRegistry(new EventBus()); const storage = createMockedStorage(); contentRegistry.register({ id: FOO_CONTENT_ID, storage, - schemas: { - content: contentSchemas, + version: { + latest: 2, }, }); const requestHandlerContext = 'mockedRequestHandlerContext'; - const ctx: any = { contentRegistry, requestHandlerContext }; + const ctx: any = { + contentRegistry, + requestHandlerContext, + getTransformsFactory: getServiceObjectTransformFactory, + }; return { ctx, storage }; }; @@ -157,6 +159,7 @@ describe('RPC -> update()', () => { const result = await fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '123', + version: 1, data: { title: 'Hello' }, }); @@ -166,7 +169,16 @@ describe('RPC -> update()', () => { }); expect(storage.update).toHaveBeenCalledWith( - { requestHandlerContext: ctx.requestHandlerContext }, + { + requestHandlerContext: ctx.requestHandlerContext, + version: { + request: 1, + latest: 2, // from the registry + }, + utils: { + getTransforms: expect.any(Function), + }, + }, '123', { title: 'Hello' }, undefined @@ -181,82 +193,69 @@ describe('RPC -> update()', () => { ).rejects.toEqual(new Error('Content [unknown] is not registered.')); }); - test('should enforce a schema for the data', () => { - const { ctx } = setup({ contentSchemas: {} as any }); - expect(() => - fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '123', data: {} }) - ).rejects.toEqual(new Error('Schema missing for rpc procedure [update.in.data].')); - }); - - test('should validate the data sent in input - missing field', () => { - const { ctx } = setup(); - expect(() => - fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '123', data: {} }) - ).rejects.toEqual( - new Error('[title]: expected value of type [string] but got [undefined]') - ); - }); - - test('should validate the data sent in input - unknown field', () => { - const { ctx } = setup(); - expect(() => - fn(ctx, { - contentTypeId: FOO_CONTENT_ID, - id: '123', - data: { title: 'Hello', unknownField: 'Hello' }, - }) - ).rejects.toEqual(new Error('[unknownField]: definition for this key is missing')); - }); - - test('should enforce a schema for options if options are passed', () => { + test('should throw if the request version is higher than the registered version', () => { const { ctx } = setup(); expect(() => fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '123', data: { title: 'Hello' }, - options: { foo: 'bar' }, + version: 7, }) - ).rejects.toEqual(new Error('Schema missing for rpc procedure [update.in.options].')); + ).rejects.toEqual(new Error('Invalid version. Latest version is [2].')); }); + }); - test('should validate the options', () => { - const { ctx } = setup({ - contentSchemas: { + describe('object versioning', () => { + test('should expose a utility to transform and validate services objects', () => { + const { ctx, storage } = setup(); + fn(ctx, { + contentTypeId: FOO_CONTENT_ID, + id: '123', + version: 1, + data: { title: 'Hello' }, + }); + const [[storageContext]] = storage.update.mock.calls; + + // getTransforms() utils should be available from context + const { getTransforms } = storageContext.utils ?? {}; + expect(getTransforms).not.toBeUndefined(); + + const definitions: ContentManagementServiceDefinitionVersioned = { + 1: { update: { in: { - data: fooDataSchema, - options: schema.object({ validOption: schema.maybe(schema.boolean()) }), + options: { + schema: schema.object({ + version1: schema.string(), + }), + up: (pre: object) => ({ ...pre, version2: 'added' }), + }, }, }, - } as any, - }); - expect(() => - fn(ctx, { - contentTypeId: FOO_CONTENT_ID, - id: '123', - data: { title: 'Hello' }, - options: { foo: 'bar' }, - }) - ).rejects.toEqual(new Error('[foo]: definition for this key is missing')); - }); + }, + 2: {}, + }; - test('should validate the result if schema is provided', () => { - const { ctx, storage } = setup({ - contentSchemas: { - update: { - in: { data: fooDataSchema }, - out: { result: schema.object({ validField: schema.maybe(schema.boolean()) }) }, - }, - } as any, + const transforms = getTransforms(definitions, 1); + + // Some smoke tests for the getTransforms() utils. Complete test suite is inside + // the package @kbn/object-versioning + expect(transforms.update.in.options.up({ version1: 'foo' }).value).toEqual({ + version1: 'foo', + version2: 'added', }); - const invalidResult = { wrongField: 'bad' }; - storage.update.mockResolvedValueOnce(invalidResult); + const optionsUpTransform = transforms.update.in.options.up({ version1: 123 }); - expect(() => - fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '123', data: { title: 'Hello' } }) - ).rejects.toEqual(new Error('[wrongField]: definition for this key is missing')); + expect(optionsUpTransform.value).toBe(null); + expect(optionsUpTransform.error?.message).toBe( + '[version1]: expected value of type [string] but got [number]' + ); + + expect(transforms.update.in.options.validate({ version1: 123 })?.message).toBe( + '[version1]: expected value of type [string] but got [number]' + ); }); }); }); diff --git a/src/plugins/content_management/server/rpc/procedures/update.ts b/src/plugins/content_management/server/rpc/procedures/update.ts index 9ea3b0487d58b..104f6019b0866 100644 --- a/src/plugins/content_management/server/rpc/procedures/update.ts +++ b/src/plugins/content_management/server/rpc/procedures/update.ts @@ -10,56 +10,28 @@ import type { UpdateIn } from '../../../common'; import type { StorageContext, ContentCrud } from '../../core'; import type { ProcedureDefinition } from '../rpc_service'; import type { Context } from '../types'; -import { validate } from '../../utils'; +import { validateRequestVersion } from './utils'; export const update: ProcedureDefinition> = { schemas: rpcSchemas.update, - fn: async (ctx, { contentTypeId, id, data, options }) => { + fn: async (ctx, { contentTypeId, id, version: _version, data, options }) => { const contentDefinition = ctx.contentRegistry.getDefinition(contentTypeId); - const { update: schemas } = contentDefinition.schemas.content; - - // Validate data to be stored - if (schemas?.in?.data) { - const error = validate(data, schemas.in.data); - if (error) { - // TODO: Improve error handling - throw error; - } - } else { - // TODO: Improve error handling - throw new Error('Schema missing for rpc procedure [update.in.data].'); - } - - // Validate the possible options - if (options) { - if (!schemas.in?.options) { - // TODO: Improve error handling - throw new Error('Schema missing for rpc procedure [update.in.options].'); - } - const error = validate(options, schemas.in.options); - if (error) { - // TODO: Improve error handling - throw error; - } - } + const version = validateRequestVersion(_version, contentDefinition.version.latest); // Execute CRUD const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(contentTypeId); const storageContext: StorageContext = { requestHandlerContext: ctx.requestHandlerContext, + version: { + request: version, + latest: contentDefinition.version.latest, + }, + utils: { + getTransforms: ctx.getTransformsFactory(contentTypeId), + }, }; const result = await crudInstance.update(storageContext, id, data, options); - // Validate result - const resultSchema = schemas.out?.result; - if (resultSchema) { - const error = validate(result.result, resultSchema); - if (error) { - // TODO: Improve error handling - throw error; - } - } - return result; }, }; diff --git a/src/plugins/content_management/server/rpc/procedures/utils.ts b/src/plugins/content_management/server/rpc/procedures/utils.ts new file mode 100644 index 0000000000000..df0f4315257e7 --- /dev/null +++ b/src/plugins/content_management/server/rpc/procedures/utils.ts @@ -0,0 +1,32 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { validateVersion } from '@kbn/object-versioning/lib/utils'; +import type { Version } from '@kbn/object-versioning'; + +export const validateRequestVersion = ( + requestVersion: Version | undefined, + latestVersion: Version +): Version => { + if (requestVersion === undefined) { + // this should never happen as we have schema in place at the route level + throw new Error('Request version missing'); + } + + const { result, value: requestVersionNumber } = validateVersion(requestVersion); + + if (!result) { + throw new Error(`Invalid version [${requestVersion}]. Must be an integer.`); + } + + if (requestVersionNumber > latestVersion) { + throw new Error(`Invalid version. Latest version is [${latestVersion}].`); + } + + return requestVersionNumber; +}; diff --git a/src/plugins/content_management/server/rpc/routes/routes.ts b/src/plugins/content_management/server/rpc/routes/routes.ts index c5d57fe3e010e..e89fbc6ae8953 100644 --- a/src/plugins/content_management/server/rpc/routes/routes.ts +++ b/src/plugins/content_management/server/rpc/routes/routes.ts @@ -12,6 +12,7 @@ import { ProcedureName } from '../../../common'; import type { ContentRegistry } from '../../core'; import type { RpcService } from '../rpc_service'; +import { getServiceObjectTransformFactory } from '../services_transforms_factory'; import type { Context as RpcContext } from '../types'; import { wrapError } from './error_wrapper'; @@ -53,6 +54,7 @@ export function initRpcRoutes( const context: RpcContext = { contentRegistry, requestHandlerContext, + getTransformsFactory: getServiceObjectTransformFactory, }; const { name } = request.params as { name: ProcedureName }; diff --git a/src/plugins/content_management/server/rpc/services_transforms_factory.ts b/src/plugins/content_management/server/rpc/services_transforms_factory.ts new file mode 100644 index 0000000000000..913eb8e5a1580 --- /dev/null +++ b/src/plugins/content_management/server/rpc/services_transforms_factory.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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import LRUCache from 'lru-cache'; +import type { ObjectMigrationDefinition } from '@kbn/object-versioning'; +import type { + ContentManagementServiceDefinitionVersioned, + Version, + ContentManagementGetTransformsFn, +} from '@kbn/object-versioning'; +import { + compileServiceDefinitions, + getContentManagmentServicesTransforms, +} from '@kbn/object-versioning'; + +/** + * We keep a cache of compiled service definition to avoid unnecessary recompile on every request. + */ +const compiledCache = new LRUCache({ + max: 50, +}); + +/** + * Wrap the "getContentManagmentServicesTransforms()" handler from the @kbn/object-versioning package + * to be able to cache the service definitions compilations so we can reuse them accross request as the + * services definitions won't change until a new Elastic version is released. In which case the cache + * will be cleared. + * + * @param contentTypeId The content type id for the service definition + * @returns A "getContentManagmentServicesTransforms()" + */ +export const getServiceObjectTransformFactory = + (contentTypeId: string): ContentManagementGetTransformsFn => + (definitions: ContentManagementServiceDefinitionVersioned, requestVersion: Version) => { + const compiledFromCache = compiledCache.get(contentTypeId); + if (compiledFromCache) { + return getContentManagmentServicesTransforms(definitions, requestVersion, compiledFromCache); + } + + const compiled = compileServiceDefinitions(definitions); + compiledCache.set(contentTypeId, compiled); + + return getContentManagmentServicesTransforms(definitions, requestVersion, compiled); + }; diff --git a/src/plugins/content_management/server/rpc/types.ts b/src/plugins/content_management/server/rpc/types.ts index 71ce1bd4bf86d..e12ae82f1691c 100644 --- a/src/plugins/content_management/server/rpc/types.ts +++ b/src/plugins/content_management/server/rpc/types.ts @@ -6,9 +6,11 @@ * Side Public License, v 1. */ import type { RequestHandlerContext } from '@kbn/core-http-request-handler-context-server'; +import type { ContentManagementGetTransformsFn } from '@kbn/object-versioning'; import type { ContentRegistry } from '../core'; export interface Context { contentRegistry: ContentRegistry; requestHandlerContext: RequestHandlerContext; + getTransformsFactory: (contentTypeId: string) => ContentManagementGetTransformsFn; } diff --git a/src/plugins/content_management/tsconfig.json b/src/plugins/content_management/tsconfig.json index a5316fbfac1c1..692aa3a03176e 100644 --- a/src/plugins/content_management/tsconfig.json +++ b/src/plugins/content_management/tsconfig.json @@ -8,6 +8,7 @@ "@kbn/core", "@kbn/config-schema", "@kbn/core-http-request-handler-context-server", + "@kbn/object-versioning", ], "exclude": [ "target/**/*", diff --git a/src/plugins/controls/kibana.jsonc b/src/plugins/controls/kibana.jsonc index defb62693b55c..0defa22bd351f 100644 --- a/src/plugins/controls/kibana.jsonc +++ b/src/plugins/controls/kibana.jsonc @@ -15,10 +15,9 @@ "embeddable", "dataViews", "data", - "unifiedSearch" + "unifiedSearch", + "uiActions" ], - "extraPublicDirs": [ - "common" - ] + "extraPublicDirs": ["common"] } } diff --git a/src/plugins/controls/public/control_group/actions/delete_control_action.test.tsx b/src/plugins/controls/public/control_group/actions/delete_control_action.test.tsx new file mode 100644 index 0000000000000..19d036ae5a6b3 --- /dev/null +++ b/src/plugins/controls/public/control_group/actions/delete_control_action.test.tsx @@ -0,0 +1,87 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { + lazyLoadReduxEmbeddablePackage, + ReduxEmbeddablePackage, +} from '@kbn/presentation-util-plugin/public'; +import { ErrorEmbeddable } from '@kbn/embeddable-plugin/public'; + +import { ControlOutput } from '../../types'; +import { ControlGroupInput } from '../types'; +import { pluginServices } from '../../services'; +import { DeleteControlAction } from './delete_control_action'; +import { OptionsListEmbeddableInput } from '../../options_list'; +import { controlGroupInputBuilder } from '../control_group_input_builder'; +import { ControlGroupContainer } from '../embeddable/control_group_container'; +import { OptionsListEmbeddable } from '../../options_list/embeddable/options_list_embeddable'; + +let container: ControlGroupContainer; +let embeddable: OptionsListEmbeddable; +let reduxEmbeddablePackage: ReduxEmbeddablePackage; + +beforeAll(async () => { + reduxEmbeddablePackage = await lazyLoadReduxEmbeddablePackage(); + + const controlGroupInput = { chainingSystem: 'NONE', panels: {} } as ControlGroupInput; + controlGroupInputBuilder.addOptionsListControl(controlGroupInput, { + dataViewId: 'test-data-view', + title: 'test', + fieldName: 'test-field', + width: 'medium', + grow: false, + }); + container = new ControlGroupContainer(reduxEmbeddablePackage, controlGroupInput); + await container.untilInitialized(); + + embeddable = container.getChild(container.getChildIds()[0]); +}); + +test('Action is incompatible with Error Embeddables', async () => { + const deleteControlAction = new DeleteControlAction(); + const errorEmbeddable = new ErrorEmbeddable('Wow what an awful error', { id: ' 404' }); + expect(await deleteControlAction.isCompatible({ embeddable: errorEmbeddable as any })).toBe( + false + ); +}); + +test('Execute throws an error when called with an embeddable not in a parent', async () => { + const deleteControlAction = new DeleteControlAction(); + const optionsListEmbeddable = new OptionsListEmbeddable( + reduxEmbeddablePackage, + {} as OptionsListEmbeddableInput, + {} as ControlOutput + ); + await expect(async () => { + await deleteControlAction.execute({ embeddable: optionsListEmbeddable }); + }).rejects.toThrow(Error); +}); + +describe('Execute should open a confirm modal', () => { + test('Canceling modal will keep control', async () => { + const spyOn = jest.fn().mockResolvedValue(false); + pluginServices.getServices().overlays.openConfirm = spyOn; + + const deleteControlAction = new DeleteControlAction(); + await deleteControlAction.execute({ embeddable }); + expect(spyOn).toHaveBeenCalled(); + + expect(container.getPanelCount()).toBe(1); + }); + + test('Confirming modal will delete control', async () => { + const spyOn = jest.fn().mockResolvedValue(true); + pluginServices.getServices().overlays.openConfirm = spyOn; + + const deleteControlAction = new DeleteControlAction(); + await deleteControlAction.execute({ embeddable }); + expect(spyOn).toHaveBeenCalled(); + + expect(container.getPanelCount()).toBe(0); + }); +}); diff --git a/src/plugins/controls/public/control_group/actions/delete_control_action.tsx b/src/plugins/controls/public/control_group/actions/delete_control_action.tsx new file mode 100644 index 0000000000000..7a44c537d1d9d --- /dev/null +++ b/src/plugins/controls/public/control_group/actions/delete_control_action.tsx @@ -0,0 +1,91 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; + +import { EuiButtonIcon, EuiToolTip } from '@elastic/eui'; +import { ViewMode, isErrorEmbeddable } from '@kbn/embeddable-plugin/public'; +import { Action, IncompatibleActionError } from '@kbn/ui-actions-plugin/public'; + +import { ACTION_DELETE_CONTROL } from '.'; +import { pluginServices } from '../../services'; +import { ControlGroupStrings } from '../control_group_strings'; +import { ControlEmbeddable, DataControlInput } from '../../types'; +import { isControlGroup } from '../embeddable/control_group_helpers'; + +export interface DeleteControlActionContext { + embeddable: ControlEmbeddable; +} + +export class DeleteControlAction implements Action { + public readonly type = ACTION_DELETE_CONTROL; + public readonly id = ACTION_DELETE_CONTROL; + public order = 2; + + private openConfirm; + + constructor() { + ({ + overlays: { openConfirm: this.openConfirm }, + } = pluginServices.getServices()); + } + + public readonly MenuItem = ({ context }: { context: DeleteControlActionContext }) => { + return ( + + this.execute(context)} + color="danger" + /> + + ); + }; + + public getDisplayName({ embeddable }: DeleteControlActionContext) { + if (!embeddable.parent || !isControlGroup(embeddable.parent)) { + throw new IncompatibleActionError(); + } + return ControlGroupStrings.floatingActions.getRemoveButtonTitle(); + } + + public getIconType({ embeddable }: DeleteControlActionContext) { + if (!embeddable.parent || !isControlGroup(embeddable.parent)) { + throw new IncompatibleActionError(); + } + return 'cross'; + } + + public async isCompatible({ embeddable }: DeleteControlActionContext) { + if (isErrorEmbeddable(embeddable)) return false; + const controlGroup = embeddable.parent; + return Boolean( + controlGroup && + isControlGroup(controlGroup) && + controlGroup.getInput().viewMode === ViewMode.EDIT + ); + } + + public async execute({ embeddable }: DeleteControlActionContext) { + if (!embeddable.parent || !isControlGroup(embeddable.parent)) { + throw new IncompatibleActionError(); + } + this.openConfirm(ControlGroupStrings.management.deleteControls.getSubtitle(), { + confirmButtonText: ControlGroupStrings.management.deleteControls.getConfirm(), + cancelButtonText: ControlGroupStrings.management.deleteControls.getCancel(), + title: ControlGroupStrings.management.deleteControls.getDeleteTitle(), + buttonColor: 'danger', + }).then((confirmed) => { + if (confirmed) { + embeddable.parent?.removeEmbeddable(embeddable.id); + } + }); + } +} diff --git a/src/plugins/controls/public/control_group/actions/edit_control_action.test.tsx b/src/plugins/controls/public/control_group/actions/edit_control_action.test.tsx new file mode 100644 index 0000000000000..7c4f15f091b9c --- /dev/null +++ b/src/plugins/controls/public/control_group/actions/edit_control_action.test.tsx @@ -0,0 +1,114 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { + lazyLoadReduxEmbeddablePackage, + ReduxEmbeddablePackage, +} from '@kbn/presentation-util-plugin/public'; +import { ErrorEmbeddable } from '@kbn/embeddable-plugin/public'; + +import { ControlOutput } from '../../types'; +import { ControlGroupInput } from '../types'; +import { pluginServices } from '../../services'; +import { EditControlAction } from './edit_control_action'; +import { DeleteControlAction } from './delete_control_action'; +import { TimeSliderEmbeddableFactory } from '../../time_slider'; +import { OptionsListEmbeddableFactory, OptionsListEmbeddableInput } from '../../options_list'; +import { ControlGroupContainer } from '../embeddable/control_group_container'; +import { OptionsListEmbeddable } from '../../options_list/embeddable/options_list_embeddable'; + +let reduxEmbeddablePackage: ReduxEmbeddablePackage; + +const controlGroupInput = { chainingSystem: 'NONE', panels: {} } as ControlGroupInput; +const deleteControlAction = new DeleteControlAction(); + +beforeAll(async () => { + reduxEmbeddablePackage = await lazyLoadReduxEmbeddablePackage(); +}); + +test('Action is incompatible with Error Embeddables', async () => { + const editControlAction = new EditControlAction(deleteControlAction); + const errorEmbeddable = new ErrorEmbeddable('Wow what an awful error', { id: ' 404' }); + expect(await editControlAction.isCompatible({ embeddable: errorEmbeddable as any })).toBe(false); +}); + +test('Action is incompatible with embeddables that are not editable', async () => { + const mockEmbeddableFactory = new TimeSliderEmbeddableFactory(); + const mockGetFactory = jest.fn().mockReturnValue(mockEmbeddableFactory); + pluginServices.getServices().controls.getControlFactory = mockGetFactory; + pluginServices.getServices().embeddable.getEmbeddableFactory = mockGetFactory; + + const editControlAction = new EditControlAction(deleteControlAction); + const emptyContainer = new ControlGroupContainer(reduxEmbeddablePackage, controlGroupInput); + await emptyContainer.untilInitialized(); + await emptyContainer.addTimeSliderControl(); + + expect( + await editControlAction.isCompatible({ + embeddable: emptyContainer.getChild(emptyContainer.getChildIds()[0]) as any, + }) + ).toBe(false); +}); + +test('Action is compatible with embeddables that are editable', async () => { + const mockEmbeddableFactory = new OptionsListEmbeddableFactory(); + const mockGetFactory = jest.fn().mockReturnValue(mockEmbeddableFactory); + pluginServices.getServices().controls.getControlFactory = mockGetFactory; + pluginServices.getServices().embeddable.getEmbeddableFactory = mockGetFactory; + + const editControlAction = new EditControlAction(deleteControlAction); + const emptyContainer = new ControlGroupContainer(reduxEmbeddablePackage, controlGroupInput); + await emptyContainer.untilInitialized(); + await emptyContainer.addOptionsListControl({ + dataViewId: 'test-data-view', + title: 'test', + fieldName: 'test-field', + width: 'medium', + grow: false, + }); + + expect( + await editControlAction.isCompatible({ + embeddable: emptyContainer.getChild(emptyContainer.getChildIds()[0]) as any, + }) + ).toBe(true); +}); + +test('Execute throws an error when called with an embeddable not in a parent', async () => { + const editControlAction = new EditControlAction(deleteControlAction); + const optionsListEmbeddable = new OptionsListEmbeddable( + reduxEmbeddablePackage, + {} as OptionsListEmbeddableInput, + {} as ControlOutput + ); + await expect(async () => { + await editControlAction.execute({ embeddable: optionsListEmbeddable }); + }).rejects.toThrow(Error); +}); + +test('Execute should open a flyout', async () => { + const spyOn = jest.fn().mockResolvedValue(undefined); + pluginServices.getServices().overlays.openFlyout = spyOn; + + const emptyContainer = new ControlGroupContainer(reduxEmbeddablePackage, controlGroupInput); + await emptyContainer.untilInitialized(); + await emptyContainer.addOptionsListControl({ + dataViewId: 'test-data-view', + title: 'test', + fieldName: 'test-field', + width: 'medium', + grow: false, + }); + const embeddable: OptionsListEmbeddable = emptyContainer.getChild( + emptyContainer.getChildIds()[0] + ); + + const editControlAction = new EditControlAction(deleteControlAction); + await editControlAction.execute({ embeddable }); + expect(spyOn).toHaveBeenCalled(); +}); diff --git a/src/plugins/controls/public/control_group/actions/edit_control_action.tsx b/src/plugins/controls/public/control_group/actions/edit_control_action.tsx new file mode 100644 index 0000000000000..9500640332446 --- /dev/null +++ b/src/plugins/controls/public/control_group/actions/edit_control_action.tsx @@ -0,0 +1,125 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; + +import { EuiButtonIcon, EuiToolTip } from '@elastic/eui'; +import { toMountPoint } from '@kbn/kibana-react-plugin/public'; +import { isErrorEmbeddable, ViewMode } from '@kbn/embeddable-plugin/public'; +import { Action, IncompatibleActionError } from '@kbn/ui-actions-plugin/public'; + +import { pluginServices } from '../../services'; +import { EditControlFlyout } from './edit_control_flyout'; +import { DeleteControlAction } from './delete_control_action'; +import { ControlGroupStrings } from '../control_group_strings'; +import { ACTION_EDIT_CONTROL, ControlGroupContainer } from '..'; +import { ControlEmbeddable, DataControlInput } from '../../types'; +import { setFlyoutRef } from '../embeddable/control_group_container'; +import { isControlGroup } from '../embeddable/control_group_helpers'; + +export interface EditControlActionContext { + embeddable: ControlEmbeddable; +} + +export class EditControlAction implements Action { + public readonly type = ACTION_EDIT_CONTROL; + public readonly id = ACTION_EDIT_CONTROL; + public order = 1; + + private getEmbeddableFactory; + private openFlyout; + private theme$; + + constructor(private deleteControlAction: DeleteControlAction) { + ({ + embeddable: { getEmbeddableFactory: this.getEmbeddableFactory }, + overlays: { openFlyout: this.openFlyout }, + theme: { theme$: this.theme$ }, + } = pluginServices.getServices()); + } + + public readonly MenuItem = ({ context }: { context: EditControlActionContext }) => { + const { embeddable } = context; + return ( + + this.execute(context)} + color="text" + /> + + ); + }; + + public getDisplayName({ embeddable }: EditControlActionContext) { + if (!embeddable.parent || !isControlGroup(embeddable.parent)) { + throw new IncompatibleActionError(); + } + return ControlGroupStrings.floatingActions.getEditButtonTitle(); + } + + public getIconType({ embeddable }: EditControlActionContext) { + if (!embeddable.parent || !isControlGroup(embeddable.parent)) { + throw new IncompatibleActionError(); + } + return 'pencil'; + } + + public async isCompatible({ embeddable }: EditControlActionContext) { + if (isErrorEmbeddable(embeddable)) return false; + const controlGroup = embeddable.parent; + const factory = this.getEmbeddableFactory(embeddable.type); + + return Boolean( + controlGroup && + isControlGroup(controlGroup) && + controlGroup.getInput().viewMode === ViewMode.EDIT && + factory && + (await factory.isEditable()) + ); + } + + public async execute({ embeddable }: EditControlActionContext) { + if (!embeddable.parent || !isControlGroup(embeddable.parent)) { + throw new IncompatibleActionError(); + } + const controlGroup = embeddable.parent as ControlGroupContainer; + const ReduxWrapper = controlGroup.getReduxEmbeddableTools().Wrapper; + + const flyoutInstance = this.openFlyout( + toMountPoint( + + this.deleteControlAction.execute({ embeddable })} + closeFlyout={() => { + setFlyoutRef(undefined); + flyoutInstance.close(); + }} + /> + , + + { theme$: this.theme$ } + ), + { + 'aria-label': ControlGroupStrings.manageControl.getFlyoutEditTitle(), + outsideClickCloses: false, + onClose: (flyout) => { + setFlyoutRef(undefined); + flyout.close(); + }, + ownFocus: true, + // @ts-ignore - TODO: Remove this once https://github.com/elastic/eui/pull/6645 lands in Kibana + focusTrapProps: { scrollLock: true }, + } + ); + setFlyoutRef(flyoutInstance); + } +} diff --git a/src/plugins/controls/public/control_group/actions/edit_control_flyout.tsx b/src/plugins/controls/public/control_group/actions/edit_control_flyout.tsx new file mode 100644 index 0000000000000..c5f3dda8f5f8c --- /dev/null +++ b/src/plugins/controls/public/control_group/actions/edit_control_flyout.tsx @@ -0,0 +1,119 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { isEqual } from 'lodash'; +import React, { useState } from 'react'; + +import { EmbeddableFactoryNotFoundError } from '@kbn/embeddable-plugin/public'; + +import { DataControlInput, ControlEmbeddable, IEditableControlFactory } from '../../types'; +import { pluginServices } from '../../services'; +import { ControlGroupStrings } from '../control_group_strings'; +import { useControlGroupContainerContext } from '../control_group_renderer'; +import { ControlEditor } from '../editor/control_editor'; + +export const EditControlFlyout = ({ + embeddable, + closeFlyout, + removeControl, +}: { + embeddable: ControlEmbeddable; + closeFlyout: () => void; + removeControl: () => void; +}) => { + // Controls Services Context + const { + overlays: { openConfirm }, + controls: { getControlFactory }, + } = pluginServices.getServices(); + // Redux embeddable container Context + const reduxContext = useControlGroupContainerContext(); + const { + embeddableInstance: controlGroup, + actions: { setControlWidth, setControlGrow }, + useEmbeddableSelector, + useEmbeddableDispatch, + } = reduxContext; + const dispatch = useEmbeddableDispatch(); + + // current state + const panels = useEmbeddableSelector((state) => state.explicitInput.panels); + const panel = panels[embeddable.id]; + + const [currentGrow, setCurrentGrow] = useState(panel.grow); + const [currentWidth, setCurrentWidth] = useState(panel.width); + const [inputToReturn, setInputToReturn] = useState>({}); + + const onCancel = () => { + if ( + isEqual(panel.explicitInput, { + ...panel.explicitInput, + ...inputToReturn, + }) && + currentGrow === panel.grow && + currentWidth === panel.width + ) { + closeFlyout(); + return; + } + openConfirm(ControlGroupStrings.management.discardChanges.getSubtitle(), { + confirmButtonText: ControlGroupStrings.management.discardChanges.getConfirm(), + cancelButtonText: ControlGroupStrings.management.discardChanges.getCancel(), + title: ControlGroupStrings.management.discardChanges.getTitle(), + buttonColor: 'danger', + }).then((confirmed) => { + if (confirmed) { + closeFlyout(); + } + }); + }; + + const onSave = async (type?: string) => { + if (!type) { + closeFlyout(); + return; + } + + const factory = getControlFactory(type) as IEditableControlFactory; + if (!factory) throw new EmbeddableFactoryNotFoundError(type); + if (factory.presaveTransformFunction) { + setInputToReturn(factory.presaveTransformFunction(inputToReturn, embeddable)); + } + + if (currentWidth !== panel.width) + dispatch(setControlWidth({ width: currentWidth, embeddableId: embeddable.id })); + if (currentGrow !== panel.grow) + dispatch(setControlGrow({ grow: currentGrow, embeddableId: embeddable.id })); + + closeFlyout(); + await controlGroup.replaceEmbeddable(embeddable.id, inputToReturn, type); + }; + + return ( + onCancel()} + updateTitle={(newTitle) => (inputToReturn.title = newTitle)} + setLastUsedDataViewId={(lastUsed) => controlGroup.setLastUsedDataViewId(lastUsed)} + updateWidth={(newWidth) => setCurrentWidth(newWidth)} + updateGrow={(newGrow) => setCurrentGrow(newGrow)} + onTypeEditorChange={(partialInput) => { + setInputToReturn({ ...inputToReturn, ...partialInput }); + }} + onSave={(type) => onSave(type)} + removeControl={() => { + closeFlyout(); + removeControl(); + }} + /> + ); +}; diff --git a/src/plugins/controls/public/control_group/actions/index.ts b/src/plugins/controls/public/control_group/actions/index.ts new file mode 100644 index 0000000000000..2bc869bb8f478 --- /dev/null +++ b/src/plugins/controls/public/control_group/actions/index.ts @@ -0,0 +1,10 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export const ACTION_EDIT_CONTROL = 'editControl'; +export const ACTION_DELETE_CONTROL = 'deleteControl'; diff --git a/src/plugins/controls/public/control_group/component/control_frame_component.tsx b/src/plugins/controls/public/control_group/component/control_frame_component.tsx index 85be2b03b6fbb..2697e941ab234 100644 --- a/src/plugins/controls/public/control_group/component/control_frame_component.tsx +++ b/src/plugins/controls/public/control_group/component/control_frame_component.tsx @@ -10,7 +10,6 @@ import React, { useEffect, useMemo, useState } from 'react'; import classNames from 'classnames'; import { EuiButtonEmpty, - EuiButtonIcon, EuiFormControlLayout, EuiFormLabel, EuiFormRow, @@ -23,11 +22,8 @@ import { FormattedMessage } from '@kbn/i18n-react'; import { Markdown } from '@kbn/kibana-react-plugin/public'; import { useReduxEmbeddableContext, FloatingActions } from '@kbn/presentation-util-plugin/public'; import { ControlGroupReduxState } from '../types'; -import { pluginServices } from '../../services'; -import { EditControlButton } from '../editor/edit_control'; import { ControlGroupStrings } from '../control_group_strings'; import { useChildEmbeddable } from '../../hooks/use_child_embeddable'; -import { TIME_SLIDER_CONTROL } from '../../../common'; import { controlGroupReducers } from '../state/control_group_reducers'; import { ControlGroupContainer } from '..'; @@ -41,7 +37,7 @@ const ControlFrameError = ({ error }: ControlFrameErrorProps) => { setPopoverOpen((open) => !open)} className={'errorEmbeddableCompact__button'} textProps={{ className: 'errorEmbeddableCompact__text' }} @@ -93,12 +89,9 @@ export const ControlFrame = ({ ControlGroupContainer >(); + const viewMode = select((state) => state.explicitInput.viewMode); const controlStyle = select((state) => state.explicitInput.controlStyle); - - // Controls Services Context - const { - overlays: { openConfirm }, - } = pluginServices.getServices(); + const disabledActions = select((state) => state.explicitInput.disabledActions); const embeddable = useChildEmbeddable({ untilEmbeddableLoaded: controlGroup.untilEmbeddableLoaded.bind(controlGroup), @@ -126,36 +119,6 @@ export const ControlFrame = ({ }; }, [embeddable, embeddableRoot]); - const floatingActions = ( - <> - {!fatalError && embeddableType !== TIME_SLIDER_CONTROL && ( - - - - )} - - - openConfirm(ControlGroupStrings.management.deleteControls.getSubtitle(), { - confirmButtonText: ControlGroupStrings.management.deleteControls.getConfirm(), - cancelButtonText: ControlGroupStrings.management.deleteControls.getCancel(), - title: ControlGroupStrings.management.deleteControls.getDeleteTitle(), - buttonColor: 'danger', - }).then((confirmed) => { - if (confirmed) { - controlGroup.removeEmbeddable(embeddableId); - } - }) - } - iconType="cross" - color="danger" - /> - - - ); - const embeddableParentClassNames = classNames('controlFrame__control', { 'controlFrame--twoLine': controlStyle === 'twoLine', 'controlFrame--oneLine': controlStyle === 'oneLine', @@ -219,7 +182,9 @@ export const ControlFrame = ({ 'controlFrameFloatingActions--twoLine': usingTwoLineLayout, 'controlFrameFloatingActions--oneLine': !usingTwoLineLayout, })} - actions={floatingActions} + viewMode={viewMode} + embeddable={embeddable} + disabledActions={disabledActions} isEnabled={embeddable && enableActions} > ; -} - -export const EditControlButton = ({ embeddableId }: { embeddableId: string }) => { - // Controls Services Context - const { - overlays: { openFlyout, openConfirm }, - controls: { getControlFactory }, - theme: { theme$ }, - } = pluginServices.getServices(); - // Redux embeddable container Context - const reduxContext = useControlGroupContainerContext(); - const { - embeddableInstance: controlGroup, - actions: { setControlWidth, setControlGrow }, - useEmbeddableSelector, - useEmbeddableDispatch, - } = reduxContext; - const dispatch = useEmbeddableDispatch(); - - // current state - const panels = useEmbeddableSelector((state) => state.explicitInput.panels); - - // keep up to date ref of latest panel state for comparison when closing editor. - const latestPanelState = useRef(panels[embeddableId]); - useEffect(() => { - latestPanelState.current = panels[embeddableId]; - }, [panels, embeddableId]); - - const editControl = async () => { - const ControlsServicesProvider = pluginServices.getContextProvider(); - const embeddable = (await controlGroup.untilEmbeddableLoaded( - embeddableId - )) as ControlEmbeddable; - - const initialInputPromise = new Promise((resolve, reject) => { - const panel = panels[embeddableId]; - let factory = getControlFactory(panel.type); - if (!factory) throw new EmbeddableFactoryNotFoundError(panel.type); - - let inputToReturn: Partial = {}; - - let removed = false; - const onCancel = (ref: OverlayRef) => { - if ( - removed || - (isEqual(latestPanelState.current.explicitInput, { - ...panel.explicitInput, - ...inputToReturn, - }) && - isEqual(latestPanelState.current.width, panel.width) && - isEqual(latestPanelState.current.grow, panel.grow)) - ) { - reject(); - ref.close(); - return; - } - openConfirm(ControlGroupStrings.management.discardChanges.getSubtitle(), { - confirmButtonText: ControlGroupStrings.management.discardChanges.getConfirm(), - cancelButtonText: ControlGroupStrings.management.discardChanges.getCancel(), - title: ControlGroupStrings.management.discardChanges.getTitle(), - buttonColor: 'danger', - }).then((confirmed) => { - if (confirmed) { - dispatch(setControlWidth({ width: panel.width, embeddableId })); - dispatch(setControlGrow({ grow: panel.grow, embeddableId })); - reject(); - ref.close(); - } - }); - }; - - const onSave = (ref: OverlayRef, type?: string) => { - if (!type) { - reject(); - ref.close(); - return; - } - - // if the control now has a new type, need to replace the old factory with - // one of the correct new type - if (latestPanelState.current.type !== type) { - factory = getControlFactory(type); - if (!factory) throw new EmbeddableFactoryNotFoundError(type); - } - const editableFactory = factory as IEditableControlFactory; - if (editableFactory.presaveTransformFunction) { - inputToReturn = editableFactory.presaveTransformFunction(inputToReturn, embeddable); - } - resolve({ type, controlInput: inputToReturn }); - ref.close(); - }; - - const ReduxWrapper = controlGroup.getReduxEmbeddableTools().Wrapper; - - const flyoutInstance = openFlyout( - toMountPoint( - - - onCancel(flyoutInstance)} - updateTitle={(newTitle) => (inputToReturn.title = newTitle)} - setLastUsedDataViewId={(lastUsed) => controlGroup.setLastUsedDataViewId(lastUsed)} - updateWidth={(newWidth) => - dispatch(setControlWidth({ width: newWidth, embeddableId })) - } - updateGrow={(grow) => dispatch(setControlGrow({ grow, embeddableId }))} - onTypeEditorChange={(partialInput) => { - inputToReturn = { ...inputToReturn, ...partialInput }; - }} - onSave={(type) => onSave(flyoutInstance, type)} - removeControl={() => { - openConfirm(ControlGroupStrings.management.deleteControls.getSubtitle(), { - confirmButtonText: ControlGroupStrings.management.deleteControls.getConfirm(), - cancelButtonText: ControlGroupStrings.management.deleteControls.getCancel(), - title: ControlGroupStrings.management.deleteControls.getDeleteTitle(), - buttonColor: 'danger', - }).then((confirmed) => { - if (confirmed) { - controlGroup.removeEmbeddable(embeddableId); - removed = true; - flyoutInstance.close(); - } - }); - }} - /> - - , - { theme$ } - ), - { - 'aria-label': ControlGroupStrings.manageControl.getFlyoutEditTitle(), - outsideClickCloses: false, - onClose: (flyout) => { - onCancel(flyout); - setFlyoutRef(undefined); - }, - } - ); - setFlyoutRef(flyoutInstance); - }); - - initialInputPromise.then( - async (promise) => { - await controlGroup.replaceEmbeddable(embeddable.id, promise.controlInput, promise.type); - }, - () => {} // swallow promise rejection because it can be part of normal flow - ); - }; - - return ( - editControl()} - color="text" - /> - ); -}; diff --git a/src/plugins/controls/public/control_group/embeddable/control_group_helpers.ts b/src/plugins/controls/public/control_group/embeddable/control_group_helpers.ts index 1afcdc539bf87..7318a489feac9 100644 --- a/src/plugins/controls/public/control_group/embeddable/control_group_helpers.ts +++ b/src/plugins/controls/public/control_group/embeddable/control_group_helpers.ts @@ -6,9 +6,13 @@ * Side Public License, v 1. */ -import { ControlsPanels } from '../types'; -import { pluginServices } from '../../services'; +import { type IEmbeddable } from '@kbn/embeddable-plugin/public'; + import { getDataControlFieldRegistry } from '../editor/data_control_editor_tools'; +import { type ControlGroupContainer } from './control_group_container'; +import { pluginServices } from '../../services'; +import { CONTROL_GROUP_TYPE } from '../types'; +import { ControlsPanels } from '../types'; export const getNextPanelOrder = (panels?: ControlsPanels) => { let nextOrder = 0; @@ -34,3 +38,7 @@ export const getCompatibleControlType = async ({ const field = fieldRegistry[fieldName]; return field.compatibleControlTypes[0]; }; + +export const isControlGroup = (embeddable: IEmbeddable): embeddable is ControlGroupContainer => { + return embeddable.isContainer && embeddable.type === CONTROL_GROUP_TYPE; +}; diff --git a/src/plugins/controls/public/control_group/index.ts b/src/plugins/controls/public/control_group/index.ts index 1967a8074beab..745e41ec474b1 100644 --- a/src/plugins/controls/public/control_group/index.ts +++ b/src/plugins/controls/public/control_group/index.ts @@ -14,6 +14,8 @@ export type { ControlGroupInput, ControlGroupOutput } from './types'; export { CONTROL_GROUP_TYPE } from './types'; export { ControlGroupContainerFactory } from './embeddable/control_group_container_factory'; +export { ACTION_EDIT_CONTROL, ACTION_DELETE_CONTROL } from './actions'; + export { type AddDataControlProps, type AddOptionsListControlProps, diff --git a/src/plugins/controls/public/index.ts b/src/plugins/controls/public/index.ts index ff0f139b27a75..1e9df544bd1c9 100644 --- a/src/plugins/controls/public/index.ts +++ b/src/plugins/controls/public/index.ts @@ -58,6 +58,8 @@ export { LazyControlGroupRenderer, useControlGroupContainerContext, type ControlGroupRendererProps, + ACTION_DELETE_CONTROL, + ACTION_EDIT_CONTROL, } from './control_group'; export function plugin() { diff --git a/src/plugins/controls/public/options_list/components/options_list_popover_title.tsx b/src/plugins/controls/public/options_list/components/options_list_popover_title.tsx index 40361260e56c0..08aee48f61e28 100644 --- a/src/plugins/controls/public/options_list/components/options_list_popover_title.tsx +++ b/src/plugins/controls/public/options_list/components/options_list_popover_title.tsx @@ -34,7 +34,7 @@ export const OptionsListPopoverTitle = () => { diff --git a/src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx b/src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx index 2292555316b82..8465016ce4402 100644 --- a/src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx +++ b/src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx @@ -20,8 +20,8 @@ import { OptionsListEmbeddableInput, OPTIONS_LIST_CONTROL, } from '../../../common/options_list/types'; -import { ControlEmbeddable, DataControlField, IEditableControlFactory } from '../../types'; import { OptionsListEditorOptions } from '../components/options_list_editor_options'; +import { ControlEmbeddable, DataControlField, IEditableControlFactory } from '../../types'; export class OptionsListEmbeddableFactory implements EmbeddableFactoryDefinition, IEditableControlFactory @@ -48,8 +48,11 @@ export class OptionsListEmbeddableFactory ((newInput.fieldName && !deepEqual(newInput.fieldName, embeddable.getInput().fieldName)) || (newInput.dataViewId && !deepEqual(newInput.dataViewId, embeddable.getInput().dataViewId))) ) { - // if the field name or data view id has changed in this editing session, selected options are invalid, so reset them. - newInput.selectedOptions = []; + // if the field name or data view id has changed in this editing session, reset all selections + newInput.selectedOptions = undefined; + newInput.existsSelected = undefined; + newInput.exclude = undefined; + newInput.sort = undefined; } return newInput; }; @@ -67,7 +70,7 @@ export class OptionsListEmbeddableFactory public controlEditorOptionsComponent = OptionsListEditorOptions; - public isEditable = () => Promise.resolve(false); + public isEditable = () => Promise.resolve(true); public getDisplayName = () => i18n.translate('controls.optionsList.displayName', { diff --git a/src/plugins/controls/public/plugin.ts b/src/plugins/controls/public/plugin.ts index 00673b79d1d2a..85a892c9eea83 100644 --- a/src/plugins/controls/public/plugin.ts +++ b/src/plugins/controls/public/plugin.ts @@ -7,7 +7,7 @@ */ import { CoreSetup, CoreStart, Plugin } from '@kbn/core/public'; -import { EmbeddableFactory } from '@kbn/embeddable-plugin/public'; +import { EmbeddableFactory, PANEL_HOVER_TRIGGER } from '@kbn/embeddable-plugin/public'; import { ControlGroupContainerFactory, @@ -28,7 +28,6 @@ import { IEditableControlFactory, ControlInput, } from './types'; - export class ControlsPlugin implements Plugin< @@ -113,10 +112,21 @@ export class ControlsPlugin } public start(coreStart: CoreStart, startPlugins: ControlsPluginStartDeps): ControlsPluginStart { - this.startControlsKibanaServices(coreStart, startPlugins); + this.startControlsKibanaServices(coreStart, startPlugins).then(async () => { + const { uiActions } = startPlugins; - const { getControlFactory, getControlTypes } = controlsService; + const { DeleteControlAction } = await import('./control_group/actions/delete_control_action'); + const deleteControlAction = new DeleteControlAction(); + uiActions.registerAction(deleteControlAction); + uiActions.attachAction(PANEL_HOVER_TRIGGER, deleteControlAction.id); + const { EditControlAction } = await import('./control_group/actions/edit_control_action'); + const editControlAction = new EditControlAction(deleteControlAction); + uiActions.registerAction(editControlAction); + uiActions.attachAction(PANEL_HOVER_TRIGGER, editControlAction.id); + }); + + const { getControlFactory, getControlTypes } = controlsService; return { getControlFactory, getControlTypes, diff --git a/src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx b/src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx index 730b0d91bbe61..2a86d5c186fc2 100644 --- a/src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx +++ b/src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx @@ -41,7 +41,7 @@ export class RangeSliderEmbeddableFactory public canCreateNew = () => false; - public isEditable = () => Promise.resolve(false); + public isEditable = () => Promise.resolve(true); public async create(initialInput: RangeSliderEmbeddableInput, parent?: IContainer) { const reduxEmbeddablePackage = await lazyLoadReduxEmbeddablePackage(); diff --git a/src/plugins/controls/public/services/plugin_services.ts b/src/plugins/controls/public/services/plugin_services.ts index 20950d42df516..805382254130a 100644 --- a/src/plugins/controls/public/services/plugin_services.ts +++ b/src/plugins/controls/public/services/plugin_services.ts @@ -34,12 +34,12 @@ export const providers: PluginServiceProviders< controls: new PluginServiceProvider(controlsServiceFactory), data: new PluginServiceProvider(dataServiceFactory), dataViews: new PluginServiceProvider(dataViewsServiceFactory), + embeddable: new PluginServiceProvider(embeddableServiceFactory), http: new PluginServiceProvider(httpServiceFactory), optionsList: new PluginServiceProvider(optionsListServiceFactory, ['data', 'http']), overlays: new PluginServiceProvider(overlaysServiceFactory), settings: new PluginServiceProvider(settingsServiceFactory), theme: new PluginServiceProvider(themeServiceFactory), - embeddable: new PluginServiceProvider(embeddableServiceFactory), unifiedSearch: new PluginServiceProvider(unifiedSearchServiceFactory), }; diff --git a/src/plugins/controls/public/time_slider/embeddable/time_slider_embeddable_factory.tsx b/src/plugins/controls/public/time_slider/embeddable/time_slider_embeddable_factory.tsx index b062bcc4370fe..d3f3418104328 100644 --- a/src/plugins/controls/public/time_slider/embeddable/time_slider_embeddable_factory.tsx +++ b/src/plugins/controls/public/time_slider/embeddable/time_slider_embeddable_factory.tsx @@ -35,6 +35,7 @@ export class TimeSliderEmbeddableFactory public isFieldCompatible = () => false; public isEditable = () => Promise.resolve(false); + public canCreateNew = () => false; public getDisplayName = () => i18n.translate('controls.timeSlider.displayName', { diff --git a/src/plugins/controls/public/types.ts b/src/plugins/controls/public/types.ts index 17608ee7bef8d..6e26440c1410d 100644 --- a/src/plugins/controls/public/types.ts +++ b/src/plugins/controls/public/types.ts @@ -7,6 +7,7 @@ */ import { ReactNode } from 'react'; + import { Filter } from '@kbn/es-query'; import { EmbeddableFactory, @@ -15,9 +16,11 @@ import { EmbeddableStart, IEmbeddable, } from '@kbn/embeddable-plugin/public'; +import { UiActionsStart } from '@kbn/ui-actions-plugin/public'; import { DataPublicPluginStart } from '@kbn/data-plugin/public'; import { DataViewField, DataViewsPublicPluginStart } from '@kbn/data-views-plugin/public'; import { UnifiedSearchPublicPluginStart } from '@kbn/unified-search-plugin/public'; + import { ControlInput } from '../common/types'; import { ControlsServiceType } from './services/controls/types'; @@ -86,10 +89,11 @@ export interface ControlsPluginSetupDeps { embeddable: EmbeddableSetup; } export interface ControlsPluginStartDeps { - data: DataPublicPluginStart; - unifiedSearch: UnifiedSearchPublicPluginStart; + uiActions: UiActionsStart; embeddable: EmbeddableStart; + data: DataPublicPluginStart; dataViews: DataViewsPublicPluginStart; + unifiedSearch: UnifiedSearchPublicPluginStart; } // re-export from common diff --git a/src/plugins/controls/tsconfig.json b/src/plugins/controls/tsconfig.json index 5029897be467b..5da6923aaaf5d 100644 --- a/src/plugins/controls/tsconfig.json +++ b/src/plugins/controls/tsconfig.json @@ -34,6 +34,7 @@ "@kbn/storybook", "@kbn/ui-theme", "@kbn/safer-lodash-set", + "@kbn/ui-actions-plugin", ], "exclude": [ "target/**/*", diff --git a/src/plugins/custom_integrations/common/index.ts b/src/plugins/custom_integrations/common/index.ts index 6d2252f3c3d43..90e1d387470ac 100755 --- a/src/plugins/custom_integrations/common/index.ts +++ b/src/plugins/custom_integrations/common/index.ts @@ -12,43 +12,45 @@ export const PLUGIN_NAME = 'customIntegrations'; * A map of category names and their corresponding titles. */ // TODO: consider i18n -export const INTEGRATION_CATEGORY_DISPLAY = { - aws: 'AWS', - azure: 'Azure', - cloud: 'Cloud', - config_management: 'Config management', - containers: 'Containers', - crm: 'CRM', - custom: 'Custom', - datastore: 'Datastore', - elastic_stack: 'Elastic Stack', - google_cloud: 'Google Cloud', - infrastructure: 'Infrastructure', - kubernetes: 'Kubernetes', - languages: 'Languages', - message_queue: 'Message queue', - microsoft_365: 'Microsoft 365', - monitoring: 'Monitoring', - network: 'Network', - notification: 'Notification', - os_system: 'OS & System', - productivity: 'Productivity', - security: 'Security', - sample_data: 'Sample data', - support: 'Support', - threat_intel: 'Threat intelligence', - ticketing: 'Ticketing', - version_control: 'Version control', - web: 'Web', +export const INTEGRATION_CATEGORY_DISPLAY: { + [key: string]: { title: string; parent_id?: string }; +} = { + aws: { title: 'AWS', parent_id: undefined }, + azure: { title: 'Azure', parent_id: undefined }, + cloud: { title: 'Cloud', parent_id: undefined }, + config_management: { title: 'Config management', parent_id: undefined }, + containers: { title: 'Containers', parent_id: undefined }, + crm: { title: 'CRM', parent_id: undefined }, + custom: { title: 'Custom', parent_id: undefined }, + datastore: { title: 'Datastore', parent_id: undefined }, + elastic_stack: { title: 'Elastic Stack', parent_id: undefined }, + google_cloud: { title: 'Google Cloud', parent_id: undefined }, + infrastructure: { title: 'Infrastructure', parent_id: undefined }, + kubernetes: { title: 'Kubernetes', parent_id: undefined }, + languages: { title: 'Languages', parent_id: undefined }, + message_queue: { title: 'Message queue', parent_id: undefined }, + microsoft_365: { title: 'Microsoft 365', parent_id: undefined }, + monitoring: { title: 'Monitoring', parent_id: undefined }, + network: { title: 'Network', parent_id: undefined }, + notification: { title: 'Notification', parent_id: undefined }, + os_system: { title: 'OS & System', parent_id: undefined }, + productivity: { title: 'Productivity', parent_id: undefined }, + security: { title: 'Security', parent_id: undefined }, + sample_data: { title: 'Sample data', parent_id: undefined }, + support: { title: 'Support', parent_id: undefined }, + threat_intel: { title: 'Threat intelligence', parent_id: undefined }, + ticketing: { title: 'Ticketing', parent_id: undefined }, + version_control: { title: 'Version control', parent_id: undefined }, + web: { title: 'Web', parent_id: undefined }, // Kibana added - communications: 'Communications', - enterprise_search: 'Enterprise search', - file_storage: 'File storage', - language_client: 'Language client', - upload_file: 'Upload a file', - website_search: 'Website search', - geo: 'Geo', + communications: { title: 'Communications', parent_id: undefined }, + enterprise_search: { title: 'Enterprise search', parent_id: undefined }, + file_storage: { title: 'File storage', parent_id: undefined }, + language_client: { title: 'Language client', parent_id: undefined }, + upload_file: { title: 'Upload a file', parent_id: undefined }, + website_search: { title: 'Website search', parent_id: undefined }, + geo: { title: 'Geo', parent_id: undefined }, }; // featured integrations will be brought to the top of the search results for @@ -61,7 +63,7 @@ export const FEATURED_INTEGRATIONS_BY_CATEGORY = { /** * A category applicable to an Integration. */ -export type IntegrationCategory = keyof typeof INTEGRATION_CATEGORY_DISPLAY; +export type IntegrationCategory = string; /** * The list of all available categories. diff --git a/src/plugins/dashboard/public/dashboard_container/component/grid/_dashboard_grid.scss b/src/plugins/dashboard/public/dashboard_container/component/grid/_dashboard_grid.scss index 450df53c0990a..940accfa4a545 100644 --- a/src/plugins/dashboard/public/dashboard_container/component/grid/_dashboard_grid.scss +++ b/src/plugins/dashboard/public/dashboard_container/component/grid/_dashboard_grid.scss @@ -54,10 +54,18 @@ width: 100% !important; /* 1 */ top: 0 !important; /* 1 */ left: 0 !important; /* 1 */ + padding: $euiSizeS; // Altered panel styles can be found in ../panel } +// Remove padding in fullscreen mode +.kbnAppWrapper--hiddenChrome { + .dshDashboardGrid__item--expanded { + padding: 0; + } +} + // REACT-GRID .react-grid-item { diff --git a/src/plugins/dashboard/public/dashboard_container/component/grid/dashboard_grid.tsx b/src/plugins/dashboard/public/dashboard_container/component/grid/dashboard_grid.tsx index 56555b2406395..86ef728eebd34 100644 --- a/src/plugins/dashboard/public/dashboard_container/component/grid/dashboard_grid.tsx +++ b/src/plugins/dashboard/public/dashboard_container/component/grid/dashboard_grid.tsx @@ -68,14 +68,13 @@ function ResponsiveGrid({ }); const MARGINS = useMargins ? 8 : 0; - // We can't take advantage of isDraggable or isResizable due to performance concerns: - // https://github.com/STRML/react-grid-layout/issues/240 + return ( { }, {} as { [key: string]: DashboardPanelState } ); + // onLayoutChange gets called by react grid layout a lot more than it should, so only dispatch the updated panels if the layout has actually changed if (!getPanelLayoutsAreEqual(panels, updatedPanels)) { dispatch(setPanels(updatedPanels)); diff --git a/src/plugins/dashboard/public/dashboard_container/component/panel/_dashboard_panel.scss b/src/plugins/dashboard/public/dashboard_container/component/panel/_dashboard_panel.scss index f2d017e54dc7b..f04e5e29d960b 100644 --- a/src/plugins/dashboard/public/dashboard_container/component/panel/_dashboard_panel.scss +++ b/src/plugins/dashboard/public/dashboard_container/component/panel/_dashboard_panel.scss @@ -5,10 +5,8 @@ */ // LAYOUT MODES - // Adjust borders/etc... for non-spaced out and expanded panels -.dshLayout-withoutMargins, -.dshDashboardGrid__item--expanded { +.dshLayout-withoutMargins { .embPanel { box-shadow: none; border-radius: 0; @@ -21,4 +19,9 @@ .embPanel { border-color: transparent; } + + .embPanel--dragHandle:hover { + background-color: unset; + cursor: default; + } } diff --git a/src/plugins/dashboard/public/services/notifications/notifications.stub.ts b/src/plugins/dashboard/public/services/notifications/notifications.stub.ts index 83381991fa6f6..18b88f1e16a17 100644 --- a/src/plugins/dashboard/public/services/notifications/notifications.stub.ts +++ b/src/plugins/dashboard/public/services/notifications/notifications.stub.ts @@ -17,5 +17,6 @@ export const notificationsServiceFactory: NotificationsServiceFactory = () => { return { toasts: pluginMock.toasts, + showErrorDialog: pluginMock.showErrorDialog, }; }; diff --git a/src/plugins/dashboard/public/services/notifications/notifications_service.ts b/src/plugins/dashboard/public/services/notifications/notifications_service.ts index f3728c79cf64d..1f4101f2adebe 100644 --- a/src/plugins/dashboard/public/services/notifications/notifications_service.ts +++ b/src/plugins/dashboard/public/services/notifications/notifications_service.ts @@ -17,10 +17,11 @@ export type NotificationsServiceFactory = KibanaPluginServiceFactory< export const notificationsServiceFactory: NotificationsServiceFactory = ({ coreStart }) => { const { - notifications: { toasts }, + notifications: { toasts, showErrorDialog }, } = coreStart; return { toasts, + showErrorDialog, }; }; diff --git a/src/plugins/dashboard/public/services/notifications/types.ts b/src/plugins/dashboard/public/services/notifications/types.ts index 4d439eaa73d6b..462a59df289ab 100644 --- a/src/plugins/dashboard/public/services/notifications/types.ts +++ b/src/plugins/dashboard/public/services/notifications/types.ts @@ -10,4 +10,5 @@ import type { CoreStart } from '@kbn/core/public'; export interface DashboardNotificationsService { toasts: CoreStart['notifications']['toasts']; + showErrorDialog: CoreStart['notifications']['showErrorDialog']; } diff --git a/src/plugins/data/common/search/aggs/agg_types.ts b/src/plugins/data/common/search/aggs/agg_types.ts index 5e8343ba417b4..33485b2fda629 100644 --- a/src/plugins/data/common/search/aggs/agg_types.ts +++ b/src/plugins/data/common/search/aggs/agg_types.ts @@ -66,7 +66,6 @@ export const getAggTypes = () => ({ { name: BUCKET_TYPES.FILTERS, fn: buckets.getFiltersBucketAgg }, { name: BUCKET_TYPES.SIGNIFICANT_TERMS, fn: buckets.getSignificantTermsBucketAgg }, { name: BUCKET_TYPES.SIGNIFICANT_TEXT, fn: buckets.getSignificantTextBucketAgg }, - { name: BUCKET_TYPES.GEOHASH_GRID, fn: buckets.getGeoHashBucketAgg }, { name: BUCKET_TYPES.GEOTILE_GRID, fn: buckets.getGeoTitleBucketAgg }, { name: BUCKET_TYPES.SAMPLER, fn: buckets.getSamplerBucketAgg }, { name: BUCKET_TYPES.DIVERSIFIED_SAMPLER, fn: buckets.getDiversifiedSamplerBucketAgg }, @@ -84,7 +83,6 @@ export const getAggTypesFunctions = () => [ buckets.aggDateRange, buckets.aggRange, buckets.aggGeoTile, - buckets.aggGeoHash, buckets.aggHistogram, buckets.aggDateHistogram, buckets.aggTerms, diff --git a/src/plugins/data/common/search/aggs/aggs_service.test.ts b/src/plugins/data/common/search/aggs/aggs_service.test.ts index c12b2d93b029d..c7f3fc54bfaf4 100644 --- a/src/plugins/data/common/search/aggs/aggs_service.test.ts +++ b/src/plugins/data/common/search/aggs/aggs_service.test.ts @@ -65,7 +65,6 @@ describe('Aggs service', () => { "filters", "significant_terms", "significant_text", - "geohash_grid", "geotile_grid", "sampler", "diversified_sampler", @@ -121,7 +120,6 @@ describe('Aggs service', () => { "filters", "significant_terms", "significant_text", - "geohash_grid", "geotile_grid", "sampler", "diversified_sampler", diff --git a/src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts b/src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts index fa34c7f6535c1..91b0bc1b56fc3 100644 --- a/src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts +++ b/src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts @@ -18,7 +18,6 @@ export enum BUCKET_TYPES { RARE_TERMS = 'rare_terms', SIGNIFICANT_TERMS = 'significant_terms', SIGNIFICANT_TEXT = 'significant_text', - GEOHASH_GRID = 'geohash_grid', GEOTILE_GRID = 'geotile_grid', DATE_HISTOGRAM = 'date_histogram', SAMPLER = 'sampler', diff --git a/src/plugins/data/common/search/aggs/buckets/geo_hash.test.ts b/src/plugins/data/common/search/aggs/buckets/geo_hash.test.ts deleted file mode 100644 index efdbc921290a3..0000000000000 --- a/src/plugins/data/common/search/aggs/buckets/geo_hash.test.ts +++ /dev/null @@ -1,206 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { getGeoHashBucketAgg } from './geo_hash'; -import { AggConfigs, IAggConfigs } from '../agg_configs'; -import { mockAggTypesRegistry } from '../test_helpers'; -import { BUCKET_TYPES } from './bucket_agg_types'; -import { BucketAggType, IBucketAggConfig } from './bucket_agg_type'; - -describe('Geohash Agg', () => { - let geoHashBucketAgg: BucketAggType; - - beforeEach(() => { - geoHashBucketAgg = getGeoHashBucketAgg(); - }); - - const getAggConfigs = (params?: Record) => { - const indexPattern = { - id: '1234', - title: 'logstash-*', - fields: { - getByName: () => field, - filter: () => [field], - }, - } as any; - - const field = { - name: 'location', - indexPattern, - }; - - return new AggConfigs( - indexPattern, - [ - { - id: BUCKET_TYPES.GEOHASH_GRID, - type: BUCKET_TYPES.GEOHASH_GRID, - schema: 'segment', - params: { - field: { - name: 'location', - }, - isFilteredByCollar: true, - useGeocentroid: true, - mapZoom: 10, - mapBounds: { - top_left: { lat: 1.0, lon: -1.0 }, - bottom_right: { lat: -1.0, lon: 1.0 }, - }, - ...params, - }, - }, - ], - { - typesRegistry: mockAggTypesRegistry(), - }, - jest.fn() - ); - }; - - describe('precision parameter', () => { - const PRECISION_PARAM_INDEX = 2; - - let precisionParam: any; - - beforeEach(() => { - precisionParam = geoHashBucketAgg.params[PRECISION_PARAM_INDEX]; - }); - - test('should select precision parameter', () => { - expect(precisionParam.name).toEqual('precision'); - }); - }); - - test('produces the expected expression ast', () => { - const aggConfigs = getAggConfigs(); - expect(aggConfigs.aggs[0].toExpressionAst()).toMatchInlineSnapshot(` - Object { - "chain": Array [ - Object { - "arguments": Object { - "autoPrecision": Array [ - true, - ], - "enabled": Array [ - true, - ], - "field": Array [ - "location", - ], - "id": Array [ - "geohash_grid", - ], - "isFilteredByCollar": Array [ - true, - ], - "precision": Array [ - 2, - ], - "schema": Array [ - "segment", - ], - "useGeocentroid": Array [ - true, - ], - }, - "function": "aggGeoHash", - "type": "function", - }, - ], - "type": "expression", - } - `); - }); - - describe('getRequestAggs', () => { - describe('initial aggregation creation', () => { - let aggConfigs: IAggConfigs; - let geoHashGridAgg: IBucketAggConfig; - - beforeEach(() => { - aggConfigs = getAggConfigs(); - geoHashGridAgg = aggConfigs.aggs[0] as IBucketAggConfig; - }); - - test('should create filter, geohash_grid, and geo_centroid aggregations', () => { - const requestAggs = geoHashBucketAgg.getRequestAggs(geoHashGridAgg) as IBucketAggConfig[]; - - expect(requestAggs.length).toEqual(3); - expect(requestAggs[0].type.name).toEqual('filter'); - expect(requestAggs[1].type.name).toEqual('geohash_grid'); - expect(requestAggs[2].type.name).toEqual('geo_centroid'); - }); - }); - }); - - describe('aggregation options', () => { - test('should only create geohash_grid and geo_centroid aggregations when isFilteredByCollar is false', () => { - const aggConfigs = getAggConfigs({ isFilteredByCollar: false }); - const requestAggs = geoHashBucketAgg.getRequestAggs( - aggConfigs.aggs[0] as IBucketAggConfig - ) as IBucketAggConfig[]; - - expect(requestAggs.length).toEqual(2); - expect(requestAggs[0].type.name).toEqual('geohash_grid'); - expect(requestAggs[1].type.name).toEqual('geo_centroid'); - }); - - test('should only create filter and geohash_grid aggregations when useGeocentroid is false', () => { - const aggConfigs = getAggConfigs({ useGeocentroid: false }); - const requestAggs = geoHashBucketAgg.getRequestAggs( - aggConfigs.aggs[0] as IBucketAggConfig - ) as IBucketAggConfig[]; - - expect(requestAggs.length).toEqual(2); - expect(requestAggs[0].type.name).toEqual('filter'); - expect(requestAggs[1].type.name).toEqual('geohash_grid'); - }); - }); - - describe('aggregation creation after map interaction', () => { - let originalRequestAggs: IBucketAggConfig[]; - - beforeEach(() => { - originalRequestAggs = geoHashBucketAgg.getRequestAggs( - getAggConfigs({ - boundingBox: { - top_left: { lat: 1, lon: -1 }, - bottom_right: { lat: -1, lon: 1 }, - }, - }).aggs[0] as IBucketAggConfig - ) as IBucketAggConfig[]; - }); - - test('should change geo_bounding_box filter aggregation and vis session state when map movement is outside map collar', () => { - const [, geoBoxingBox] = geoHashBucketAgg.getRequestAggs( - getAggConfigs({ - boundingBox: { - top_left: { lat: 10.0, lon: -10.0 }, - bottom_right: { lat: 9.0, lon: -9.0 }, - }, - }).aggs[0] as IBucketAggConfig - ) as IBucketAggConfig[]; - - expect(originalRequestAggs[1].params).not.toEqual(geoBoxingBox.params); - }); - - test('should not change geo_bounding_box filter aggregation and vis session state when map movement is within map collar', () => { - const [, geoBoxingBox] = geoHashBucketAgg.getRequestAggs( - getAggConfigs({ - boundingBox: { - top_left: { lat: 1, lon: -1 }, - bottom_right: { lat: -1, lon: 1 }, - }, - }).aggs[0] as IBucketAggConfig - ) as IBucketAggConfig[]; - - expect(originalRequestAggs[1].params).toEqual(geoBoxingBox.params); - }); - }); -}); diff --git a/src/plugins/data/common/search/aggs/buckets/geo_hash.ts b/src/plugins/data/common/search/aggs/buckets/geo_hash.ts deleted file mode 100644 index bec2e06efca1f..0000000000000 --- a/src/plugins/data/common/search/aggs/buckets/geo_hash.ts +++ /dev/null @@ -1,121 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { i18n } from '@kbn/i18n'; -import { GeoBoundingBox, geoBoundingBoxToAst } from '../../expressions'; - -import { BucketAggType, IBucketAggConfig } from './bucket_agg_type'; -import { KBN_FIELD_TYPES } from '../../..'; -import { BUCKET_TYPES } from './bucket_agg_types'; -import { aggGeoHashFnName } from './geo_hash_fn'; -import { BaseAggParams } from '../types'; - -const defaultBoundingBox = { - top_left: { lat: 1, lon: 1 }, - bottom_right: { lat: 0, lon: 0 }, -}; - -const defaultPrecision = 2; - -const geohashGridTitle = i18n.translate('data.search.aggs.buckets.geohashGridTitle', { - defaultMessage: 'Geohash', -}); - -export interface AggParamsGeoHash extends BaseAggParams { - field: string; - autoPrecision?: boolean; - precision?: number; - useGeocentroid?: boolean; - isFilteredByCollar?: boolean; - boundingBox?: GeoBoundingBox; -} - -export const getGeoHashBucketAgg = () => - new BucketAggType({ - name: BUCKET_TYPES.GEOHASH_GRID, - expressionName: aggGeoHashFnName, - title: geohashGridTitle, - makeLabel: () => geohashGridTitle, - params: [ - { - name: 'field', - type: 'field', - filterFieldTypes: KBN_FIELD_TYPES.GEO_POINT, - }, - { - name: 'autoPrecision', - default: true, - write: () => {}, - }, - { - name: 'precision', - default: defaultPrecision, - write(aggConfig, output) { - output.params.precision = aggConfig.params.precision; - }, - }, - { - name: 'useGeocentroid', - default: true, - write: () => {}, - }, - { - name: 'isFilteredByCollar', - default: true, - write: () => {}, - }, - { - name: 'boundingBox', - default: null, - write: () => {}, - toExpressionAst: geoBoundingBoxToAst, - }, - ], - getRequestAggs(agg) { - const aggs = []; - const params = agg.params; - - if (params.isFilteredByCollar && agg.getField()) { - aggs.push( - agg.aggConfigs.createAggConfig( - { - type: 'filter', - id: 'filter_agg', - enabled: true, - params: { - geo_bounding_box: { - ignore_unmapped: true, - [agg.getField().name]: params.boundingBox || defaultBoundingBox, - }, - }, - } as any, - { addToAggConfigs: false } - ) - ); - } - - aggs.push(agg); - - if (params.useGeocentroid) { - aggs.push( - agg.aggConfigs.createAggConfig( - { - type: 'geo_centroid', - enabled: true, - params: { - field: agg.getField(), - }, - }, - { addToAggConfigs: false } - ) - ); - } - - return aggs; - }, - }); diff --git a/src/plugins/data/common/search/aggs/buckets/geo_hash_fn.test.ts b/src/plugins/data/common/search/aggs/buckets/geo_hash_fn.test.ts deleted file mode 100644 index 0df8c42f70bfb..0000000000000 --- a/src/plugins/data/common/search/aggs/buckets/geo_hash_fn.test.ts +++ /dev/null @@ -1,95 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { functionWrapper } from '../test_helpers'; -import { aggGeoHash } from './geo_hash_fn'; - -describe('agg_expression_functions', () => { - describe('aggGeoHash', () => { - const fn = functionWrapper(aggGeoHash()); - - test('fills in defaults when only required args are provided', () => { - const actual = fn({ - field: 'geo_field', - }); - expect(actual).toMatchInlineSnapshot(` - Object { - "type": "agg_type", - "value": Object { - "enabled": true, - "id": undefined, - "params": Object { - "autoPrecision": undefined, - "boundingBox": undefined, - "customLabel": undefined, - "field": "geo_field", - "isFilteredByCollar": undefined, - "json": undefined, - "precision": undefined, - "useGeocentroid": undefined, - }, - "schema": undefined, - "type": "geohash_grid", - }, - } - `); - }); - - test('includes optional params when they are provided', () => { - const actual = fn({ - field: 'geo_field', - autoPrecision: false, - precision: 10, - useGeocentroid: true, - isFilteredByCollar: false, - boundingBox: { - type: 'geo_bounding_box', - top_left: [-74.1, 40.73], - bottom_right: [-71.12, 40.01], - }, - }); - - expect(actual.value).toMatchInlineSnapshot(` - Object { - "enabled": true, - "id": undefined, - "params": Object { - "autoPrecision": false, - "boundingBox": Object { - "bottom_right": Array [ - -71.12, - 40.01, - ], - "top_left": Array [ - -74.1, - 40.73, - ], - }, - "customLabel": undefined, - "field": "geo_field", - "isFilteredByCollar": false, - "json": undefined, - "precision": 10, - "useGeocentroid": true, - }, - "schema": undefined, - "type": "geohash_grid", - } - `); - }); - - test('correctly parses json string argument', () => { - const actual = fn({ - field: 'geo_field', - json: '{ "foo": true }', - }); - - expect(actual.value.params.json).toEqual('{ "foo": true }'); - }); - }); -}); diff --git a/src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts b/src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts deleted file mode 100644 index c1028133e56b1..0000000000000 --- a/src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts +++ /dev/null @@ -1,122 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { omit } from 'lodash'; -import { i18n } from '@kbn/i18n'; -import { Assign } from '@kbn/utility-types'; -import { ExpressionFunctionDefinition } from '@kbn/expressions-plugin/common'; - -import { GeoBoundingBoxOutput } from '../../expressions'; -import { AggExpressionType, AggExpressionFunctionArgs, BUCKET_TYPES } from '..'; - -export const aggGeoHashFnName = 'aggGeoHash'; - -type Input = any; -type AggArgs = AggExpressionFunctionArgs; - -type Arguments = Assign; -type Output = AggExpressionType; -type FunctionDefinition = ExpressionFunctionDefinition< - typeof aggGeoHashFnName, - Input, - Arguments, - Output ->; - -export const aggGeoHash = (): FunctionDefinition => ({ - name: aggGeoHashFnName, - help: i18n.translate('data.search.aggs.function.buckets.geoHash.help', { - defaultMessage: 'Generates a serialized agg config for a Geo Hash agg', - }), - type: 'agg_type', - args: { - id: { - types: ['string'], - help: i18n.translate('data.search.aggs.buckets.geoHash.id.help', { - defaultMessage: 'ID for this aggregation', - }), - }, - enabled: { - types: ['boolean'], - default: true, - help: i18n.translate('data.search.aggs.buckets.geoHash.enabled.help', { - defaultMessage: 'Specifies whether this aggregation should be enabled', - }), - }, - schema: { - types: ['string'], - help: i18n.translate('data.search.aggs.buckets.geoHash.schema.help', { - defaultMessage: 'Schema to use for this aggregation', - }), - }, - field: { - types: ['string'], - required: true, - help: i18n.translate('data.search.aggs.buckets.geoHash.field.help', { - defaultMessage: 'Field to use for this aggregation', - }), - }, - useGeocentroid: { - types: ['boolean'], - help: i18n.translate('data.search.aggs.buckets.geoHash.useGeocentroid.help', { - defaultMessage: 'Specifies whether to use geocentroid for this aggregation', - }), - }, - autoPrecision: { - types: ['boolean'], - help: i18n.translate('data.search.aggs.buckets.geoHash.autoPrecision.help', { - defaultMessage: 'Specifies whether to use auto precision for this aggregation', - }), - }, - isFilteredByCollar: { - types: ['boolean'], - help: i18n.translate('data.search.aggs.buckets.geoHash.isFilteredByCollar.help', { - defaultMessage: 'Specifies whether to filter by collar', - }), - }, - boundingBox: { - types: ['geo_bounding_box'], - help: i18n.translate('data.search.aggs.buckets.geoHash.boundingBox.help', { - defaultMessage: 'Filter results based on a point location within a bounding box', - }), - }, - precision: { - types: ['number'], - help: i18n.translate('data.search.aggs.buckets.geoHash.precision.help', { - defaultMessage: 'Precision to use for this aggregation.', - }), - }, - json: { - types: ['string'], - help: i18n.translate('data.search.aggs.buckets.geoHash.json.help', { - defaultMessage: 'Advanced json to include when the agg is sent to Elasticsearch', - }), - }, - customLabel: { - types: ['string'], - help: i18n.translate('data.search.aggs.buckets.geoHash.customLabel.help', { - defaultMessage: 'Represents a custom label for this aggregation', - }), - }, - }, - fn: (input, { id, enabled, schema, boundingBox, ...params }) => { - return { - type: 'agg_type', - value: { - id, - enabled, - schema, - params: { - ...params, - boundingBox: boundingBox && omit(boundingBox, 'type'), - }, - type: BUCKET_TYPES.GEOHASH_GRID, - }, - }; - }, -}); diff --git a/src/plugins/data/common/search/aggs/buckets/index.ts b/src/plugins/data/common/search/aggs/buckets/index.ts index 1f673f96199fd..31bc7cf9ca544 100644 --- a/src/plugins/data/common/search/aggs/buckets/index.ts +++ b/src/plugins/data/common/search/aggs/buckets/index.ts @@ -17,8 +17,6 @@ export * from './filter_fn'; export * from './filter'; export * from './filters_fn'; export * from './filters'; -export * from './geo_hash_fn'; -export * from './geo_hash'; export * from './geo_tile_fn'; export * from './geo_tile'; export * from './histogram_fn'; diff --git a/src/plugins/data/common/search/aggs/types.ts b/src/plugins/data/common/search/aggs/types.ts index 4bd20b63945a2..06320728105d2 100644 --- a/src/plugins/data/common/search/aggs/types.ts +++ b/src/plugins/data/common/search/aggs/types.ts @@ -28,7 +28,6 @@ import { aggFilters, aggGeoBounds, aggGeoCentroid, - aggGeoHash, aggGeoTile, aggHistogram, aggIpRange, @@ -58,7 +57,6 @@ import { AggParamsFilters, AggParamsGeoBounds, AggParamsGeoCentroid, - AggParamsGeoHash, AggParamsGeoTile, AggParamsHistogram, AggParamsIpRange, @@ -182,7 +180,6 @@ interface SerializedAggParamsMapping { [BUCKET_TYPES.SIGNIFICANT_TERMS]: AggParamsSignificantTerms; [BUCKET_TYPES.SIGNIFICANT_TEXT]: AggParamsSignificantText; [BUCKET_TYPES.GEOTILE_GRID]: AggParamsGeoTile; - [BUCKET_TYPES.GEOHASH_GRID]: AggParamsGeoHash; [BUCKET_TYPES.HISTOGRAM]: AggParamsHistogram; [BUCKET_TYPES.DATE_HISTOGRAM]: AggParamsDateHistogram; [BUCKET_TYPES.TERMS]: AggParamsTermsSerialized; @@ -229,7 +226,6 @@ export interface AggParamsMapping { [BUCKET_TYPES.SIGNIFICANT_TERMS]: AggParamsSignificantTerms; [BUCKET_TYPES.SIGNIFICANT_TEXT]: AggParamsSignificantText; [BUCKET_TYPES.GEOTILE_GRID]: AggParamsGeoTile; - [BUCKET_TYPES.GEOHASH_GRID]: AggParamsGeoHash; [BUCKET_TYPES.HISTOGRAM]: AggParamsHistogram; [BUCKET_TYPES.DATE_HISTOGRAM]: AggParamsDateHistogram; [BUCKET_TYPES.TERMS]: AggParamsTerms; @@ -277,7 +273,6 @@ export interface AggFunctionsMapping { aggDateRange: ReturnType; aggRange: ReturnType; aggGeoTile: ReturnType; - aggGeoHash: ReturnType; aggHistogram: ReturnType; aggDateHistogram: ReturnType; aggTerms: ReturnType; diff --git a/src/plugins/data/public/index.ts b/src/plugins/data/public/index.ts index f7542ef170965..621b4ec7c1372 100644 --- a/src/plugins/data/public/index.ts +++ b/src/plugins/data/public/index.ts @@ -181,6 +181,7 @@ export { SEARCH_SESSIONS_MANAGEMENT_ID, waitUntilNextSessionCompletes$, isEsError, + getSearchErrorOverrideDisplay, SearchSource, SearchSessionState, SortDirection, diff --git a/src/plugins/data/public/search/aggs/aggs_service.test.ts b/src/plugins/data/public/search/aggs/aggs_service.test.ts index 9742314478704..e348779d6190d 100644 --- a/src/plugins/data/public/search/aggs/aggs_service.test.ts +++ b/src/plugins/data/public/search/aggs/aggs_service.test.ts @@ -52,7 +52,7 @@ describe('AggsService - public', () => { test('registers default agg types', () => { service.setup(setupDeps); const start = service.start(startDeps); - expect(start.types.getAll().buckets.length).toBe(17); + expect(start.types.getAll().buckets.length).toBe(16); expect(start.types.getAll().metrics.length).toBe(27); }); @@ -68,7 +68,7 @@ describe('AggsService - public', () => { ); const start = service.start(startDeps); - expect(start.types.getAll().buckets.length).toBe(18); + expect(start.types.getAll().buckets.length).toBe(17); expect(start.types.getAll().buckets.some(({ name }) => name === 'foo')).toBe(true); expect(start.types.getAll().metrics.length).toBe(28); expect(start.types.getAll().metrics.some(({ name }) => name === 'bar')).toBe(true); diff --git a/src/plugins/data/public/search/index.ts b/src/plugins/data/public/search/index.ts index 6cf303d424042..46024da1096d0 100644 --- a/src/plugins/data/public/search/index.ts +++ b/src/plugins/data/public/search/index.ts @@ -57,6 +57,7 @@ export { getEsPreference } from './es_search'; export type { SearchInterceptorDeps } from './search_interceptor'; export { SearchInterceptor } from './search_interceptor'; +export { getSearchErrorOverrideDisplay } from './search_interceptor/utils'; export * from './errors'; export { SearchService } from './search_service'; diff --git a/src/plugins/data/public/search/search_interceptor/search_interceptor.test.ts b/src/plugins/data/public/search/search_interceptor/search_interceptor.test.ts index 069188ebd5192..ebc7f2528a6de 100644 --- a/src/plugins/data/public/search/search_interceptor/search_interceptor.test.ts +++ b/src/plugins/data/public/search/search_interceptor/search_interceptor.test.ts @@ -23,11 +23,15 @@ import { BehaviorSubject } from 'rxjs'; import { dataPluginMock } from '../../mocks'; import { UI_SETTINGS } from '../../../common'; -jest.mock('./utils', () => ({ - createRequestHash: jest.fn().mockImplementation((input) => { - return Promise.resolve(JSON.stringify(input)); - }), -})); +jest.mock('./utils', () => { + const originalModule = jest.requireActual('./utils'); + return { + ...originalModule, + createRequestHash: jest.fn().mockImplementation((input) => { + return Promise.resolve(JSON.stringify(input)); + }), + }; +}); jest.mock('../errors/search_session_incomplete_warning', () => ({ SearchSessionIncompleteWarning: jest.fn(), diff --git a/src/plugins/data/public/search/search_interceptor/search_interceptor.ts b/src/plugins/data/public/search/search_interceptor/search_interceptor.ts index 8cf0f0a30eedf..cdc91a49e29a0 100644 --- a/src/plugins/data/public/search/search_interceptor/search_interceptor.ts +++ b/src/plugins/data/public/search/search_interceptor/search_interceptor.ts @@ -43,7 +43,6 @@ import { ToastsSetup, } from '@kbn/core/public'; -import { i18n } from '@kbn/i18n'; import { BatchedFunc, BfetchPublicSetup, DISABLE_BFETCH } from '@kbn/bfetch-plugin/public'; import { toMountPoint } from '@kbn/kibana-react-plugin/public'; import { AbortError, KibanaServerError } from '@kbn/kibana-utils-plugin/public'; @@ -70,7 +69,7 @@ import { } from '../errors'; import { ISessionService, SearchSessionState } from '../session'; import { SearchResponseCache } from './search_response_cache'; -import { createRequestHash } from './utils'; +import { createRequestHash, getSearchErrorOverrideDisplay } from './utils'; import { SearchAbortController } from './search_abort_controller'; import { SearchConfigSchema } from '../../../config'; @@ -518,25 +517,17 @@ export class SearchInterceptor { if (e instanceof AbortError || e instanceof SearchTimeoutError) { // The SearchTimeoutError is shown by the interceptor in getSearchError (regardless of how the app chooses to handle errors) return; - } else if (e instanceof EsError) { - this.deps.toasts.addDanger({ - title: i18n.translate('data.search.esErrorTitle', { - defaultMessage: 'Cannot retrieve search results', - }), - text: toMountPoint(e.getErrorMessage(this.application), { theme$: this.deps.theme.theme$ }), - }); - } else if (e.constructor.name === 'HttpFetchError' || e instanceof BfetchRequestError) { - const defaultMsg = i18n.translate('data.errors.fetchError', { - defaultMessage: 'Check your network connection and try again.', - }); + } + const overrideDisplay = getSearchErrorOverrideDisplay({ + error: e, + application: this.application, + }); + + if (overrideDisplay) { this.deps.toasts.addDanger({ - title: i18n.translate('data.search.httpErrorTitle', { - defaultMessage: 'Unable to connect to the Kibana server', - }), - text: toMountPoint(e.message || defaultMsg, { - theme$: this.deps.theme.theme$, - }), + title: overrideDisplay.title, + text: toMountPoint(overrideDisplay.body, { theme$: this.deps.theme.theme$ }), }); } else { this.deps.toasts.addError(e, { diff --git a/src/plugins/data/public/search/search_interceptor/utils.ts b/src/plugins/data/public/search/search_interceptor/utils.ts index a03198808bdda..c36a5ded6a2e8 100644 --- a/src/plugins/data/public/search/search_interceptor/utils.ts +++ b/src/plugins/data/public/search/search_interceptor/utils.ts @@ -8,7 +8,42 @@ import stringify from 'json-stable-stringify'; import { Sha256 } from '@kbn/crypto-browser'; +import { i18n } from '@kbn/i18n'; +import { ReactNode } from 'react'; +import { BfetchRequestError } from '@kbn/bfetch-plugin/public'; +import { ApplicationStart } from '@kbn/core-application-browser'; +import { EsError } from '../errors'; export async function createRequestHash(keys: Record) { return new Sha256().update(stringify(keys), 'utf8').digest('hex'); } + +export function getSearchErrorOverrideDisplay({ + error, + application, +}: { + error: Error; + application: ApplicationStart; +}): { title: string; body: ReactNode } | undefined { + if (error instanceof EsError) { + return { + title: i18n.translate('data.search.esErrorTitle', { + defaultMessage: 'Cannot retrieve search results', + }), + body: error.getErrorMessage(application), + }; + } + + if (error.constructor.name === 'HttpFetchError' || error instanceof BfetchRequestError) { + const defaultMsg = i18n.translate('data.errors.fetchError', { + defaultMessage: 'Check your network connection and try again.', + }); + + return { + title: i18n.translate('data.search.httpErrorTitle', { + defaultMessage: 'Unable to connect to the Kibana server', + }), + body: error.message || defaultMsg, + }; + } +} diff --git a/src/plugins/data/public/search/session/session_indicator/search_session_indicator/search_session_indicator.tsx b/src/plugins/data/public/search/session/session_indicator/search_session_indicator/search_session_indicator.tsx index 465c447039e5e..091c080969329 100644 --- a/src/plugins/data/public/search/session/session_indicator/search_session_indicator/search_session_indicator.tsx +++ b/src/plugins/data/public/search/session/session_indicator/search_session_indicator/search_session_indicator.tsx @@ -311,7 +311,7 @@ const searchSessionIndicatorViewStateToProps: { [SearchSessionState.Canceled]: { button: { color: 'danger', - iconType: 'alert', + iconType: 'error', 'aria-label': i18n.translate('data.searchSessionIndicator.canceledIconAriaLabel', { defaultMessage: 'Search session stopped', }), diff --git a/src/plugins/data/public/search/session/sessions_mgmt/components/actions/delete_button.tsx b/src/plugins/data/public/search/session/sessions_mgmt/components/actions/delete_button.tsx index 39c8b8d0fc38c..46f7698fe589f 100644 --- a/src/plugins/data/public/search/session/sessions_mgmt/components/actions/delete_button.tsx +++ b/src/plugins/data/public/search/session/sessions_mgmt/components/actions/delete_button.tsx @@ -68,7 +68,7 @@ export const createDeleteActionDescriptor = ( uiSession: UISession, core: CoreStart ): IClickActionDescriptor => ({ - iconType: 'crossInACircleFilled', + iconType: 'trash', label: , onClick: async () => { const ref = core.overlays.openModal( diff --git a/src/plugins/data/public/search/session/sessions_mgmt/components/status.tsx b/src/plugins/data/public/search/session/sessions_mgmt/components/status.tsx index 68dec9750cf2e..62942c86c40a4 100644 --- a/src/plugins/data/public/search/session/sessions_mgmt/components/status.tsx +++ b/src/plugins/data/public/search/session/sessions_mgmt/components/status.tsx @@ -104,7 +104,7 @@ const getStatusAttributes = ({ case SearchSessionStatus.CANCELLED: return { - icon: , + icon: , label: {getStatusText(session.status)}, toolTipContent: i18n.translate('data.mgmt.searchSessions.status.message.cancelled', { defaultMessage: 'Cancelled by user', @@ -114,7 +114,7 @@ const getStatusAttributes = ({ case SearchSessionStatus.ERROR: return { textColor: 'danger', - icon: , + icon: , label: {getStatusText(session.status)}, toolTipContent: session.errors && session.errors.length > 0 diff --git a/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx b/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx index f6db378bb2942..cfedbd59b29e5 100644 --- a/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx +++ b/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx @@ -107,7 +107,7 @@ export const getColumns = ( <> {' '} {' '} + The ShardFailureModal component received invalid properties ); diff --git a/src/plugins/data/server/saved_objects/query.ts b/src/plugins/data/server/saved_objects/query.ts index 0e11bf7a9f2e0..c32a13e85888a 100644 --- a/src/plugins/data/server/saved_objects/query.ts +++ b/src/plugins/data/server/saved_objects/query.ts @@ -33,7 +33,10 @@ export const querySavedObjectType: SavedObjectsType = { title: { type: 'text' }, description: { type: 'text' }, query: { - properties: { language: { type: 'keyword' }, query: { type: 'keyword', index: false } }, + dynamic: false, + properties: { + language: { type: 'keyword' }, + }, }, filters: { dynamic: false, diff --git a/src/plugins/data/tsconfig.json b/src/plugins/data/tsconfig.json index 48bb37d77ed95..dc9b57dca02df 100644 --- a/src/plugins/data/tsconfig.json +++ b/src/plugins/data/tsconfig.json @@ -46,6 +46,7 @@ "@kbn/crypto-browser", "@kbn/config", "@kbn/config-schema", + "@kbn/core-application-browser", ], "exclude": [ "target/**/*", diff --git a/src/plugins/data_view_field_editor/public/components/confirm_modals/delete_field_modal.tsx b/src/plugins/data_view_field_editor/public/components/confirm_modals/delete_field_modal.tsx index a9d6d596baf22..4a953c1e6c22f 100644 --- a/src/plugins/data_view_field_editor/public/components/confirm_modals/delete_field_modal.tsx +++ b/src/plugins/data_view_field_editor/public/components/confirm_modals/delete_field_modal.tsx @@ -99,7 +99,12 @@ export function DeleteFieldModal({ fieldsToDelete, closeModal, confirmDelete }: confirmButtonText={confirmButtonText} confirmButtonDisabled={confirmContent?.toUpperCase() !== 'REMOVE'} > - + {isMultiple && ( <>

{warningMultipleFields}

diff --git a/src/plugins/data_view_field_editor/public/components/confirm_modals/save_field_type_or_name_changed_modal.tsx b/src/plugins/data_view_field_editor/public/components/confirm_modals/save_field_type_or_name_changed_modal.tsx index 51af86868c632..2e3aaf93a1861 100644 --- a/src/plugins/data_view_field_editor/public/components/confirm_modals/save_field_type_or_name_changed_modal.tsx +++ b/src/plugins/data_view_field_editor/public/components/confirm_modals/save_field_type_or_name_changed_modal.tsx @@ -70,7 +70,7 @@ export const SaveFieldTypeOrNameChangedModal: React.FC = ({ diff --git a/src/plugins/data_view_field_editor/public/components/field_editor/field_editor.tsx b/src/plugins/data_view_field_editor/public/components/field_editor/field_editor.tsx index 88c91ab645776..11da38cb2a1e7 100644 --- a/src/plugins/data_view_field_editor/public/components/field_editor/field_editor.tsx +++ b/src/plugins/data_view_field_editor/public/components/field_editor/field_editor.tsx @@ -276,7 +276,7 @@ const FieldEditorComponent = ({ field, onChange, onFormModifiedChange }: Props) diff --git a/src/plugins/data_view_field_editor/public/components/preview/field_list/field_list_item.tsx b/src/plugins/data_view_field_editor/public/components/preview/field_list/field_list_item.tsx index 7631e251e2033..21b2baa320074 100644 --- a/src/plugins/data_view_field_editor/public/components/preview/field_list/field_list_item.tsx +++ b/src/plugins/data_view_field_editor/public/components/preview/field_list/field_list_item.tsx @@ -83,7 +83,7 @@ export const PreviewListItem: React.FC = ({ if (hasScriptError) { return (
- + {i18n.translate('indexPatternFieldEditor.fieldPreview.scriptErrorBadgeLabel', { defaultMessage: 'Script error', })} diff --git a/src/plugins/data_view_field_editor/public/components/preview/field_preview.tsx b/src/plugins/data_view_field_editor/public/components/preview/field_preview.tsx index f331e62bd7016..672f0a747991d 100644 --- a/src/plugins/data_view_field_editor/public/components/preview/field_preview.tsx +++ b/src/plugins/data_view_field_editor/public/components/preview/field_preview.tsx @@ -98,7 +98,7 @@ export const FieldPreview = () => { } )} color="warning" - iconType="alert" + iconType="warning" role="alert" data-test-subj="previewNotAvailableCallout" > diff --git a/src/plugins/data_view_field_editor/public/components/preview/field_preview_error.tsx b/src/plugins/data_view_field_editor/public/components/preview/field_preview_error.tsx index 6ca38d4d186fb..22bc24d04b714 100644 --- a/src/plugins/data_view_field_editor/public/components/preview/field_preview_error.tsx +++ b/src/plugins/data_view_field_editor/public/components/preview/field_preview_error.tsx @@ -26,7 +26,7 @@ export const FieldPreviewError = () => { defaultMessage: 'Error fetching document', })} color="danger" - iconType="alert" + iconType="error" role="alert" data-test-subj="fetchDocError" > diff --git a/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx b/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx index de421c0b8945e..adbdd1cd2681f 100644 --- a/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx +++ b/src/plugins/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx @@ -249,7 +249,7 @@ export const EditIndexPattern = withRouter( {conflictedFields.length > 0 && ( <> - +

{mappingConflictLabel}

 diff --git a/src/plugins/data_view_management/public/components/edit_index_pattern/indexed_fields_table/components/table/__snapshots__/table.test.tsx.snap b/src/plugins/data_view_management/public/components/edit_index_pattern/indexed_fields_table/components/table/__snapshots__/table.test.tsx.snap index 65c124c6676fa..06613de9ee5ad 100644 --- a/src/plugins/data_view_management/public/components/edit_index_pattern/indexed_fields_table/components/table/__snapshots__/table.test.tsx.snap +++ b/src/plugins/data_view_management/public/components/edit_index_pattern/indexed_fields_table/components/table/__snapshots__/table.test.tsx.snap @@ -113,7 +113,7 @@ exports[`Table should render conflicting type 1`] = ` color="warning" iconOnClick={[Function]} iconOnClickAriaLabel="Conflict Detail" - iconType="alert" + iconType="warning" onClick={[Function]} onClickAriaLabel="Conflict Detail" > diff --git a/src/plugins/data_view_management/public/components/edit_index_pattern/indexed_fields_table/components/table/table.tsx b/src/plugins/data_view_management/public/components/edit_index_pattern/indexed_fields_table/components/table/table.tsx index b7ed701b31c68..21fe78b68039a 100644 --- a/src/plugins/data_view_management/public/components/edit_index_pattern/indexed_fields_table/components/table/table.tsx +++ b/src/plugins/data_view_management/public/components/edit_index_pattern/indexed_fields_table/components/table/table.tsx @@ -357,7 +357,7 @@ const getConflictBtn = ( diff --git a/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/components/header/header.tsx b/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/components/header/header.tsx index dd4a4e6d71dbb..75111879c4480 100644 --- a/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/components/header/header.tsx +++ b/src/plugins/data_view_management/public/components/edit_index_pattern/scripted_fields_table/components/header/header.tsx @@ -35,7 +35,7 @@ export const Header = withRouter(({ indexPatternId, history }: HeaderProps) => { defaultMessage="Scripted fields can be used in visualizations and displayed in documents. However, they cannot be searched." />
- +     @@ -1181,7 +1181,7 @@ exports[`FieldEditor should show multiple type field warning with a table contai  
); const errorState = ( - + ); if (reqState === ElasticRequestState.Error || reqState === ElasticRequestState.NotFound) { diff --git a/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/table_cell_value.tsx b/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/table_cell_value.tsx index d539155ada632..b35d66e9cfe5c 100644 --- a/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/table_cell_value.tsx +++ b/src/plugins/discover/public/services/doc_views/components/doc_viewer_table/table_cell_value.tsx @@ -65,7 +65,7 @@ const IgnoreWarning: React.FC = React.memo(({ rawValue, reas `} > - + diff --git a/src/plugins/discover/tsconfig.json b/src/plugins/discover/tsconfig.json index ff8b9b0bed857..546c1cd431b6a 100644 --- a/src/plugins/discover/tsconfig.json +++ b/src/plugins/discover/tsconfig.json @@ -49,7 +49,6 @@ "@kbn/react-field", "@kbn/monaco", "@kbn/core-notifications-browser", - "@kbn/rison", "@kbn/config-schema", "@kbn/storybook", "@kbn/shared-ux-router", diff --git a/src/plugins/embeddable/public/bootstrap.ts b/src/plugins/embeddable/public/bootstrap.ts index 242fa37b75dff..54bcb4c5f647e 100644 --- a/src/plugins/embeddable/public/bootstrap.ts +++ b/src/plugins/embeddable/public/bootstrap.ts @@ -15,6 +15,7 @@ import { selectRangeTrigger, valueClickTrigger, cellValueTrigger, + panelHoverTrigger, } from './lib'; /** @@ -23,6 +24,7 @@ import { */ export const bootstrap = (uiActions: UiActionsSetup) => { uiActions.registerTrigger(contextMenuTrigger); + uiActions.registerTrigger(panelHoverTrigger); uiActions.registerTrigger(panelBadgeTrigger); uiActions.registerTrigger(panelNotificationTrigger); uiActions.registerTrigger(selectRangeTrigger); diff --git a/src/plugins/embeddable/public/index.ts b/src/plugins/embeddable/public/index.ts index 18e5484b8fa4d..9d89aab704766 100644 --- a/src/plugins/embeddable/public/index.ts +++ b/src/plugins/embeddable/public/index.ts @@ -89,6 +89,8 @@ export { isFilterableEmbeddable, shouldFetch$, shouldRefreshFilterCompareOptions, + PANEL_HOVER_TRIGGER, + panelHoverTrigger, } from './lib'; export { AttributeService, ATTRIBUTE_SERVICE_KEY } from './lib/attribute_service'; diff --git a/src/plugins/embeddable/public/lib/panel/_embeddable_panel.scss b/src/plugins/embeddable/public/lib/panel/_embeddable_panel.scss index 80814427c9371..5656bb7566775 100644 --- a/src/plugins/embeddable/public/lib/panel/_embeddable_panel.scss +++ b/src/plugins/embeddable/public/lib/panel/_embeddable_panel.scss @@ -136,10 +136,10 @@ // EDITING MODE .embPanel--editing { - border-style: dashed !important; - border-color: $euiColorMediumShade !important; + outline-style: dashed !important; + outline-color: $euiColorMediumShade !important; transition: all $euiAnimSpeedFast $euiAnimSlightResistance; - border-width: $euiBorderWidthThin; + outline-width: $euiBorderWidthThin; &:hover, &:focus { diff --git a/src/plugins/embeddable/public/lib/panel/embeddable_panel_error.tsx b/src/plugins/embeddable/public/lib/panel/embeddable_panel_error.tsx index 4aba5ed105154..b5b9eaa267bde 100644 --- a/src/plugins/embeddable/public/lib/panel/embeddable_panel_error.tsx +++ b/src/plugins/embeddable/public/lib/panel/embeddable_panel_error.tsx @@ -72,7 +72,7 @@ export function EmbeddablePanelError({ } data-test-subj="embeddableStackError" - iconType="alert" + iconType="warning" iconColor="danger" layout="vertical" actions={ diff --git a/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/customize_panel/customize_panel_action.tsx b/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/customize_panel/customize_panel_action.tsx index ec6c2011ca53d..a5d8719b99c99 100644 --- a/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/customize_panel/customize_panel_action.tsx +++ b/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/customize_panel/customize_panel_action.tsx @@ -129,6 +129,8 @@ export class CustomizePanelAction implements Action { size: 's', 'data-test-subj': 'customizePanel', + // @ts-ignore - TODO: Remove this once https://github.com/elastic/eui/pull/6645 lands in Kibana + focusTrapProps: { scrollLock: true }, } ); overlayTracker?.openOverlay(handle); diff --git a/src/plugins/embeddable/public/lib/triggers/triggers.ts b/src/plugins/embeddable/public/lib/triggers/triggers.ts index 529b6bfede65b..94c09c2d79376 100644 --- a/src/plugins/embeddable/public/lib/triggers/triggers.ts +++ b/src/plugins/embeddable/public/lib/triggers/triggers.ts @@ -78,6 +78,17 @@ export const contextMenuTrigger: Trigger = { }), }; +export const PANEL_HOVER_TRIGGER = 'PANEL_HOVER_TRIGGER'; +export const panelHoverTrigger: Trigger = { + id: PANEL_HOVER_TRIGGER, + title: i18n.translate('embeddableApi.panelHoverTrigger.title', { + defaultMessage: 'Panel hover', + }), + description: i18n.translate('embeddableApi.panelHoverTrigger.description', { + defaultMessage: "A new action will be added to the panel's hover menu", + }), +}; + export const PANEL_BADGE_TRIGGER = 'PANEL_BADGE_TRIGGER'; export const panelBadgeTrigger: Trigger = { id: PANEL_BADGE_TRIGGER, diff --git a/src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/page_error.tsx b/src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/page_error.tsx index a0f132d76c511..0d2e5a7f8f635 100644 --- a/src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/page_error.tsx +++ b/src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/page_error.tsx @@ -65,7 +65,7 @@ export const PageError: React.FunctionComponent = ({ ) } - iconType="alert" + iconType="warning" actions={actions} {...rest} /> diff --git a/src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx b/src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx index a1652b4e153f5..7b9731f14df12 100644 --- a/src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx +++ b/src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx @@ -29,7 +29,7 @@ export const SectionError: React.FunctionComponent = ({ } = error; return ( - + {cause ? message || errorString :

{message || errorString}

} {cause && ( diff --git a/src/plugins/expression_error/public/components/error_component.tsx b/src/plugins/expression_error/public/components/error_component.tsx index 8f13d70fe3540..f0b54f72b2795 100644 --- a/src/plugins/expression_error/public/components/error_component.tsx +++ b/src/plugins/expression_error/public/components/error_component.tsx @@ -52,7 +52,7 @@ function ErrorComponent({ onLoaded, parentNode, error }: ErrorComponentProps) { height: buttonSize, width: buttonSize, }} - type="alert" + type="warning" /> } isOpen={isPopoverOpen} diff --git a/src/plugins/home/public/application/components/guided_onboarding/getting_started.tsx b/src/plugins/home/public/application/components/guided_onboarding/getting_started.tsx index 01d39efbcf2b8..2b89ad75affbf 100644 --- a/src/plugins/home/public/application/components/guided_onboarding/getting_started.tsx +++ b/src/plugins/home/public/application/components/guided_onboarding/getting_started.tsx @@ -146,7 +146,7 @@ export const GettingStarted = () => { if (isError) { return ( diff --git a/src/plugins/home/server/services/tutorials/tutorials_registry.test.ts b/src/plugins/home/server/services/tutorials/tutorials_registry.test.ts index 7046500dc717e..5a8c6dc55bda4 100644 --- a/src/plugins/home/server/services/tutorials/tutorials_registry.test.ts +++ b/src/plugins/home/server/services/tutorials/tutorials_registry.test.ts @@ -27,7 +27,7 @@ const INVALID_TUTORIAL: TutorialSchema = { name: '', isBeta: false, shortDescription: 'short description', - euiIconType: 'alert', + euiIconType: 'warning', longDescription: 'long description with lots of text', completionTimeMinutes: 10, previewImagePath: 'path', @@ -49,7 +49,7 @@ const VALID_TUTORIAL: TutorialSchema = { moduleName: 'test', isBeta: false, shortDescription: 'short description', - euiIconType: 'alert', + euiIconType: 'warning', longDescription: 'long description with lots of text', completionTimeMinutes: 10, previewImagePath: 'path', @@ -128,7 +128,7 @@ describe('TutorialsRegistry', () => { description: 'short description', icons: [ { - src: 'alert', + src: 'warning', type: 'eui', }, ], diff --git a/src/plugins/input_control_vis/public/components/vis/__snapshots__/form_row.test.tsx.snap b/src/plugins/input_control_vis/public/components/vis/__snapshots__/form_row.test.tsx.snap index 8a1bbc60c4511..950577cf806d2 100644 --- a/src/plugins/input_control_vis/public/components/vis/__snapshots__/form_row.test.tsx.snap +++ b/src/plugins/input_control_vis/public/components/vis/__snapshots__/form_row.test.tsx.snap @@ -17,7 +17,7 @@ exports[`renders control with warning 1`] = ` position="top" > test control diff --git a/src/plugins/input_control_vis/public/components/vis/form_row.tsx b/src/plugins/input_control_vis/public/components/vis/form_row.tsx index 5e28ab42db695..0540c5bf5be95 100644 --- a/src/plugins/input_control_vis/public/components/vis/form_row.tsx +++ b/src/plugins/input_control_vis/public/components/vis/form_row.tsx @@ -32,7 +32,7 @@ export function FormRow(props: FormRowProps) { const label = props.warningMsg ? ( <> - + {props.label} diff --git a/src/plugins/interactive_setup/public/cluster_configuration_form.tsx b/src/plugins/interactive_setup/public/cluster_configuration_form.tsx index 5ce4068039b85..d511e69dffdf8 100644 --- a/src/plugins/interactive_setup/public/cluster_configuration_form.tsx +++ b/src/plugins/interactive_setup/public/cluster_configuration_form.tsx @@ -222,7 +222,7 @@ export const ClusterConfigurationForm: FunctionComponent = ({ - className = '', - actions, - isEnabled, children, + viewMode, + isEnabled, + embeddable, + className = '', + disabledActions, }) => { + const { + uiActions: { getTriggerCompatibleActions }, + } = pluginServices.getServices(); + + const [floatingActions, setFloatingActions] = useState(undefined); + + useEffect(() => { + if (!embeddable) return; + + const getActions = async () => { + const context = { + embeddable, + trigger: panelHoverTrigger, + }; + const actions = (await getTriggerCompatibleActions(PANEL_HOVER_TRIGGER, context)) + .filter((action): action is Action & { MenuItem: React.FC } => { + return action.MenuItem !== undefined && (disabledActions ?? []).indexOf(action.id) === -1; + }) + .sort((a, b) => (a.order || 0) - (b.order || 0)); + if (actions.length > 0) { + setFloatingActions( + <> + {actions.map((action) => + React.createElement(action.MenuItem, { + key: action.id, + context, + }) + )} + + ); + } else { + setFloatingActions(undefined); + } + }; + + getActions(); + }, [embeddable, getTriggerCompatibleActions, viewMode, disabledActions]); + return (
{children} - {isEnabled && ( -
{actions}
+ {isEnabled && floatingActions && ( +
+ {floatingActions} +
)}
); diff --git a/src/plugins/presentation_util/public/mocks.ts b/src/plugins/presentation_util/public/mocks.ts index 8804c21bf6d9c..2a3bdba1a0a7e 100644 --- a/src/plugins/presentation_util/public/mocks.ts +++ b/src/plugins/presentation_util/public/mocks.ts @@ -13,7 +13,9 @@ import { registry } from './services/plugin_services'; import { registerExpressionsLanguage } from '.'; const createStartContract = (coreStart: CoreStart): PresentationUtilPluginStart => { - pluginServices.setRegistry(registry.start({ coreStart, startPlugins: { dataViews: {} } as any })); + pluginServices.setRegistry( + registry.start({ coreStart, startPlugins: { dataViews: {}, uiActions: {} } as any }) + ); const startContract: PresentationUtilPluginStart = { ContextProvider: pluginServices.getContextProvider(), diff --git a/src/plugins/presentation_util/public/services/plugin_services.story.ts b/src/plugins/presentation_util/public/services/plugin_services.story.ts index 8eb38a3dee019..b95b99e1dbca8 100644 --- a/src/plugins/presentation_util/public/services/plugin_services.story.ts +++ b/src/plugins/presentation_util/public/services/plugin_services.story.ts @@ -18,12 +18,14 @@ import { capabilitiesServiceFactory } from './capabilities/capabilities.story'; import { dataViewsServiceFactory } from './data_views/data_views.story'; import { dashboardsServiceFactory } from './dashboards/dashboards.stub'; import { labsServiceFactory } from './labs/labs.story'; +import { uiActionsServiceFactory } from './ui_actions/ui_actions.stub'; export const providers: PluginServiceProviders = { capabilities: new PluginServiceProvider(capabilitiesServiceFactory), labs: new PluginServiceProvider(labsServiceFactory), dataViews: new PluginServiceProvider(dataViewsServiceFactory), dashboards: new PluginServiceProvider(dashboardsServiceFactory), + uiActions: new PluginServiceProvider(uiActionsServiceFactory), }; export const pluginServices = new PluginServices(); diff --git a/src/plugins/presentation_util/public/services/plugin_services.stub.ts b/src/plugins/presentation_util/public/services/plugin_services.stub.ts index 8f69efbcbe0c4..427fbf9a3b6eb 100644 --- a/src/plugins/presentation_util/public/services/plugin_services.stub.ts +++ b/src/plugins/presentation_util/public/services/plugin_services.stub.ts @@ -15,12 +15,14 @@ import { capabilitiesServiceFactory } from './capabilities/capabilities.story'; import { dataViewsServiceFactory } from './data_views/data_views.story'; import { dashboardsServiceFactory } from './dashboards/dashboards.stub'; import { labsServiceFactory } from './labs/labs.story'; +import { uiActionsServiceFactory } from './ui_actions/ui_actions.stub'; export const providers: PluginServiceProviders = { capabilities: new PluginServiceProvider(capabilitiesServiceFactory), labs: new PluginServiceProvider(labsServiceFactory), dataViews: new PluginServiceProvider(dataViewsServiceFactory), dashboards: new PluginServiceProvider(dashboardsServiceFactory), + uiActions: new PluginServiceProvider(uiActionsServiceFactory), }; export const pluginServices = new PluginServices(); diff --git a/src/plugins/presentation_util/public/services/plugin_services.ts b/src/plugins/presentation_util/public/services/plugin_services.ts index 04f36836bd1ff..266912446b63c 100644 --- a/src/plugins/presentation_util/public/services/plugin_services.ts +++ b/src/plugins/presentation_util/public/services/plugin_services.ts @@ -18,6 +18,7 @@ import { PresentationUtilPluginStartDeps } from '../types'; import { capabilitiesServiceFactory } from './capabilities/capabilities_service'; import { dataViewsServiceFactory } from './data_views/data_views_service'; import { dashboardsServiceFactory } from './dashboards/dashboards_service'; +import { uiActionsServiceFactory } from './ui_actions/ui_actions_service'; import { labsServiceFactory } from './labs/labs_service'; import { PresentationUtilServices } from './types'; @@ -29,6 +30,7 @@ export const providers: PluginServiceProviders< labs: new PluginServiceProvider(labsServiceFactory), dataViews: new PluginServiceProvider(dataViewsServiceFactory), dashboards: new PluginServiceProvider(dashboardsServiceFactory), + uiActions: new PluginServiceProvider(uiActionsServiceFactory), }; export const pluginServices = new PluginServices(); diff --git a/src/plugins/presentation_util/public/services/types.ts b/src/plugins/presentation_util/public/services/types.ts index b2d32788b1762..861d4f55068ac 100644 --- a/src/plugins/presentation_util/public/services/types.ts +++ b/src/plugins/presentation_util/public/services/types.ts @@ -10,11 +10,13 @@ import { PresentationLabsService } from './labs/types'; import { PresentationDashboardsService } from './dashboards/types'; import { PresentationCapabilitiesService } from './capabilities/types'; import { PresentationDataViewsService } from './data_views/types'; +import { PresentationUiActionsService } from './ui_actions/types'; export interface PresentationUtilServices { + capabilities: PresentationCapabilitiesService; dashboards: PresentationDashboardsService; dataViews: PresentationDataViewsService; - capabilities: PresentationCapabilitiesService; + uiActions: PresentationUiActionsService; labs: PresentationLabsService; } diff --git a/src/plugins/presentation_util/public/services/ui_actions/types.ts b/src/plugins/presentation_util/public/services/ui_actions/types.ts new file mode 100644 index 0000000000000..141be2dfa20d0 --- /dev/null +++ b/src/plugins/presentation_util/public/services/ui_actions/types.ts @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { UiActionsStart } from '@kbn/ui-actions-plugin/public'; + +export interface PresentationUiActionsService { + getTriggerCompatibleActions: UiActionsStart['getTriggerCompatibleActions']; +} diff --git a/src/plugins/presentation_util/public/services/ui_actions/ui_actions.stub.ts b/src/plugins/presentation_util/public/services/ui_actions/ui_actions.stub.ts new file mode 100644 index 0000000000000..449cd7e8184ce --- /dev/null +++ b/src/plugins/presentation_util/public/services/ui_actions/ui_actions.stub.ts @@ -0,0 +1,18 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +import { uiActionsPluginMock } from '@kbn/ui-actions-plugin/public/mocks'; + +import { PluginServiceFactory } from '../create'; +import { PresentationUiActionsService } from './types'; + +type CapabilitiesServiceFactory = PluginServiceFactory; + +export const uiActionsServiceFactory: CapabilitiesServiceFactory = () => { + const { getTriggerCompatibleActions } = uiActionsPluginMock.createStartContract(); + return { getTriggerCompatibleActions }; +}; diff --git a/src/plugins/presentation_util/public/services/ui_actions/ui_actions_service.ts b/src/plugins/presentation_util/public/services/ui_actions/ui_actions_service.ts new file mode 100644 index 0000000000000..dc6b16240faba --- /dev/null +++ b/src/plugins/presentation_util/public/services/ui_actions/ui_actions_service.ts @@ -0,0 +1,25 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { PresentationUtilPluginStartDeps } from '../../types'; +import { PresentationUiActionsService } from './types'; +import { KibanaPluginServiceFactory } from '../create'; + +export type UiActionsServiceFactory = KibanaPluginServiceFactory< + PresentationUiActionsService, + PresentationUtilPluginStartDeps +>; + +export const uiActionsServiceFactory: UiActionsServiceFactory = ({ startPlugins }) => { + const { + uiActions: { getTriggerCompatibleActions }, + } = startPlugins; + return { + getTriggerCompatibleActions, + }; +}; diff --git a/src/plugins/presentation_util/public/types.ts b/src/plugins/presentation_util/public/types.ts index 277c0960b269e..3b2785da82c0e 100644 --- a/src/plugins/presentation_util/public/types.ts +++ b/src/plugins/presentation_util/public/types.ts @@ -7,6 +7,7 @@ */ import { DataViewsPublicPluginStart } from '@kbn/data-views-plugin/public'; +import { UiActionsStart } from '@kbn/ui-actions-plugin/public/plugin'; import { registerExpressionsLanguage } from '.'; import { PresentationLabsService } from './services/labs/types'; @@ -23,4 +24,5 @@ export interface PresentationUtilPluginSetupDeps {} export interface PresentationUtilPluginStartDeps { dataViews: DataViewsPublicPluginStart; + uiActions: UiActionsStart; } diff --git a/src/plugins/presentation_util/tsconfig.json b/src/plugins/presentation_util/tsconfig.json index adc524125392e..394337e477ef9 100644 --- a/src/plugins/presentation_util/tsconfig.json +++ b/src/plugins/presentation_util/tsconfig.json @@ -28,6 +28,7 @@ "@kbn/react-field", "@kbn/config-schema", "@kbn/storybook", + "@kbn/ui-actions-plugin", ], "exclude": [ "target/**/*", diff --git a/src/plugins/saved_objects_finder/public/finder/saved_object_finder.test.tsx b/src/plugins/saved_objects_finder/public/finder/saved_object_finder.test.tsx index 7e560906b8ae9..1c8ed33853c87 100644 --- a/src/plugins/saved_objects_finder/public/finder/saved_object_finder.test.tsx +++ b/src/plugins/saved_objects_finder/public/finder/saved_object_finder.test.tsx @@ -10,7 +10,14 @@ const nextTick = () => new Promise((res) => process.nextTick(res)); import lodash from 'lodash'; jest.spyOn(lodash, 'debounce').mockImplementation((fn: any) => fn); -import { EuiInMemoryTable, EuiLink, EuiSearchBarProps, Query } from '@elastic/eui'; +import { + EuiInMemoryTable, + EuiLink, + EuiSearchBarProps, + EuiText, + EuiButton, + Query, +} from '@elastic/eui'; import { IconType } from '@elastic/eui'; import { mount, shallow } from 'enzyme'; import React from 'react'; @@ -133,63 +140,130 @@ describe('SavedObjectsFinder', () => { }); }); - it('should list initial items', async () => { - const core = coreMock.createStart(); - (core.http.get as any as jest.SpyInstance).mockImplementation(() => - Promise.resolve({ saved_objects: [doc] }) - ); - core.uiSettings.get.mockImplementation(() => 10); + describe('render', () => { + it('lists initial items', async () => { + const core = coreMock.createStart(); + (core.http.get as any as jest.SpyInstance).mockImplementation(() => + Promise.resolve({ saved_objects: [doc] }) + ); + core.uiSettings.get.mockImplementation(() => 10); - const wrapper = shallow( - - ); + const wrapper = shallow( + + ); - wrapper.instance().componentDidMount!(); - await nextTick(); - expect( - wrapper - .find(EuiInMemoryTable) - .prop('items') - .map((item: any) => item.attributes) - ).toEqual([doc.attributes]); - }); + wrapper.instance().componentDidMount!(); + await nextTick(); + expect( + wrapper + .find(EuiInMemoryTable) + .prop('items') + .map((item: any) => item.attributes) + ).toEqual([doc.attributes]); + }); - it('should call onChoose on item click', async () => { - const chooseStub = sinon.stub(); - const core = coreMock.createStart(); - (core.http.get as any as jest.SpyInstance).mockImplementation(() => - Promise.resolve({ saved_objects: [doc] }) - ); - core.uiSettings.get.mockImplementation(() => 10); + it('calls onChoose on item click', async () => { + const chooseStub = sinon.stub(); + const core = coreMock.createStart(); + (core.http.get as any as jest.SpyInstance).mockImplementation(() => + Promise.resolve({ saved_objects: [doc] }) + ); + core.uiSettings.get.mockImplementation(() => 10); - const wrapper = mount( - - ); + const wrapper = mount( + + ); - wrapper.instance().componentDidMount!(); - await nextTick(); - wrapper.update(); - findTestSubject(wrapper, 'savedObjectTitleExample-title').simulate('click'); - expect(chooseStub.calledWith('1', 'search', `${doc.attributes.title} (Search)`, doc)).toEqual( - true - ); + wrapper.instance().componentDidMount!(); + await nextTick(); + wrapper.update(); + findTestSubject(wrapper, 'savedObjectTitleExample-title').simulate('click'); + expect(chooseStub.calledWith('1', 'search', `${doc.attributes.title} (Search)`, doc)).toEqual( + true + ); + }); + + it('with help text', async () => { + const core = coreMock.createStart(); + (core.http.get as any as jest.SpyInstance).mockImplementation(() => + Promise.resolve({ saved_objects: [doc] }) + ); + core.uiSettings.get.mockImplementation(() => 10); + + const wrapper = shallow( + + ); + + wrapper.instance().componentDidMount!(); + await nextTick(); + expect(wrapper.find(EuiText).childAt(0).text()).toEqual( + 'This is some description about the action' + ); + }); + + it('with left button', async () => { + const core = coreMock.createStart(); + (core.http.get as any as jest.SpyInstance).mockImplementation(() => + Promise.resolve({ saved_objects: [doc] }) + ); + core.uiSettings.get.mockImplementation(() => 10); + const button = Hello; + const wrapper = shallow( + + ); + + wrapper.instance().componentDidMount!(); + await nextTick(); + const searchBar = wrapper.find(EuiInMemoryTable).prop('search') as EuiSearchBarProps; + const toolsLeft = searchBar!.toolsLeft; + expect(toolsLeft).toMatchInlineSnapshot( + ` + + + Hello + + + ` + ); + }); }); describe('sorting', () => { diff --git a/src/plugins/saved_objects_finder/public/finder/saved_object_finder.tsx b/src/plugins/saved_objects_finder/public/finder/saved_object_finder.tsx index 2db81716876c9..56f8b203f694c 100644 --- a/src/plugins/saved_objects_finder/public/finder/saved_object_finder.tsx +++ b/src/plugins/saved_objects_finder/public/finder/saved_object_finder.tsx @@ -8,7 +8,7 @@ import { debounce } from 'lodash'; import PropTypes from 'prop-types'; -import React from 'react'; +import React, { ReactElement, ReactNode } from 'react'; import type { SavedObjectsManagementPluginStart } from '@kbn/saved-objects-management-plugin/public'; import { @@ -22,6 +22,9 @@ import { SearchFilterConfig, Query, PropertySort, + EuiFlexItem, + EuiFlexGroup, + EuiText, } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; @@ -69,9 +72,11 @@ interface BaseSavedObjectFinder { name: string, savedObject: SavedObjectCommon ) => void; - noItemsMessage?: React.ReactNode; + noItemsMessage?: ReactNode; savedObjectMetaData: Array>; showFilter?: boolean; + leftChildren?: ReactElement | ReactElement[]; + helpText?: string; } interface SavedObjectFinderFixedPage extends BaseSavedObjectFinder { @@ -355,23 +360,35 @@ export class SavedObjectFinderUi extends React.Component< ] : undefined, toolsRight: this.props.children ? <>{this.props.children} : undefined, + toolsLeft: this.props.leftChildren ? <>{this.props.leftChildren} : undefined, }; return ( - { - this.setState({ sort }); - }} - /> + + {this.props.helpText ? ( + + + {this.props.helpText} + + + ) : undefined} + + { + this.setState({ sort }); + }} + /> + + ); } } diff --git a/src/plugins/saved_objects_management/public/management_section/object_view/components/__snapshots__/not_found_errors.test.tsx.snap b/src/plugins/saved_objects_management/public/management_section/object_view/components/__snapshots__/not_found_errors.test.tsx.snap index 0155059029f4e..303cbeaebe1de 100644 --- a/src/plugins/saved_objects_management/public/management_section/object_view/components/__snapshots__/not_found_errors.test.tsx.snap +++ b/src/plugins/saved_objects_management/public/management_section/object_view/components/__snapshots__/not_found_errors.test.tsx.snap @@ -11,7 +11,7 @@ exports[`NotFoundErrors component renders correctly for index-pattern type 1`] = aria-hidden="true" class="emotion-euiCallOut__icon" color="inherit" - data-euiicon-type="alert" + data-euiicon-type="warning" /> There is a problem with this saved object

@@ -60,7 +60,7 @@ exports[`NotFoundErrors component renders correctly for index-pattern-field type aria-hidden="true" class="emotion-euiCallOut__icon" color="inherit" - data-euiicon-type="alert" + data-euiicon-type="warning" /> There is a problem with this saved object

@@ -109,7 +109,7 @@ exports[`NotFoundErrors component renders correctly for search type 1`] = ` aria-hidden="true" class="emotion-euiCallOut__icon" color="inherit" - data-euiicon-type="alert" + data-euiicon-type="warning" /> There is a problem with this saved object

@@ -158,7 +158,7 @@ exports[`NotFoundErrors component renders correctly for unknown type 1`] = ` aria-hidden="true" class="emotion-euiCallOut__icon" color="inherit" - data-euiicon-type="alert" + data-euiicon-type="warning" /> There is a problem with this saved object

diff --git a/src/plugins/saved_objects_management/public/management_section/object_view/components/not_found_errors.tsx b/src/plugins/saved_objects_management/public/management_section/object_view/components/not_found_errors.tsx index c6cf64115d6a2..3e4efa4e9c199 100644 --- a/src/plugins/saved_objects_management/public/management_section/object_view/components/not_found_errors.tsx +++ b/src/plugins/saved_objects_management/public/management_section/object_view/components/not_found_errors.tsx @@ -61,7 +61,7 @@ export const NotFoundErrors = ({ type, docLinks }: NotFoundErrors) => { defaultMessage="There is a problem with this saved object" /> } - iconType="alert" + iconType="warning" color="danger" >
{getMessage()}
diff --git a/src/plugins/saved_objects_management/public/management_section/objects_table/components/__snapshots__/relationships.test.tsx.snap b/src/plugins/saved_objects_management/public/management_section/objects_table/components/__snapshots__/relationships.test.tsx.snap index f9579693eb135..c7afed8ba4262 100644 --- a/src/plugins/saved_objects_management/public/management_section/objects_table/components/__snapshots__/relationships.test.tsx.snap +++ b/src/plugins/saved_objects_management/public/management_section/objects_table/components/__snapshots__/relationships.test.tsx.snap @@ -393,7 +393,7 @@ exports[`Relationships should render invalid relations 1`] = ` diff --git a/src/plugins/saved_objects_management/public/management_section/objects_table/components/delete_confirm_modal.tsx b/src/plugins/saved_objects_management/public/management_section/objects_table/components/delete_confirm_modal.tsx index 65e29fb1fd194..a422526c7afad 100644 --- a/src/plugins/saved_objects_management/public/management_section/objects_table/components/delete_confirm_modal.tsx +++ b/src/plugins/saved_objects_management/public/management_section/objects_table/components/delete_confirm_modal.tsx @@ -94,7 +94,7 @@ export const DeleteConfirmModal: FC = ({ defaultMessage="Some objects cannot be deleted" /> } - iconType="alert" + iconType="warning" color="warning" >

@@ -119,7 +119,7 @@ export const DeleteConfirmModal: FC = ({ values={{ sharedObjectsCount }} /> } - iconType="alert" + iconType="warning" color="warning" >

diff --git a/src/plugins/saved_objects_management/public/management_section/objects_table/components/import_summary.tsx b/src/plugins/saved_objects_management/public/management_section/objects_table/components/import_summary.tsx index 70788ac04af4b..be0cc126b079a 100644 --- a/src/plugins/saved_objects_management/public/management_section/objects_table/components/import_summary.tsx +++ b/src/plugins/saved_objects_management/public/management_section/objects_table/components/import_summary.tsx @@ -167,7 +167,7 @@ const StatusIndicator: FC<{ item: ImportItem }> = ({ item }) => { case 'error': return ( diff --git a/src/plugins/saved_objects_management/public/management_section/objects_table/components/relationships.tsx b/src/plugins/saved_objects_management/public/management_section/objects_table/components/relationships.tsx index 825e661979136..070b3129bcb1b 100644 --- a/src/plugins/saved_objects_management/public/management_section/objects_table/components/relationships.tsx +++ b/src/plugins/saved_objects_management/public/management_section/objects_table/components/relationships.tsx @@ -194,7 +194,7 @@ export class Relationships extends Component { data-share-url={this.state.url} data-test-subj="copyShareUrlButton" size="s" - iconType={this.state.showWarningButton ? 'alert' : undefined} + iconType={this.state.showWarningButton ? 'warning' : undefined} color={this.state.showWarningButton ? 'warning' : 'primary'} > {this.props.isEmbedded ? ( diff --git a/src/plugins/share/public/url_service/redirect/components/error.tsx b/src/plugins/share/public/url_service/redirect/components/error.tsx index 716848427c638..c7e9e1a9f1095 100644 --- a/src/plugins/share/public/url_service/redirect/components/error.tsx +++ b/src/plugins/share/public/url_service/redirect/components/error.tsx @@ -32,7 +32,7 @@ export interface ErrorProps { export const Error: React.FC = ({ title = defaultTitle, error }) => { return ( {title}} body={ diff --git a/src/plugins/telemetry/public/mocks.ts b/src/plugins/telemetry/public/mocks.ts index e96740fe1bee6..297563460e888 100644 --- a/src/plugins/telemetry/public/mocks.ts +++ b/src/plugins/telemetry/public/mocks.ts @@ -48,7 +48,7 @@ export function mockTelemetryService({ const telemetryService = new TelemetryService({ config, http: httpServiceMock.createStartContract(), - notifications: notificationServiceMock.createStartContract(), + notifications: notificationServiceMock.createSetupContract(), isScreenshotMode, currentKibanaVersion, reportOptInStatusChange, diff --git a/src/plugins/telemetry/public/services/telemetry_service.ts b/src/plugins/telemetry/public/services/telemetry_service.ts index c1b96f4749067..e7b3e69ab9e83 100644 --- a/src/plugins/telemetry/public/services/telemetry_service.ts +++ b/src/plugins/telemetry/public/services/telemetry_service.ts @@ -7,7 +7,7 @@ */ import { i18n } from '@kbn/i18n'; -import { CoreStart } from '@kbn/core/public'; +import { CoreSetup, CoreStart } from '@kbn/core/public'; import { TelemetryPluginConfig } from '../plugin'; import { getTelemetryChannelEndpoint } from '../../common/telemetry_config/get_telemetry_channel_endpoint'; import type { @@ -19,7 +19,7 @@ import { PAYLOAD_CONTENT_ENCODING } from '../../common/constants'; interface TelemetryServiceConstructor { config: TelemetryPluginConfig; http: CoreStart['http']; - notifications: CoreStart['notifications']; + notifications: CoreSetup['notifications']; isScreenshotMode: boolean; currentKibanaVersion: string; reportOptInStatusChange?: boolean; @@ -32,7 +32,7 @@ interface TelemetryServiceConstructor { export class TelemetryService { private readonly http: CoreStart['http']; private readonly reportOptInStatusChange: boolean; - private readonly notifications: CoreStart['notifications']; + private readonly notifications: CoreSetup['notifications']; private readonly defaultConfig: TelemetryPluginConfig; private readonly isScreenshotMode: boolean; private updatedConfig?: TelemetryPluginConfig; diff --git a/src/plugins/telemetry_management_section/public/components/__snapshots__/telemetry_management_section.test.tsx.snap b/src/plugins/telemetry_management_section/public/components/__snapshots__/telemetry_management_section.test.tsx.snap index a341fcd17b76d..322a698e9bdaf 100644 --- a/src/plugins/telemetry_management_section/public/components/__snapshots__/telemetry_management_section.test.tsx.snap +++ b/src/plugins/telemetry_management_section/public/components/__snapshots__/telemetry_management_section.test.tsx.snap @@ -305,6 +305,7 @@ exports[`TelemetryManagementSectionComponent renders null because allowChangingO }, "isScreenshotMode": false, "notifications": Object { + "showErrorDialog": [MockFunction], "toasts": Object { "add": [MockFunction], "addDanger": [MockFunction], diff --git a/src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/components/drilldown_form/drilldown_form.tsx b/src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/components/drilldown_form/drilldown_form.tsx index 33032e7914e19..548c33d5f9b4a 100644 --- a/src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/components/drilldown_form/drilldown_form.tsx +++ b/src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/components/drilldown_form/drilldown_form.tsx @@ -53,7 +53,7 @@ export const DrilldownForm: React.FC = ({ if (!!triggers && !triggers.items.length) { // Below callout is not translated, because this message is only for developers. return ( - +

No triggers provided in triggers prop.

diff --git a/src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/components/drilldown_table/drilldown_table.tsx b/src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/components/drilldown_table/drilldown_table.tsx index 3607ce42a69f5..ecc0d23f09092 100644 --- a/src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/components/drilldown_table/drilldown_table.tsx +++ b/src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/components/drilldown_table/drilldown_table.tsx @@ -75,7 +75,7 @@ export const DrilldownTable: React.FC = ({ {drilldown.error && ( = ({ diff --git a/src/plugins/unified_field_list/public/components/field_list_grouped/fields_accordion.tsx b/src/plugins/unified_field_list/public/components/field_list_grouped/fields_accordion.tsx index cda13fd18a42e..1989840af1b29 100644 --- a/src/plugins/unified_field_list/public/components/field_list_grouped/fields_accordion.tsx +++ b/src/plugins/unified_field_list/public/components/field_list_grouped/fields_accordion.tsx @@ -100,7 +100,7 @@ function InnerFieldsAccordion({ aria-label={i18n.translate('unifiedFieldList.fieldsAccordion.existenceErrorAriaLabel', { defaultMessage: 'Existence fetch failed', })} - type="alert" + type="warning" color="warning" content={i18n.translate('unifiedFieldList.fieldsAccordion.existenceErrorLabel', { defaultMessage: "Field information can't be loaded", diff --git a/src/plugins/unified_histogram/public/chart/hooks/use_time_range.test.tsx b/src/plugins/unified_histogram/public/chart/hooks/use_time_range.test.tsx index 35951d637315c..b32681aaf6946 100644 --- a/src/plugins/unified_histogram/public/chart/hooks/use_time_range.test.tsx +++ b/src/plugins/unified_histogram/public/chart/hooks/use_time_range.test.tsx @@ -164,7 +164,7 @@ describe('useTimeRange', () => { color="warning" content="This interval creates buckets that are too large to show in the selected time range, so it has been scaled to 1 minute." title="Warning" - type="alert" + type="warning" /> @@ -230,7 +230,7 @@ describe('useTimeRange', () => { color="warning" content="This interval creates too many buckets to show in the selected time range, so it has been scaled to 1 minute." title="Warning" - type="alert" + type="warning" /> diff --git a/src/plugins/unified_histogram/public/chart/hooks/use_time_range.tsx b/src/plugins/unified_histogram/public/chart/hooks/use_time_range.tsx index dbf563da17588..8f7786b2c6be7 100644 --- a/src/plugins/unified_histogram/public/chart/hooks/use_time_range.tsx +++ b/src/plugins/unified_histogram/public/chart/hooks/use_time_range.tsx @@ -114,7 +114,12 @@ export const useTimeRange = ({ > {timeRangeDisplay} - + ); diff --git a/src/plugins/unified_search/public/dataview_picker/change_dataview.tsx b/src/plugins/unified_search/public/dataview_picker/change_dataview.tsx index e828e4d1a2bc1..670c16515286d 100644 --- a/src/plugins/unified_search/public/dataview_picker/change_dataview.tsx +++ b/src/plugins/unified_search/public/dataview_picker/change_dataview.tsx @@ -249,7 +249,7 @@ export function ChangeDataView({ )} > diff --git a/src/plugins/unified_search/public/query_string_input/query_bar_menu_panels.tsx b/src/plugins/unified_search/public/query_string_input/query_bar_menu_panels.tsx index b074fdd391d7c..e32a9a13d64f0 100644 --- a/src/plugins/unified_search/public/query_string_input/query_bar_menu_panels.tsx +++ b/src/plugins/unified_search/public/query_string_input/query_bar_menu_panels.tsx @@ -371,7 +371,7 @@ export function QueryBarMenuPanels({ { name: strings.getClearllFiltersButtonLabel(), disabled: !hasFiltersOrQuery && !Boolean(savedQuery), - icon: 'crossInACircleFilled', + icon: 'cross', 'data-test-subj': 'filter-sets-removeAllFilters', onClick: () => { closePopover(); diff --git a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/editor_footer.tsx b/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/editor_footer.tsx index ff7237e059925..90e30b6c019e6 100644 --- a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/editor_footer.tsx +++ b/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/editor_footer.tsx @@ -68,7 +68,7 @@ export const EditorFooter = memo(function EditorFooter({ - + - + {i18n.translate( diff --git a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/index.tsx b/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/index.tsx index 18f08bfa750eb..e68f4517cad2b 100644 --- a/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/index.tsx +++ b/src/plugins/unified_search/public/query_string_input/text_based_languages_editor/index.tsx @@ -500,7 +500,7 @@ export const TextBasedLanguagesEditor = memo(function TextBasedLanguagesEditor({ diff --git a/src/plugins/vis_default_editor/public/components/agg.tsx b/src/plugins/vis_default_editor/public/components/agg.tsx index e3794077b005d..c816bfaf8c115 100644 --- a/src/plugins/vis_default_editor/public/components/agg.tsx +++ b/src/plugins/vis_default_editor/public/components/agg.tsx @@ -159,7 +159,7 @@ function DefaultEditorAgg({ actionIcons.push({ id: 'hasErrors', color: 'danger', - type: 'alert', + type: 'error', tooltip: i18n.translate('visDefaultEditor.agg.errorsAriaLabel', { defaultMessage: '{schemaTitle} {aggTitle} aggregation has errors', values: { aggTitle, schemaTitle }, diff --git a/src/plugins/vis_default_editor/public/components/agg_params_map.ts b/src/plugins/vis_default_editor/public/components/agg_params_map.ts index e7361af3b7e6d..7802da7bf9e2f 100644 --- a/src/plugins/vis_default_editor/public/components/agg_params_map.ts +++ b/src/plugins/vis_default_editor/public/components/agg_params_map.ts @@ -24,12 +24,6 @@ const buckets = { [BUCKET_TYPES.FILTERS]: { filters: controls.FiltersParamEditor, }, - [BUCKET_TYPES.GEOHASH_GRID]: { - autoPrecision: controls.AutoPrecisionParamEditor, - precision: controls.PrecisionParamEditor, - useGeocentroid: controls.UseGeocentroidParamEditor, - isFilteredByCollar: controls.IsFilteredByCollarParamEditor, - }, [BUCKET_TYPES.HISTOGRAM]: { interval: controls.NumberIntervalParamEditor, maxBars: controls.MaxBarsParamEditor, diff --git a/src/plugins/vis_default_editor/public/components/controls/auto_precision.tsx b/src/plugins/vis_default_editor/public/components/controls/auto_precision.tsx deleted file mode 100644 index 7e2244216d4f2..0000000000000 --- a/src/plugins/vis_default_editor/public/components/controls/auto_precision.tsx +++ /dev/null @@ -1,32 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import React from 'react'; - -import { EuiSwitch, EuiFormRow } from '@elastic/eui'; -import { i18n } from '@kbn/i18n'; -import { AggParamEditorProps } from '../agg_param_props'; - -function AutoPrecisionParamEditor({ value = false, setValue }: AggParamEditorProps) { - const label = i18n.translate('visDefaultEditor.controls.changePrecisionLabel', { - defaultMessage: 'Change precision on map zoom', - }); - - return ( - - setValue(ev.target.checked)} - /> - - ); -} - -export { AutoPrecisionParamEditor }; diff --git a/src/plugins/vis_default_editor/public/components/controls/index.ts b/src/plugins/vis_default_editor/public/components/controls/index.ts index 6c54c4fd0d54a..3d040130b2acd 100644 --- a/src/plugins/vis_default_editor/public/components/controls/index.ts +++ b/src/plugins/vis_default_editor/public/components/controls/index.ts @@ -6,7 +6,6 @@ * Side Public License, v 1. */ -export { AutoPrecisionParamEditor } from './auto_precision'; export { DateRangesParamEditor } from './date_ranges'; export { DropPartialsParamEditor } from './drop_partials'; export { ExtendedBoundsParamEditor } from './extended_bounds'; @@ -16,7 +15,6 @@ export { HasExtendedBoundsParamEditor } from './has_extended_bounds'; export { IncludeExcludeParamEditor } from './include_exclude'; export { IpRangesParamEditor } from './ip_ranges'; export { IpRangeTypeParamEditor } from './ip_range_type'; -export { IsFilteredByCollarParamEditor } from './is_filtered_by_collar'; export { MetricAggParamEditor } from './metric_agg'; export { MinDocCountParamEditor } from './min_doc_count'; export { MissingBucketParamEditor } from './missing_bucket'; @@ -26,7 +24,6 @@ export { OtherBucketParamEditor } from './other_bucket'; export { OrderAggParamEditor } from './order_agg'; export { PercentilesEditor } from './percentiles'; export { PercentileRanksEditor } from './percentile_ranks'; -export { PrecisionParamEditor } from './precision'; export { RangesControl } from './range_control'; export { RawJsonParamEditor } from './raw_json'; export { ScaleMetricsParamEditor } from './scale_metrics'; @@ -40,5 +37,4 @@ export { TopFieldParamEditor } from './top_field'; export { TopSizeParamEditor } from './top_size'; export { TopSortFieldParamEditor } from './top_sort_field'; export { OrderParamEditor } from './order'; -export { UseGeocentroidParamEditor } from './use_geocentroid'; export { MaxBarsParamEditor } from './max_bars'; diff --git a/src/plugins/vis_default_editor/public/components/controls/is_filtered_by_collar.tsx b/src/plugins/vis_default_editor/public/components/controls/is_filtered_by_collar.tsx deleted file mode 100644 index eebc68de54387..0000000000000 --- a/src/plugins/vis_default_editor/public/components/controls/is_filtered_by_collar.tsx +++ /dev/null @@ -1,36 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import React from 'react'; -import { i18n } from '@kbn/i18n'; -import { SwitchParamEditor } from './switch'; -import { AggParamEditorProps } from '../agg_param_props'; - -function IsFilteredByCollarParamEditor(props: AggParamEditorProps) { - return ( - - ); -} - -export { IsFilteredByCollarParamEditor }; diff --git a/src/plugins/vis_default_editor/public/components/controls/precision.tsx b/src/plugins/vis_default_editor/public/components/controls/precision.tsx deleted file mode 100644 index 872c254cc9105..0000000000000 --- a/src/plugins/vis_default_editor/public/components/controls/precision.tsx +++ /dev/null @@ -1,43 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import React from 'react'; - -import { EuiRange, EuiFormRow } from '@elastic/eui'; -import { i18n } from '@kbn/i18n'; -import { IUiSettingsClient } from '@kbn/core/public'; - -import { useKibana } from '@kbn/kibana-react-plugin/public'; -import { AggParamEditorProps } from '../agg_param_props'; - -function PrecisionParamEditor({ agg, value, setValue }: AggParamEditorProps) { - const { services } = useKibana<{ uiSettings: IUiSettingsClient }>(); - const label = i18n.translate('visDefaultEditor.controls.precisionLabel', { - defaultMessage: 'Precision', - }); - - if (agg.params.autoPrecision) { - return null; - } - - return ( - - setValue(Number(ev.currentTarget.value))} - data-test-subj={`visEditorMapPrecision${agg.id}`} - showValue - compressed - /> - - ); -} - -export { PrecisionParamEditor }; diff --git a/src/plugins/vis_default_editor/public/components/controls/use_geocentroid.tsx b/src/plugins/vis_default_editor/public/components/controls/use_geocentroid.tsx deleted file mode 100644 index 613921c40288b..0000000000000 --- a/src/plugins/vis_default_editor/public/components/controls/use_geocentroid.tsx +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import React from 'react'; -import { EuiSwitch, EuiFormRow } from '@elastic/eui'; -import { i18n } from '@kbn/i18n'; -import { AggParamEditorProps } from '../agg_param_props'; - -function UseGeocentroidParamEditor({ value = false, setValue }: AggParamEditorProps) { - const label = i18n.translate('visDefaultEditor.controls.placeMarkersOffGridLabel', { - defaultMessage: 'Place markers off grid (use geocentroid)', - }); - - return ( - - setValue(ev.target.checked)} - /> - - ); -} - -export { UseGeocentroidParamEditor }; diff --git a/src/plugins/vis_default_editor/public/components/sidebar/controls.tsx b/src/plugins/vis_default_editor/public/components/sidebar/controls.tsx index 3ae15ed24832d..678a6c2edaf97 100644 --- a/src/plugins/vis_default_editor/public/components/sidebar/controls.tsx +++ b/src/plugins/vis_default_editor/public/components/sidebar/controls.tsx @@ -83,7 +83,7 @@ function DefaultEditorControls({ defaultMessage: 'Errors in the highlighted fields need to be resolved.', })} > - + => min: 0, max: 1, aggFilter: [ - '!geohash_grid', '!geotile_grid', '!filter', '!sampler', diff --git a/src/plugins/vis_types/pie/public/sample_vis.test.mocks.ts b/src/plugins/vis_types/pie/public/sample_vis.test.mocks.ts index 58a512d95bd64..fdf731224d8d7 100644 --- a/src/plugins/vis_types/pie/public/sample_vis.test.mocks.ts +++ b/src/plugins/vis_types/pie/public/sample_vis.test.mocks.ts @@ -93,7 +93,6 @@ export const samplePieVis = { min: 0, max: null, aggFilter: [ - '!geohash_grid', '!geotile_grid', '!filter', '!sampler', @@ -113,7 +112,6 @@ export const samplePieVis = { min: 0, max: 1, aggFilter: [ - '!geohash_grid', '!geotile_grid', '!filter', '!sampler', diff --git a/src/plugins/vis_types/pie/public/vis_type/pie.ts b/src/plugins/vis_types/pie/public/vis_type/pie.ts index 8d4b7b6828e39..dfe88e3191a91 100644 --- a/src/plugins/vis_types/pie/public/vis_type/pie.ts +++ b/src/plugins/vis_types/pie/public/vis_type/pie.ts @@ -90,7 +90,6 @@ export const getPieVisTypeDefinition = ({ min: 0, max: Infinity, aggFilter: [ - '!geohash_grid', '!geotile_grid', '!filter', '!sampler', @@ -110,7 +109,6 @@ export const getPieVisTypeDefinition = ({ min: 0, max: 1, aggFilter: [ - '!geohash_grid', '!geotile_grid', '!filter', '!sampler', diff --git a/src/plugins/vis_types/timelion/server/lib/load_functions.js b/src/plugins/vis_types/timelion/server/lib/load_functions.js index cb765c1cb7dca..8329623261d20 100644 --- a/src/plugins/vis_types/timelion/server/lib/load_functions.js +++ b/src/plugins/vis_types/timelion/server/lib/load_functions.js @@ -9,6 +9,7 @@ import _ from 'lodash'; import globby from 'globby'; import path from 'path'; +import normalizePath from 'normalize-path'; import processFunctionDefinition from './process_function_definition'; export default function (directory) { @@ -19,7 +20,7 @@ export default function (directory) { // Get a list of all files and use the filename as the object key const files = _.map( globby - .sync(path.resolve(__dirname, '../' + directory + '/*.js')) + .sync(normalizePath(path.resolve(__dirname, '../' + directory + '/*.js'))) .filter((filename) => !filename.includes('.test')), function (file) { const name = file.substring(file.lastIndexOf('/') + 1, file.lastIndexOf('.')); @@ -29,7 +30,7 @@ export default function (directory) { // Get a list of all directories with an index.js, use the directory name as the key in the object const directories = _.chain( - globby.sync(path.resolve(__dirname, '../' + directory + '/*/index.js')) + globby.sync(normalizePath(path.resolve(__dirname, '../' + directory + '/*/index.js'))) ) .map(function (file) { const parts = file.split('/'); diff --git a/src/plugins/vis_types/timeseries/public/application/components/error.js b/src/plugins/vis_types/timeseries/public/application/components/error.js index ad37ba853efdf..c2b3027493f97 100644 --- a/src/plugins/vis_types/timeseries/public/application/components/error.js +++ b/src/plugins/vis_types/timeseries/public/application/components/error.js @@ -47,7 +47,7 @@ export function ErrorComponent(props) { return (
-